manila

share abandon

Abandon a share

openstack share abandon [--wait] <share> [<share> ...]
--wait

Wait until share is abandoned

share

Name or ID of the share(s)

This command is provided by the python-manilaclient plugin.

share access create

Create new share access rule

openstack share access create
    [--properties [<key=value> [<key=value> ...]]]
    [--access-level <access_level>]
    <share>
    <access_type>
    <access_to>
--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.

share access delete

Delete a share access rule

openstack 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.

share access list

List share access rule

openstack share access list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--properties [<key=value> [<key=value> ...]]]
    <share>
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--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.

share access set

Set properties to share access rule. Available for API microversion 2.45 and higher

openstack 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.

share access show

Display a share access rule. Available for API microversion 2.45 and higher

openstack share access show <access_id>
access_id

ID of the NAS share access rule.

This command is provided by the python-manilaclient plugin.

share access unset

Unset properties of share access rule. Available for API microversion 2.45 and higher

openstack 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.

share adopt

Adopt a share

openstack share adopt
    [--name <name>]
    [--description <description>]
    [--share-type <share-type>]
    [--driver-options [<key=value> [<key=value> ...]]]
    [--public]
    [--share-server-id <share-server-id>]
    [--wait]
    <service-host>
    <protocol>
    <export-path>
--name <name>

Optional share name. (Default=None)

--description <description>

Optional share description. (Default=None)

--share-type <share-type>

Optional share type assigned to share. (Default=None)

--driver-options <key=value>

Optional driver options as key=value pairs (Default=None).

--public

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-id <share-server-id>

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

Wait until share is adopted

service-host

Service host: some.host@driver#pool.

protocol

Protocol of the share to manage, such as NFS or CIFS.

export-path

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.

share create

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>
--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).

--wait

Wait for share creation

share_protocol

Share protocol (NFS, CIFS, CephFS, GlusterFS or HDFS)

size

Share size in GiB.

This command is provided by the python-manilaclient plugin.

share delete

Delete a share

openstack share delete
    [--share-group <share-group>]
    [--force]
    [--wait]
    <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)

--wait

Wait for share deletion

share

Share(s) to delete (name or ID)

This command is provided by the python-manilaclient plugin.

share export location list

List export location of a share

openstack share export location list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <share>
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

share

Name or ID of share

This command is provided by the python-manilaclient plugin.

share export location show

Show export location of a share

openstack share export location show <share> <export-location>
share

Name or ID of share

export-location

ID of the share export location

This command is provided by the python-manilaclient plugin.

share list

List shares

openstack share list
    [--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>]
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--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.

share message delete

Remove one or more messages

openstack share message delete <message> [<message> ...]
message

ID of the message(s).

This command is provided by the python-manilaclient plugin.

share message list

Lists all messages

openstack share message list
    [--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>]
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--resource-id <resource-id>

Filters results by a resource uuid. Default=None.

--resource-type <resource-type>

Filters results by a resource type. Default=None. Example: “openstack message list –resource-type share”

--action-id <action-id>

Filters results by action id. Default=None.

--detail-id <detail-id>

Filters results by detail id. Default=None.

--request-id <request-id>

Filters results by request id. Default=None.

--message-level <message-level>

Filters results by the message level. Default=None. Example: “openstack message list –message-level ERROR”.

--limit <limit>

Maximum number of messages to return. (Default=None)

--since <since>

Return only user messages created since given date. The date format must be conforming to ISO8601. Available only for microversion >= 2.52.

--before <before>

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.

share message show

Show details about a message

openstack share message show <message>
message

ID of the message.

This command is provided by the python-manilaclient plugin.

share properties show

Show share properties

openstack share properties show <share>
share

Name or ID of share

This command is provided by the python-manilaclient plugin.

share quota delete

Delete Quota

openstack 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.

share quota set

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]
--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.

share quota show

Show Quota

openstack share quota show
    [--project <project>]
    [--user <user>]
    [--share-type <share-type>]
    [--detail]
    [--defaults]
--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.

share resize

Resize a share

openstack share resize [--wait] <share> <new-size>
--wait

Wait for share resize

share

Name or ID of share to resize

new-size

New size of share, in GiBs

This command is provided by the python-manilaclient plugin.

share revert

Revert a share to the specified snapshot.

openstack share revert <snapshot>
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.

share set

Set share properties

openstack share set
    [--property <key=value>]
    [--name <name>]
    [--description <description>]
    [--public <public>]
    [--status <status>]
    <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.

--status <status>

Explicitly update the status of a share (Admin only). Examples include: available, error, creating, deleting, error_deleting.

share

Share to modify (name or ID)

This command is provided by the python-manilaclient plugin.

share show

Display share details

openstack share show <share>
share

Share to display (name or ID)

This command is provided by the python-manilaclient plugin.

share snapshot abandon

Abandon share snapshot(s)

openstack share snapshot abandon <snapshot> [<snapshot> ...]
snapshot

Name or ID of the snapshot(s) to be abandoned.

This command is provided by the python-manilaclient plugin.

share snapshot access create

Allow access to a snapshot

openstack share snapshot access create
    <snapshot>
    <access_type>
    <access_to>
snapshot

Name or ID of the snapshot

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.

share snapshot access delete

Delete access to a snapshot

openstack share snapshot access delete <snapshot> <id> [<id> ...]
snapshot

Name or ID of the share snapshot to deny access to.

id

ID(s) of the access rule(s) to be deleted.

This command is provided by the python-manilaclient plugin.

share snapshot access list

Show access list for a snapshot

openstack share snapshot access list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <snapshot>
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

snapshot

Name or ID of the share snapshot to show access list for.

This command is provided by the python-manilaclient plugin.

share snapshot adopt

Adopt a share snapshot

openstack share snapshot adopt
    [--name <name>]
    [--description <description>]
    [--driver-option <key=value>]
    <share>
    <provider-location>
--name <name>

Optional snapshot name (Default=None).

--description <description>

Optional snapshot description (Default=None).

--driver-option <key=value>

Set driver options as key=value pairs.(repeat option to set multiple key=value pairs)

share

Name or ID of the share that owns the snapshot to be adopted.

provider-location

Provider location of the snapshot on the backend.

This command is provided by the python-manilaclient plugin.

share snapshot create

Create a snapshot of the given share

openstack share snapshot create
    [--force]
    [--name <name>]
    [--description <description>]
    <share>
--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.

share snapshot delete

Delete one or more share snapshots

openstack 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.

share snapshot export location list

List export locations of a given snapshot

openstack share snapshot export location list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <snapshot>
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

snapshot

Name or ID of the share snapshot.

This command is provided by the python-manilaclient plugin.

share snapshot export location show

Show export location of the share snapshot

openstack share snapshot export location show
    <snapshot>
    <export-location>
snapshot

Name or ID of the share snapshot.

export-location

ID of the share snapshot export location.

This command is provided by the python-manilaclient plugin.

share snapshot list

List snapshots

openstack share snapshot list
    [--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]
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--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.

share snapshot set

Set share snapshot properties

openstack 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.

share snapshot show

Show details about a share snapshot

openstack share snapshot show <snapshot>
snapshot

Name or ID of the snapshot to display

This command is provided by the python-manilaclient plugin.

share snapshot unset

Unset a share snapshot property

openstack 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.

share type access create

Add access for share type

openstack 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.

share type access delete

Delete access from share type

openstack 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.

share type access list

Get access list for share type

openstack share type access list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <share_type>
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

share_type

Share type name or ID to get access list for

This command is provided by the python-manilaclient plugin.

share type create

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> [<key=value> ...]]]
    [--public <public>]
    <name>
    <spec_driver_handles_share_servers>
--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.

share type delete

Delete a share type

openstack 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.

share type list

List share types

openstack share type list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--all]
    [--extra-specs [<key=value> [<key=value> ...]]]
--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

--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

--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.

This command is provided by the python-manilaclient plugin.

share type set

Set share type properties

openstack 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.

share type show

Display share type details

openstack share type show <share_type>
share_type

Share type to display (name or ID)

This command is provided by the python-manilaclient plugin.

share type unset

Unset share type extra specs

openstack share type unset <share_type> <key> [<key> ...]
share_type

Name or ID of the share type to modify

key

Remove extra_specs from this share type

This command is provided by the python-manilaclient plugin.

share unset

Unset share properties

openstack 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.