pxctl service
pxctl service
pxctl service
Description
Service mode utilities
pxctl service exit
pxctl service exit
Description
Stop the PX daemon
pxctl service audit
pxctl service audit
Description
Audit the PX node
pxctl service node-usage
pxctl service node-usage <required-argument>
Description
Volume usage by PX node
Example
pxctl service node-usage <node-id> "Node-ID" is mandatory
pxctl service info
pxctl service info
Description
Show PX module version information
pxctl service call-home
pxctl service call-home <required-argument>
Description
Enable or disable the call home feature
Example
pxctl service call-home <enable|disable> * Required argument is "enable" or "disable"
pxctl service call-home status
pxctl service call-home status
Description
Check call-home status
pxctl service node-wipe
pxctl service node-wipe
Description
Wipes PX configuration data on this node
Flags
Flag | Description |
---|---|
( | comma-separated list of storage devices to be wiped. |
pxctl service diags
pxctl service diags
Description
creates a new tgz package with essential diagnostic information.
Flags
Flag | Description |
---|---|
( | output file name |
( | docker host daemon Default value: |
( | PX container ID |
( | gets diags from running px |
( | upload diags to cloud |
( | only dump profile |
( | creates a new tgz package with all the available diagnostic information. |
( | generate diags for all the nodes in the cluster. |
( | generate diags for a specific remote node with the provided NodeIp or NodeID. |
( | force overwrite existing diags. |
pxctl service maintenance
pxctl service maintenance
Description
Maintenance mode operations
Flags
Flag | Description |
---|---|
( | exit maintenance mode |
( | enter maintenance mode |
( | cycle maintenance mode |
pxctl service email
pxctl service email
Description
Email setting commands
pxctl service email set
pxctl service email set
Description
Configure email settings for alerts.
Flags
Flag | Description |
---|---|
( | IP or DNS name for smtp server |
( | IP or DNS name for smtp server |
( | Username to authenticate with smtp-server (if required) |
( | Password to authenticate with smtp-server (if required) |
( | Sender of alert emails (defaults to noreply@portworx.com) Default value: |
( | Recipient of alert emails. |
( | Minimum severity for email trigger, (warning|critical) Default value: |
pxctl service email get
pxctl service email get
Description
Get email settings for alerts.
pxctl service email clear
pxctl service email clear
Description
Clear email settings for alerts.
pxctl service slack
pxctl service slack
Description
Slack setting commands
pxctl service slack set
pxctl service slack set
Description
Configure slack settings for alerts.
Flags
Flag | Description |
---|---|
( | url of the slack webhook This flag is required. |
( | Minimum severity for slack trigger, (warning|critical) Default value: |
pxctl service slack get
pxctl service slack get
Description
Get slack settings for alerts.
pxctl service slack delete
pxctl service slack delete
Description
Delete slack settings for alerts.
pxctl service drive
pxctl service drive
Description
Storage drive maintenance
pxctl service drive show
pxctl service drive show
Description
Show drives
Flags
Flag | Description |
---|
pxctl service drive add
pxctl service drive add
Description
Add storage
Flags
Flag | Description |
---|---|
( | Comma-separated source drives |
( | Cloud drive spec in type=<>,size=<> format |
( | Use this drive to create a new pool. |
( | Use this drive as a journal device |
( | Use this drive as a system metadata device. |
( | Use this drive as a cache device for the given pool (must also specify --poolID). |
( | Add this drive to the specified existing pool ID. Default value: |
( | start|status Valid values:
Default value: |
pxctl service drive replace
pxctl service drive replace
Description
Replace source drive with target drive
Flags
Flag | Description |
---|---|
( | Source drive |
( | Target drive |
( | start|cancel|status Valid values:
Default value: |
pxctl service drive rebalance
pxctl service drive rebalance
Description
Rebalance storage
Flags
Flag | Description |
---|---|
( | Storage pool |
( | start|cancel|status Valid values:
Default value: |
pxctl service drive check
pxctl service drive check
Description
Check drives
Flags
Flag | Description |
---|---|
( | Detailed report |
pxctl service node
pxctl service node
Description
Node maintenance operations
pxctl service node drain-attachments
pxctl service node drain-attachments
Description
Drain/Remove volume attachments from a node
pxctl service node drain-attachments submit
pxctl service node drain-attachments submit
Description
Submit a new job to drain attachments.
Flags
Flag | Description |
---|---|
( | NodeID of the node from which the volume attachments will be removed This flag is required. |
( | Name of the issuer who is submitting this job |
( | 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 in seconds. Default is 5 mins. Default value: |
( | Do not print summary when running the command in wait mode. |
pxctl service node drain-attachments list
pxctl service node drain-attachments list
Description
Lists drain attachment jobs in the system
pxctl service node drain-attachments status
pxctl service node drain-attachments status
Description
Status of a drain attachments job
Flags
Flag | Description |
---|---|
( | This flag is required. |
pxctl service node drain-attachments cancel
pxctl service node drain-attachments cancel
Description
Cancels a drain attachments job
Flags
Flag | Description |
---|---|
( | This flag is required. |
pxctl service node cordon-attachments
pxctl service node cordon-attachments
Description
Cordons/Disables any new volume attachments from a node. Existing volumes will stay attached
Flags
Flag | Description |
---|---|
( | ID of the node for which any new volume attachments will be disabled This flag is required. |
pxctl service node uncordon-attachments
pxctl service node uncordon-attachments
Description
Re-enables volume attachments for a node.
Flags
Flag | Description |
---|---|
( | ID of the node for which volume attachments will be re-enabled This flag is required. |
pxctl service pool
pxctl service pool
Description
Storage pool maintenance
pxctl service pool show
pxctl service pool show
Description
Show pools
Flags
Flag | Description |
---|
pxctl service pool rebalance
pxctl service pool rebalance
Description
Rebalance storage pools
pxctl service pool rebalance submit
pxctl service pool rebalance submit
Description
Submit a new rebalance job
Flags
Flag | Description |
---|---|
( | Produces steps that would be taken without making any changes to the system |
( | Comma-separated label selector of the form label1=value1,label2=value2 etc., that allows selecting pools to which over-load trigger thresholds will apply. |
( | Comma-separated label selector of the form label1=value1,label2=value2 etc., that allows selecting pools to which under-load trigger thresholds will apply. |
( | Defines how long operation should run when started. 0 values means no limit on duration |
( | delete snapshots which don't have parent on same pool after rebalance Valid values:
Default value: |
pxctl service pool rebalance list
pxctl service pool rebalance list
Description
Lists rebalance jobs in the system
pxctl service pool rebalance status
pxctl service pool rebalance status
Description
Status of a rebalance job
Flags
Flag | Description |
---|---|
( | This flag is required. |
pxctl service pool rebalance cancel
pxctl service pool rebalance cancel
Description
Cancels a rebalance job
Flags
Flag | Description |
---|---|
( | This flag is required. |
pxctl service pool rebalance resume
pxctl service pool rebalance resume
Description
Resumes a rebalance job
Flags
Flag | Description |
---|---|
( | This flag is required. |
pxctl service pool rebalance pause
pxctl service pool rebalance pause
Description
Pauses a rebalance job
Flags
Flag | Description |
---|---|
( | This flag is required. |
pxctl service pool expand
pxctl service pool expand
Description
Expand pool
Flags
Flag | Description |
---|---|
( | 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 This flag is required. |
( | Pool's UID This flag is required. |
( | Operation to perform to expand the pool (add-drive, resize-drive, auto) This flag is required. Default value: |
( | Don't wait for volumes on the pool to be clean before starting expansion |
pxctl service pool update
pxctl service pool update
Description
Update pool properties
Example
pxctl sv pool update [flags] <pool-id> *pool-id or --uid <pool-uid> flag is mandatory, if both are specified, pool-uid is ignored
Flags
Flag | Description |
---|---|
( | IO Priority Valid values:
Default value: |
( | comma separated name=value pairs (empty value to remove label) Default value: |
( | extend pool to maximum available physical storage |
( | Pool's UID |
( | Admin command to reset pool's last operation. Pool resources won't be cleaned up. Use with caution! |
pxctl service pool cache
pxctl service pool cache
Description
Update cache properties on a given pool
pxctl service pool cache configure
pxctl service pool cache configure <required-argument>
Description
configure cache parameters for a pool
Example
pxctl sv pool cache configure [flags] <pool-id> *pool-id is mandatory
Flags
Flag | Description |
---|---|
( | cache operating mode Valid values:
|
( | cache blocksize hint, software can optimize this value Default value: |
( | cache policy Valid values:
|
( | cache settings |
pxctl service pool cache status
pxctl service pool cache status <required-argument>
Description
cache status on given pool
Example
pxctl sv pool cache status <pool-id> *pool-id is mandatory
pxctl service pool cache enable
pxctl service pool cache enable <required-argument>
Description
enable cache on a pool
Example
pxctl sv pool cache enable <pool-id> *pool-id is mandatory
pxctl service pool cache disable
pxctl service pool cache disable <required-argument>
Description
disable cache on a pool
Example
pxctl sv pool cache disable <pool-id> *pool-id is mandatory
pxctl service pool cache flush
pxctl service pool cache flush <required-argument>
Description
force cache flush on a pool
Example
pxctl sv pool cache flush <pool-id> *pool-id is mandatory
Flags
Flag | Description |
---|---|
( | start|status Valid values:
Default value: |
pxctl service pool maintenance
pxctl service pool maintenance
Description
Pool maintenance
Flags
Flag | Description |
---|---|
( | exit maintenance mode |
( | enter maintenance mode |
( | Assume 'yes' to confirmation prompt |
pxctl service kvdb
pxctl service kvdb
Description
PX Kvdb operations
pxctl service kvdb restore
pxctl service kvdb restore
Description
Restore keys and values into kvdb from a kvdb.dump file
Example
/opt/pwx/bin/pxctl service kvdb restore --kvdb_dump_file <file_path>
Flags
Flag | Description |
---|---|
( | Kvdb dump file location This flag is required. |
( | Force will delete any existing keys from kvdb and perform the restore |
pxctl service kvdb endpoints
pxctl service kvdb endpoints
Description
List the kvdb client endpoints
pxctl service kvdb members
pxctl service kvdb members
Description
List the kvdb cluster members
pxctl service relaxedreclaim
pxctl service relaxedreclaim <required-argument>
Description
Manage the RelaxedReclaim queue for the node
pxctl service relaxedreclaim purge
pxctl service relaxedreclaim purge
Description
Purge the RelaxedReclaim queue for the node
Example
/opt/pwx/bin/pxctl service relaxedreclaim purge <node-id>
pxctl service relaxedreclaim list
pxctl service relaxedreclaim list
Description
List the RelaxedReclaim queue for the node
Example
/opt/pwx/bin/pxctl service relaxedreclaim list
pxctl service relaxedreclaim delete
pxctl service relaxedreclaim delete
Description
Delete a volume from the RelaxedReclaim queue for the node
Example
/opt/pwx/bin/pxctl service relaxedreclaim delete <vol-id>
pxctl service usage-report
pxctl service usage-report
Description
creates & download tgz package for px consumption reports
Flags
Flag | Description |
---|---|
( | generate reports for px consumption |