.. ## WARNING ###################################### .. This file is automatically generated, do not edit .. ################################################# ======================================= Shared file systems command-line client ======================================= The manila client is the command-line interface (CLI) for the Shared file systems API and its extensions. This chapter documents :command:`manila` version ``1.7.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 ] [--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. ``cg-create`` Creates a new consistency group. ``cg-delete`` Remove one or more consistency groups. ``cg-list`` List consistency groups with filters. ``cg-reset-state`` Explicitly update the state of a consistency group. ``cg-show`` Show details about a consistency group. ``cg-snapshot-create`` Creates a new consistency group snapshot. ``cg-snapshot-delete`` Remove one or more consistency group snapshots. ``cg-snapshot-list`` List consistency group snapshots with filters. ``cg-snapshot-members`` Get member details for a consistency group snapshot. ``cg-snapshot-reset-state`` Explicitly update the state of a consistency group. ``cg-snapshot-show`` Show details about a consistency group snapshot. ``cg-snapshot-update`` Update a consistency group snapshot. ``cg-update`` Update a consistency group. ``create`` Creates a new share (NFS, CIFS, 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. ``list`` List NAS shares with filters. ``manage`` Manage share not handled by Manila. ``metadata`` Set or delete metadata on a share. ``metadata-show`` Show metadata of given share. ``metadata-update-all`` Update all metadata of a share. ``migrate`` Migrates share to a new host. ``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. ``quota-defaults`` List the default quotas for a tenant. ``quota-delete`` Delete quota for a tenant/user. The quota will revert back to default. ``quota-show`` List the quotas for a tenant/user. ``quota-update`` Update the quotas for a tenant/user. ``rate-limits`` Print a list of rate limits for a user. ``reset-state`` Explicitly update the state of a share. ``security-service-create`` Create security service used by tenant. ``security-service-delete`` Delete security service. ``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. ``service-enable`` Enables 'manila-share' or 'manila-scheduler' services. ``service-list`` List all services. ``share-instance-force-delete`` Attempt force-delete of share instance, regardless of state. ``share-instance-list`` List share instances. ``share-instance-reset-state`` Explicitly update the state of a share instance. ``share-instance-show`` Show details about a share instance. ``share-network-create`` Create description for network used by the tenant. ``share-network-delete`` Delete share network. ``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-server-delete`` Delete share server. ``share-server-details`` Show share server details. ``share-server-list`` List all share servers. ``share-server-show`` Show share server info. ``show`` Show details about a NAS share. ``shrink`` Decreases the size of an existing share. ``snapshot-create`` Add a new snapshot. ``snapshot-delete`` Remove a snapshot. ``snapshot-force-delete`` Attempt force-delete of snapshot, regardless of state. ``snapshot-list`` List all the snapshots. ``snapshot-rename`` Rename a snapshot. ``snapshot-reset-state`` Explicitly update the state of a snapshot. ``snapshot-show`` Show details about a snapshot. ``type-access-add`` Adds share type access for the given project. ``type-access-list`` Print access information about the given share type. ``type-access-remove`` Removes share type access for the given project. ``type-create`` Create a new share type. ``type-delete`` Delete a specific share type. ``type-key`` Set or unset extra_spec for a share type. ``type-list`` Print a list of available 'share types'. ``unmanage`` Unmanage share. ``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 :option:`--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 :option:`--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]``. ``--service-type `` Defaults to compute for most actions. ``--service-name `` Defaults to ``env[MANILA_SERVICE_NAME]``. ``--share-service-name `` Defaults to ``env[MANILA_share_service_name]``. ``--endpoint-type `` Defaults to ``env[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), and "cert" are supported). ```` Value that defines access. Optional arguments ------------------ ``--access-level , --access_level `` Share access level ("rw" and "ro" access levels are supported). Defaults to None. .. _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 e.g. :option:`--columns` "access_type,access_to" .. _manila_api-version: manila api-version ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila api-version Display the API version information. .. _manila_cg-create: manila cg-create ~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-create [--name ] [--description ] [--share-types ] [--share-network ] [--source-cgsnapshot-id ] Creates a new consistency group. Optional arguments ------------------ ``--name `` Optional consistency group name. (Default=None) ``--description `` Optional consistency group description. (Default=None) ``--share-types , --share_types `` Optional list of share types. (Default=None) ``--share-network , --share_network `` Specify share-network name or id. ``--source-cgsnapshot-id ,`` ``--source_cgsnapshot_id `` Optional snapshot ID to create the share from. (Default=None) .. _manila_cg-delete: manila cg-delete ~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-delete [--force] [ ...] Remove one or more consistency groups. Positional arguments -------------------- ```` Name or ID of the consistency group(s). Optional arguments ------------------ ``--force`` Attempt to force delete the consistency group (Default=False). .. _manila_cg-list: manila cg-list ~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-list [--all-tenants [<0|1>]] [--limit ] [--offset ] [--columns ] List consistency groups with filters. Optional arguments ------------------ ``--all-tenants [<0|1>]`` Display information from all tenants (Admin only). ``--limit `` Maximum number of consistency groups to return. (Default=None) ``--offset `` Start position of consistency group listing. ``--columns `` Comma separated list of columns to be displayed e.g. :option:`--columns` "id,name" .. _manila_cg-reset-state: manila cg-reset-state ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-reset-state [--state ] Explicitly update the state of a consistency group. Positional arguments -------------------- ```` Name or ID of the consistency group state to modify. Optional arguments ------------------ ``--state `` Indicate which state to assign the consistency group. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used. .. _manila_cg-show: manila cg-show ~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-show Show details about a consistency group. Positional arguments -------------------- ```` Name or ID of the consistency group. .. _manila_cg-snapshot-create: manila cg-snapshot-create ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-snapshot-create [--name ] [--description ] Creates a new consistency group snapshot. Positional arguments -------------------- ```` Name or ID of the consistency group. Optional arguments ------------------ ``--name `` Optional consistency group snapshot name. (Default=None) ``--description `` Optional consistency group snapshot description. (Default=None) .. _manila_cg-snapshot-delete: manila cg-snapshot-delete ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-snapshot-delete [--force] [ ...] Remove one or more consistency group snapshots. Positional arguments -------------------- ```` Name or ID of the consistency group snapshot. Optional arguments ------------------ ``--force`` Attempt to force delete the cg snapshot(s) (Default=False). .. _manila_cg-snapshot-list: manila cg-snapshot-list ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-snapshot-list [--all-tenants [<0|1>]] [--limit ] [--offset ] [--detailed DETAILED] [--columns ] List consistency group snapshots with filters. Optional arguments ------------------ ``--all-tenants [<0|1>]`` Display information from all tenants (Admin only). ``--limit `` Maximum number of consistency group snapshots to return.(Default=None) ``--offset `` Start position of consistency group snapshot listing. ``--detailed DETAILED`` Show detailed information about snapshots. ``--columns `` Comma separated list of columns to be displayed e.g. :option:`--columns` "id,name" .. _manila_cg-snapshot-members: manila cg-snapshot-members ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-snapshot-members [--limit ] [--offset ] Get member details for a consistency group snapshot. Positional arguments -------------------- ```` Name or ID of the consistency group snapshot. Optional arguments ------------------ ``--limit `` Maximum number of shares to return. (Default=None) ``--offset `` Start position of security services listing. .. _manila_cg-snapshot-reset-state: manila cg-snapshot-reset-state ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-snapshot-reset-state [--state ] Explicitly update the state of a consistency group. Positional arguments -------------------- ```` Name or ID of the consistency group snapshot. Optional arguments ------------------ ``--state `` Indicate which state to assign the consistency group. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used. .. _manila_cg-snapshot-show: manila cg-snapshot-show ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-snapshot-show Show details about a consistency group snapshot. Positional arguments -------------------- ```` Name or ID of the consistency group snapshot. .. _manila_cg-snapshot-update: manila cg-snapshot-update ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-snapshot-update [--name ] [--description ] Update a consistency group snapshot. Positional arguments -------------------- ```` Name or ID of the cg snapshot to update. Optional arguments ------------------ ``--name `` Optional new name for the cg snapshot. (Default=None ``--description `` Optional cg snapshot description. (Default=None) .. _manila_cg-update: manila cg-update ~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila cg-update [--name ] [--description ] Update a consistency group. Positional arguments -------------------- ```` Name or ID of the consistency group to update. Optional arguments ------------------ ``--name `` Optional new name for the consistency group. (Default=None) ``--description `` Optional consistency group description. (Default=None) .. _manila_create: manila create ~~~~~~~~~~~~~ .. code-block:: console usage: manila create [--snapshot-id ] [--name ] [--metadata [ [ ...]]] [--share-network ] [--description ] [--share-type ] [--public] [--availability-zone ] [--consistency-group ] Creates a new share (NFS, CIFS, GlusterFS or HDFS). Positional arguments -------------------- ```` Share type (NFS, CIFS, GlusterFS or HDFS). ```` Share size in GiB. Optional arguments ------------------ ``--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 `` 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. ``--consistency-group ,`` ``--consistency_group ,`` ``--cg `` Optional consistency group name or ID in which to create the share. (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 [--consistency-group ] [ ...] Remove one or more shares. Positional arguments -------------------- ```` Name or ID of the share(s). Optional arguments ------------------ ``--consistency-group ,`` ``--consistency_group ,`` ``--cg `` Optional consistency group name or ID which contains the share. (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 e.g. :option:`--columns` "id,name" .. _manila_force-delete: manila force-delete ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila force-delete [ ...] Attempt force-delete of share, regardless of state. 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] [--consistency-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. ``--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', 'export_location', '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 ':option:`--all-tenants`'. ``--public`` Add public shares from all tenants to result. ``--consistency-group ,`` ``--consistency_group ,`` ``--cg `` Filter results by consistency group name or ID. ``--columns `` Comma separated list of columns to be displayed e.g. :option:`--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. 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:/foo_path, CIFS share such as: \\\\10.0.0.1\\foo_name_of_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_migrate: manila migrate ~~~~~~~~~~~~~~ .. code-block:: console usage: manila migrate [--force-host-copy ] Migrates share to a new host. Positional arguments -------------------- ```` Name or ID of share to migrate. ```` Destination host and pool. Optional arguments ------------------ ``--force-host-copy `` Enables or disables generic host-based force- migration, which bypasses driver optimizations. Default=False. .. _manila_pool-list: manila pool-list ~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila pool-list [--host ] [--backend ] [--pool ] [--columns ] 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 e.g. :option:`--columns` "name,host" .. _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. 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. 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 ] 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. .. _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. 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 `` 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 e.g. :option:`--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. 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_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 security service. Positional arguments -------------------- ```` Security service name or ID 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 e.g. :option:`--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. Positional arguments -------------------- ```` Host name as 'foo_host@bar_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. Positional arguments -------------------- ```` Host name as 'foo_host@bar_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. 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 e.g. :option:`--columns` "id,host" .. _manila_share-instance-force-delete: manila share-instance-force-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila share-instance-force-delete [ ...] Attempt force-delete of share instance, regardless of state. 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. Optional arguments ------------------ ``--share-id , --share_id `` Filter results by share ID. ``--columns `` Comma separated list of columns to be displayed e.g. :option:`--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. 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. 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. 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 [--nova-net-id ] [--neutron-net-id ] [--neutron-subnet-id ] [--name ] [--description ] Create description for network used by the tenant. Optional arguments ------------------ ``--nova-net-id ,`` ``--nova-net_id ,`` ``--nova_net_id ,`` ``--nova_net-id `` Nova net ID. Used to set up network for share servers. ``--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 share network. Positional arguments -------------------- ```` Name or ID of share network 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 ] [--nova-net-id ] [--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. ``--nova-net-id ,`` ``--nova_net_id ,`` ``--nova_net-id ,`` ``--nova-net_id `` Filter results by Nova net ID. ``--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 e.g. :option:`--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 e.g. :option:`--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 [--nova-net-id ] [--neutron-net-id ] [--neutron-subnet-id ] [--name ] [--description ] Update share network data. Positional arguments -------------------- ```` Name or ID of share network to update. Optional arguments ------------------ ``--nova-net-id ,`` ``--nova-net_id ,`` ``--nova_net_id ,`` ``--nova_net-id `` Nova net ID. Used to set up network for share servers. ``--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-server-delete: manila share-server-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila share-server-delete Delete share server. Positional arguments -------------------- ```` ID of share server. .. _manila_share-server-details: manila share-server-details ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila share-server-details Show share server details. 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. 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 e.g. :option:`--columns` "id,host,status" .. _manila_share-server-show: manila share-server-show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila share-server-show Show share server info. 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-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 a snapshot. Positional arguments -------------------- ```` Name or ID of the snapshot to delete. .. _manila_snapshot-force-delete: manila snapshot-force-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila snapshot-force-delete Attempt force-delete of snapshot, regardless of state. Positional arguments -------------------- ```` Name or ID of the snapshot to force delete. .. _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 e.g. :option:`--columns` "id,name" .. _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. 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_type-access-add: manila type-access-add ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: manila type-access-add Adds share type access for the given project. 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. 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. 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 ] [--is_public ] Create a new share type. 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 that used for filtering of back ends by their capability to create share snapshots. (Default is True). ``--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 a specific share type. Positional arguments -------------------- ```` Name or ID of the share type to delete. .. _manila_type-key: manila type-key ~~~~~~~~~~~~~~~ .. code-block:: console usage: manila type-key [ [ ...]] Set or unset extra_spec for a share type. 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 e.g. :option:`--columns` "id,name" .. _manila_unmanage: manila unmanage ~~~~~~~~~~~~~~~ .. code-block:: console usage: manila unmanage Unmanage share. 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.