pxctl volume
pxctl volume
pxctl volume
Description
Manage volumes
Example
pxctl volume create -s 100 myVolName
pxctl volume create
pxctl volume create <required-argument>
Description
Create a volume
Example
pxctl volume create [flags] volume-name
Flags
Flag | Description |
---|---|
( | make this a globally shared namespace volume |
( | encrypt this volume using AES-256 |
( | secret_key to use to fetch secret_data for the PBKDF2 function |
( | Secret options is used to pass specific secret parameters. Usage: --secret_options=k1=v1,k2=v2 |
( | Use cluster wide secret key to fetch secret_data |
( | list of comma-separated name=value `pairs` |
( | volume size in GB Default value: |
( | block size in Bytes Default value: |
( | block device queue depth Default value:
|
( | replication factor Default value:
|
( | auto scale to max number Default value:
|
( | IO Priority Valid values:
Default value: |
( | Journal data for this volume |
( | Reply to async write requests after it is copied to shared memory |
( | Enable async IO to backing storage |
( | Disable discard support for this volume |
( | Enable fastpath IO support for this volume |
( | IO Profile Valid values:
Default value: |
( | sticky volumes cannot be deleted until the flag is disabled |
( | export this volume via Sharedv4 |
( | creates a sharedv4 service volume when used with the sharedv4 option Valid values:
|
( | specifies how aggressively to fail over to a new server for a sharedv4 or sharedv4 service volume Valid values:
|
( | aggregation level Valid values:
Default value: |
( | comma-separated Node Ids or Pool Ids |
( | comma-separated Zone names |
( | comma-separated Rack names |
( | group |
( | enforce group during provision |
( | requested nodes, zones, racks are optional |
( | periodic snapshot interval in `mins,k` (keeps 5 by default), 0 disables all schedule snapshots |
( | daily snapshot at specified `hh:mm,k` (keeps 7 by default) |
( | weekly snapshot at specified `weekday@hh:mm,k` (keeps 5 by default) |
( | monthly snapshot at specified `day@hh:mm,k` (keeps 12 by default) |
( | policy names separated by comma |
( | storage policy name |
( | comma separated list of mount options provided as key=value pairs |
( | comma separated list of sharedv4 client mount options provided as key=value pairs |
( | proxy endpoint provided in the following format '<protocol>://<endpoint>' Ex 'nfs://<nfs-server-ip>' |
( | export path for nfs proxy volume |
( | sub path from the nfs share to which this proxy volume has access to |
( | Enable On-demand COW on volume Default value: |
( | Enable Direct IO on volume |
( | maximum iops this volume is restricted to. syntax --max_iops <ReadIOPS>,<WriteIOPS>. provide off for no throttling. e.g. --max_iops off,1000 |
( | maximum io bandwidth (MB/s) this volume is restricted to. syntax --max_bandwidth <ReadBW>,<WriteBW>. provide off for no throttling. e.g. --max_bandwidth 200,off |
pxctl volume list
pxctl volume list
Description
List volumes in the cluster
Flags
Flag | Description |
---|---|
( | show all volumes, including snapshots |
( | show all volumes whose replica is present on the given node |
( | show all volumes whose replica is present on the given pool |
( | show all volumes whose replica is present on the given cloud drive |
( | volume name used during creation if any |
( | list of comma-separated name=value pairs |
( | show all snapshots (read-only volumes) |
( | show all schedule created snapshots |
( | filter volumes by sched policy |
( | show all snapshots created for given volume |
( | show only volumes |
( | show all volumes for given group |
( | show all volumes sorted by creation time |
( | list volume snapshots in the trashcan in the cluster |
pxctl volume update
pxctl volume update <required-argument>
Description
Update volume settings
Example
pxctl volume update [flags] volName
Flags
Flag | Description |
---|---|
( | list of comma-separated name=value pairs to update (use empty label value to remove label) |
( | set shared setting Valid values:
Default value: |
( | set export options |
( | Set mount options for a volume. Provide the mount options as a comma-separated key=value pairs. (Use empty value to reset mount options) |
( | Set sharedv4 client mount options for a volume. Provide the mount options as a comma-separated key=value pairs. (Use empty value to reset mount options) |
( | set sticky setting Valid values:
Default value: |
( | block device queue depth Default value:
|
( | New scale factor Default value:
|
( | Journal data for this volume Valid values:
Default value: |
( | Reply to async write requests after it is copied to shared memory Valid values:
Default value: |
( | Set Pure FB NFS endpoint for a FB DirectAccess volume. Provide the Pure FB NFS endpoint as a string. |
( | Enable async IO to backing storage Valid values:
Default value: |
( | Disable discard support for this volume Valid values:
Default value: |
( | IO Profile Valid values:
Default value: |
( | IO Priority Valid values:
Default value: |
( | Set/Reset the Group field on a Volume |
( | New size for the volume (GiB) Default value: |
( | set sharedv4 setting Valid values:
Default value: |
( | set sharedv4 service type. (Use empty value to clear this setting) Valid values:
|
( | set sharedv4 failover strategy. (Use empty value to clear this setting) Valid values:
|
( | Enable fastpath IO support for this volume |
( | Enable On-demand COW on volume Valid values:
Default value: |
( | maximum iops this volume is restricted to. syntax --max_iops <ReadIOPS>,<WriteIOPS>. provide off for no throttling. e.g. --max_iops off,1000 |
( | maximum io bandwidth (MB/s) this volume is restricted to. syntax --max_bandwidth <ReadBW>,<WriteBW>. provide off for no throttling. e.g. --max_bandwidth 200,off |
pxctl volume ha-update
pxctl volume ha-update <required-argument>
Description
Update volume HA level
Example
pxctl volume ha-update --repl 3 myVol
Flags
Flag | Description |
---|---|
( | New replication factor Default value:
|
( | comma-separated Node ID(s) or Pool UUID(s) |
( | comma-separated Zone names (only for ha-increase) |
( | comma-separated Rack names (only for ha-increase) |
( | Cancel ha-increase operation |
( | requested nodes, zones, racks are optional |
( | comma-separated Node Id(s) to be used as source for ha-increase operation |
pxctl volume snap-interval-update
pxctl volume snap-interval-update <required-argument>
Description
Update volume configuration
Example
pxctl volume snap-interval-update [flags] volName
Flags
Flag | Description |
---|---|
( | periodic snapshot interval in mins,k (keeps 5 by default), 0 disables all schedule snapshots |
( | daily snapshot at specified hh:mm,k (keeps 7 by default) |
( | weekly snapshot at specified weekday@hh:mm,k (keeps 5 by default) |
( | monthly snapshot at specified day@hh:mm,k (keeps 12 by default) |
( | policy names separated by comma |
pxctl volume inspect
pxctl volume inspect <required-argument>
Description
Inspect a volume
Example
pxctl volume inspect [flags] volName
Flags
Flag | Description |
---|---|
( | extended report on volume state |
pxctl volume requests
pxctl volume requests
Description
Show all pending requests
pxctl volume usage
pxctl volume usage <required-argument>
Description
Show volume usage information
Example
/opt/pwx/bin/pxctl volume usage myVol
pxctl volume delete
pxctl volume delete <required-argument>
Description
Delete a volume
Example
pxctl volume delete [flags] myVol
Flags
Flag | Description |
---|
pxctl volume stats
pxctl volume stats <required-argument>
Description
Volume Statistics
Example
pxctl volume stats [flags] volName
pxctl volume import
pxctl volume import <required-argument>
Description
Import data into a volume
Example
pxctl volume import [flags] volName
Flags
Flag | Description |
---|---|
( | Local source `path` for the data |
( | Secret options is used to pass specific secret parameters. Usage: --secret_options=k1=v1,k2=v2 |
( | the encryption passphrase for this volume can be fetched from the secret provider |
pxctl volume clone
pxctl volume clone <required-argument>
Description
Create a clone volume
Example
pxctl volume clone [flags] volName
Flags
Flag | Description |
---|---|
( | clone name |
( | list of comma-separated name=value pairs |
pxctl volume restore
pxctl volume restore <required-argument>
Description
Restore volume from snapshot
Example
pxctl volume restore [flags] volName
Flags
Flag | Description |
---|---|
( | snapshot-name-or-ID |
( | volume name or id in trashcan |
pxctl volume snapshot
pxctl volume snapshot
Description
Manage volume snapshots
pxctl volume snapshot create
pxctl volume snapshot create <required-argument>
Description
Create a volume snapshot
Example
pxctl volume snapshot create [flags] volName
Flags
Flag | Description |
---|---|
( | snapshot name |
( | list of comma-separated name=value pairs |
pxctl volume snapshot group
pxctl volume snapshot group
Description
Create group snapshots for given group id or labels
Flags
Flag | Description |
---|---|
( | group id |
( | list of comma-separated name=value pairs |
( | list of comma-separated volume IDs |
( | delete created snaps if not all volumes succeeded in the group |
pxctl volume access
pxctl volume access
Description
This command manages access permissions to a volume. There are two ways to provide access, one is by adding a group and the other is by adding a specific user as a collaborator. When adding a collaborator, you must use the unique id of the user. Please consult with your admin on how to obtain the unique id of the user. ACCESS TYPES When adding a group or collaborator, an access type must also be given, which can be either Read, Write, or Admin. A Read access type allows access to the volume without modifying it. With a Read access type, one can clone or inspect the volume. A Write access type allows modification of the volume and its metadata, for example allowing to mount, unmount, and restoring the volume from snapshot in addition to all Read access. An Admin access type allows full access to the volume, like deleting the volume in addition to all Write access. SETTING ACCESS TYPES To set access types, add the following suffix to the group or collaborator separated by a colon ':' r - For Read access type w - For Write access type a - For Admin access type SETTING PUBLIC ACCESS To set public access, add either w, write, r, or read with the public flag.
Example
Add read access for group1
pxctl v access add <volume> --group group1:r
Add write access for group2
pxctl v access add <volume> --group group2:w
Add admin access for user1
pxctl v access add <volume> --collaborator user1Id:a
Add public access for user2
pxctl v access add <volume> --public w
Remove user1's access
pxctl v access remove <volume> --collaborator user1Id
Remove user2's public access
pxctl v access remove <volume> --public
Set the entire volume access spec with one command. This clears any previous settings.
pxctl v access update <volume> --groups group1:r,group2:w --collaborators user1Id:a
Show the volume access spec for a given volume
pxctl v access show <volume>
pxctl volume access show
pxctl volume access show
Description
List the owner and volume ACLS
Example
pxctl volume access show [flags] volName
pxctl volume access add
pxctl volume access add
Description
Adds a single group or collaborator
Example
pxctl volume access add [flags] volName
Flags
Flag | Description |
---|---|
( | group to add with access type. See volume access help for more information |
( | collaborator to add with access type. Must be the unique id of the user. See volume access for more information |
( | update the ownership as public |
pxctl volume access remove
pxctl volume access remove
Description
Removes a single group or collaborator
Example
pxctl volume access remove [flags] volName
Flags
Flag | Description |
---|---|
( | group to remove |
( | collaborator to remove |
( | update the ownership as public |
pxctl volume access update
pxctl volume access update
Description
Update the owner and/or complete set of volume ACLS
Example
pxctl volume access update [flags] volName
Flags
Flag | Description |
---|---|
( | username of the desired owner. Only an administrator can change this value. |
( | list of comma-separated group names with access type. See volume access for more information |
( | list of comma-separated collaborator names with access type. See volume access for more information |
pxctl volume locate
pxctl volume locate
Description
Locate volume
Example
pxctl volume locate volume_id
pxctl volume check
pxctl volume check
Description
Perform Background filesystem consistency check operation on the volume
Example
pxctl volume check <sub_cmd> [flags] volume-name
pxctl volume check start
pxctl volume check start <required-argument>
Description
Start filesystem consistency check on the volume
Example
pxctl volume check start --mode fix_safe volume-name
Flags
Flag | Description |
---|---|
( | select what mode to run filesystem consistency check This flag is required. Valid values:
|
pxctl volume check stop
pxctl volume check stop <required-argument>
Description
Stop filesystem consistency check on the volume, if any
Example
pxctl volume check stop volume-name
pxctl volume check status
pxctl volume check status <required-argument>
Description
Get the Status of filesystem consistency check on the volume
Example
pxctl volume check status volume-name
pxctl volume autofstrim
pxctl volume autofstrim
Description
Periodically frees unused blocks in the volume to the portworx pool
Example
pxctl volume autofstrim
pxctl volume autofstrim status
pxctl volume autofstrim status
Description
Status of auto filesystem trim
Example
pxctl volume autofstrim status volume-name
pxctl volume autofstrim usage
pxctl volume autofstrim usage
Description
Report volume usage and trimmable space in locally attached volumes
Example
pxctl volume autofstrim usage
pxctl volume autofstrim push
pxctl volume autofstrim push
Description
Push front to autofstrim job queue
Example
pxctl volume autofstrim push volume-name
pxctl volume autofstrim pop
pxctl volume autofstrim pop
Description
Pop auto fstrim job in queue or stop job if active
Example
pxctl volume autofstrim pop volume-name
pxctl volume trim
pxctl volume trim
Description
Frees unused blocks in the volume to the portworx pool
Example
pxctl volume trim <sub_cmd> [flags] volume-name
pxctl volume trim start
pxctl volume trim start <required-argument>
Description
Start filesystem trim on the volume
Example
pxctl volume trim start volume-name
pxctl volume trim status
pxctl volume trim status
Description
Status of filesystem trim on the volume
Example
pxctl volume trim status
pxctl volume trim stop
pxctl volume trim stop <required-argument>
Description
Stop filesystem trim on the volume
Example
pxctl volume trim stop volume-name
pxctl volume trim usage
pxctl volume trim usage
Description
Report volume usage and trimmable space in locally attached volumes
Example
pxctl volume trim usage