Abandon a share
openstack share abandon [--wait] <share> [<share> ...]
Wait until share is abandoned
Name or ID of the share(s)
This command is provided by the python-manilaclient plugin.
Create new share access rule
openstack share access create
[--properties [<key=value> ...]]
[--access-level <access_level>]
<share>
<access_type>
<access_to>
Space separated list of key=value pairs of properties. OPTIONAL: Default=None. Available only for API microversion >= 2.45.
Share access level (“rw” and “ro” access levels are supported). Defaults to rw.
Name or ID of the NAS share to modify.
Access rule type (only “ip”, “user” (user or group), “cert” or “cephx” are supported).
Value that defines access.
This command is provided by the python-manilaclient plugin.
Delete a share access rule
openstack share access delete <share> <id>
Name or ID of the NAS share to modify.
ID of the access rule to be deleted.
This command is provided by the python-manilaclient plugin.
List share access rule
openstack share access list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--properties [<key=value> ...]]
<share>
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Filters results by properties (key=value). OPTIONAL: Default=None. Available only for API microversion >= 2.45
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
openstack share access set [--property <key=value>] <access_id>
Set a property to this share access rule. (Repeat option to set multiple properties) Available only for API microversion >= 2.45.
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
openstack share access 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
openstack share access unset [--property <key>] <access_id>
Remove property from share access rule. (Repeat option to remove multiple properties) Available only for API microversion >= 2.45.
ID of the NAS share access rule.
This command is provided by the python-manilaclient plugin.
Adopt a share
openstack share adopt
[--name <name>]
[--description <description>]
[--share-type <share-type>]
[--driver-options [<key=value> ...]]
[--public]
[--share-server-id <share-server-id>]
[--wait]
<service-host>
<protocol>
<export-path>
Optional share name. (Default=None)
Optional share description. (Default=None)
Optional share type assigned to share. (Default=None)
Optional driver options as key=value pairs (Default=None).
Level of visibility for share. Defines whether other projects are able to see it or not. Available only for microversion >= 2.8. (Default=False)
Share server associated with share when using a share type with “driver_handles_share_servers” extra_spec set to True. Available only for microversion >= 2.49. (Default=None)
Wait until share is adopted
Service host: some.host@driver#pool.
Protocol of the share to manage, such as NFS or CIFS.
Share export path, NFS share such as: 10.0.0.1:/example_path, CIFS share such as: \10.0.0.1example_cifs_share.
This command is provided by the python-manilaclient plugin.
List all availability zones
openstack share availability zone list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
This command is provided by the python-manilaclient plugin.
Create new share
openstack share create
[--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>]
[--wait]
<share_protocol>
<size>
Optional share name. (Default=None)
Optional snapshot ID to create the share from. (Default=None)
Set a property to this share (repeat option to set multiple properties)
Optional network info ID or name.
Optional share description. (Default=None)
Level of visibility for share. Defines whether other tenants are able to see it or not. (Default = False)
Optional share type. Use of optional shares type is deprecated. (Default=Default)
Availability zone in which share should be created.
Optional share group name or ID in which to create the share. (Default=None).
Wait for share creation
Share protocol (NFS, CIFS, CephFS, GlusterFS or HDFS)
Share size in GiB.
This command is provided by the python-manilaclient plugin.
Delete a share
openstack share delete
[--share-group <share-group>]
[--force]
[--wait]
<share>
[<share> ...]
Optional share group (name or ID)which contains the share
Attempt forced removal of share(s), regardless of state (defaults to False)
Wait for share deletion
Share(s) to delete (name or ID)
This command is provided by the python-manilaclient plugin.
List export location of a share
openstack share export location list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
<share>
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Name or ID of share
This command is provided by the python-manilaclient plugin.
Show export location of a share
openstack share export location show <share> <export-location>
Name or ID of share
ID of the share export location
This command is provided by the python-manilaclient plugin.
Create new share group
openstack share group create
[--name <name>]
[--description <description>]
[--share-types <share-types> [<share-types> ...]]
[--share-group-type <share-group-type>]
[--share-network <share-network>]
[--source-share-group-snapshot <source-share-group-snapshot>]
[--availability-zone <availability-zone>]
[--wait]
Share group name
Share group description.
Name or ID of share type(s).
Share group type name or ID of the share group to be created.
Specify share network name or id
Share group snapshot name or ID to create the share group from.
Optional availability zone in which group should be created
Wait for share group creation
This command is provided by the python-manilaclient plugin.
Delete one or more share groups
openstack share group delete
[--force]
[--wait]
<share_group>
[<share_group> ...]
Attempt to force delete the share group (Default=False) (Admin only).
Wait for share group to delete
Name or ID of the share group(s) to delete
This command is provided by the python-manilaclient plugin.
List share groups
openstack share group list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all-projects]
[--name <name>]
[--description <description>]
[--status <status>]
[--share-server <share-server-id>]
[--share-group-type <share-group-type>]
[--snapshot <snapshot>]
[--host <host>]
[--share-network <share-network>]
[--project <project>]
[--project-domain <project-domain>]
[--limit <limit>]
[--marker <marker>]
[--sort <key>[:<direction>]]
[--name~ <name~>]
[--description~ <description~>]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Display share groups from all projects (Admin only).
Filter results by name.
Filter results by description. Available only for microversion >= 2.36.
Filter results by status.
Filter results by share server ID.
Filter results by a share group type ID or name that was used for share group creation.
Filter results by share group snapshot name or ID that was used to create the share group.
Filter results by host.
Filter results by share-network name or ID.
Filter results by project name or ID. Useful with set key ‘–all-projects’.
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Limit the number of share groups returned
The last share group ID of the previous page
Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma
Filter results matching a share group name pattern. Available only for microversion >= 2.36.
Filter results matching a share group description pattern. Available only for microversion >= 2.36.
This command is provided by the python-manilaclient plugin.
Explicitly set share group status
openstack share group set
[--name <name>]
[--description <description>]
[--status <status>]
<share-group>
New name for the share group. (Default=None)
Share group description. (Default=None)
Explicitly update the status of a share group (Admin only). Examples include: available, error, creating, deleting, error_deleting.
Name or ID of the share group to update.
This command is provided by the python-manilaclient plugin.
Show details about a share group
openstack share group show <share-group>
Name or ID of the share group.
This command is provided by the python-manilaclient plugin.
Unset a share group property
openstack share group unset [--name] [--description] <share-group>
Unset share group name.
Unset share group description.
Name or ID of the share group to set a property for.
This command is provided by the python-manilaclient plugin.
Forces the deletion of a share instance
openstack share instance delete [--wait] <instance> [<instance> ...]
Wait for share instance deletion.
ID of the share instance to delete.
This command is provided by the python-manilaclient plugin.
List share instance export locations
openstack share instance export location list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
<instance>
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
ID of the share instance.
This command is provided by the python-manilaclient plugin.
Show export location for a share instance.
openstack share instance export location show
<instance>
<export_location>
Name or ID of the share instance
ID of the share instance export location.
This command is provided by the python-manilaclient plugin.
List share instances
openstack share instance list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--share <share>]
[--export-location <export-location>]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Name or ID of the share to list instances for.
Export location to list instances for.
This command is provided by the python-manilaclient plugin.
Explicitly reset share instance status
openstack share instance set [--status <status>] <instance>
Indicate which state to assign the instance. Options are: available, error, creating, deleting,error_deleting, migrating, migrating_to, server_migrating.
Instance to be modified.
This command is provided by the python-manilaclient plugin.
Show share instance
openstack share instance show <instance>
ID of the share instance.
This command is provided by the python-manilaclient plugin.
Show a list of share limits for a user.
openstack share limits show
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
(--absolute | --rate)
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Get the absolute limits for the user
Get the API rate limits for the user
This command is provided by the python-manilaclient plugin.
List shares
openstack share list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--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>]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Filter shares by share name
Filter shares by status
Filter shares by snapshot name or id.
Include public shares
Filter shares exported on a given share network
Filter shares of a given share type
Filter shares belonging to a given share group
Filter shares belonging to a given host (admin only)
Filter shares exported via a given share server (admin only)
Filter shares by project (name or ID) (admin only)
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Filter results by user (name or ID) (admin only)
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
Include all projects (admin only)
Filter shares having a given metadata key=value property (repeat option to filter by multiple properties)
Filter shares with extra specs (key=value) of the share type that they belong to. (repeat option to filter by multiple extra specs)
List additional fields in output
Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma
Maximum number of shares to display
The last share ID of the previous page
This command is provided by the python-manilaclient plugin.
Remove one or more messages
openstack share message delete <message> [<message> ...]
ID of the message(s).
This command is provided by the python-manilaclient plugin.
Lists all messages
openstack share message list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--resource-id <resource-id>]
[--resource-type <resource-type>]
[--action-id <action-id>]
[--detail-id <detail-id>]
[--request-id <request-id>]
[--message-level <message-level>]
[--limit <limit>]
[--since <since>]
[--before <before>]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Filters results by a resource uuid. Default=None.
Filters results by a resource type. Default=None. Example: “openstack message list –resource-type share”
Filters results by action id. Default=None.
Filters results by detail id. Default=None.
Filters results by request id. Default=None.
Filters results by the message level. Default=None. Example: “openstack message list –message-level ERROR”.
Maximum number of messages to return. (Default=None)
Return only user messages created since given date. The date format must be conforming to ISO8601. Available only for microversion >= 2.52.
Return only user messages created before given date. The date format must be conforming to ISO8601. Available only for microversion >= 2.52.
This command is provided by the python-manilaclient plugin.
Show details about a message
openstack share message show <message>
ID of the message.
This command is provided by the python-manilaclient plugin.
Create a share network
openstack share network create
[--name <share-network>]
[--description <description>]
[--neutron-net-id <neutron-net-id>]
[--neutron-subnet-id <neutron-subnet-id>]
[--availability-zone <availability-zone>]
Add a name to the share network (Optional)
Add a description to the share network (Optional).
ID of the neutron network that must be associated with the share network (Optional). The network specified will be associated with the ‘default’ share network subnet, unless ‘availability-zone’ is also specified.
ID of the neutron sub-network that must be associated with the share network (Optional). The subnet specified will be associated with the ‘default’ share network subnet, unless ‘availability-zone’ is also specified.
Name or ID of the avalilability zone to assign the specified network subnet parameters to. Must be used in conjunction with ‘neutron-net-id’ and ‘neutron-subnet-id’. Do not specify this parameter if the network must be available across all availability zones (‘default’ share network subnet). Available only for microversion >= 2.51.
This command is provided by the python-manilaclient plugin.
Delete one or more share networks
openstack share network delete
[--wait]
<share-network>
[<share-network> ...]
Wait for the share network(s) to be deleted
Name or ID of the share network(s) to delete
This command is provided by the python-manilaclient plugin.
List share networks
openstack share network list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--name <share-network>]
[--name~ <share-network-name-pattern>]
[--description <share-network-description>]
[--description~ <share-network-description-pattern>]
[--all-projects]
[--project <project>]
[--project-domain <project-domain>]
[--created-since <yyyy-mm-dd>]
[--created-before <yyyy-mm-dd>]
[--security-service <security-service>]
[--neutron-net-id <neutron-net-id>]
[--neutron-subnet-id <neutron-subnet-id>]
[--network-type <network-type>]
[--segmentation-id <segmentation-id>]
[--cidr <X.X.X.X/X>]
[--ip-version 4/6]
[--detail]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Filter share networks by name
Filter share networks by name-pattern. Available only for microversion >= 2.36.
Filter share networks by description. Available only for microversion >= 2.36
Filter share networks by description-pattern. Available only for microversion >= 2.36.
Include all projects (admin only)
Filter share networks by project (name or ID) (admin only)
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Filter share networks by date they were created after. The date can be in the format yyyy-mm-dd.
Filter share networks by date they were created before. The date can be in the format yyyy-mm-dd.
Filter share networks by the name or ID of a security service attached to the network.
Filter share networks by the ID of a neutron network.
Filter share networks by the ID of a neutron sub network.
Filter share networks by the type of network. Examples include “flat”, “vlan”, “vxlan”, “geneve”, etc.
Filter share networks by the segmentation ID of network. Relevant only for segmented networks such as “vlan”, “vxlan”, “geneve”, etc.
Filter share networks by the CIDR of network.
Filter share networks by the IP Version of the network, either 4 or 6.
List share networks with details
This command is provided by the python-manilaclient plugin.
Set share network properties
openstack share network set
[--name <name>]
[--description <description>]
[--status <status>]
[--neutron-net-id <neutron-net-id>]
[--neutron-subnet-id <neutron-subnet-id>]
[--current-security-service <security-service>]
[--new-security-service <security-service>]
[--check-only]
[--restart-check]
<share-network>
Set a new name to the share network.
Set a new description to the share network.
Assign a status to the share network (Admin only). Options include : active, error, network_change. Available only for microversion >= 2.63.
Update the neutron network associated with the default share network subnet. If a default share network subnet is not present or if the share network is in use, setting this will fail.
Update the neutron subnetwork associated with the default share network subnet. If a default share network subnet is not present or if the share network is in use, setting this will fail.
Name or ID of a security service that is currently associated with a share network that must be replaced. Replacing a security service is only available for microversions >= 2.63.
Name or ID of a security service that must be associated with the share network. When replacing a security service, the current security service must also be provided with the ‘–current-security-service’ option. Replacing a security service is only available for microversions >= 2.63.
Run a dry-run of a security service replacement. Available only for microversion >=2.63
Restart a dry-run of a security service replacement. Helpful when check results are stale. Available only for microversion >=2.63.
Name or ID of the share network to set a property for
This command is provided by the python-manilaclient plugin.
Show details about a share network
openstack share network show <share-network>
Name or ID of the share network to display
This command is provided by the python-manilaclient plugin.
Unset a share network property
openstack share network unset
[--name]
[--description]
[--security-service <security-service>]
<share-network>
Unset share network name.
Unset share network description.
Disassociate a security service from the share network. This is only possible with unused share networks.
Name or ID of the share network to unset a property of
This command is provided by the python-manilaclient plugin.
List all backend storage pools known to the scheduler (Admin only).
openstack share pool list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--host <host>]
[--backend <backend>]
[--pool <pool>]
[--detail]
[--share-type <share-type>]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Filter results by host name. Regular expressions are supported.
Filter results by backend name. Regular expressions are supported.
Filter results by pool name. Regular expressions are supported.
Show detailed information about pools.
Filter results by share type name or ID. Available only for microversion >= 2.23
This command is provided by the python-manilaclient plugin.
Show share properties
openstack share properties show <share>
Name or ID of share
This command is provided by the python-manilaclient plugin.
Delete Quota
openstack share quota delete
[--project <project>]
[--user <user>]
[--share-type <share-type>]
Name or ID of the project to delete quotas for.
Name or ID of user to delete the quotas for. Optional. Mutually exclusive with ‘–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
openstack 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]
[--per-share-gigabytes <per-share-gigabytes>]
Name or ID of the project to set the quotas for.
Name or ID of a user to set the quotas for. Optional. Mutually exclusive with ‘–share-type’.
New value for the “shares” quota.
New value for the “snapshots” quota.
New value for the “gigabytes” quota.
New value for the “snapshot-gigabytes” quota.
New value for the “share-networks” quota.
New value for the “share-groups” quota.Available only for microversion >= 2.40
New value for the “share-group-snapshots” quota.
Number of share replicas. Available only for microversion >= 2.53
Capacity of share replicas in total. Available only for microversion >= 2.53
Name or ID of a share type to set the quotas for. Optional. Mutually exclusive with ‘–user’. Available only for microversion >= 2.39
Force update the quota.
New value for the ‘per-share-gigabytes’ quota.Available only for microversion >= 2.62
This command is provided by the python-manilaclient plugin.
Show Quota
openstack share quota show
[--project <project>]
[--user <user>]
[--share-type <share-type>]
[--detail]
[--defaults]
Name or ID of hte project to list quotas for.
Name or ID of user to list the quotas for. Optional. Mutually exclusive with ‘–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
Optional flag to indicate whether to show quota in detail. Default false, available only for microversion >= 2.25.
Show the default quotas for the project.
This command is provided by the python-manilaclient plugin.
Create a replica of the given share
openstack share replica create
[--availability-zone <availability-zone>]
[--wait]
<share>
Availability zone in which the replica should be created.
Wait for replica creation
Name or ID of the share to replicate.
This command is provided by the python-manilaclient plugin.
Delete one or more share replicas
openstack share replica delete
[--force]
[--wait]
<replica>
[<replica> ...]
Attempt to force delete a replica on its backend. Using this option will purge the replica from Manila even if it is not cleaned up on the backend.
Wait for share replica deletion
Name or ID of the replica(s) to delete
This command is provided by the python-manilaclient plugin.
List export locations of a share replica.
openstack share replica export location list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
<replica>
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
ID of the share replica.
This command is provided by the python-manilaclient plugin.
Show details of a share replica’s export location.
openstack share replica export location show
<replica>
<export-location>
ID of the share replica.
ID of the share replica export location.
This command is provided by the python-manilaclient plugin.
List share replicas
openstack share replica list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--share <share>]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Name or ID of the share to list replicas for.
This command is provided by the python-manilaclient plugin.
Promote specified replica to ‘active’ replica_state.
openstack share replica promote <replica>
ID of the share replica.
This command is provided by the python-manilaclient plugin.
Attempt to update the share replica with its ‘active’ mirror.
openstack share replica resync <replica>
ID of the share replica to resync.
This command is provided by the python-manilaclient plugin.
Explicitly set share replica status and/or replica-state
openstack share replica set
[--replica-state <replica-state>]
[--status <status>]
<replica>
Indicate which replica_state to assign the replica. Options include in_sync, out_of_sync, active and error.
Indicate which status to assign the replica. Options include available, error, creating, deleting and error_deleting.
ID of the share replica to modify.
This command is provided by the python-manilaclient plugin.
Show details about a replica
openstack share replica show <replica>
ID of the share replica.
This command is provided by the python-manilaclient plugin.
Resize a share
openstack share resize [--wait] <share> <new-size>
Wait for share resize
Name or ID of share to resize
New size of share, in GiBs
This command is provided by the python-manilaclient plugin.
Revert a share to the specified snapshot.
openstack share revert <snapshot>
Name or ID of the snapshot to restore. The snapshot must be the most recent one known to manila.
This command is provided by the python-manilaclient plugin.
List share services (Admin only).
openstack share service list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--host <host>]
[--binary <binary>]
[--status <status>]
[--state <state>]
[--zone <zone>]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Filter services by name of the host.
Filter services by the name of the service.
Filter results by status.
Filter results by state.
Filter services by their availability zone.
This command is provided by the python-manilaclient plugin.
Enable/Disable share service (Admin only).
openstack share service set [--enable | --disable] <host> <binary>
Enable share service
Disable share service
Host name as ‘example_host@example_backend’.
Service binary, could be ‘manila-share’, ‘manila-scheduler’ or ‘manila-data’
This command is provided by the python-manilaclient plugin.
Set share properties
openstack share set
[--property <key=value>]
[--name <name>]
[--description <description>]
[--public <public>]
[--status <status>]
<share>
Set a property to this share (repeat option to set multiple properties)
New share name. (Default=None)
New share description. (Default=None)
Level of visibility for share. Defines whether other tenants are able to see it or not.
Explicitly update the status of a share (Admin only). Examples include: available, error, creating, deleting, error_deleting.
Share to modify (name or ID)
This command is provided by the python-manilaclient plugin.
Display share details
openstack share show <share>
Share to display (name or ID)
This command is provided by the python-manilaclient plugin.
Abandon share snapshot(s)
openstack share snapshot abandon <snapshot> [<snapshot> ...]
Name or ID of the snapshot(s) to be abandoned.
This command is provided by the python-manilaclient plugin.
Allow access to a snapshot
openstack share snapshot access create
<snapshot>
<access_type>
<access_to>
Name or ID of the snapshot
Access rule type (only “ip”, “user” (user or group), “cert” or “cephx” are supported).
Value that defines access.
This command is provided by the python-manilaclient plugin.
Delete access to a snapshot
openstack share snapshot access delete <snapshot> <id> [<id> ...]
Name or ID of the share snapshot to deny access to.
ID(s) of the access rule(s) to be deleted.
This command is provided by the python-manilaclient plugin.
Show access list for a snapshot
openstack share snapshot access list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
<snapshot>
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Name or ID of the share snapshot to show access list for.
This command is provided by the python-manilaclient plugin.
Adopt a share snapshot
openstack share snapshot adopt
[--name <name>]
[--description <description>]
[--driver-option <key=value>]
<share>
<provider-location>
Optional snapshot name (Default=None).
Optional snapshot description (Default=None).
Set driver options as key=value pairs.(repeat option to set multiple key=value pairs)
Name or ID of the share that owns the snapshot to be adopted.
Provider location of the snapshot on the backend.
This command is provided by the python-manilaclient plugin.
Create a snapshot of the given share
openstack share snapshot create
[--force]
[--name <name>]
[--description <description>]
<share>
Optional flag to indicate whether to snapshot a share even if it’s busy. (Default=False)
Add a name to the snapshot (Optional).
Add a description to the snapshot (Optional).
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
openstack share snapshot delete [--force] <snapshot> [<snapshot> ...]
Delete the snapshot(s) ignoring the current state.
Name or ID of the snapshot(s) to delete
This command is provided by the python-manilaclient plugin.
List export locations of a given snapshot
openstack share snapshot export location list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
<snapshot>
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Name or ID of the share snapshot.
This command is provided by the python-manilaclient plugin.
Show export location of the share snapshot
openstack share snapshot export location show
<snapshot>
<export-location>
Name or ID of the share snapshot.
ID of the share snapshot export location.
This command is provided by the python-manilaclient plugin.
List export locations from a share snapshot instance.
openstack share snapshot instance export location list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
<instance>
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Name or ID of the share instance.
This command is provided by the python-manilaclient plugin.
Show export location of the share snapshot instance.
openstack share snapshot instance export location show
<snapshot_instance>
<export_location>
ID of the share snapshot instance.
ID of the share snapshot instance export location.
This command is provided by the python-manilaclient plugin.
List all share snapshot instances
openstack share snapshot instance list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--snapshot <snapshot>]
[--detailed]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Filter results by share snapshot ID.
Show detailed information about snapshot instances.
This command is provided by the python-manilaclient plugin.
Explicitly update the state of a share snapshot instance.
openstack share snapshot instance set
[--status <status>]
<snapshot_instance>
Indicate state to update the snapshot instance to. Default is available.
ID of the share snapshot instance to update.
This command is provided by the python-manilaclient plugin.
Show details about a share snapshot instance.
openstack share snapshot instance show <snapshot_instance>
ID of the share snapshot instance.
This command is provided by the python-manilaclient plugin.
List snapshots
openstack share snapshot list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--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]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Display snapshots from all projects (Admin only).
Filter results by name.
Filter results by description. Available only for microversion >= 2.36.
Filter results by status
Name or ID of a share to filter results by.
Option to filter snapshots by usage.
Limit the number of snapshots returned
The last share ID of the previous page
Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma
Filter results matching a share snapshot name pattern. Available only for microversion >= 2.36.
Filter results matching a share snapshot description pattern. Available only for microversion >= 2.36.
List share snapshots with details
This command is provided by the python-manilaclient plugin.
Set share snapshot properties
openstack share snapshot set
[--name <name>]
[--description <description>]
[--status <status>]
<snapshot>
Set a name to the snapshot.
Set a description to the snapshot.
Assign a status to the snapshot (Admin only). Options include : available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, error_deleting.
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
openstack share snapshot show <snapshot>
Name or ID of the snapshot to display
This command is provided by the python-manilaclient plugin.
Unset a share snapshot property
openstack share snapshot unset [--name] [--description] <snapshot>
Unset snapshot name.
Unset snapshot description.
Name or ID of the snapshot to set a property for
This command is provided by the python-manilaclient plugin.
Add access for share type
openstack share type access create <share_type> <project_id>
Share type name or ID to add access to
Project ID to add share type access for
This command is provided by the python-manilaclient plugin.
Delete access from share type
openstack share type access delete <share_type> <project_id>
Share type name or ID to delete access from
Project ID to delete share type access for
This command is provided by the python-manilaclient plugin.
Get access list for share type
openstack share type access list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
<share_type>
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Share type name or ID to get access list for
This command is provided by the python-manilaclient plugin.
Create new share type
openstack share type create
[--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> ...]]
[--public <public>]
<name>
<spec_driver_handles_share_servers>
Share type description. Available only for microversion >= 2.41.
Boolean extra spec used for filtering of back ends by their capability to create share snapshots.
Boolean extra spec used for filtering of back ends by their capability to create shares from snapshots.
Boolean extra spec used for filtering of back ends by their capability to revert shares to snapshots. (Default is False).
Boolean extra spec used for filtering of back ends by their capability to mount share snapshots. (Default is False).
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.
Make type accessible to the public (default true).
Share type name
Required extra specification. Valid values are ‘true’ and ‘false’
This command is provided by the python-manilaclient plugin.
Delete a share type
openstack share type delete <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
openstack share type list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all]
[--extra-specs [<key=value> ...]]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Display all share types whatever public or private. Default=False. (Admin only)
Filter share types with extra specs (key=value). Available only for API microversion >= 2.43. OPTIONAL: Default=None.
This command is provided by the python-manilaclient plugin.
Set share type properties
openstack share type set
[--extra-specs [<key=value> ...]]
[--public <public>]
[--description <description>]
[--name <name>]
<share_type>
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.
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
New description of share type. Available only for microversion >= 2.50
New name of share type. Available only for microversion >= 2.50
Name or ID of the share type to modify
This command is provided by the python-manilaclient plugin.
Display share type details
openstack share type show <share_type>
Share type to display (name or ID)
This command is provided by the python-manilaclient plugin.
Unset share type extra specs
openstack share type unset <share_type> <key> [<key> ...]
Name or ID of the share type to modify
Remove extra_specs from this share type
This command is provided by the python-manilaclient plugin.
Unset share properties
openstack share unset
[--property <key>]
[--name]
[--description]
<share>
Remove a property from share (repeat option to remove multiple properties)
Unset share name.
Unset share description.
Share to modify (name or ID)
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.