pxctl cluster
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 |
---|---|
( | 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 |
---|---|
( | 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 |
---|---|
( | 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 |
---|---|
( | IO Priority Valid values:
Default value: |
( | 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 |
---|---|
( | IP address of the remote cluster This flag is required. |
( | Port of the remote cluster Default value: |
( | Authentication token from the remote cluster This flag is required. |
( | Set as the default cluster pair |
( | Enable DR mode for the cluster pair |
pxctl cluster pair delete
pxctl cluster pair delete
Description
Delete a cluster pair
Flags
Flag | Description |
---|---|
( | 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 |
---|---|
( | 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 |
---|---|
( | Timeout (in minutes) after which storage-less nodes will be automatically decommissioned. Timeout cannot be set to zero. Default value: |
( | Number of `days` to raise alert before license expires. Set to zero to disable alerts. Default value: |
( | Interval for license expiry checks. Valid only if 'license-expiry-check' is defined. Default value: |
( | Enable or disable repl-add based resync Valid values:
Default value: |
( | Interval (in minutes) after which internal snapshots are rotated Default value: |
( | Timeout (in minutes) to wait for a snapshot to complete in the backend Default value: |
( | Default RPC timeout (in minutes) for all client communications Default value: |
( | Timeout (in minutes) after which offline replicas will be moved to available nodes. Set timeout to zero to disable replica move. Default value: |
( | Timeout (in minutes) for which the kvdb lock will be held during FB create volume call. minimum duration 3 mins. Default value: |
( | Duration (in minutes) after which cached stats for FB volumes will expire. minimum duration 1 min. Default value: |
( | 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: |
( | Timestamp record threshold after which offline replicas will be moved to available nodes. Set threshold to zero to disable replica move. Default value: |
( | Domain policy for domains Valid values:
Default value: |
( | Enable or disable Metro DR domain protection Valid values:
Default value: |
( | Frequency of dumping stats in seconds. Default value:
|
( | Number of stats dump files to keep. Setting to 0 disables the periodic dumps. Default value:
|
( | Default IO-Profile for volumes Valid values:
Default value: |
( | Enable or disable optimized restores Valid values:
Default value: |
( | Timeout in minutes for stalled cloudsnap abort. Should be => 10 minutes Default value: |
( | Time in hours after which the failed cloudsnaps are deleted for a configured credential. 0 disables deleting failed cloudsnaps |
( | Number of cloudsnap threads doing concurrent uploads/downloads. Valid values >= 2 and <= 16, others automatically rounded Default value: |
( | Enable or disable cloudsnap catalog collection Valid values:
Default value: |
( | Retry limit on error for cloudsnap operations with objectstore. Default value:
|
( | Configure periodic interval (in minutes) to query unique blocks size for volumes. Default value: |
( | Configure periodic interval (in seconds) to compute the IO profile for volume. Only applies to volumes with \"auto_journal\" IO profile. Default value: |
( | Semi-colon separate string of labels, example 'node=uuid1,uuid2;io_priority=high'. Use '' to reset to default. |
( | 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. |
( | 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: |
( | Timeout in seconds for sharedv4 (NFS) mount commands. Default value: |
( | proxy to be used by cloudsnap (setting not required if using PX_HTTP_PROXY/PX_HTTPS_PROXY env. variables) |
( | network interface name used by cloudsnaps(data, mgmt, eth0, etc) |
( | Enable or disable temporary kvdb loss support Valid values:
Default value: |
( | Comma separated key value pairs for runtime options |
( | Specify type of action for runtime options Valid values:
Default value: |
( | Comma separated key value labels for node specific runtime options. |
( | for detached volumes none will not generate schedule snapshots, optimized will generated one, always will generate them always Valid values:
Default value: |
( | Maximum number of concurrent api invocations allowed Default value: |
( | Enable periodic cache flush Valid values:
Default value: |
( | Interval at which cache flush would be performed. Default value: |
( | Disable, or enable with a minimum and maximum dirty block percentage in cache. (Valid Range: [10 90]). e.g. on,33,67 |
( | Expiration (in minutes) is the time the volume stays in trashcan before being purged. |
( | Sets the full backup frequency. Default value:
|
( | Enable cloudsnap using metadata optimization Valid values:
Default value: |
( | 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: |
( | 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: |
( | Lttng command to execute Valid values:
|
( | Amount of disk space (GB) to be utilized by lttng trace files. Greater than 0 enables traces and 0 disables it |
( | Start fstrim on a scheduled time (UTC). Example:daily=hh:mm or weekly=weekday@hh:mm. Autofstrim will be disabled in cluster. |
( | Duration of scheduled fstrim in hours. Daily limit is [1, 23] hrs and weekly limit is [1, 167] hrs. |
( | Maximum throughput (KiB, MiB or GiB) at which fstrim would free blocks to backing store, in each interval. Max value = 10GiB Default value: |
( | Lttng loglevel setting Valid values:
Default value: |
( | Minimum throughput (KiB, MiB or GiB) at which fstrim would free blocks to backing store, in each interval. Min value = 1MiB Default value: |
( | Chunk size (MB) of each defrag command issued by the defrag schedule Default value:
|
( | Pool used space percentage threshold above which defrag would be disabled on pools Default value:
|
( | Enable/Disable SkinnySnaps. Allows snapshots to be created with lower number of replicas than the parent volume. Valid values:
Default value: |
( | 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: |
( | Cluster-wide average network bandwith usage limit in mebibytes per second, use 0 to disable this limit |
( | The number of seconds to wait before deleting the volume/snapshot staged in RelaxedReclaim queue. Set to zero to disable RelaxedReclaim. |
( | Maximum number of volumes/snapshots that can be staged for RelaxedReclaim. Default value: |
( | Enable/Disable automatic fstrim Valid values:
Default value: |
( | 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: |
( | Internal(in seconds) associated with the fstrim-io-rate(MB) is freed to backing store. Minimum 1 second. Default value: |
( | Disable Pure1 incremental uploads of PX information Valid values:
|
( | Interval for Pure1 incremental uploads of PX information. Default value: |
( | Migrate legacy shared volumes to sharedv4 service volumes Valid values:
|
( | Interval in hours at which a kvdb defrag will be run. Default is 2 weeks. Set to 0 to disable kvdb defrag. Default value: |
( | Minimum Kvdb DB size in MBs to trigger a defrag. Default value: |
( | Bounce app pods if a rw volume mount turns read-only. Default behavior is to look at FADA volume mounts only. Valid values:
Default value: |
( | 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: |
( | 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' |
( | Interval in minutes at which a job to fix VPS will be run. Set to 0 to disable the job. Default value: |
( | Storage vMotion (vSphere only) API timeout (minutes) interval. Disable job with value 0. Default value: |
pxctl cluster defrag
pxctl cluster defrag
Description
File system defragmentation
pxctl cluster defrag schedule
pxctl cluster defrag schedule
Description
Schedule of defragmentation job
pxctl cluster defrag schedule create
pxctl cluster defrag schedule create
Description
Create a defrag schedule
Example
pxctl cluster defrag schedule create --start-time daily=19:15 --max-duration-minutes 90
Flags
Flag | Description |
---|---|
( | Define the scheduled time to start running defrag tasks. Valid formats: daily=19:15, weekly=Sunday@19:15, monthly=22@19:15 This flag is required. |
( | Define how many minutes the individual defrag job should run This flag is required. |
( | Define the maximum number of nodes allowed to run defrag tasks in parallel Default value: |
( | Comma-separated node uuids to specify the list of nodes run by this schedule. If empty, run on all nodes. Cannot coexist with --exclude-nodes and --node-selector |
( | Comma-separated node uuids to specify the list of nodes skipped by this schedule. Cannot coexist with --include-nodes |
( | Comma-separated label selectors of the form label1=value1,label2=value2 etc., to specify the list of nodes run by this schedule. Can coexist with --exclude-nodes but cannot coexist with --include-nodes |
( | After running one iteration on all nodes, the schedule will be automatically deleted |
pxctl cluster defrag schedule show
pxctl cluster defrag schedule show
Description
Show defrag schedules in the system
Example
pxctl cluster defrag schedule show --schedule-id <schedule-id>
Flags
Flag | Description |
---|---|
( | Schedule ID |
pxctl cluster defrag schedule delete
pxctl cluster defrag schedule delete <required-argument>
Description
Delete a defrag schedule
Example
pxctl cluster defrag schedule delete <schedule-id>
Flags
Flag | Description |
---|
pxctl cluster defrag schedule clean-up
pxctl cluster defrag schedule clean-up
Description
Clean up defrag schedules and jobs
Example
pxctl cluster defrag schedule clean-up
Flags
Flag | Description |
---|
pxctl cluster defrag status
pxctl cluster defrag status
Description
Show defragmentation status
Example
pxctl cluster defrag status --node <node-uuid>
Flags
Flag | Description |
---|---|
( | Node UUID |