---

pxctl service

Description

Service mode utilities

pxctl service exit

Description

Stop the PX daemon

pxctl service audit

Description

Audit the PX node

pxctl service node-usage

Description

Volume usage by PX node

Example

pxctl service info

Description

Show PX module version information

pxctl service call-home

Description

Enable or disable the call home feature

Example

pxctl service node-wipe

Description

Wipes PX configuration data on this node

Flags

Flag	Description
--all, -a (bool)	clears PX footprint from all storage devices
--pxv (bool)	Force removal of journal devices when using PXV
--storage_devices, -s (str)	comma-separated list of storage devices to be wiped.

pxctl service diags

Description

creates a new tgz package with essential diagnostic information.

Flags

Flag	Description
--output, -o (str)	output file name
--dockerhost (str)	docker host daemon Default value: unix:///var/run/docker.sock
--container (str)	PX container ID
--live, -l (bool)	gets diags from running px
--upload, -u (bool)	upload diags to cloud
--upload-file (str)	skips diags generation, upload given file directly to cloud
--profile, -p (bool)	only dump profile
--all, -a (bool)	creates a new tgz package with all the available diagnostic information.
--cluster, -c (bool)	generate diags for all the nodes in the cluster.
--node, -n (str)	generate diags for a specific remote node with the provided NodeIp or NodeID.
--force, -f (bool)	force overwrite existing diags.
--extra (bool)	Collect extra information (used primarily for test).

pxctl service maintenance

Description

Maintenance mode operations

Flags

Flag	Description
--exit, -x (bool)	exit maintenance mode
--enter, -e (bool)	enter maintenance mode
--cycle, -c (bool)	cycle maintenance mode
--reset, -r (bool)	reset the system
--%!s(bool=true), -%!s(bool=true) (bool)	Assume 'yes' to confirmation prompt

pxctl service email

Description

Email setting commands

pxctl service email set

Description

Configure email settings for alerts.

Flags

Flag	Description
--server, -s (str)	IP or DNS name for smtp server
--smtp-port, -p (str)	IP or DNS name for smtp server
--username, -u (str)	Username to authenticate with smtp-server (if required)
--password (str)	Password to authenticate with smtp-server (if required)
--sender (str)	Sender of alert emails (defaults to noreply@portworx.com) Default value: noreply@portworx.com
--recipient, -r (str)	Recipient of alert emails.
--severity (str)	Minimum severity for email trigger, (warning|critical) Default value: critical
--notify (bool)	Notify portworx of critical alerts

pxctl service email get

Description

Get email settings for alerts.

pxctl service email clear

Description

Clear email settings for alerts.

pxctl service slack

Description

Slack setting commands

pxctl service slack set

Description

Configure slack settings for alerts.

Flags

Flag	Description
--webhookurl, -w (str)	url of the slack webhook Required: true
--severity, -s (str)	Minimum severity for slack trigger, (warning|critical) Default value: critical

pxctl service slack get

Description

Get slack settings for alerts.

pxctl service slack delete

Description

Delete slack settings for alerts.

pxctl service drive

Description

Storage drive maintenance

pxctl service drive show

Description

Show drives

Flags

Flag	Description
--all, -a (bool)	Shows additional information on the drive usage

pxctl service drive add

Description

Add storage

Flags

Flag	Description
--drive, -d (str)	comma-separated source drives
--spec, -s (str)	Cloud drive spec in type=<>,size=<> format
--newpool (bool)	Create a new pool using this drive.
--journal (bool)	Use this drive as a journal device.
--metadata (bool)	Use this drive as a system metadata device.
--cache (int)	Use this drive as a cache device for given pool. Default value: -1
--poolID, -p (int)	Add the drive to the specified existing pool ID. Default value: -1
--operation, -o (str)	start|status Default value: start
--%!s(bool=true), -%!s(bool=true) (bool)	Assume 'yes' to confirmation prompt
--skip-deprecation (bool)	Allow running deprecated drive add commands

pxctl service drive replace

Description

Replace source drive with target drive

Flags

Flag	Description
--source, -s (str)	Source drive
--target, -t (str)	Target drive
--operation, -o (str)	start|cancel|status Default value: start

pxctl service drive rebalance

Description

Rebalance storage

Flags

Flag	Description
--poolID, -p (str)	Storage pool
--operation, -o (str)	start|cancel|status Default value: status
--full (bool)	full rebalance (use with caution)

pxctl service drive check

Description

Check drives

Flags

Flag	Description
--full (bool)	Detailed report

pxctl service node

Description

Node maintenance operations

pxctl service node drain-attachments

Description

Drain/Remove volume attachments from a node

pxctl service node drain-attachments submit

Description

Submit a new job to drain attachments.

Flags

Flag	Description
--%!s(bool=true), -y (bool)	Skips user confirmation
--node, -n (str)	NodeID of the node from which the volume attachments will be removed Required: true
--issuer, -i (str)	Name of the issuer who is submitting this job
--wait, -w (bool)	Wait until the drain job is complete. The command will be unblocked when the job completes or a it hits a 5 min timeout.
--wait-timeout-sec, -t (int)	Wait timeout in seconds. Default is 5 mins. Default value: 300
--quiet, -q (bool)	Do not print summary when running the command in wait mode.

pxctl service node drain-attachments list

Description

Lists drain attachment jobs in the system

pxctl service node drain-attachments status

Description

Status of a drain attachments job

Flags

Flag	Description
--job-id, -i (str)	Required: true

pxctl service node drain-attachments cancel

Description

Cancels a drain attachments job

Flags

Flag	Description
--job-id, -i (str)	Required: true

pxctl service node cordon-attachments

Description

Cordons/Disables any new volume attachments from a node. Existing volumes will stay attached

Flags

Flag	Description
--node (str)	ID of the node for which any new volume attachments will be disabled Required: true

pxctl service node uncordon-attachments

Description

Re-enables volume attachments for a node.

Flags

Flag	Description
--node (str)	ID of the node for which volume attachments will be re-enabled Required: true

pxctl service pool

Description

Storage pool maintenance

pxctl service pool show

Description

Show pools

Flags

Flag	Description
--all, -a (bool)	Shows additional information on the drive usage

pxctl service pool rebalance

Description

Rebalance storage pools

pxctl service pool rebalance submit

Description

Submit a new rebalance job

Flags

Flag	Description
--%!s(bool=true), -y (bool)	Skips user confirmation
--dry-run, -d (bool)	Produces steps that would be taken without making any changes to the system
--source-pool-selector (str)	Comma-separated label selector of the form label1=value1,label2=value2 etc., that allows selecting pools to which over-load trigger thresholds will apply.
--target-pool-selector (str)	Comma-separated label selector of the form label1=value1,label2=value2 etc., that allows selecting pools to which under-load trigger thresholds will apply.
--max-duration-minutes, -m (uint)	Defines how long operation should run when started. 0 values means no limit on duration
--remove-repl-1-snapshots (str)	delete snapshots which don't have parent on same pool after rebalance

pxctl service pool rebalance list

Description

Lists rebalance jobs in the system

pxctl service pool rebalance status

Description

Status of a rebalance job

Flags

Flag	Description
--job-id, -i (str)	Required: true

pxctl service pool rebalance cancel

Description

Cancels a rebalance job

Flags

Flag	Description
--job-id, -i (str)	Required: true

pxctl service pool rebalance resume

Description

Resumes a rebalance job

Flags

Flag	Description
--job-id, -i (str)	Required: true

pxctl service pool rebalance pause

Description

Pauses a rebalance job

Flags

Flag	Description
--job-id, -i (str)	Required: true

pxctl service pool expand

Description

Expand pool

Flags

Flag	Description
--size, -s (int)	Minimum new required size of the storage pool in GiB. The eventual size of the pool can be greater than this as PX needs to add/resize disks such that all disks in the pool are of the same size Required: true
--uid, -u (str)	Pool's UID Required: true
--operation, -o (str)	Operation to perform to expand the pool Default value: auto Required: true
--dont-wait-for-clean-volumes, -f (bool)	Don't wait for volumes on the pool to be clean before starting expansion

pxctl service pool update

Description

Update pool properties

Example

Flags

Flag	Description
--io_priority (str)	IO Priority Default value: low
--labels (str)	comma separated name=value pairs (empty value to remove label) Default value: NoLabel
--resize (bool)	extend pool to maximum available physical storage
--uid, -u (str)	Pool's UID
--reset-last-op (bool)	Admin command to reset pool's last operation. Pool resources won't be cleaned up. Use with caution!
--skip-deprecation (bool)	Allow running deprecated pool update commands

pxctl service pool cache

Description

Update cache properties on a given pool

pxctl service pool cache configure

Description

configure cache parameters for a pool

Example

Flags

Flag	Description
--mode (str)	cache operating mode
--blocksize (str)	cache blocksize hint, software can optimize this value Default value: auto
--policy (str)	cache policy
--tunables (str)	cache settings

pxctl service pool cache status

Description

cache status on given pool

Example

pxctl service pool cache enable

Description

enable cache on a pool

Example

pxctl service pool cache disable

Description

disable cache on a pool

Example

pxctl service pool cache flush

Description

force cache flush on a pool

Example

Flags

Flag	Description
--operation, -o (str)	start|status Default value: start

pxctl service pool maintenance

Description

Pool maintenance

Flags

Flag	Description
--exit, -x (bool)	exit maintenance mode
--enter, -e (bool)	enter maintenance mode
--%!s(bool=true), -%!s(bool=true) (bool)	Assume 'yes' to confirmation prompt

pxctl service kvdb

Description

PX Kvdb operations

pxctl service kvdb restore

Description

Restore keys and values into kvdb from a kvdb.dump file

Example

Flags

Flag	Description
--kvdb_dump_file, -k (str)	Kvdb dump file location Required: true
--force, -f (bool)	Force will delete any existing keys from kvdb and perform the restore

pxctl service kvdb endpoints

Description

List the kvdb client endpoints

pxctl service kvdb members

Description

List the kvdb cluster members

pxctl service relaxedreclaim

Description

Manage the RelaxedReclaim queue for the node

pxctl service relaxedreclaim purge

Description

Purge the RelaxedReclaim queue for the node

Example

pxctl service relaxedreclaim list

Description

List the RelaxedReclaim queue for the node

Example

pxctl service relaxedreclaim delete

Description

Delete a volume from the RelaxedReclaim queue for the node

Example

pxctl service usage-report

Description

creates & download tgz package for px consumption reports

Flags

Flag	Description
--download (bool)	generate reports for px consumption
--year (int)	generate reports of px consumption Default value: 2022
--month (int)	generate reports of px consumption for month Default value: 1