.. ################################################### .. ## 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). ``message-delete`` Remove one or more messages. ``message-list`` Lists all messages. ``message-show`` Show message's details. ``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_message-delete: manila message-delete ---------------------- .. code-block:: console usage: manila message-delete [ ...] Remove one or more messages. **Positional arguments:** ```` ID of the message(s). .. _manila_message-list: manila message-list ---------------------- .. code-block:: console usage: manila message-list [--resource_id ] [--resource_type ] [--action_id ] [--detail_id ] [--request_id ] [--level ] [--limit ] [--offset ] [--sort-key ] [--sort-dir ] [--columns ] Lists all messages. **Optional arguments:** ``--resource_id , --resource-id , --resource `` Filters results by a resource uuid. (Default=None). ``--resource_type , --resource-type `` Filters results by a resource type. (Default=None). Example: "manila message-list --resource_type share" ``--action_id , --action-id , --action `` Filters results by action id. (Default=None). ``--detail_id , --detail-id , --detail `` Filters results by detail id. (Default=None). ``--request_id , --request-id , --request `` Filters results by request id. (Default=None). ``--level , --message_level , --message-level `` Filters results by the message level. (Default=None). Example: "manila message-list --level ERROR". ``--limit `` Maximum number of messages to return. (Default=None) ``--offset `` Start position of message listing. ``--sort-key , --sort_key `` Key to be sorted, available keys are ('id', 'project_id', 'request_id', 'resource_type', 'action_id', 'detail_id', 'resource_id', 'message_level', 'expires_at', 'request_id', 'created_at'). (Default=desc). ``--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 "resource_id, user_message". .. _manila_message-show: manila message-show ---------------------- .. code-block:: console usage: manila message-show Show details about a message. **Positional arguments:** ```` ID of the message. .. _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 ] [--share-groups ] [--share-group-snapshots ] 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. ``--share-groups , --share_groups `` New value for the "share_groups" quota. ``--share-group-snapshots , --share_group_snapshots `` New value for the "share_group_snapshots" 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 ] [--share-type ] 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. ``--share-type , --share_type `` UUID or name of a share type to set the quotas for. Optional. Mutually exclusive with '--user-id'. Available only for microversion >= 2.39 .. _manila_quota-show: manila quota-show ----------------- .. code-block:: console usage: manila quota-show [--tenant ] [--user ] [--share-type ] [--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. ``--share-type , --share_type `` UUID or name of a share type to set the quotas for. Optional. Mutually exclusive with '--user-id'. 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. .. _manila_quota-update: manila quota-update ------------------- .. code-block:: console usage: manila quota-update [--user ] [--shares ] [--snapshots ] [--gigabytes ] [--snapshot-gigabytes ] [--share-networks ] [--share-groups ] [--share-group-snapshots ] [--share-type ] [--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. ``--share-groups , --share_groups `` New value for the "share_groups" quota. ``--share-group-snapshots , --share_group_snapshots `` New value for the "share_group_snapshots" quota. ``--share-type , --share_type `` UUID or name of a share type to set the quotas for. Optional. Mutually exclusive with '--user-id'. Available only for microversion >= 2.39 ``--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