List of released CLI commands available in openstack client. These commands
can be referenced by executing openstack help share
.
Create new share
share create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--name <name>]
[--snapshot-id <snapshot-id>]
[--property <key=value>]
[--share-network <network-info>]
[--description <description>]
[--public <public>]
[--share-type <share-type>]
[--availability-zone <availability-zone>]
[--share-group <share-group>]
<share_protocol>
<size>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--name
<name>
¶Optional share name. (Default=None)
--snapshot-id
<snapshot-id>
¶Optional snapshot ID to create the share from. (Default=None)
--property
<key=value>
¶Set a property to this share (repeat option to set multiple properties)
--share-network
<network-info>
¶Optional network info ID or name.
--description
<description>
¶Optional share description. (Default=None)
--public
<public>
¶Level of visibility for share. Defines whether other tenants are able to see it or not. (Default = False)
--share-type
<share-type>
¶Optional share type. Use of optional shares type is deprecated. (Default=Default)
--availability-zone
<availability-zone>
¶Availability zone in which share should be created.
--share-group
<share-group>
¶Optional share group name or ID in which to create the share. (Default=None).
share_protocol
¶Share protocol (NFS, CIFS, CephFS, GlusterFS or HDFS)
size
¶Share size in GiB.
This command is provided by the python-manilaclient plugin.
List shares
share list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--name <share-name>]
[--status <share-status>]
[--snapshot <share-network-id>]
[--public]
[--share-network <share-network-name-or-id>]
[--share-type <share-type-name-or-id>]
[--share-group <share-group-name-or-id>]
[--host <share-host>]
[--share-server <share-server-id>]
[--project <project>]
[--project-domain <project-domain>]
[--user <user>]
[--user-domain <user-domain>]
[--all-projects]
[--property <key=value>]
[--extra-spec <key=value>]
[--long]
[--sort <key>[:<direction>]]
[--limit <num-shares>]
[--marker <share>]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--noindent
¶whether to disable indenting the JSON
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--sort-column
SORT_COLUMN
¶specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
--name
<share-name>
¶Filter shares by share name
--status
<share-status>
¶Filter shares by status
--snapshot
<share-network-id>
¶Filter shares by snapshot name or id.
--public
¶Include public shares
--share-network
<share-network-name-or-id>
¶Filter shares exported on a given share network
--share-type
<share-type-name-or-id>
¶Filter shares of a given share type
--share-group
<share-group-name-or-id>
¶Filter shares belonging to a given share group
--host
<share-host>
¶Filter shares belonging to a given host (admin only)
--share-server
<share-server-id>
¶Filter shares exported via a given share server (admin only)
--project
<project>
¶Filter shares by project (name or ID) (admin only)
--project-domain
<project-domain>
¶Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--user
<user>
¶Filter results by user (name or ID) (admin only)
--user-domain
<user-domain>
¶Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
--all-projects
¶Include all projects (admin only)
--property
<key=value>
¶Filter shares having a given metadata key=value property (repeat option to filter by multiple properties)
--extra-spec
<key=value>
¶Filter shares with extra specs (key=value) of the share type that they belong to. (repeat option to filter by multiple extra specs)
--long
¶List additional fields in output
--sort
<key>[:<direction>]
¶Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma
--limit
<num-shares>
¶Maximum number of shares to display
--marker
<share>
¶The last share ID of the previous page
This command is provided by the python-manilaclient plugin.
Display share details
share show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<share>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
share
¶Share to display (name or ID)
This command is provided by the python-manilaclient plugin.
Delete a share
share delete
[--share-group <share-group>]
[--force]
<share>
[<share> ...]
--share-group
<share-group>
¶Optional share group (name or ID)which contains the share
--force
¶Attempt forced removal of share(s), regardless of state (defaults to False)
share
¶Share(s) to delete (name or ID)
This command is provided by the python-manilaclient plugin.
Set share properties
share set
[--property <key=value>]
[--name <name>]
[--description <description>]
[--public <public>]
<share>
--property
<key=value>
¶Set a property to this share (repeat option to set multiple properties)
--name
<name>
¶New share name. (Default=None)
--description
<description>
¶New share description. (Default=None)
--public
<public>
¶Level of visibility for share. Defines whether other tenants are able to see it or not.
share
¶Share to modify (name or ID)
This command is provided by the python-manilaclient plugin.
Unset share properties
share unset [--property <key>] [--name] [--description] <share>
--property
<key>
¶Remove a property from share (repeat option to remove multiple properties)
--name
¶Unset share name.
--description
¶Unset share description.
share
¶Share to modify (name or ID)
This command is provided by the python-manilaclient plugin.
Create new share access rule
share access create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--properties [<key=value> [<key=value> ...]]]
[--access-level <access_level>]
<share>
<access_type>
<access_to>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--properties
<key=value>
¶Space separated list of key=value pairs of properties. OPTIONAL: Default=None. Available only for API microversion >= 2.45.
--access-level
<access_level>
¶Share access level (“rw” and “ro” access levels are supported). Defaults to rw.
share
¶Name or ID of the NAS share to modify.
access_type
¶Access rule type (only “ip”, “user” (user or group), “cert” or “cephx” are supported).
access_to
¶Value that defines access.
This command is provided by the python-manilaclient plugin.
Delete a share access rule
share access delete <share> <id>
share
¶Name or ID of the NAS share to modify.
id
¶ID of the access rule to be deleted.
This command is provided by the python-manilaclient plugin.
List share access rule
share access list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--columns <columns>]
[--properties [<key=value> [<key=value> ...]]]
<share>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--noindent
¶whether to disable indenting the JSON
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--sort-column
SORT_COLUMN
¶specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
--columns
<columns>
¶Comma separated list of columns to be displayed. Example –columns “access_type,access_to”.
--properties
<key=value>
¶Filters results by properties (key=value). OPTIONAL: Default=None. Available only for API microversion >= 2.45
share
¶Name or ID of the share.
This command is provided by the python-manilaclient plugin.
Set properties to share access rule. Available for API microversion 2.45 and higher
share access set [--property <key=value>] <access_id>
--property
<key=value>
¶Set a property to this share access rule. (Repeat option to set multiple properties) Available only for API microversion >= 2.45.
access_id
¶ID of the NAS share access rule.
This command is provided by the python-manilaclient plugin.
Display a share access rule. Available for API microversion 2.45 and higher
share access show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<access_id>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
access_id
¶ID of the NAS share access rule.
This command is provided by the python-manilaclient plugin.
Unset properties of share access rule. Available for API microversion 2.45 and higher
share access unset [--property <key>] <access_id>
--property
<key>
¶Remove property from share access rule. (Repeat option to remove multiple properties) Available only for API microversion >= 2.45.
access_id
¶ID of the NAS share access rule.
This command is provided by the python-manilaclient plugin.
Add access for share type
share type access create <share_type> <project_id>
share_type
¶Share type name or ID to add access to
project_id
¶Project ID to add share type access for
This command is provided by the python-manilaclient plugin.
Delete access from share type
share type access delete <share_type> <project_id>
share_type
¶Share type name or ID to delete access from
project_id
¶Project ID to delete share type access for
This command is provided by the python-manilaclient plugin.
Get access list for share type
share type access list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
<share_type>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--noindent
¶whether to disable indenting the JSON
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--sort-column
SORT_COLUMN
¶specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
share_type
¶Share type name or ID to get access list for
This command is provided by the python-manilaclient plugin.
Create new share type
share type create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--description <description>]
[--snapshot-support <snapshot_support>]
[--create-share-from-snapshot-support <create_share_from_snapshot_support>]
[--revert-to-snapshot-support <revert_to_snapshot_support>]
[--mount-snapshot-support <mount_snapshot_support>]
[--extra-specs [<key=value> [<key=value> ...]]]
[--public <public>]
<name>
<spec_driver_handles_share_servers>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--description
<description>
¶Share type description. Available only for microversion >= 2.41.
--snapshot-support
<snapshot_support>
¶Boolean extra spec used for filtering of back ends by their capability to create share snapshots.
--create-share-from-snapshot-support
<create_share_from_snapshot_support>
¶Boolean extra spec used for filtering of back ends by their capability to create shares from snapshots.
--revert-to-snapshot-support
<revert_to_snapshot_support>
¶Boolean extra spec used for filtering of back ends by their capability to revert shares to snapshots. (Default is False).
--mount-snapshot-support
<mount_snapshot_support>
¶Boolean extra spec used for filtering of back ends by their capability to mount share snapshots. (Default is False).
--extra-specs
<key=value>
¶Extra specs key and value of share type that will be used for share type creation. OPTIONAL: Default=None. example –extra-specs thin_provisioning=’<is> True’, replication_type=readable.
--public
<public>
¶Make type accessible to the public (default true).
name
¶Share type name
spec_driver_handles_share_servers
¶Required extra specification. Valid values are ‘true’ and ‘false’
This command is provided by the python-manilaclient plugin.
Delete a share type
share type delete <share_types> [<share_types> ...]
share_types
¶Name or ID of the share type(s) to delete
This command is provided by the python-manilaclient plugin.
List share types
share type list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--all]
[--extra-specs [<key=value> [<key=value> ...]]]
[--columns <columns>]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--noindent
¶whether to disable indenting the JSON
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--sort-column
SORT_COLUMN
¶specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
--all
¶Display all share types whatever public or private. Default=False. (Admin only)
--extra-specs
<key=value>
¶Filter share types with extra specs (key=value). Available only for API microversion >= 2.43. OPTIONAL: Default=None.
--columns
<columns>
¶Comma separated list of columns to be displayed example –columns “id,name”.
This command is provided by the python-manilaclient plugin.
Set share type properties
share type set
[--extra-specs [<key=value> [<key=value> ...]]]
[--public <public>]
[--description <description>]
[--name <name>]
<share_type>
--extra-specs
<key=value>
¶Extra specs key and value of share type that will be used for share type creation. OPTIONAL: Default=None. example –extra-specs thin_provisioning=’<is> True’, replication_type=readable.
--public
<public>
¶New visibility of the share type. If set to True, share type will be available to all projects in the cloud. Available only for microversion >= 2.50
--description
<description>
¶New description of share type. Available only for microversion >= 2.50
--name
<name>
¶New name of share type. Available only for microversion >= 2.50
share_type
¶Name or ID of the share type to modify
This command is provided by the python-manilaclient plugin.
Display share type details
share type show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<share_type>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
share_type
¶Share type to display (name or ID)
This command is provided by the python-manilaclient plugin.
Delete Quota
share quota delete
[--project <project>]
[--user <user>]
[--share-type <share-type>]
--project
<project>
¶Name or ID of the project to delete quotas for.
--user
<user>
¶Name or ID of user to delete the quotas for. Optional. Mutually exclusive with ‘–share-type’.
--share-type
<share-type>
¶Name or ID of a share type to delete the quotas for. Optional. Mutually exclusive with ‘–user’. Available only for microversion >= 2.39
This command is provided by the python-manilaclient plugin.
Set Quota
share quota set
[--project <project>]
[--user <user>]
[--shares <shares>]
[--snapshots <snapshots>]
[--gigabytes <gigabytes>]
[--snapshot-gigabytes <snapshot-gigabytes>]
[--share-networks <share-networks>]
[--share-groups <share-groups>]
[--share-group-snapshots <share-group-snapshots>]
[--share-replicas <share-replicas>]
[--replica-gigabytes <replica-gigabytes>]
[--share-type <share-type>]
[--force]
--project
<project>
¶Name or ID of the project to set the quotas for.
--user
<user>
¶Name or ID of a user to set the quotas for. Optional. Mutually exclusive with ‘–share-type’.
--shares
<shares>
¶New value for the “shares” quota.
--snapshots
<snapshots>
¶New value for the “snapshots” quota.
--gigabytes
<gigabytes>
¶New value for the “gigabytes” quota.
--snapshot-gigabytes
<snapshot-gigabytes>
¶New value for the “snapshot-gigabytes” quota.
--share-networks
<share-networks>
¶New value for the “share-networks” quota.
--share-groups
<share-groups>
¶New value for the “share-groups” quota.Available only for microversion >= 2.40
--share-group-snapshots
<share-group-snapshots>
¶New value for the “share-group-snapshots” quota.
--share-replicas
<share-replicas>
¶Number of share replicas. Available only for microversion >= 2.53
--replica-gigabytes
<replica-gigabytes>
¶Capacity of share replicas in total. Available only for microversion >= 2.53
--share-type
<share-type>
¶Name or ID of a share type to set the quotas for. Optional. Mutually exclusive with ‘–user’. Available only for microversion >= 2.39
--force
¶Force update the quota.
This command is provided by the python-manilaclient plugin.
Show Quota
share quota show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--project <project>]
[--user <user>]
[--share-type <share-type>]
[--detail]
[--defaults]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--project
<project>
¶Name or ID of hte project to list quotas for.
--user
<user>
¶Name or ID of user to list the quotas for. Optional. Mutually exclusive with ‘–share-type’.
--share-type
<share-type>
¶UUID or name of a share type to list the quotas for. Optional. Mutually exclusive with ‘–user’. Available only for microversion >= 2.39
--detail
¶Optional flag to indicate whether to show quota in detail. Default false, available only for microversion >= 2.25.
--defaults
¶Show the default quotas for the project.
This command is provided by the python-manilaclient plugin.
Create a snapshot of the given share
share snapshot create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--force]
[--name <name>]
[--description <description>]
<share>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--force
¶Optional flag to indicate whether to snapshot a share even if it’s busy. (Default=False)
--name
<name>
¶Add a name to the snapshot (Optional).
--description
<description>
¶Add a description to the snapshot (Optional).
share
¶Name or ID of the share to create snapshot of
This command is provided by the python-manilaclient plugin.
Delete one or more share snapshots
share snapshot delete [--force] <snapshot> [<snapshot> ...]
--force
¶Delete the snapshot(s) ignoring the current state.
snapshot
¶Name or ID of the snapshot(s) to delete
This command is provided by the python-manilaclient plugin.
List snapshots
share snapshot list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--all-projects]
[--name <name>]
[--description <description>]
[--status <status>]
[--share <share>]
[--usage <usage>]
[--limit <num-snapshots>]
[--marker <snapshot>]
[--sort <key>[:<direction>]]
[--name~ <name~>]
[--description~ <description~>]
[--detail]
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--quote
<QUOTE_MODE>
¶when to include quotes, defaults to nonnumeric
--noindent
¶whether to disable indenting the JSON
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
--sort-column
SORT_COLUMN
¶specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
--all-projects
¶Display snapshots from all projects (Admin only).
--name
<name>
¶Filter results by name.
--description
<description>
¶Filter results by description. Available only for microversion >= 2.36.
--status
<status>
¶Filter results by status
--share
<share>
¶Name or ID of a share to filter results by.
--usage
<usage>
¶Option to filter snapshots by usage.
--limit
<num-snapshots>
¶Limit the number of snapshots returned
--marker
<snapshot>
¶The last share ID of the previous page
--sort
<key>[:<direction>]
¶Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma
--name~
<name~>
¶Filter results matching a share snapshot name pattern. Available only for microversion >= 2.36.
--description~
<description~>
¶Filter results matching a share snapshot description pattern. Available only for microversion >= 2.36.
--detail
¶List share snapshots with details
This command is provided by the python-manilaclient plugin.
Set share snapshot properties
share snapshot set
[--name <name>]
[--description <description>]
[--status <status>]
<snapshot>
--name
<name>
¶Set a name to the snapshot.
--description
<description>
¶Set a description to the snapshot.
--status
<status>
¶Assign a status to the snapshot (Admin only). Options include : available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, error_deleting.
snapshot
¶Name or ID of the snapshot to set a property for
This command is provided by the python-manilaclient plugin.
Show details about a share snapshot
share snapshot show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<snapshot>
-f
<FORMATTER>
,
--format
<FORMATTER>
¶the output format, defaults to table
-c
COLUMN
,
--column
COLUMN
¶specify the column(s) to include, can be repeated to show multiple columns
--noindent
¶whether to disable indenting the JSON
--prefix
<PREFIX>
¶add a prefix to all variable names
--max-width
<integer>
¶Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width
¶Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty
¶Print empty table if there is no data to show.
snapshot
¶Name or ID of the snapshot to display
This command is provided by the python-manilaclient plugin.
Unset a share snapshot property
share snapshot unset [--name] [--description] <snapshot>
--name
¶Unset snapshot name.
--description
¶Unset snapshot description.
snapshot
¶Name or ID of the snapshot to set a property for
This command is provided by the python-manilaclient plugin.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.