diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 970fe6f44a..89b3cd3487 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -18,4 +18,5 @@ Command Line Interface .. toctree:: :maxdepth: 1 + manila manila-manage diff --git a/doc/source/cli/manila.rst b/doc/source/cli/manila.rst new file mode 100644 index 0000000000..db45f949bc --- /dev/null +++ b/doc/source/cli/manila.rst @@ -0,0 +1,3597 @@ +.. ################################################### +.. ## WARNING ###################################### +.. ############## WARNING ########################## +.. ########################## WARNING ############## +.. ###################################### WARNING ## +.. ################################################### +.. ################################################### +.. ## +.. This file is tool-generated. Do not edit manually. +.. http://docs.openstack.org/contributor-guide/ +.. doc-tools/cli-reference.html +.. ## +.. ## WARNING ###################################### +.. ############## WARNING ########################## +.. ########################## WARNING ############## +.. ###################################### WARNING ## +.. ################################################### + +======================================================== +Shared File Systems service (manila) command-line client +======================================================== + +The manila client is the command-line interface (CLI) for +the Shared File Systems service (manila) API and its extensions. + +This chapter documents :command:`manila` version ``1.16.0``. + +For help on a specific :command:`manila` command, enter: + +.. code-block:: console + + $ manila help COMMAND + +.. _manila_command_usage: + +manila usage +~~~~~~~~~~~~ + +.. code-block:: console + + usage: manila [--version] [-d] [--os-cache] [--os-reset-cache] + [--os-user-id ] [--os-username ] + [--os-password ] + [--os-tenant-name ] + [--os-project-name ] + [--os-tenant-id ] + [--os-project-id ] + [--os-user-domain-id ] + [--os-user-domain-name ] + [--os-project-domain-id ] + [--os-project-domain-name ] + [--os-auth-url ] [--os-region-name ] + [--os-token ] [--bypass-url ] + [--service-type ] [--service-name ] + [--share-service-name ] + [--endpoint-type ] + [--os-share-api-version ] + [--os-cacert ] [--retries ] + [--os-cert ] + ... + +**Subcommands:** + +``absolute-limits`` + Print a list of absolute limits for a user. + +``access-allow`` + Allow access to the share. + +``access-deny`` + Deny access to a share. + +``access-list`` + Show access list for share. + +``api-version`` + Display the API version information. + +``availability-zone-list`` + List all availability zones. + +``create`` + Creates a new share (NFS, CIFS, CephFS, GlusterFS or + HDFS). + +``credentials`` + Show user credentials returned from auth. + +``delete`` + Remove one or more shares. + +``endpoints`` + Discover endpoints that get returned from the + authenticate services. + +``extend`` + Increases the size of an existing share. + +``extra-specs-list`` + Print a list of current 'share types and extra specs' + (Admin Only). + +``force-delete`` + Attempt force-delete of share, regardless of state + (Admin only). + +``list`` + List NAS shares with filters. + +``manage`` + Manage share not handled by Manila (Admin only). + +``metadata`` + Set or delete metadata on a share. + +``metadata-show`` + Show metadata of given share. + +``metadata-update-all`` + Update all metadata of a share. + +``migration-cancel`` + Cancels migration of a given share when copying (Admin + only, Experimental). + +``migration-complete`` + Completes migration for a given share (Admin only, + Experimental). + +``migration-get-progress`` + Gets migration progress of a given share when copying + (Admin only, Experimental). + +``migration-start`` + Migrates share to a new host (Admin only, + Experimental). + +``pool-list`` + List all backend storage pools known to the scheduler + (Admin only). + +``quota-class-show`` + List the quotas for a quota class. + +``quota-class-update`` + Update the quotas for a quota class (Admin only). + +``quota-defaults`` + List the default quotas for a tenant. + +``quota-delete`` + Delete quota for a tenant/user. The quota will revert + back to default (Admin only). + +``quota-show`` + List the quotas for a tenant/user. + +``quota-update`` + Update the quotas for a tenant/user (Admin only). + +``rate-limits`` + Print a list of rate limits for a user. + +``reset-state`` + Explicitly update the state of a share (Admin only). + +``reset-task-state`` + Explicitly update the task state of a share (Admin + only, Experimental). + +``revert-to-snapshot`` + Revert a share to the specified snapshot. + +``security-service-create`` + Create security service used by tenant. + +``security-service-delete`` + Delete one or more security services. + +``security-service-list`` + Get a list of security services. + +``security-service-show`` + Show security service. + +``security-service-update`` + Update security service. + +``service-disable`` + Disables 'manila-share' or 'manila-scheduler' services + (Admin only). + +``service-enable`` + Enables 'manila-share' or 'manila-scheduler' services + (Admin only). + +``service-list`` + List all services (Admin only). + +``share-export-location-list`` + List export locations of a given share. + +``share-export-location-show`` + Show export location of the share. + +``share-group-create`` + Creates a new share group (Experimental). + +``share-group-delete`` + Remove one or more share groups (Experimental). + +``share-group-list`` + List share groups with filters (Experimental). + +``share-group-reset-state`` + Explicitly update the state of a share group (Admin + only, Experimental). + +``share-group-show`` + Show details about a share group (Experimental). + +``share-group-snapshot-create`` + Creates a new share group snapshot (Experimental). + +``share-group-snapshot-delete`` + Remove one or more share group snapshots + (Experimental). + +``share-group-snapshot-list`` + List share group snapshots with filters + (Experimental). + +``share-group-snapshot-list-members`` + List members of a share group snapshot (Experimental). + +``share-group-snapshot-reset-state`` + Explicitly update the state of a share group snapshot + (Admin only, Experimental). + +``share-group-snapshot-show`` + Show details about a share group snapshot + (Experimental). + +``share-group-snapshot-update`` + Update a share group snapshot (Experimental). + +``share-group-type-access-add`` + Adds share group type access for the given project + (Admin only). + +``share-group-type-access-list`` + Print access information about a share group type + (Admin only). + +``share-group-type-access-remove`` + Removes share group type access for the given project + (Admin only). + +``share-group-type-create`` + Create a new share group type (Admin only). + +``share-group-type-delete`` + Delete a specific share group type (Admin only). + +``share-group-type-key`` + Set or unset group_spec for a share group type (Admin + only). + +``share-group-type-list`` + Print a list of available 'share group types'. + +``share-group-type-specs-list`` + Print a list of 'share group types specs' (Admin + Only). + +``share-group-update`` + Update a share group (Experimental). + +``share-instance-export-location-list`` + List export locations of a given share instance. + +``share-instance-export-location-show`` + Show export location for the share instance. + +``share-instance-force-delete`` + Force-delete the share instance, regardless of state + (Admin only). + +``share-instance-list`` + List share instances (Admin only). + +``share-instance-reset-state`` + Explicitly update the state of a share instance (Admin + only). + +``share-instance-show`` + Show details about a share instance (Admin only). + +``share-network-create`` + Create description for network used by the tenant. + +``share-network-delete`` + Delete one or more share networks. + +``share-network-list`` + Get a list of network info. + +``share-network-security-service-add`` + Associate security service with share network. + +``share-network-security-service-list`` + Get list of security services associated with a given + share network. + +``share-network-security-service-remove`` + Dissociate security service from share network. + +``share-network-show`` + Get a description for network used by the tenant. + +``share-network-update`` + Update share network data. + +``share-replica-create`` + Create a share replica (Experimental). + +``share-replica-delete`` + Remove one or more share replicas (Experimental). + +``share-replica-list`` + List share replicas (Experimental). + +``share-replica-promote`` + Promote specified replica to 'active' replica_state + (Experimental). + +``share-replica-reset-replica-state`` + Explicitly update the 'replica_state' of a share + replica (Experimental). + +``share-replica-reset-state`` + Explicitly update the 'status' of a share replica + (Experimental). + +``share-replica-resync`` + Attempt to update the share replica with its 'active' + mirror (Experimental). + +``share-replica-show`` + Show details about a replica (Experimental). + +``share-server-delete`` + Delete one or more share servers (Admin only). + +``share-server-details`` + Show share server details (Admin only). + +``share-server-list`` + List all share servers (Admin only). + +``share-server-show`` + Show share server info (Admin only). + +``show`` + Show details about a NAS share. + +``shrink`` + Decreases the size of an existing share. + +``snapshot-access-allow`` + Allow read only access to a snapshot. + +``snapshot-access-deny`` + Deny access to a snapshot. + +``snapshot-access-list`` + Show access list for a snapshot. + +``snapshot-create`` + Add a new snapshot. + +``snapshot-delete`` + Remove one or more snapshots. + +``snapshot-export-location-list`` + List export locations of a given snapshot. + +``snapshot-export-location-show`` + Show export location of the share snapshot. + +``snapshot-force-delete`` + Attempt force-deletion of one or more snapshots. + Regardless of the state (Admin only). + +``snapshot-instance-export-location-list`` + List export locations of a given snapshot instance. + +``snapshot-instance-export-location-show`` + Show export location of the share instance snapshot. + +``snapshot-instance-list`` + List share snapshot instances. + +``snapshot-instance-reset-state`` + Explicitly update the state of a share snapshot + instance. + +``snapshot-instance-show`` + Show details about a share snapshot instance. + +``snapshot-list`` + List all the snapshots. + +``snapshot-manage`` + Manage share snapshot not handled by Manila (Admin + only). + +``snapshot-rename`` + Rename a snapshot. + +``snapshot-reset-state`` + Explicitly update the state of a snapshot (Admin + only). + +``snapshot-show`` + Show details about a snapshot. + +``snapshot-unmanage`` + Unmanage one or more share snapshots (Admin only). + +``type-access-add`` + Adds share type access for the given project (Admin + only). + +``type-access-list`` + Print access information about the given share type + (Admin only). + +``type-access-remove`` + Removes share type access for the given project (Admin + only). + +``type-create`` + Create a new share type (Admin only). + +``type-delete`` + Delete one or more specific share types (Admin only). + +``type-key`` + Set or unset extra_spec for a share type (Admin only). + +``type-list`` + Print a list of available 'share types'. + +``unmanage`` + Unmanage share (Admin only). + +``update`` + Rename a share. + +``bash-completion`` + Print arguments for bash_completion. Prints all of the + commands and options to stdout so that the + manila.bash_completion script doesn't have to hard + code them. + +``help`` + Display help about this program or one of its + subcommands. + +``list-extensions`` + List all the os-api extensions that are available. + +.. _manila_command_options: + +manila optional arguments +~~~~~~~~~~~~~~~~~~~~~~~~~ + +``--version`` + show program's version number and exit + +``-d, --debug`` + Print debugging output. + +``--os-cache`` + Use the auth token cache. Defaults to ``env[OS_CACHE]``. + +``--os-reset-cache`` + Delete cached password and auth token. + +``--os-user-id `` + Defaults to env [OS_USER_ID]. + +``--os-username `` + Defaults to ``env[OS_USERNAME]``. + +``--os-password `` + Defaults to ``env[OS_PASSWORD]``. + +``--os-tenant-name `` + Defaults to ``env[OS_TENANT_NAME]``. + +``--os-project-name `` + Another way to specify tenant name. This option is + mutually exclusive with --os-tenant-name. Defaults to + ``env[OS_PROJECT_NAME]``. + +``--os-tenant-id `` + Defaults to ``env[OS_TENANT_ID]``. + +``--os-project-id `` + Another way to specify tenant ID. This option is + mutually exclusive with --os-tenant-id. Defaults to + ``env[OS_PROJECT_ID]``. + +``--os-user-domain-id `` + OpenStack user domain ID. Defaults to + ``env[OS_USER_DOMAIN_ID]``. + +``--os-user-domain-name `` + OpenStack user domain name. Defaults to + ``env[OS_USER_DOMAIN_NAME]``. + +``--os-project-domain-id `` + Defaults to ``env[OS_PROJECT_DOMAIN_ID]``. + +``--os-project-domain-name `` + Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``. + +``--os-auth-url `` + Defaults to ``env[OS_AUTH_URL]``. + +``--os-region-name `` + Defaults to ``env[OS_REGION_NAME]``. + +``--os-token `` + Defaults to ``env[OS_TOKEN]``. + +``--bypass-url `` + Use this API endpoint instead of the Service Catalog. + Defaults to ``env[OS_MANILA_BYPASS_URL]``. + +``--service-type `` + Defaults to compute for most actions. + +``--service-name `` + Defaults to ``env[OS_MANILA_SERVICE_NAME]``. + +``--share-service-name `` + Defaults to ``env[OS_MANILA_SHARE_SERVICE_NAME]``. + +``--endpoint-type `` + Defaults to ``env[OS_MANILA_ENDPOINT_TYPE]`` or publicURL. + +``--os-share-api-version `` + Accepts 1.x to override default to + ``env[OS_SHARE_API_VERSION]``. + +``--os-cacert `` + Specify a CA bundle file to use in verifying a TLS + (https) server certificate. Defaults to + ``env[OS_CACERT]``. + +``--retries `` + Number of retries. + +``--os-cert `` + Defaults to ``env[OS_CERT]``. + +.. _manila_absolute-limits: + +manila absolute-limits +---------------------- + +.. code-block:: console + + usage: manila absolute-limits + +Print a list of absolute limits for a user. + +.. _manila_access-allow: + +manila access-allow +------------------- + +.. code-block:: console + + usage: manila access-allow [--access-level ] + + +Allow access to the share. + +**Positional arguments:** + +```` + 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. + +**Optional arguments:** + +``--access-level , --access_level `` + Share access level ("rw" and "ro" access levels are + supported). Defaults to rw. + +.. _manila_access-deny: + +manila access-deny +------------------ + +.. code-block:: console + + usage: manila access-deny + +Deny access to a share. + +**Positional arguments:** + +```` + Name or ID of the NAS share to modify. + +```` + ID of the access rule to be deleted. + +.. _manila_access-list: + +manila access-list +------------------ + +.. code-block:: console + + usage: manila access-list [--columns ] + +Show access list for share. + +**Positional arguments:** + +```` + Name or ID of the share. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "access_type,access_to". + +.. _manila_api-version: + +manila api-version +------------------ + +.. code-block:: console + + usage: manila api-version + +Display the API version information. + +.. _manila_availability-zone-list: + +manila availability-zone-list +----------------------------- + +.. code-block:: console + + usage: manila availability-zone-list [--columns ] + +List all availability zones. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,name". + +.. _manila_create: + +manila create +------------- + +.. code-block:: console + + usage: manila create [--snapshot-id ] [--name ] + [--metadata [ [ ...]]] + [--share-network ] + [--description ] [--share-type ] + [--public] [--availability-zone ] + [--share-group ] + + +Creates a new share (NFS, CIFS, CephFS, GlusterFS or HDFS). + +**Positional arguments:** + +```` + Share protocol (NFS, CIFS, CephFS, GlusterFS or HDFS). + +```` + Share size in GiB. + +**Optional arguments:** + +``--snapshot-id , --snapshot_id `` + Optional snapshot ID to create the share from. + (Default=None) + +``--name `` + Optional share name. (Default=None) + +``--metadata [ [ ...]]`` + Metadata key=value pairs (Optional, Default=None). + +``--share-network , --share_network `` + Optional network info ID or name. + +``--description `` + Optional share description. (Default=None) + +``--share-type , --share_type , --volume-type , --volume_type `` + Optional share type. Use of optional volume type is + deprecated. (Default=None) + +``--public`` + Level of visibility for share. Defines whether other + tenants are able to see it or not. + +``--availability-zone , --availability_zone , --az `` + Availability zone in which share should be created. + +``--share-group , --share_group , --group `` + Optional share group name or ID in which to create the + share (Experimental, Default=None). + +.. _manila_credentials: + +manila credentials +------------------ + +.. code-block:: console + + usage: manila credentials + +Show user credentials returned from auth. + +.. _manila_delete: + +manila delete +------------- + +.. code-block:: console + + usage: manila delete [--share-group ] [ ...] + +Remove one or more shares. + +**Positional arguments:** + +```` + Name or ID of the share(s). + +**Optional arguments:** + +``--share-group , --share_group , --group `` + Optional share group name or ID which contains the + share (Experimental, Default=None). + +.. _manila_endpoints: + +manila endpoints +---------------- + +.. code-block:: console + + usage: manila endpoints + +Discover endpoints that get returned from the authenticate services. + +.. _manila_extend: + +manila extend +------------- + +.. code-block:: console + + usage: manila extend + +Increases the size of an existing share. + +**Positional arguments:** + +```` + Name or ID of share to extend. + +```` + New size of share, in GiBs. + +.. _manila_extra-specs-list: + +manila extra-specs-list +----------------------- + +.. code-block:: console + + usage: manila extra-specs-list [--columns ] + +Print a list of current 'share types and extra specs' (Admin Only). + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,name". + +.. _manila_force-delete: + +manila force-delete +------------------- + +.. code-block:: console + + usage: manila force-delete [ ...] + +Attempt force-delete of share, regardless of state (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share(s) to force delete. + +.. _manila_list: + +manila list +----------- + +.. code-block:: console + + usage: manila list [--all-tenants [<0|1>]] [--name ] [--status ] + [--share-server-id ] + [--metadata [ [ ...]]] + [--extra-specs [ [ ...]]] + [--share-type ] [--limit ] + [--offset ] [--sort-key ] + [--sort-dir ] [--snapshot ] + [--host ] [--share-network ] + [--project-id ] [--public] + [--share-group ] [--columns ] + +List NAS shares with filters. + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Display information from all tenants (Admin only). + +``--name `` + Filter results by name. + +``--status `` + Filter results by status. + +``--share-server-id , --share-server_id , --share_server-id , --share_server_id `` + Filter results by share server ID (Admin only). + +``--metadata [ [ ...]]`` + Filters results by a metadata key and value. OPTIONAL: + Default=None. + +``--extra-specs [ [ ...]], --extra_specs [ [ ...]]`` + Filters results by a extra specs key and value of + share type that was used for share creation. OPTIONAL: + Default=None. + +``--share-type , --volume-type , --share_type , --share-type-id , --volume-type-id , --share-type_id , --share_type-id , --share_type_id , --volume_type , --volume_type_id `` + Filter results by a share type id or name that was + used for share creation. + +``--limit `` + Maximum number of shares to return. OPTIONAL: + Default=None. + +``--offset `` + Set offset to define start point of share listing. + OPTIONAL: Default=None. + +``--sort-key , --sort_key `` + Key to be sorted, available keys are ('id', 'status', + 'size', 'host', 'share_proto', 'availability_zone', + 'user_id', 'project_id', 'created_at', 'updated_at', + 'display_name', 'name', 'share_type_id', 'share_type', + 'share_network_id', 'share_network', 'snapshot_id', + 'snapshot'). OPTIONAL: Default=None. + +``--sort-dir , --sort_dir `` + Sort direction, available values are ('asc', 'desc'). + OPTIONAL: Default=None. + +``--snapshot `` + Filer results by snapshot name or id, that was used + for share. + +``--host `` + Filter results by host. + +``--share-network , --share_network `` + Filter results by share-network name or id. + +``--project-id , --project_id `` + Filter results by project id. Useful with set key + '--all-tenants'. + +``--public`` + Add public shares from all tenants to result. + +``--share-group , --share_group , --group `` + Filter results by share group name or ID + (Experimental, Default=None). + +``--columns `` + Comma separated list of columns to be displayed + example --columns "export_location,is public". + +.. _manila_list-extensions: + +manila list-extensions +---------------------- + +.. code-block:: console + + usage: manila list-extensions + +List all the os-api extensions that are available. + +.. _manila_manage: + +manila manage +------------- + +.. code-block:: console + + usage: manila manage [--name ] [--description ] + [--share_type ] + [--driver_options [ [ ...]]] + [--public] + + +Manage share not handled by Manila (Admin only). + +**Positional arguments:** + +```` + manage-share 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.1\\example_cifs_share. + +**Optional arguments:** + +``--name `` + Optional share name. (Default=None) + +``--description `` + Optional share description. (Default=None) + +``--share_type , --share-type `` + Optional share type assigned to share. (Default=None) + +``--driver_options [ [ ...]], --driver-options [ [ ...]]`` + Driver option key=value pairs (Optional, + Default=None). + +``--public`` + Level of visibility for share. Defines whether other + tenants are able to see it or not. Available only for + microversion >= 2.8. + +.. _manila_metadata: + +manila metadata +--------------- + +.. code-block:: console + + usage: manila metadata [ ...] + +Set or delete metadata on a share. + +**Positional arguments:** + +```` + Name or ID of the share to update metadata on. + +```` + Actions: 'set' or 'unset'. + +```` + Metadata to set or unset (key is only necessary on unset). + +.. _manila_metadata-show: + +manila metadata-show +-------------------- + +.. code-block:: console + + usage: manila metadata-show + +Show metadata of given share. + +**Positional arguments:** + +```` + Name or ID of the share. + +.. _manila_metadata-update-all: + +manila metadata-update-all +-------------------------- + +.. code-block:: console + + usage: manila metadata-update-all [ ...] + +Update all metadata of a share. + +**Positional arguments:** + +```` + Name or ID of the share to update metadata on. + +```` + Metadata entry or entries to update. + +.. _manila_migration-cancel: + +manila migration-cancel +----------------------- + +.. code-block:: console + + usage: manila migration-cancel + +Cancels migration of a given share when copying (Admin only, Experimental). + +**Positional arguments:** + +```` + Name or ID of share to cancel migration. + +.. _manila_migration-complete: + +manila migration-complete +------------------------- + +.. code-block:: console + + usage: manila migration-complete + +Completes migration for a given share (Admin only, Experimental). + +**Positional arguments:** + +```` + Name or ID of share to complete migration. + +.. _manila_migration-get-progress: + +manila migration-get-progress +----------------------------- + +.. code-block:: console + + usage: manila migration-get-progress + +Gets migration progress of a given share when copying (Admin only, +Experimental). + +**Positional arguments:** + +```` + Name or ID of the share to get share migration progress + information. + +.. _manila_migration-start: + +manila migration-start +---------------------- + +.. code-block:: console + + usage: manila migration-start [--force_host_assisted_migration ] + --preserve-metadata + --preserve-snapshots --writable + --nondisruptive + [--new_share_network ] + [--new_share_type ] + + +Migrates share to a new host (Admin only, Experimental). + +**Positional arguments:** + +```` + Name or ID of share to migrate. + +```` + Destination host where share will be migrated to. Use + the format 'host@backend#pool'. + +**Optional arguments:** + +``--force_host_assisted_migration , --force-host-assisted-migration `` + Enforces the use of the host-assisted migration + approach, which bypasses driver optimizations. + Default=False. + +``--preserve-metadata , --preserve_metadata `` + Enforces migration to preserve all file metadata when + moving its contents. If set to True, host-assisted + migration will not be attempted. + +``--preserve-snapshots , --preserve_snapshots `` + Enforces migration of the share snapshots to the + destination. If set to True, host-assisted migration + will not be attempted. + +``--writable `` + Enforces migration to keep the share writable while + contents + are + being + moved. + If + set + to + True, + host-assisted + migration + will + not + be + attempted. + +``--nondisruptive `` + Enforces migration to be nondisruptive. If set to + True, host-assisted migration will not be attempted. + +``--new_share_network , --new-share-network `` + Specify the new share network for the share. Do not + specify this parameter if the migrating share has to + be retained within its current share network. + +``--new_share_type , --new-share-type `` + Specify the new share type for the share. Do not + specify this parameter if the migrating share has to + be retained with its current share type. + +.. _manila_pool-list: + +manila pool-list +---------------- + +.. code-block:: console + + usage: manila pool-list [--host ] [--backend ] [--pool ] + [--columns ] [--detail] + [--share-type ] + +List all backend storage pools known to the scheduler (Admin only). + +**Optional arguments:** + +``--host `` + Filter results by host name. Regular expressions are + supported. + +``--backend `` + Filter results by backend name. Regular expressions + are supported. + +``--pool `` + Filter results by pool name. Regular expressions are + supported. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "name,host". + +``--detail, --detailed`` + Show detailed information about pools. (Default=False) + +``--share-type , --share_type , --share-type-id , --share_type_id `` + Filter results by share type name or ID. + (Default=None)Available only for microversion >= 2.23. + +.. _manila_quota-class-show: + +manila quota-class-show +----------------------- + +.. code-block:: console + + usage: manila quota-class-show + +List the quotas for a quota class. + +**Positional arguments:** + +```` + Name of quota class to list the quotas for. + +.. _manila_quota-class-update: + +manila quota-class-update +------------------------- + +.. code-block:: console + + usage: manila quota-class-update [--shares ] [--snapshots ] + [--gigabytes ] + [--snapshot-gigabytes ] + [--share-networks ] + + +Update the quotas for a quota class (Admin only). + +**Positional arguments:** + +```` + Name of quota class to set the quotas for. + +**Optional arguments:** + +``--shares `` + New value for the "shares" quota. + +``--snapshots `` + New value for the "snapshots" quota. + +``--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. + +.. _manila_quota-defaults: + +manila quota-defaults +--------------------- + +.. code-block:: console + + usage: manila quota-defaults [--tenant ] + +List the default quotas for a tenant. + +**Optional arguments:** + +``--tenant `` + ID of tenant to list the default quotas for. + +.. _manila_quota-delete: + +manila quota-delete +------------------- + +.. code-block:: console + + usage: manila quota-delete [--tenant ] [--user ] + +Delete quota for a tenant/user. The quota will revert back to default (Admin +only). + +**Optional arguments:** + +``--tenant `` + ID of tenant to delete quota for. + +``--user `` + ID of user to delete quota for. + +.. _manila_quota-show: + +manila quota-show +----------------- + +.. code-block:: console + + usage: manila quota-show [--tenant ] [--user ] [--detail] + +List the quotas for a tenant/user. + +**Optional arguments:** + +``--tenant `` + ID of tenant to list the quotas for. + +``--user `` + ID of user to list the quotas for. + +``--detail`` + Optional flag to indicate whether to show quota in + detail. Default false, available only for microversion + >= 2.25. + +.. _manila_quota-update: + +manila quota-update +------------------- + +.. code-block:: console + + usage: manila quota-update [--user ] [--shares ] + [--snapshots ] [--gigabytes ] + [--snapshot-gigabytes ] + [--share-networks ] [--force] + + +Update the quotas for a tenant/user (Admin only). + +**Positional arguments:** + +```` + UUID of tenant to set the quotas for. + +**Optional arguments:** + +``--user `` + ID of user to set the quotas for. + +``--shares `` + New value for the "shares" quota. + +``--snapshots `` + New value for the "snapshots" quota. + +``--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. + +``--force`` + Whether force update the quota even if the already + used and reserved exceeds the new quota. + +.. _manila_rate-limits: + +manila rate-limits +------------------ + +.. code-block:: console + + usage: manila rate-limits [--columns ] + +Print a list of rate limits for a user. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "verb,uri,value". + +.. _manila_reset-state: + +manila reset-state +------------------ + +.. code-block:: console + + usage: manila reset-state [--state ] + +Explicitly update the state of a share (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share to modify. + +**Optional arguments:** + +``--state `` + Indicate which state to assign the share. Options include + available, error, creating, deleting, error_deleting. If no + state is provided, available will be used. + +.. _manila_reset-task-state: + +manila reset-task-state +----------------------- + +.. code-block:: console + + usage: manila reset-task-state [--task-state ] + +Explicitly update the task state of a share (Admin only, Experimental). + +**Positional arguments:** + +```` + Name or ID of the share to modify. + +**Optional arguments:** + +``--task-state , --task_state , --state `` + Indicate which task state to assign the share. Options + include migration_starting, migration_in_progress, + migration_completing, migration_success, + migration_error, migration_cancelled, + migration_driver_in_progress, + migration_driver_phase1_done, data_copying_starting, + data_copying_in_progress, data_copying_completing, + data_copying_completed, data_copying_cancelled, + data_copying_error. If no value is provided, None will + be used. + +.. _manila_revert-to-snapshot: + +manila revert-to-snapshot +------------------------- + +.. code-block:: console + + usage: manila revert-to-snapshot + +Revert a share to the specified snapshot. + +**Positional arguments:** + +```` + Name or ID of the snapshot to restore. The snapshot must be the + most recent one known to manila. + +.. _manila_security-service-create: + +manila security-service-create +------------------------------ + +.. code-block:: console + + usage: manila security-service-create [--dns-ip ] [--server ] + [--domain ] [--user ] + [--password ] [--name ] + [--description ] + + +Create security service used by tenant. + +**Positional arguments:** + +```` + Security service type: 'ldap', 'kerberos' or + 'active_directory'. + +**Optional arguments:** + +``--dns-ip `` + DNS IP address used inside tenant's network. + +``--server `` + Security service IP address or hostname. + +``--domain `` + Security service domain. + +``--user `` + Security service user or group used by tenant. + +``--password `` + Password used by user. + +``--name `` + Security service name. + +``--description `` + Security service description. + +.. _manila_security-service-delete: + +manila security-service-delete +------------------------------ + +.. code-block:: console + + usage: manila security-service-delete + [ ...] + +Delete one or more security services. + +**Positional arguments:** + +```` + Name or ID of the security service(s) to delete. + +.. _manila_security-service-list: + +manila security-service-list +---------------------------- + +.. code-block:: console + + usage: manila security-service-list [--all-tenants [<0|1>]] + [--share-network ] + [--status ] [--name ] + [--type ] [--user ] + [--dns-ip ] [--server ] + [--domain ] [--detailed [<0|1>]] + [--offset ] [--limit ] + [--columns ] + +Get a list of security services. + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Display information from all tenants (Admin only). + +``--share-network , --share_network `` + Filter results by share network id or name. + +``--status `` + Filter results by status. + +``--name `` + Filter results by name. + +``--type `` + Filter results by type. + +``--user `` + Filter results by user or group used by tenant. + +``--dns-ip , --dns_ip `` + Filter results by DNS IP address used inside tenant's + network. + +``--server `` + Filter results by security service IP address or + hostname. + +``--domain `` + Filter results by domain. + +``--detailed [<0|1>]`` + Show detailed information about filtered security + services. + +``--offset `` + Start position of security services listing. + +``--limit `` + Number of security services to return per request. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "name,type". + +.. _manila_security-service-show: + +manila security-service-show +---------------------------- + +.. code-block:: console + + usage: manila security-service-show + +Show security service. + +**Positional arguments:** + +```` + Security service name or ID to show. + +.. _manila_security-service-update: + +manila security-service-update +------------------------------ + +.. code-block:: console + + usage: manila security-service-update [--dns-ip ] [--server ] + [--domain ] [--user ] + [--password ] [--name ] + [--description ] + + +Update security service. + +**Positional arguments:** + +```` + Security service name or ID to update. + +**Optional arguments:** + +``--dns-ip `` + DNS IP address used inside tenant's network. + +``--server `` + Security service IP address or hostname. + +``--domain `` + Security service domain. + +``--user `` + Security service user or group used by tenant. + +``--password `` + Password used by user. + +``--name `` + Security service name. + +``--description `` + Security service description. + +.. _manila_service-disable: + +manila service-disable +---------------------- + +.. code-block:: console + + usage: manila service-disable + +Disables 'manila-share' or 'manila-scheduler' services (Admin only). + +**Positional arguments:** + +```` + Host name as 'example_host@example_backend'. + +```` + Service binary, could be 'manila-share' or 'manila-scheduler'. + +.. _manila_service-enable: + +manila service-enable +--------------------- + +.. code-block:: console + + usage: manila service-enable + +Enables 'manila-share' or 'manila-scheduler' services (Admin only). + +**Positional arguments:** + +```` + Host name as 'example_host@example_backend'. + +```` + Service binary, could be 'manila-share' or 'manila-scheduler'. + +.. _manila_service-list: + +manila service-list +------------------- + +.. code-block:: console + + usage: manila service-list [--host ] [--binary ] + [--status ] [--state ] + [--zone ] [--columns ] + +List all services (Admin only). + +**Optional arguments:** + +``--host `` + Name of host. + +``--binary `` + Service binary. + +``--status `` + Filter results by status. + +``--state `` + Filter results by state. + +``--zone `` + Availability zone. + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,host". + +.. _manila_share-export-location-list: + +manila share-export-location-list +--------------------------------- + +.. code-block:: console + + usage: manila share-export-location-list [--columns ] + +List export locations of a given share. + +**Positional arguments:** + +```` + Name or ID of the share. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,host,status". + +.. _manila_share-export-location-show: + +manila share-export-location-show +--------------------------------- + +.. code-block:: console + + usage: manila share-export-location-show + +Show export location of the share. + +**Positional arguments:** + +```` + Name or ID of the share. + +```` + ID of the share export location. + +.. _manila_share-group-create: + +manila share-group-create +------------------------- + +.. code-block:: console + + usage: manila share-group-create [--name ] [--description ] + [--share-types ] + [--share-group-type ] + [--share-network ] + [--source-share-group-snapshot ] + [--availability-zone ] + +Creates a new share group (Experimental). + +**Optional arguments:** + +``--name `` + Optional share group name. (Default=None) + +``--description `` + Optional share group description. (Default=None) + +``--share-types , --share_types `` + Comma-separated list of share types. (Default=None) + +``--share-group-type , --share_group_type , --type `` + Share group type name or ID of the share group to be + created. (Default=None) + +``--share-network , --share_network `` + Specify share network name or id. + +``--source-share-group-snapshot , --source_share_group_snapshot `` + Optional share group snapshot name or ID to create the + share group from. (Default=None) + +``--availability-zone , --availability_zone , --az `` + Optional availability zone in which group should be + created. (Default=None) + +.. _manila_share-group-delete: + +manila share-group-delete +------------------------- + +.. code-block:: console + + usage: manila share-group-delete [--force] [ ...] + +Remove one or more share groups (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share_group(s). + +**Optional arguments:** + +``--force`` + Attempt to force delete the share group (Default=False) + (Admin only). + +.. _manila_share-group-list: + +manila share-group-list +----------------------- + +.. code-block:: console + + usage: manila share-group-list [--all-tenants [<0|1>]] [--name ] + [--status ] + [--share-server-id ] + [--share-group-type ] + [--snapshot ] [--host ] + [--share-network ] + [--project-id ] [--limit ] + [--offset ] [--sort-key ] + [--sort-dir ] [--columns ] + +List share groups with filters (Experimental). + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Display information from all tenants (Admin only). + +``--name `` + Filter results by name. + +``--status `` + Filter results by status. + +``--share-server-id , --share-server_id , --share_server-id , --share_server_id `` + Filter results by share server ID (Admin only). + +``--share-group-type , --share-group-type-id , --share_group_type , --share_group_type_id `` + Filter results by a share group type ID or name that + was used for share group creation. + +``--snapshot `` + Filter results by share group snapshot name or ID that + was used to create the share group. + +``--host `` + Filter results by host. + +``--share-network , --share_network `` + Filter results by share-network name or ID. + +``--project-id , --project_id `` + Filter results by project ID. Useful with set key + '--all-tenants'. + +``--limit `` + Maximum number of share groups to return. + (Default=None) + +``--offset `` + Start position of share group listing. + +``--sort-key , --sort_key `` + Key to be sorted, available keys are ('id', 'name', + 'status', 'host', 'user_id', 'project_id', + 'created_at', 'availability_zone', 'share_network', + 'share_network_id', 'share_group_type', + 'share_group_type_id', + 'source_share_group_snapshot_id'). Default=None. + +``--sort-dir , --sort_dir `` + Sort direction, available values are ('asc', 'desc'). + OPTIONAL: Default=None. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "id,name". + +.. _manila_share-group-reset-state: + +manila share-group-reset-state +------------------------------ + +.. code-block:: console + + usage: manila share-group-reset-state [--state ] + +Explicitly update the state of a share group (Admin only, Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group to modify. + +**Optional arguments:** + +``--state `` + Indicate which state to assign the share group. Options + include available, error, creating, deleting, + error_deleting. If no state is provided, available will be + used. + +.. _manila_share-group-show: + +manila share-group-show +----------------------- + +.. code-block:: console + + usage: manila share-group-show + +Show details about a share group (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group. + +.. _manila_share-group-snapshot-create: + +manila share-group-snapshot-create +---------------------------------- + +.. code-block:: console + + usage: manila share-group-snapshot-create [--name ] + [--description ] + + +Creates a new share group snapshot (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group. + +**Optional arguments:** + +``--name `` + Optional share group snapshot name. (Default=None) + +``--description `` + Optional share group snapshot description. + (Default=None) + +.. _manila_share-group-snapshot-delete: + +manila share-group-snapshot-delete +---------------------------------- + +.. code-block:: console + + usage: manila share-group-snapshot-delete [--force] + + [ ...] + +Remove one or more share group snapshots (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group snapshot(s) to delete. + +**Optional arguments:** + +``--force`` + Attempt to force delete the share group snapshot(s) + (Default=False) (Admin only). + +.. _manila_share-group-snapshot-list: + +manila share-group-snapshot-list +-------------------------------- + +.. code-block:: console + + usage: manila share-group-snapshot-list [--all-tenants [<0|1>]] + [--name ] [--status ] + [--share-group-id ] + [--limit ] [--offset ] + [--sort-key ] + [--sort-dir ] + [--detailed DETAILED] + [--columns ] + +List share group snapshots with filters (Experimental). + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Display information from all tenants (Admin only). + +``--name `` + Filter results by name. + +``--status `` + Filter results by status. + +``--share-group-id , --share_group_id `` + Filter results by share group ID. + +``--limit `` + Maximum number of share group snapshots to return. + (Default=None) + +``--offset `` + Start position of share group snapshot listing. + +``--sort-key , --sort_key `` + Key to be sorted, available keys are ('id', 'name', + 'status', 'host', 'user_id', 'project_id', + 'created_at', 'share_group_id'). Default=None. + +``--sort-dir , --sort_dir `` + Sort direction, available values are ('asc', 'desc'). + OPTIONAL: Default=None. + +``--detailed DETAILED`` + Show detailed information about share group snapshots. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "id,name". + +.. _manila_share-group-snapshot-list-members: + +manila share-group-snapshot-list-members +---------------------------------------- + +.. code-block:: console + + usage: manila share-group-snapshot-list-members [--columns ] + + +List members of a share group snapshot (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group snapshot. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed + example --columns "id,name". + +.. _manila_share-group-snapshot-reset-state: + +manila share-group-snapshot-reset-state +--------------------------------------- + +.. code-block:: console + + usage: manila share-group-snapshot-reset-state [--state ] + + +Explicitly update the state of a share group snapshot (Admin only, +Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group snapshot. + +**Optional arguments:** + +``--state `` + Indicate which state to assign the share group + snapshot. Options include available, error, creating, + deleting, error_deleting. If no state is provided, + available will be used. + +.. _manila_share-group-snapshot-show: + +manila share-group-snapshot-show +-------------------------------- + +.. code-block:: console + + usage: manila share-group-snapshot-show + +Show details about a share group snapshot (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group snapshot. + +.. _manila_share-group-snapshot-update: + +manila share-group-snapshot-update +---------------------------------- + +.. code-block:: console + + usage: manila share-group-snapshot-update [--name ] + [--description ] + + +Update a share group snapshot (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group snapshot to update. + +**Optional arguments:** + +``--name `` + Optional new name for the share group snapshot. + (Default=None) + +``--description `` + Optional share group snapshot description. + (Default=None) + +.. _manila_share-group-type-access-add: + +manila share-group-type-access-add +---------------------------------- + +.. code-block:: console + + usage: manila share-group-type-access-add + +Adds share group type access for the given project (Admin only). + +**Positional arguments:** + +```` + Share group type name or ID to add access for the given + project. + +```` + Project ID to add share group type access for. + +.. _manila_share-group-type-access-list: + +manila share-group-type-access-list +----------------------------------- + +.. code-block:: console + + usage: manila share-group-type-access-list + +Print access information about a share group type (Admin only). + +**Positional arguments:** + +```` + Filter results by share group type name or ID. + +.. _manila_share-group-type-access-remove: + +manila share-group-type-access-remove +------------------------------------- + +.. code-block:: console + + usage: manila share-group-type-access-remove + +Removes share group type access for the given project (Admin only). + +**Positional arguments:** + +```` + Share group type name or ID to remove access for the + given project. + +```` + Project ID to remove share group type access for. + +.. _manila_share-group-type-create: + +manila share-group-type-create +------------------------------ + +.. code-block:: console + + usage: manila share-group-type-create [--is_public ] + + +Create a new share group type (Admin only). + +**Positional arguments:** + +```` + Name of the new share group type. + +```` + Comma-separated list of share type names or IDs. + +**Optional arguments:** + +``--is_public , --is-public `` + Make type accessible to the public (default true). + +.. _manila_share-group-type-delete: + +manila share-group-type-delete +------------------------------ + +.. code-block:: console + + usage: manila share-group-type-delete + +Delete a specific share group type (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share group type to delete. + +.. _manila_share-group-type-key: + +manila share-group-type-key +--------------------------- + +.. code-block:: console + + usage: manila share-group-type-key + [ [ ...]] + +Set or unset group_spec for a share group type (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share group type. + +```` + Actions: 'set' or 'unset'. + +```` + Group specs to set or unset (key is only necessary on + unset). + +.. _manila_share-group-type-list: + +manila share-group-type-list +---------------------------- + +.. code-block:: console + + usage: manila share-group-type-list [--all] [--columns ] + +Print a list of available 'share group types'. + +**Optional arguments:** + +``--all`` + Display all share group types (Admin only). + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,name". + +.. _manila_share-group-type-specs-list: + +manila share-group-type-specs-list +---------------------------------- + +.. code-block:: console + + usage: manila share-group-type-specs-list [--columns ] + +Print a list of 'share group types specs' (Admin Only). + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,name". + +.. _manila_share-group-update: + +manila share-group-update +------------------------- + +.. code-block:: console + + usage: manila share-group-update [--name ] [--description ] + + +Update a share group (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share group to update. + +**Optional arguments:** + +``--name `` + Optional new name for the share group. (Default=None) + +``--description `` + Optional share group description. (Default=None) + +.. _manila_share-instance-export-location-list: + +manila share-instance-export-location-list +------------------------------------------ + +.. code-block:: console + + usage: manila share-instance-export-location-list [--columns ] + + +List export locations of a given share instance. + +**Positional arguments:** + +```` + Name or ID of the share instance. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,host,status". + +.. _manila_share-instance-export-location-show: + +manila share-instance-export-location-show +------------------------------------------ + +.. code-block:: console + + usage: manila share-instance-export-location-show + +Show export location for the share instance. + +**Positional arguments:** + +```` + Name or ID of the share instance. + +```` + ID of the share instance export location. + +.. _manila_share-instance-force-delete: + +manila share-instance-force-delete +---------------------------------- + +.. code-block:: console + + usage: manila share-instance-force-delete [ ...] + +Force-delete the share instance, regardless of state (Admin only). + +**Positional arguments:** + +```` + Name or ID of the instance(s) to force delete. + +.. _manila_share-instance-list: + +manila share-instance-list +-------------------------- + +.. code-block:: console + + usage: manila share-instance-list [--share-id ] + [--columns ] + +List share instances (Admin only). + +**Optional arguments:** + +``--share-id , --share_id `` + Filter results by share ID. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "id,host,status". + +.. _manila_share-instance-reset-state: + +manila share-instance-reset-state +--------------------------------- + +.. code-block:: console + + usage: manila share-instance-reset-state [--state ] + +Explicitly update the state of a share instance (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share instance to modify. + +**Optional arguments:** + +``--state `` + Indicate which state to assign the instance. Options + include available, error, creating, deleting, + error_deleting, migrating,migrating_to. If no state is + provided, available will be used. + +.. _manila_share-instance-show: + +manila share-instance-show +-------------------------- + +.. code-block:: console + + usage: manila share-instance-show + +Show details about a share instance (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share instance. + +.. _manila_share-network-create: + +manila share-network-create +--------------------------- + +.. code-block:: console + + usage: manila share-network-create [--neutron-net-id ] + [--neutron-subnet-id ] + [--name ] + [--description ] + +Create description for network used by the tenant. + +**Optional arguments:** + +``--neutron-net-id , --neutron-net_id , --neutron_net_id , --neutron_net-id `` + Neutron network ID. Used to set up network for share + servers. + +``--neutron-subnet-id , --neutron-subnet_id , --neutron_subnet_id , --neutron_subnet-id `` + Neutron subnet ID. Used to set up network for share + servers. This subnet should belong to specified + neutron network. + +``--name `` + Share network name. + +``--description `` + Share network description. + +.. _manila_share-network-delete: + +manila share-network-delete +--------------------------- + +.. code-block:: console + + usage: manila share-network-delete [ ...] + +Delete one or more share networks. + +**Positional arguments:** + +```` + Name or ID of share network(s) to be deleted. + +.. _manila_share-network-list: + +manila share-network-list +------------------------- + +.. code-block:: console + + usage: manila share-network-list [--all-tenants [<0|1>]] + [--project-id ] [--name ] + [--created-since ] + [--created-before ] + [--security-service ] + [--neutron-net-id ] + [--neutron-subnet-id ] + [--network-type ] + [--segmentation-id ] + [--cidr ] [--ip-version ] + [--offset ] [--limit ] + [--columns ] + +Get a list of network info. + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Display information from all tenants (Admin only). + +``--project-id , --project_id `` + Filter results by project ID. + +``--name `` + Filter results by name. + +``--created-since , --created_since `` + Return only share networks created since given date. + The date is in the format 'yyyy-mm-dd'. + +``--created-before , --created_before `` + Return only share networks created until given date. + The date is in the format 'yyyy-mm-dd'. + +``--security-service , --security_service `` + Filter results by attached security service. + +``--neutron-net-id , --neutron_net_id , --neutron_net-id , --neutron-net_id `` + Filter results by neutron net ID. + +``--neutron-subnet-id , --neutron_subnet_id , --neutron-subnet_id , --neutron_subnet-id `` + Filter results by neutron subnet ID. + +``--network-type , --network_type `` + Filter results by network type. + +``--segmentation-id , --segmentation_id `` + Filter results by segmentation ID. + +``--cidr `` + Filter results by CIDR. + +``--ip-version , --ip_version `` + Filter results by IP version. + +``--offset `` + Start position of share networks listing. + +``--limit `` + Number of share networks to return per request. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "id". + +.. _manila_share-network-security-service-add: + +manila share-network-security-service-add +----------------------------------------- + +.. code-block:: console + + usage: manila share-network-security-service-add + + +Associate security service with share network. + +**Positional arguments:** + +```` + Share network name or ID. + +```` + Security service name or ID to associate with. + +.. _manila_share-network-security-service-list: + +manila share-network-security-service-list +------------------------------------------ + +.. code-block:: console + + usage: manila share-network-security-service-list [--columns ] + + +Get list of security services associated with a given share network. + +**Positional arguments:** + +```` + Share network name or ID. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,name". + +.. _manila_share-network-security-service-remove: + +manila share-network-security-service-remove +-------------------------------------------- + +.. code-block:: console + + usage: manila share-network-security-service-remove + + +Dissociate security service from share network. + +**Positional arguments:** + +```` + Share network name or ID. + +```` + Security service name or ID to dissociate. + +.. _manila_share-network-show: + +manila share-network-show +------------------------- + +.. code-block:: console + + usage: manila share-network-show + +Get a description for network used by the tenant. + +**Positional arguments:** + +```` + Name or ID of the share network to show. + +.. _manila_share-network-update: + +manila share-network-update +--------------------------- + +.. code-block:: console + + usage: manila share-network-update [--neutron-net-id ] + [--neutron-subnet-id ] + [--name ] + [--description ] + + +Update share network data. + +**Positional arguments:** + +```` + Name or ID of share network to update. + +**Optional arguments:** + +``--neutron-net-id , --neutron-net_id , --neutron_net_id , --neutron_net-id `` + Neutron network ID. Used to set up network for share + servers. This option is deprecated and will be + rejected in newer releases of OpenStack Manila. + +``--neutron-subnet-id , --neutron-subnet_id , --neutron_subnet_id , --neutron_subnet-id `` + Neutron subnet ID. Used to set up network for share + servers. This subnet should belong to specified + neutron network. + +``--name `` + Share network name. + +``--description `` + Share network description. + +.. _manila_share-replica-create: + +manila share-replica-create +--------------------------- + +.. code-block:: console + + usage: manila share-replica-create [--availability-zone ] + [--share-network ] + + +Create a share replica (Experimental). + +**Positional arguments:** + +```` + Name or ID of the share to replicate. + +**Optional arguments:** + +``--availability-zone , --availability_zone , --az `` + Optional Availability zone in which replica should be + created. + +``--share-network , --share_network `` + Optional network info ID or name. + +.. _manila_share-replica-delete: + +manila share-replica-delete +--------------------------- + +.. code-block:: console + + usage: manila share-replica-delete [--force] [ ...] + +Remove one or more share replicas (Experimental). + +**Positional arguments:** + +```` + ID of the share replica. + +**Optional arguments:** + +``--force`` + Attempt to force deletion of a replica on its backend. Using this + option will purge the replica from Manila even if it is not + cleaned up on the backend. Defaults to False. + +.. _manila_share-replica-list: + +manila share-replica-list +------------------------- + +.. code-block:: console + + usage: manila share-replica-list [--share-id ] [--columns ] + +List share replicas (Experimental). + +**Optional arguments:** + +``--share-id , --share_id , --si `` + List replicas belonging to share. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "replica_state,id". + +.. _manila_share-replica-promote: + +manila share-replica-promote +---------------------------- + +.. code-block:: console + + usage: manila share-replica-promote + +Promote specified replica to 'active' replica_state (Experimental). + +**Positional arguments:** + +```` + ID of the share replica. + +.. _manila_share-replica-reset-replica-state: + +manila share-replica-reset-replica-state +---------------------------------------- + +.. code-block:: console + + usage: manila share-replica-reset-replica-state + [--replica-state ] + + +Explicitly update the 'replica_state' of a share replica (Experimental). + +**Positional arguments:** + +```` + ID of the share replica to modify. + +**Optional arguments:** + +``--replica-state , --replica_state , --state `` + Indicate which replica_state to assign the replica. + Options include in_sync, out_of_sync, active, error. + If no state is provided, out_of_sync will be used. + +.. _manila_share-replica-reset-state: + +manila share-replica-reset-state +-------------------------------- + +.. code-block:: console + + usage: manila share-replica-reset-state [--state ] + +Explicitly update the 'status' of a share replica (Experimental). + +**Positional arguments:** + +```` + ID of the share replica to modify. + +**Optional arguments:** + +``--state `` + Indicate which state to assign the replica. Options include + available, error, creating, deleting, error_deleting. If no + state is provided, available will be used. + +.. _manila_share-replica-resync: + +manila share-replica-resync +--------------------------- + +.. code-block:: console + + usage: manila share-replica-resync + +Attempt to update the share replica with its 'active' mirror (Experimental). + +**Positional arguments:** + +```` + ID of the share replica to resync. + +.. _manila_share-replica-show: + +manila share-replica-show +------------------------- + +.. code-block:: console + + usage: manila share-replica-show + +Show details about a replica (Experimental). + +**Positional arguments:** + +```` + ID of the share replica. + +.. _manila_share-server-delete: + +manila share-server-delete +-------------------------- + +.. code-block:: console + + usage: manila share-server-delete [ ...] + +Delete one or more share servers (Admin only). + +**Positional arguments:** + +```` + ID of the share server(s) to delete. + +.. _manila_share-server-details: + +manila share-server-details +--------------------------- + +.. code-block:: console + + usage: manila share-server-details + +Show share server details (Admin only). + +**Positional arguments:** + +```` + ID of share server. + +.. _manila_share-server-list: + +manila share-server-list +------------------------ + +.. code-block:: console + + usage: manila share-server-list [--host ] [--status ] + [--share-network ] + [--project-id ] + [--columns ] + +List all share servers (Admin only). + +**Optional arguments:** + +``--host `` + Filter results by name of host. + +``--status `` + Filter results by status. + +``--share-network `` + Filter results by share network. + +``--project-id `` + Filter results by project ID. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "id,host,status". + +.. _manila_share-server-show: + +manila share-server-show +------------------------ + +.. code-block:: console + + usage: manila share-server-show + +Show share server info (Admin only). + +**Positional arguments:** + +```` + ID of share server. + +.. _manila_show: + +manila show +----------- + +.. code-block:: console + + usage: manila show + +Show details about a NAS share. + +**Positional arguments:** + +```` + Name or ID of the NAS share. + +.. _manila_shrink: + +manila shrink +------------- + +.. code-block:: console + + usage: manila shrink + +Decreases the size of an existing share. + +**Positional arguments:** + +```` + Name or ID of share to shrink. + +```` + New size of share, in GiBs. + +.. _manila_snapshot-access-allow: + +manila snapshot-access-allow +---------------------------- + +.. code-block:: console + + usage: manila snapshot-access-allow + +Allow read only access to a snapshot. + +**Positional arguments:** + +```` + Name or ID of the share snapshot to allow access to. + +```` + Access rule type (only "ip", "user"(user or group), "cert" or + "cephx" are supported). + +```` + Value that defines access. + +.. _manila_snapshot-access-deny: + +manila snapshot-access-deny +--------------------------- + +.. code-block:: console + + usage: manila snapshot-access-deny [ ...] + +Deny access to a snapshot. + +**Positional arguments:** + +```` + Name or ID of the share snapshot to deny access to. + +```` + ID(s) of the access rule(s) to be deleted. + +.. _manila_snapshot-access-list: + +manila snapshot-access-list +--------------------------- + +.. code-block:: console + + usage: manila snapshot-access-list [--columns ] + +Show access list for a snapshot. + +**Positional arguments:** + +```` + Name or ID of the share snapshot to list access of. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "access_type,access_to". + +.. _manila_snapshot-create: + +manila snapshot-create +---------------------- + +.. code-block:: console + + usage: manila snapshot-create [--force ] [--name ] + [--description ] + + +Add a new snapshot. + +**Positional arguments:** + +```` + Name or ID of the share to snapshot. + +**Optional arguments:** + +``--force `` + Optional flag to indicate whether to snapshot a share + even if it's busy. (Default=False) + +``--name `` + Optional snapshot name. (Default=None) + +``--description `` + Optional snapshot description. (Default=None) + +.. _manila_snapshot-delete: + +manila snapshot-delete +---------------------- + +.. code-block:: console + + usage: manila snapshot-delete [ ...] + +Remove one or more snapshots. + +**Positional arguments:** + +```` + Name or ID of the snapshot(s) to delete. + +.. _manila_snapshot-export-location-list: + +manila snapshot-export-location-list +------------------------------------ + +.. code-block:: console + + usage: manila snapshot-export-location-list [--columns ] + +List export locations of a given snapshot. + +**Positional arguments:** + +```` + Name or ID of the snapshot. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,path". + +.. _manila_snapshot-export-location-show: + +manila snapshot-export-location-show +------------------------------------ + +.. code-block:: console + + usage: manila snapshot-export-location-show + +Show export location of the share snapshot. + +**Positional arguments:** + +```` + Name or ID of the snapshot. + +```` + ID of the share snapshot export location. + +.. _manila_snapshot-force-delete: + +manila snapshot-force-delete +---------------------------- + +.. code-block:: console + + usage: manila snapshot-force-delete [ ...] + +Attempt force-deletion of one or more snapshots. Regardless of the state +(Admin only). + +**Positional arguments:** + +```` + Name or ID of the snapshot(s) to force delete. + +.. _manila_snapshot-instance-export-location-list: + +manila snapshot-instance-export-location-list +--------------------------------------------- + +.. code-block:: console + + usage: manila snapshot-instance-export-location-list [--columns ] + + +List export locations of a given snapshot instance. + +**Positional arguments:** + +```` + Name or ID of the snapshot instance. + +**Optional arguments:** + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,path,is_admin_only". + +.. _manila_snapshot-instance-export-location-show: + +manila snapshot-instance-export-location-show +--------------------------------------------- + +.. code-block:: console + + usage: manila snapshot-instance-export-location-show + + +Show export location of the share instance snapshot. + +**Positional arguments:** + +```` + ID of the share snapshot instance. + +```` + ID of the share snapshot instance export location. + +.. _manila_snapshot-instance-list: + +manila snapshot-instance-list +----------------------------- + +.. code-block:: console + + usage: manila snapshot-instance-list [--snapshot ] + [--columns ] + [--detailed ] + +List share snapshot instances. + +**Optional arguments:** + +``--snapshot `` + Filter results by share snapshot ID. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "id". + +``--detailed `` + Show detailed information about snapshot instances. + (Default=False) + +.. _manila_snapshot-instance-reset-state: + +manila snapshot-instance-reset-state +------------------------------------ + +.. code-block:: console + + usage: manila snapshot-instance-reset-state [--state ] + + +Explicitly update the state of a share snapshot instance. + +**Positional arguments:** + +```` + ID of the snapshot instance to modify. + +**Optional arguments:** + +``--state `` + Indicate which state to assign the snapshot instance. + Options include available, error, creating, deleting, + error_deleting. If no state is provided, available will + be used. + +.. _manila_snapshot-instance-show: + +manila snapshot-instance-show +----------------------------- + +.. code-block:: console + + usage: manila snapshot-instance-show + +Show details about a share snapshot instance. + +**Positional arguments:** + +```` + ID of the share snapshot instance. + +.. _manila_snapshot-list: + +manila snapshot-list +-------------------- + +.. code-block:: console + + usage: manila snapshot-list [--all-tenants [<0|1>]] [--name ] + [--status ] [--share-id ] + [--usage [any|used|unused]] [--limit ] + [--offset ] [--sort-key ] + [--sort-dir ] [--columns ] + +List all the snapshots. + +**Optional arguments:** + +``--all-tenants [<0|1>]`` + Display information from all tenants (Admin only). + +``--name `` + Filter results by name. + +``--status `` + Filter results by status. + +``--share-id , --share_id `` + Filter results by source share ID. + +``--usage [any|used|unused]`` + Either filter or not snapshots by its usage. OPTIONAL: + Default=any. + +``--limit `` + Maximum number of share snapshots to return. OPTIONAL: + Default=None. + +``--offset `` + Set offset to define start point of share snapshots + listing. OPTIONAL: Default=None. + +``--sort-key , --sort_key `` + Key to be sorted, available keys are ('id', 'status', + 'size', 'share_id', 'user_id', 'project_id', + 'progress', 'name', 'display_name'). Default=None. + +``--sort-dir , --sort_dir `` + Sort direction, available values are ('asc', 'desc'). + OPTIONAL: Default=None. + +``--columns `` + Comma separated list of columns to be displayed + example --columns "id,name". + +.. _manila_snapshot-manage: + +manila snapshot-manage +---------------------- + +.. code-block:: console + + usage: manila snapshot-manage [--name ] [--description ] + [--driver_options [ [ ...]]] + + +Manage share snapshot not handled by Manila (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share. + +```` + Provider location of the snapshot on the backend. + +**Optional arguments:** + +``--name `` + Optional snapshot name (Default=None). + +``--description `` + Optional snapshot description (Default=None). + +``--driver_options [ [ ...]], --driver-options [ [ ...]]`` + Optional driver options as key=value pairs + (Default=None). + +.. _manila_snapshot-rename: + +manila snapshot-rename +---------------------- + +.. code-block:: console + + usage: manila snapshot-rename [--description ] + [] + +Rename a snapshot. + +**Positional arguments:** + +```` + Name or ID of the snapshot to rename. + +```` + New name for the snapshot. + +**Optional arguments:** + +``--description `` + Optional snapshot description. (Default=None) + +.. _manila_snapshot-reset-state: + +manila snapshot-reset-state +--------------------------- + +.. code-block:: console + + usage: manila snapshot-reset-state [--state ] + +Explicitly update the state of a snapshot (Admin only). + +**Positional arguments:** + +```` + Name or ID of the snapshot to modify. + +**Optional arguments:** + +``--state `` + Indicate which state to assign the snapshot. Options + include available, error, creating, deleting, + error_deleting. If no state is provided, available will be + used. + +.. _manila_snapshot-show: + +manila snapshot-show +-------------------- + +.. code-block:: console + + usage: manila snapshot-show + +Show details about a snapshot. + +**Positional arguments:** + +```` + Name or ID of the snapshot. + +.. _manila_snapshot-unmanage: + +manila snapshot-unmanage +------------------------ + +.. code-block:: console + + usage: manila snapshot-unmanage [ ...] + +Unmanage one or more share snapshots (Admin only). + +**Positional arguments:** + +```` + Name or ID of the snapshot(s). + +.. _manila_type-access-add: + +manila type-access-add +---------------------- + +.. code-block:: console + + usage: manila type-access-add + +Adds share type access for the given project (Admin only). + +**Positional arguments:** + +```` + Share type name or ID to add access for the given project. + +```` + Project ID to add share type access for. + +.. _manila_type-access-list: + +manila type-access-list +----------------------- + +.. code-block:: console + + usage: manila type-access-list + +Print access information about the given share type (Admin only). + +**Positional arguments:** + +```` + Filter results by share type name or ID. + +.. _manila_type-access-remove: + +manila type-access-remove +------------------------- + +.. code-block:: console + + usage: manila type-access-remove + +Removes share type access for the given project (Admin only). + +**Positional arguments:** + +```` + Share type name or ID to remove access for the given project. + +```` + Project ID to remove share type access for. + +.. _manila_type-create: + +manila type-create +------------------ + +.. code-block:: console + + usage: manila type-create [--snapshot_support ] + [--create_share_from_snapshot_support ] + [--revert_to_snapshot_support ] + [--mount_snapshot_support ] + [--extra-specs [ [ ...]]] + [--is_public ] + + +Create a new share type (Admin only). + +**Positional arguments:** + +```` + Name of the new share type. + +```` + Required extra specification. Valid values are + 'true'/'1' and 'false'/'0'. + +**Optional arguments:** + +``--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 [ [ ...]], --extra_specs [ [ ...]]`` + Extra specs key and value of share type that will be + used for share type creation. OPTIONAL: Default=None. + example --extra-specs thin_provisioning=' True', + replication_type=readable. + +``--is_public , --is-public `` + Make type accessible to the public (default true). + +.. _manila_type-delete: + +manila type-delete +------------------ + +.. code-block:: console + + usage: manila type-delete [ ...] + +Delete one or more specific share types (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share type(s) to delete. + +.. _manila_type-key: + +manila type-key +--------------- + +.. code-block:: console + + usage: manila type-key [ [ ...]] + +Set or unset extra_spec for a share type (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share type. + +```` + Actions: 'set' or 'unset'. + +```` + Extra_specs to set or unset (key is only necessary on unset). + +.. _manila_type-list: + +manila type-list +---------------- + +.. code-block:: console + + usage: manila type-list [--all] [--columns ] + +Print a list of available 'share types'. + +**Optional arguments:** + +``--all`` + Display all share types (Admin only). + +``--columns `` + Comma separated list of columns to be displayed example + --columns "id,name". + +.. _manila_unmanage: + +manila unmanage +--------------- + +.. code-block:: console + + usage: manila unmanage + +Unmanage share (Admin only). + +**Positional arguments:** + +```` + Name or ID of the share(s). + +.. _manila_update: + +manila update +------------- + +.. code-block:: console + + usage: manila update [--name ] [--description ] + [--is-public ] + + +Rename a share. + +**Positional arguments:** + +```` + Name or ID of the share to rename. + +**Optional arguments:** + +``--name `` + New name for the share. + +``--description `` + Optional share description. (Default=None) + +``--is-public , --is_public `` + Public share is visible for all tenants. +