Version: 3.1

pxctl cluster

pxctl cluster

Description

Manage the cluster

pxctl cluster list

pxctl cluster list

Description

List nodes in the cluster

pxctl cluster inspect

pxctl cluster inspect

Description

Inspect a node

pxctl cluster delete

pxctl cluster delete <required-argument>

Description

Delete a node

Example

/opt/pwx/bin/pxctl cluster delete [flags] nodeID

Flags

Flag Description

Flag	Description
`--force`, `--f` (`bool`)	Forcibly remove node, which may cause volumes to be irrevocably deleted

--force, --f

(bool)

Forcibly remove node, which may cause volumes to be irrevocably deleted

pxctl cluster domains

pxctl cluster domains

Description

A set of commands to manage Portworx Cluster Domains

pxctl cluster domains show

pxctl cluster domains show

Description

Lists all cluster domains

pxctl cluster domains activate

pxctl cluster domains activate

Description

Activates the provided cluster domain

Flags

Flag Description

Flag	Description
`--name`, `--n` (`str`)	name of the domain to activate This flag is required.

--name, --n

(str)

name of the domain to activate

This flag is required.

pxctl cluster domains deactivate

pxctl cluster domains deactivate

Description

Deactivates the provided cluster domain

Flags

Flag Description

Flag	Description
`--name`, `--n` (`str`)	name of the domain to activate This flag is required.

--name, --n

(str)

name of the domain to activate

This flag is required.

pxctl cluster provision-status

pxctl cluster provision-status

Description

Show cluster provision status

Flags

Flag Description

Flag	Description
`--io_priority` (`str`)	IO Priority Valid values: `high` `medium` `low` Default value: `low`
`--show-labels` (`bool`)	Show all labels

--io_priority

(str)

IO Priority

Valid values:

high
medium
low

Default value: low

--show-labels

(bool)

Show all labels

pxctl cluster token

pxctl cluster token

Description

Manage cluster authentication token

pxctl cluster token show

pxctl cluster token show

Description

Display current authentication token

Flags

Flag	Description

pxctl cluster token reset

pxctl cluster token reset

Description

Reset token if already present

pxctl cluster pair

pxctl cluster pair

Description

Manage Portworx cluster pairs

pxctl cluster pair create

pxctl cluster pair create

Description

Pair this cluster with another Portworx cluster

Flags

Flag Description

Flag	Description
`--ip`, `--i` (`str`)	IP address of the remote cluster This flag is required.
`--remote-port`, `--p` (`uint`)	Port of the remote cluster Default value: `9001`
`--token`, `--t` (`str`)	Authentication token from the remote cluster This flag is required.
`--default`, `--d` (`bool`)	Set as the default cluster pair
`--dr-mode` (`bool`)	Enable DR mode for the cluster pair

--ip, --i

(str)

IP address of the remote cluster

This flag is required.

--remote-port, --p

(uint)

Port of the remote cluster

Default value: 9001

--token, --t

(str)

Authentication token from the remote cluster

This flag is required.

--default, --d

(bool)

Set as the default cluster pair

--dr-mode

(bool)

Enable DR mode for the cluster pair

pxctl cluster pair delete

pxctl cluster pair delete

Description

Delete a cluster pair

Flags

Flag Description

Flag	Description
`--id`, `--i` (`str`)	ID of the remote cluster This flag is required.

--id, --i

(str)

ID of the remote cluster

This flag is required.

pxctl cluster pair list

pxctl cluster pair list

Description

List the cluster pairs

pxctl cluster pair validate

pxctl cluster pair validate

Description

Validate a cluster pair

Flags

Flag Description

Flag	Description
`--id`, `--i` (`str`)	ID of the remote cluster This flag is required.

--id, --i

(str)

ID of the remote cluster

This flag is required.

pxctl cluster options

pxctl cluster options

Description

List and update cluster wide options

pxctl cluster options list

pxctl cluster options list

Description

List cluster wide options

pxctl cluster options update

pxctl cluster options update

Description

Update cluster wide options

Flags

Flag Description

Flag	Description
`--auto-decommission-timeout` (`uint`)	Timeout (in minutes) after which storage-less nodes will be automatically decommissioned. Timeout cannot be set to zero. Default value: `20`
`--license-expiry-check` (`uint`)	Number of `days` to raise alert before license expires. Set to zero to disable alerts. Default value: `7`
`--license-expiry-check-interval` (`str`)	Interval for license expiry checks. Valid only if 'license-expiry-check' is defined. Default value: `6h`
`--resync-repl-add` (`str`)	Enable or disable repl-add based resync Valid values: `on` `off` Default value: `off`
`--internal-snapshot-interval` (`uint`)	Interval (in minutes) after which internal snapshots are rotated Default value: `30`
`--snapshot-create-timeout` (`uint`)	Timeout (in minutes) to wait for a snapshot to complete in the backend Default value: `20`
`--default-rpc-timeout` (`int`)	Default RPC timeout (in minutes) for all client communications Default value: `5`
`--repl-move-timeout` (`uint`)	Timeout (in minutes) after which offline replicas will be moved to available nodes. Set timeout to zero to disable replica move. Default value: `1440`
`--fb-lock-timeout` (`uint`)	Timeout (in minutes) for which the kvdb lock will be held during FB create volume call. minimum duration 3 mins. Default value: `3`
`--fb-stats-expiry-duration` (`uint`)	Duration (in minutes) after which cached stats for FB volumes will expire. minimum duration 1 min. Default value: `15`
`--re-add-wait-timeout` (`uint`)	Timeout (in minutes) after which re-add will abort and new replication node is added instead. Set timeout to zero to disable replica move. Default value: `1440`
`--repl-move-timestamp-records-threshold` (`uint`)	Timestamp record threshold after which offline replicas will be moved to available nodes. Set threshold to zero to disable replica move. Default value: `134217728`
`--domain-policy` (`str`)	Domain policy for domains Valid values: `strict` `eventual` Default value: `strict`
`--metro-dr-domain-protection` (`str`)	Enable or disable Metro DR domain protection Valid values: `on` `off` Default value: `on`
`--stats-dump-interval-seconds` (`int`)	Frequency of dumping stats in seconds. Default value: `120` Valid range: 30 3600
`--stats-dump-num-files` (`int`)	Number of stats dump files to keep. Setting to 0 disables the periodic dumps. Default value: `10` Valid range: 0 100
`--default-io-profile` (`str`)	Default IO-Profile for volumes Valid values: `auto` `none` Default value: `none`
`--optimized-restores` (`str`)	Enable or disable optimized restores Valid values: `on` `off` Default value: `off`
`--cloudsnap-abort-timeout-minutes` (`uint`)	Timeout in minutes for stalled cloudsnap abort. Should be => 10 minutes Default value: `10`
`--cloudsnap-cleanup-failed-hours` (`uint`)	Time in hours after which the failed cloudsnaps are deleted for a configured credential. 0 disables deleting failed cloudsnaps
`--cloudsnap-max-threads` (`uint`)	Number of cloudsnap threads doing concurrent uploads/downloads. Valid values >= 2 and <= 16, others automatically rounded Default value: `16`
`--cloudsnap-catalog` (`str`)	Enable or disable cloudsnap catalog collection Valid values: `on` `off` Default value: `off`
`--cloudsnap-err-retry-limit` (`uint`)	Retry limit on error for cloudsnap operations with objectstore. Default value: `3` Valid range: 1 15
`--uniqueblocks-size-sched-interval-minutes` (`uint`)	Configure periodic interval (in minutes) to query unique blocks size for volumes. Default value: `720`
`--io-profile-derive-interval` (`uint`)	Configure periodic interval (in seconds) to compute the IO profile for volume. Only applies to volumes with \"auto_journal\" IO profile. Default value: `20`
`--disable-provisioning-labels` (`str`)	Semi-colon separate string of labels, example 'node=uuid1,uuid2;io_priority=high'. Use '' to reset to default.
`--provisioning-commit-labels` (`str`)	Json, example of global rule followed by node specific and pool specific rule: '[{'OverCommitPercent': 200, 'SnapReservePercent': 30},{'OverCommitPercent': 50, 'SnapReservePercent':30, 'LabelSelector':{'node':'node-1,node-2', 'poolLabel':'poolValue'},]'. Use '[]' to reset to default.
`--sharedv4-threads` (`uint`)	Number of sharedv4 threads. This will affect sharedv4 volume performance as well as the amount of CPU and memory consumed for handling sharedv4 volumes. Default value: `128`
`--sharedv4-mount-timeout-sec` (`uint`)	Timeout in seconds for sharedv4 (NFS) mount commands. Default value: `120`
`--px-http-proxy` (`str`)	proxy to be used by cloudsnap (setting not required if using PX_HTTP_PROXY/PX_HTTPS_PROXY env. variables)
`--cloudsnap-nw-interface` (`str`)	network interface name used by cloudsnaps(data, mgmt, eth0, etc)
`--disabled-temporary-kvdb-loss-support` (`str`)	Enable or disable temporary kvdb loss support Valid values: `on` `off` Default value: `off`
`--runtime-options` (`str`)	Comma separated key value pairs for runtime options
`--runtime-options-action` (`str`)	Specify type of action for runtime options Valid values: `update-global` `delete-global` `update-node-specific` `delete-node-specific` Default value: `update-global`
`--runtime-options-selector` (`str`)	Comma separated key value labels for node specific runtime options.
`--snapshot-schedule-option` (`str`)	for detached volumes none will not generate schedule snapshots, optimized will generated one, always will generate them always Valid values: `none` `always` `optimized` Default value: `optimized`
`--concurrent-api-limit` (`uint`)	Maximum number of concurrent api invocations allowed Default value: `20`
`--cache-flush` (`str`)	Enable periodic cache flush Valid values: `enabled` `disabled` Default value: `disabled`
`--cache-flush-seconds` (`uint`)	Interval at which cache flush would be performed. Default value: `30`
`--poolcache` (`str`)	Disable, or enable with a minimum and maximum dirty block percentage in cache. (Valid Range: [10 90]). e.g. on,33,67
`--volume-expiration-minutes` (`uint`)	Expiration (in minutes) is the time the volume stays in trashcan before being purged.
`--cloudsnap-full-backup-frequency`, `--b` (`uint`)	Sets the full backup frequency. Default value: `7` Valid range: 1 120
`--cloudsnap-using-metadata-enabled` (`str`)	Enable cloudsnap using metadata optimization Valid values: `on` `off` Default value: `on`
`--cloudsnap-metadata-upload-percent-limit` (`uint`)	Do not use cloudsnap using metadata optimization if metadata size is over this limit in percent with respect to upload size. Value set to 0 disables this check. Default value: `15`
`--cloudsnap-metadata-upload-mb-bytes-limit` (`uint`)	Do not use cloudsnap using metadata optimization if metadata size is over this limit in size in mebibytes. Value set to 0 disables this check. Default value: `10240`
`--lttng-cmd` (`str`)	Lttng command to execute Valid values: `start` `stop` `pause` `resume`
`--lttng-disk-usage` (`uint`)	Amount of disk space (GB) to be utilized by lttng trace files. Greater than 0 enables traces and 0 disables it
`--fstrim-schedule-start` (`str`)	Start fstrim on a scheduled time (UTC). Example:daily=hh:mm or weekly=weekday@hh:mm. Autofstrim will be disabled in cluster.
`--fstrim-schedule-duration` (`int`)	Duration of scheduled fstrim in hours. Daily limit is [1, 23] hrs and weekly limit is [1, 167] hrs.
`--fstrim-max-io-rate` (`str`)	Maximum throughput (KiB, MiB or GiB) at which fstrim would free blocks to backing store, in each interval. Default value: `1GB`
`--lttng-log-level` (`str`)	Lttng loglevel setting Valid values: `err` `emerg` `alert` `debug_unit` `debug_line` `unset` `debug_function` `debug_module` `debug_process` `debug_system` `notice` `debug_program` `debug` `warning` `info` `crit` Default value: `unset`
`--fstrim-min-io-rate` (`str`)	Minimum throughput (MiB or GiB) at which fstrim would free blocks to backing store, in each interval. Default value: `1MiB`
`--skinnysnap` (`str`)	Enable/Disable SkinnySnaps. Allows snapshots to be created with lower number of replicas than the parent volume. Valid values: `on` `off` Default value: `off`
`--skinnysnap-num-repls` (`int`)	Skinnysnap Replication factor. If this value is same or greater than the volume replication level, number of snapshot replicas will be equal to the number of parent volume replicas. Valid values: `1` `2` `3` Default value: `1`
`--cloudsnap-network-limit-cluster` (`uint`)	Cluster-wide average network bandwith usage limit in mebibytes per second, use 0 to disable this limit
`--relaxedreclaim-delete-seconds` (`uint`)	The number of seconds to wait before deleting the volume/snapshot staged in RelaxedReclaim queue. Set to zero to disable RelaxedReclaim.
`--relaxedreclaim-max-pending` (`uint`)	Maximum number of volumes/snapshots that can be staged for RelaxedReclaim. Default value: `256`
`--auto-fstrim` (`str`)	Enable/Disable automatic fstrim Valid values: `on` `off` Default value: `off`
`--fstrim-io-rate` (`uint`)	Maximum throughput (in MBytes) at which fstrim would free blocks to backing store, in each interval(fstrim-io-rate-interval). Minimum is 10MB Default value: `100`
`--fstrim-io-rate-interval` (`uint`)	Internal(in seconds) associated with the fstrim-io-rate(MB) is freed to backing store. Minimum 1 second. Default value: `1`
`--incremental-uploads-disabled` (`str`)	Disable Pure1 incremental uploads of PX information Valid values: `true` `false`
`--incremental-uploads-interval-mins` (`int`)	Interval for Pure1 incremental uploads of PX information. Default value: `30`
`--kvdb-defrag-frequency-in-hours` (`int`)	Interval in hours at which a kvdb defrag will be run. Default is 2 weeks. Set to 0 to disable kvdb defrag. Default value: `336`
`--min-kvdb-defrag-limit-mb` (`int`)	Minimum Kvdb DB size in MBs to trigger a defrag. Default value: `100`
`--ro-vol-pod-bounce` (`str`)	Bounce app pods if a rw volume mount turns read-only. Default behavior is to look at FADA volume mounts only. Valid values: `fada` `all` Default value: `fada`
`--ro-vol-pod-bounce-interval` (`uint`)	Interval (in seconds) at which the background task should check for read-only (ro) volume mounts which were supposed to be read-write (rw), so it can bounce pods using such volumes. Default value: `15`
`--flasharray-iscsi-allowed-ifaces` (`str`)	Allowed iSCSI interfaces that can be used to connect to FlashArrays. Empty means all interfaces are allowed. Values must appear in output of 'iscsiadm -m iface'

--auto-decommission-timeout

(uint)

Timeout (in minutes) after which storage-less nodes will be automatically decommissioned. Timeout cannot be set to zero.

Default value: 20

--license-expiry-check

(uint)

Number of `days` to raise alert before license expires. Set to zero to disable alerts.

Default value: 7

--license-expiry-check-interval

(str)

Interval for license expiry checks. Valid only if 'license-expiry-check' is defined.

Default value: 6h

--resync-repl-add

(str)

Enable or disable repl-add based resync

Valid values:

on
off

Default value: off

--internal-snapshot-interval

(uint)

Interval (in minutes) after which internal snapshots are rotated

Default value: 30

--snapshot-create-timeout

(uint)

Timeout (in minutes) to wait for a snapshot to complete in the backend

Default value: 20

--default-rpc-timeout

(int)

Default RPC timeout (in minutes) for all client communications

Default value: 5

--repl-move-timeout

(uint)

Timeout (in minutes) after which offline replicas will be moved to available nodes. Set timeout to zero to disable replica move.

Default value: 1440

--fb-lock-timeout

(uint)

Timeout (in minutes) for which the kvdb lock will be held during FB create volume call. minimum duration 3 mins.

Default value: 3

--fb-stats-expiry-duration

(uint)

Duration (in minutes) after which cached stats for FB volumes will expire. minimum duration 1 min.

Default value: 15

--re-add-wait-timeout

(uint)

Timeout (in minutes) after which re-add will abort and new replication node is added instead. Set timeout to zero to disable replica move.

Default value: 1440

--repl-move-timestamp-records-threshold

(uint)

Timestamp record threshold after which offline replicas will be moved to available nodes. Set threshold to zero to disable replica move.

Default value: 134217728

--domain-policy

(str)

Domain policy for domains

Valid values:

strict
eventual

Default value: strict

--metro-dr-domain-protection

(str)

Enable or disable Metro DR domain protection

Valid values:

on
off

Default value: on

--stats-dump-interval-seconds

(int)

Frequency of dumping stats in seconds.

Default value: 120

Valid range:

30 3600

--stats-dump-num-files

(int)

Number of stats dump files to keep. Setting to 0 disables the periodic dumps.

Default value: 10

Valid range:

0 100

--default-io-profile

(str)

Default IO-Profile for volumes

Valid values:

auto
none

Default value: none

--optimized-restores

(str)

Enable or disable optimized restores

Valid values:

on
off

Default value: off

--cloudsnap-abort-timeout-minutes

(uint)

Timeout in minutes for stalled cloudsnap abort. Should be => 10 minutes

Default value: 10

--cloudsnap-cleanup-failed-hours

(uint)

Time in hours after which the failed cloudsnaps are deleted for a configured credential. 0 disables deleting failed cloudsnaps

--cloudsnap-max-threads

(uint)

Number of cloudsnap threads doing concurrent uploads/downloads. Valid values >= 2 and <= 16, others automatically rounded

Default value: 16

--cloudsnap-catalog

(str)

Enable or disable cloudsnap catalog collection

Valid values:

on
off

Default value: off

--cloudsnap-err-retry-limit

(uint)

Retry limit on error for cloudsnap operations with objectstore.

Default value: 3

Valid range:

1 15

--uniqueblocks-size-sched-interval-minutes

(uint)

Configure periodic interval (in minutes) to query unique blocks size for volumes.

Default value: 720

--io-profile-derive-interval

(uint)

Configure periodic interval (in seconds) to compute the IO profile for volume. Only applies to volumes with \"auto_journal\" IO profile.

Default value: 20

--disable-provisioning-labels

(str)

Semi-colon separate string of labels, example 'node=uuid1,uuid2;io_priority=high'. Use '' to reset to default.

--provisioning-commit-labels

(str)

Json, example of global rule followed by node specific and pool specific rule: '[{'OverCommitPercent': 200, 'SnapReservePercent': 30},{'OverCommitPercent': 50, 'SnapReservePercent':30, 'LabelSelector':{'node':'node-1,node-2', 'poolLabel':'poolValue'},]'. Use '[]' to reset to default.

--sharedv4-threads

(uint)

Number of sharedv4 threads. This will affect sharedv4 volume performance as well as the amount of CPU and memory consumed for handling sharedv4 volumes.

Default value: 128

--sharedv4-mount-timeout-sec

(uint)

Timeout in seconds for sharedv4 (NFS) mount commands.

Default value: 120

--px-http-proxy

(str)

proxy to be used by cloudsnap (setting not required if using PX_HTTP_PROXY/PX_HTTPS_PROXY env. variables)

--cloudsnap-nw-interface

(str)

network interface name used by cloudsnaps(data, mgmt, eth0, etc)

--disabled-temporary-kvdb-loss-support

(str)

Enable or disable temporary kvdb loss support

Valid values:

on
off

Default value: off

--runtime-options

(str)

Comma separated key value pairs for runtime options

--runtime-options-action

(str)

Specify type of action for runtime options

Valid values:

update-global
delete-global
update-node-specific
delete-node-specific

Default value: update-global

--runtime-options-selector

(str)

Comma separated key value labels for node specific runtime options.

--snapshot-schedule-option

(str)

for detached volumes none will not generate schedule snapshots, optimized will generated one, always will generate them always

Valid values:

none
always
optimized

Default value: optimized

--concurrent-api-limit

(uint)

Maximum number of concurrent api invocations allowed

Default value: 20

--cache-flush

(str)

Enable periodic cache flush

Valid values:

enabled
disabled

Default value: disabled

--cache-flush-seconds

(uint)

Interval at which cache flush would be performed.

Default value: 30

--poolcache

(str)

Disable, or enable with a minimum and maximum dirty block percentage in cache. (Valid Range: [10 90]). e.g. on,33,67

--volume-expiration-minutes

(uint)

Expiration (in minutes) is the time the volume stays in trashcan before being purged.

--cloudsnap-full-backup-frequency, --b

(uint)

Sets the full backup frequency.

Default value: 7

Valid range:

1 120

--cloudsnap-using-metadata-enabled

(str)

Enable cloudsnap using metadata optimization

Valid values:

on
off

Default value: on

--cloudsnap-metadata-upload-percent-limit

(uint)

Do not use cloudsnap using metadata optimization if metadata size is over this limit in percent with respect to upload size. Value set to 0 disables this check.

Default value: 15

--cloudsnap-metadata-upload-mb-bytes-limit

(uint)

Do not use cloudsnap using metadata optimization if metadata size is over this limit in size in mebibytes. Value set to 0 disables this check.

Default value: 10240

--lttng-cmd

(str)

Lttng command to execute

Valid values:

start
stop
pause
resume

--lttng-disk-usage

(uint)

Amount of disk space (GB) to be utilized by lttng trace files. Greater than 0 enables traces and 0 disables it

--fstrim-schedule-start

(str)

Start fstrim on a scheduled time (UTC). Example:daily=hh:mm or weekly=weekday@hh:mm. Autofstrim will be disabled in cluster.

--fstrim-schedule-duration

(int)

Duration of scheduled fstrim in hours. Daily limit is [1, 23] hrs and weekly limit is [1, 167] hrs.

--fstrim-max-io-rate

(str)

Maximum throughput (KiB, MiB or GiB) at which fstrim would free blocks to backing store, in each interval.

Default value: 1GB

--lttng-log-level

(str)

Lttng loglevel setting

Valid values:

err
emerg
alert
debug_unit
debug_line
unset
debug_function
debug_module
debug_process
debug_system
notice
debug_program
debug
warning
info
crit

Default value: unset

--fstrim-min-io-rate

(str)

Minimum throughput (MiB or GiB) at which fstrim would free blocks to backing store, in each interval.

Default value: 1MiB

--skinnysnap

(str)

Enable/Disable SkinnySnaps. Allows snapshots to be created with lower number of replicas than the parent volume.

Valid values:

on
off

Default value: off

--skinnysnap-num-repls

(int)

Skinnysnap Replication factor. If this value is same or greater than the volume replication level, number of snapshot replicas will be equal to the number of parent volume replicas.

Valid values:

Default value: 1

--cloudsnap-network-limit-cluster

(uint)

Cluster-wide average network bandwith usage limit in mebibytes per second, use 0 to disable this limit

--relaxedreclaim-delete-seconds

(uint)

The number of seconds to wait before deleting the volume/snapshot staged in RelaxedReclaim queue. Set to zero to disable RelaxedReclaim.

--relaxedreclaim-max-pending

(uint)

Maximum number of volumes/snapshots that can be staged for RelaxedReclaim.

Default value: 256

--auto-fstrim

(str)

Enable/Disable automatic fstrim

Valid values:

on
off

Default value: off

--fstrim-io-rate

(uint)

Maximum throughput (in MBytes) at which fstrim would free blocks to backing store, in each interval(fstrim-io-rate-interval). Minimum is 10MB

Default value: 100

--fstrim-io-rate-interval

(uint)

Internal(in seconds) associated with the fstrim-io-rate(MB) is freed to backing store. Minimum 1 second.

Default value: 1

--incremental-uploads-disabled

(str)

Disable Pure1 incremental uploads of PX information

Valid values:

true
false

--incremental-uploads-interval-mins

(int)

Interval for Pure1 incremental uploads of PX information.

Default value: 30

--kvdb-defrag-frequency-in-hours

(int)

Interval in hours at which a kvdb defrag will be run. Default is 2 weeks. Set to 0 to disable kvdb defrag.

Default value: 336

--min-kvdb-defrag-limit-mb

(int)

Minimum Kvdb DB size in MBs to trigger a defrag.

Default value: 100

--ro-vol-pod-bounce

(str)

Bounce app pods if a rw volume mount turns read-only. Default behavior is to look at FADA volume mounts only.

Valid values:

fada
all

Default value: fada

--ro-vol-pod-bounce-interval

(uint)

Interval (in seconds) at which the background task should check for read-only (ro) volume mounts which were supposed to be read-write (rw), so it can bounce pods using such volumes.

Default value: 15

--flasharray-iscsi-allowed-ifaces

(str)

Allowed iSCSI interfaces that can be used to connect to FlashArrays. Empty means all interfaces are allowed. Values must appear in output of 'iscsiadm -m iface'