Version: 3.1

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

Flag	Description
`--storage_devices`, `--s` (`str`)	comma-separated list of storage devices to be wiped.

--storage_devices, --s

(str)

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`, `--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
`--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.

pxctl service maintenance

pxctl service maintenance

Description

Maintenance mode operations

Flags

Flag Description

Flag	Description
`--exit`, `--x` (`bool`)	exit maintenance mode
`--enter`, `--e` (`bool`)	enter maintenance mode
`--cycle`, `--c` (`bool`)	cycle maintenance mode

--exit, --x

(bool)

exit maintenance mode

--enter, --e

(bool)

enter maintenance mode

--cycle, --c

(bool)

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

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`

--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

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

Flag	Description
`--webhookurl`, `--w` (`str`)	url of the slack webhook This flag is required.
`--severity`, `--s` (`str`)	Minimum severity for slack trigger, (warning\|critical) Default value: `critical`

--webhookurl, --w

(str)

url of the slack webhook

This flag is required.

--severity, --s

(str)

Minimum severity for slack trigger, (warning|critical)

Default value: critical

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

Flag	Description
`--drive`, `--d` (`str`)	Comma-separated source drives
`--spec`, `--s` (`str`)	Cloud drive spec in type=<>,size=<> format
`--newpool` (`bool`)	Use this drive to create a new pool.
`--journal` (`bool`)	Use this drive as a journal device (not supported with PX-StoreV2)
`--metadata` (`bool`)	Use this drive as a system metadata device.
`--use-as-cache` (`bool`)	Use this drive as a cache device for the given pool (must also specify --poolID).
`--poolID`, `--p` (`int`)	Add this drive to the specified existing pool ID. Default value: `-1`
`--operation`, `--o` (`str`)	start\|status Valid values: `start` `status` Default value: `start`

--drive, --d

(str)

Comma-separated source drives

--spec, --s

(str)

Cloud drive spec in type=<>,size=<> format

--newpool

(bool)

Use this drive to create a new pool.

--journal

(bool)

Use this drive as a journal device (not supported with PX-StoreV2)

--metadata

(bool)

Use this drive as a system metadata device.

--use-as-cache

(bool)

Use this drive as a cache device for the given pool (must also specify --poolID).

--poolID, --p

(int)

Add this drive to the specified existing pool ID.

Default value: -1

--operation, --o

(str)

start|status

Valid values:

start
status

Default value: start

pxctl service drive replace

pxctl service drive replace

Description

Replace source drive with target drive

Flags

Flag Description

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

--source, --s

(str)

Source drive

--target, --t

(str)

Target drive

--operation, --o

(str)

start|cancel|status

Valid values:

start
cancel
status

Default value: start

pxctl service drive rebalance

pxctl service drive rebalance

Description

Rebalance storage

Flags

Flag Description

Flag	Description
`--poolID`, `--p` (`str`)	Storage pool
`--operation`, `--o` (`str`)	start\|cancel\|status Valid values: `start` `cancel` `status` Default value: `status`

--poolID, --p

(str)

Storage pool

--operation, --o

(str)

start|cancel|status

Valid values:

start
cancel
status

Default value: status

pxctl service drive check

pxctl service drive check

Description

Check drives

Flags

Flag Description

Flag	Description
`--full` (`bool`)	Detailed report

--full

(bool)

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

Flag	Description
`--node`, `--n` (`str`)	NodeID of the node from which the volume attachments will be removed This flag is required.
`--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.

--node, --n

(str)

NodeID of the node from which the volume attachments will be removed

This flag is required.

--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

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

Flag	Description
`--job-id`, `--i` (`str`)	This flag is required.

--job-id, --i

(str)

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

Flag	Description
`--job-id`, `--i` (`str`)	This flag is required.

--job-id, --i

(str)

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

Flag	Description
`--node` (`str`)	ID of the node for which any new volume attachments will be disabled This flag is required.

--node

(str)

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

Flag	Description
`--node` (`str`)	ID of the node for which volume attachments will be re-enabled This flag is required.

--node

(str)

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
`--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 Valid values: `on` `off` Default value: `off`

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

Flag	Description
`--job-id`, `--i` (`str`)	This flag is required.

--job-id, --i

(str)

This flag is required.

pxctl service pool rebalance cancel

pxctl service pool rebalance cancel

Description

Cancels a rebalance job

Flags

Flag Description

Flag	Description
`--job-id`, `--i` (`str`)	This flag is required.

--job-id, --i

(str)

This flag is required.

pxctl service pool rebalance resume

pxctl service pool rebalance resume

Description

Resumes a rebalance job

Flags

Flag Description

Flag	Description
`--job-id`, `--i` (`str`)	This flag is required.

--job-id, --i

(str)

This flag is required.

pxctl service pool rebalance pause

pxctl service pool rebalance pause

Description

Pauses a rebalance job

Flags

Flag Description

Flag	Description
`--job-id`, `--i` (`str`)	This flag is required.

--job-id, --i

(str)

This flag is required.

pxctl service pool expand

pxctl service pool expand

Description

Expand pool

Flags

Flag Description

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 This flag is required.
`--uid`, `--u` (`str`)	Pool's UID This flag is required.
`--operation`, `--o` (`str`)	Operation to perform to expand the pool This flag is required. Valid values: `add-disk` `resize-disk` `auto` Default value: `auto`
`--dont-wait-for-clean-volumes`, `--f` (`bool`)	Don't wait for volumes on the pool to be clean before starting expansion

--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

This flag is required.

--uid, --u

(str)

Pool's UID

This flag is required.

--operation, --o

(str)

Operation to perform to expand the pool

This flag is required.

Valid values:

add-disk
resize-disk
auto

Default value: auto

--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

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

Flag	Description
`--io_priority` (`str`)	IO Priority Valid values: `high` `medium` `low` 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!

--io_priority

(str)

IO Priority

Valid values:

high
medium
low

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!

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

Flag	Description
`--mode` (`str`)	cache operating mode Valid values: `writethrough` `writeback`
`--blocksize` (`str`)	cache blocksize hint, software can optimize this value Default value: `auto`
`--policy` (`str`)	cache policy Valid values: `smq` `mq`
`--tunables` (`str`)	cache settings

--mode

(str)

cache operating mode

Valid values:

writethrough
writeback

--blocksize

(str)

cache blocksize hint, software can optimize this value

Default value: auto

--policy

(str)

cache policy

Valid values:

smq
mq

--tunables

(str)

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

Flag	Description
`--operation`, `--o` (`str`)	start\|status Valid values: `start` `status` Default value: `start`

--operation, --o

(str)

start|status

Valid values:

start
status

Default value: start

pxctl service pool maintenance

pxctl service pool maintenance

Description

Pool maintenance

Flags

Flag Description

Flag	Description
`--exit`, `--x` (`bool`)	exit maintenance mode
`--enter`, `--e` (`bool`)	enter maintenance mode
`--yes`, `--y` (`bool`)	Assume 'yes' to confirmation prompt

--exit, --x

(bool)

exit maintenance mode

--enter, --e

(bool)

enter maintenance mode

--yes, --y

(bool)

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

Flag	Description
`--kvdb_dump_file`, `--k` (`str`)	Kvdb dump file location This flag is required.
`--force`, `--f` (`bool`)	Force will delete any existing keys from kvdb and perform the restore

--kvdb_dump_file, --k

(str)

Kvdb dump file location

This flag is required.

--force, --f

(bool)

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

Flag	Description
`--download` (`bool`)	generate reports for px consumption

--download

(bool)

generate reports for px consumption