diff --git a/doc/cli-ref-rst/source/designate.rst b/doc/cli-ref-rst/source/designate.rst new file mode 100644 index 0000000000..db73c5ebf5 --- /dev/null +++ b/doc/cli-ref-rst/source/designate.rst @@ -0,0 +1,1002 @@ +.. ## WARNING ###################################### +.. This file is automatically generated, do not edit +.. ################################################# + +=============================== +DNS service command-line client +=============================== + +The designate client is the command-line interface (CLI) for +the DNS service API and its extensions. + +This chapter documents :command:`designate` version ``1.5.0``. + +For help on a specific :command:`designate` command, enter: + +.. code-block:: console + + $ designate help COMMAND + +.. _designate_command_usage: + +designate usage +~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] + [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] + [--os-user-domain-id OS_USER_DOMAIN_ID] + [--os-user-domain-name OS_USER_DOMAIN_NAME] + [--os-password OS_PASSWORD] [--os-tenant-name OS_TENANT_NAME] + [--os-tenant-id OS_TENANT_ID] + [--os-project-name OS_PROJECT_NAME] + [--os-domain-name OS_DOMAIN_NAME] + [--os-domain-id OS_DOMAIN_ID] [--os-project-id OS_PROJECT_ID] + [--os-project-domain-id OS_PROJECT_DOMAIN_ID] + [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] + [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] + [--os-token OS_TOKEN] [--os-endpoint OS_ENDPOINT] + [--os-endpoint-type OS_ENDPOINT_TYPE] + [--os-service-type OS_SERVICE_TYPE] [--os-cacert OS_CACERT] + [--insecure] [--all-tenants] [--edit-managed] + +.. _designate_command_options: + +designate optional arguments +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +``--version`` + show program's version number and exit + +``-v, --verbose`` + Increase verbosity of output. Can be repeated. + +``--log-file LOG_FILE`` + Specify a file to log output. Disabled by default. + +``-q, --quiet`` + Suppress output except warnings and errors. + +``-h, --help`` + Show this help message and exit. + +``--debug`` + Show tracebacks on errors. + +``--os-username OS_USERNAME`` + Name used for authentication with the OpenStack + Identity service. Defaults to ``env[OS_USERNAME]``. + +``--os-user-id OS_USER_ID`` + User ID used for authentication with the OpenStack + Identity service. Defaults to ``env[OS_USER_ID]``. + +``--os-user-domain-id OS_USER_DOMAIN_ID`` + Defaults to ``env[OS_USER_DOMAIN_ID]``. + +``--os-user-domain-name OS_USER_DOMAIN_NAME`` + Defaults to ``env[OS_USER_DOMAIN_NAME]``. + +``--os-password OS_PASSWORD`` + Password used for authentication with the OpenStack + Identity service. Defaults to ``env[OS_PASSWORD]``. + +``--os-tenant-name OS_TENANT_NAME`` + Tenant to request authorization on. Defaults to + ``env[OS_TENANT_NAME]``. + +``--os-tenant-id OS_TENANT_ID`` + Tenant to request authorization on. Defaults to + ``env[OS_TENANT_ID]``. + +``--os-project-name OS_PROJECT_NAME`` + Project to request authorization on. Defaults to + ``env[OS_PROJECT_NAME]``. + +``--os-domain-name OS_DOMAIN_NAME`` + Project to request authorization on. Defaults to + ``env[OS_DOMAIN_NAME]``. + +``--os-domain-id OS_DOMAIN_ID`` + Defaults to ``env[OS_DOMAIN_ID]``. + +``--os-project-id OS_PROJECT_ID`` + Project to request authorization on. Defaults to + ``env[OS_PROJECT_ID]``. + +``--os-project-domain-id OS_PROJECT_DOMAIN_ID`` + Defaults to ``env[OS_PROJECT_DOMAIN_ID]``. + +``--os-project-domain-name OS_PROJECT_DOMAIN_NAME`` + Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``. + +``--os-auth-url OS_AUTH_URL`` + Specify the Identity endpoint to use for + authentication. Defaults to ``env[OS_AUTH_URL]``. + +``--os-region-name OS_REGION_NAME`` + Specify the region to use. Defaults to + ``env[OS_REGION_NAME]``. + +``--os-token OS_TOKEN`` + Specify an existing token to use instead of retrieving + one via authentication (e.g. with username & + password). Defaults to ``env[OS_SERVICE_TOKEN]``. + +``--os-endpoint OS_ENDPOINT`` + Specify an endpoint to use instead of retrieving one + from the service catalog (via authentication). + Defaults to ``env[OS_DNS_ENDPOINT]``. + +``--os-endpoint-type OS_ENDPOINT_TYPE`` + Defaults to ``env[OS_ENDPOINT_TYPE]``. + +``--os-service-type OS_SERVICE_TYPE`` + Defaults to ``env[OS_DNS_SERVICE_TYPE]``, or 'dns'. + +``--os-cacert OS_CACERT`` + CA certificate bundle file. Defaults to + ``env[OS_CACERT]``. + +``--insecure`` + Explicitly allow 'insecure' SSL requests. + +``--all-tenants`` + Allows to list all domains from all tenants. + +``--edit-managed`` + Allows to edit records that are marked as managed. + +.. _designate_diagnostics-ping: + +designate diagnostics-ping +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate diagnostics-ping [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] --service + SERVICE --host HOST + +Ping a service on a given host + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--service SERVICE`` + Service name (e.g. central) + +``--host HOST`` + Hostname + +.. _designate_domain-create: + +designate domain-create +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate domain-create [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] --name NAME + --email EMAIL [--ttl TTL] + [--description DESCRIPTION] + +Create Domain + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--name NAME`` + Domain name + +``--email EMAIL`` + Domain email + +``--ttl TTL`` + Time to live (seconds) + +``--description DESCRIPTION`` + Description + +.. _designate_domain-delete: + +designate domain-delete +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate domain-delete [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] + id + +Delete Domain + +Positional arguments +-------------------- + +``id`` + Domain ID or name + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_domain-get: + +designate domain-get +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate domain-get [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + id + +Get Domain + +Positional arguments +-------------------- + +``id`` + Domain ID or name + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_domain-list: + +designate domain-list +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate domain-list [-h] + [-f {csv,html,json,json,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--quote {all,minimal,none,nonnumeric}] + +List Domains + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_domain-servers-list: + +designate domain-servers-list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate domain-servers-list [-h] + [-f {csv,html,json,json,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] + [--quote {all,minimal,none,nonnumeric}] + id + +List Domain Servers + +Positional arguments +-------------------- + +``id`` + Domain ID or name + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_domain-update: + +designate domain-update +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate domain-update [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] [--name NAME] + [--email EMAIL] [--ttl TTL] + [--description DESCRIPTION | --no-description] + id + +Update Domain + +Positional arguments +-------------------- + +``id`` + Domain ID or name + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--name NAME`` + Domain name + +``--email EMAIL`` + Domain email + +``--ttl TTL`` + Time to live (seconds) + +``--description DESCRIPTION`` + Description + +``--no-description`` + +.. _designate_quota-get: + +designate quota-get +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate quota-get [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + tenant_id + +Get Quota + +Positional arguments +-------------------- + +``tenant_id`` + Tenant ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_quota-reset: + +designate quota-reset +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate quota-reset [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + tenant_id + +Reset Quota + +Positional arguments +-------------------- + +``tenant_id`` + Tenant ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_quota-update: + +designate quota-update +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate quota-update [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] [--domains DOMAINS] + [--domain-recordsets DOMAIN_RECORDSETS] + [--recordset-records RECORDSET_RECORDS] + [--domain-records DOMAIN_RECORDS] + tenant_id + +Update Quota + +Positional arguments +-------------------- + +``tenant_id`` + Tenant ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--domains DOMAINS`` + Allowed domains + +``--domain-recordsets DOMAIN_RECORDSETS`` + Allowed domain records + +``--recordset-records RECORDSET_RECORDS`` + Allowed recordset records + +``--domain-records DOMAIN_RECORDS`` + Allowed domain records + +.. _designate_record-create: + +designate record-create +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate record-create [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] --name NAME + --type TYPE --data DATA [--ttl TTL] + [--priority PRIORITY] + [--description DESCRIPTION] + domain_id + +Create Record + +Positional arguments +-------------------- + +``domain_id`` + Domain ID or name + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--name NAME`` + Record (relative|absolute) name + +``--type TYPE`` + Record type + +``--data DATA`` + Record data + +``--ttl TTL`` + Record TTL + +``--priority PRIORITY`` + Record priority + +``--description DESCRIPTION`` + Description + +.. _designate_record-delete: + +designate record-delete +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate record-delete [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] + domain_id id + +Delete Record + +Positional arguments +-------------------- + +``domain_id`` + Domain ID or name + +``id`` + Record ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_record-get: + +designate record-get +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate record-get [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + domain_id id + +Get Record + +Positional arguments +-------------------- + +``domain_id`` + Domain ID or name + +``id`` + Record ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_record-list: + +designate record-list +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate record-list [-h] + [-f {csv,html,json,json,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--quote {all,minimal,none,nonnumeric}] + domain_id + +List Records + +Positional arguments +-------------------- + +``domain_id`` + Domain ID or name + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_record-update: + +designate record-update +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate record-update [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] [--name NAME] + [--type TYPE] [--data DATA] + [--description DESCRIPTION | --no-description] + [--ttl TTL | --no-ttl] + [--priority PRIORITY | --no-priority] + domain_id id + +Update Record + +Positional arguments +-------------------- + +``domain_id`` + Domain ID or name + +``id`` + Record ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--name NAME`` + Record name + +``--type TYPE`` + Record type + +``--data DATA`` + Record data + +``--description DESCRIPTION`` + Description + +``--no-description`` + +``--ttl TTL`` + Record time to live (seconds) + +``--no-ttl`` + +``--priority PRIORITY`` + Record priority + +``--no-priority`` + +.. _designate_report-count-all: + +designate report-count-all +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate report-count-all [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] + +Get count totals for all tenants, domains and records + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_report-count-domains: + +designate report-count-domains +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate report-count-domains [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] + +Get counts for total domains + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_report-count-records: + +designate report-count-records +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate report-count-records [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] + +Get counts for total records + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_report-count-tenants: + +designate report-count-tenants +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate report-count-tenants [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] + +Get counts for total tenants + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_report-tenant-domains: + +designate report-tenant-domains +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate report-tenant-domains [-h] + [-f {csv,html,json,json,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] + [--quote {all,minimal,none,nonnumeric}] + --report-tenant-id REPORT_TENANT_ID + +Get a list of domains for given tenant + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--report-tenant-id REPORT_TENANT_ID`` + The tenant_id being reported on. + +.. _designate_report-tenants-all: + +designate report-tenants-all +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate report-tenants-all [-h] + [-f {csv,html,json,json,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] + [--quote {all,minimal,none,nonnumeric}] + +Get list of tenants and domain count for each + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_server-create: + +designate server-create +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate server-create [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] --name NAME + +Create Server + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--name NAME`` + Server name + +.. _designate_server-delete: + +designate server-delete +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate server-delete [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] + id + +Delete Server + +Positional arguments +-------------------- + +``id`` + Server ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_server-get: + +designate server-get +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate server-get [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + id + +Get Server + +Positional arguments +-------------------- + +``id`` + Server ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_server-list: + +designate server-list +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate server-list [-h] + [-f {csv,html,json,json,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--quote {all,minimal,none,nonnumeric}] + +List Servers + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_server-update: + +designate server-update +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate server-update [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] + [--noindent] [--prefix PREFIX] [--name NAME] + id + +Update Server + +Positional arguments +-------------------- + +``id`` + Server ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +``--name NAME`` + Server name + +.. _designate_sync-all: + +designate sync-all +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate sync-all [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + +Sync Everything + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_sync-domain: + +designate sync-domain +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate sync-domain [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + domain_id + +Sync a single Domain + +Positional arguments +-------------------- + +``domain_id`` + Domain ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_sync-record: + +designate sync-record +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate sync-record [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + domain_id record_id + +Sync a single Record + +Positional arguments +-------------------- + +``domain_id`` + Domain ID + +``record_id`` + Record ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + +.. _designate_touch-domain: + +designate touch-domain +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: designate touch-domain [-h] + [-f {html,json,json,shell,table,value,yaml,yaml}] + [-c COLUMN] [--max-width ] [--noindent] + [--prefix PREFIX] + domain_id + +Touch a single Domain + +Positional arguments +-------------------- + +``domain_id`` + Domain ID + +Optional arguments +------------------ + +``-h, --help`` + show this help message and exit + diff --git a/doc/cli-ref-rst/source/index.rst b/doc/cli-ref-rst/source/index.rst index da595d6426..b1b6f7e450 100644 --- a/doc/cli-ref-rst/source/index.rst +++ b/doc/cli-ref-rst/source/index.rst @@ -29,9 +29,13 @@ Contents magnum trove trove-misc + sahara + designate + monasca neutron-misc heat cloudkitty + manila ceilometer gnocchi mistral diff --git a/doc/cli-ref-rst/source/manila.rst b/doc/cli-ref-rst/source/manila.rst new file mode 100644 index 0000000000..112c1dce17 --- /dev/null +++ b/doc/cli-ref-rst/source/manila.rst @@ -0,0 +1,2632 @@ +.. ## 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.6.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 + +Show access list for share. + +Positional arguments +-------------------- + +```` + Name or ID of the share. + +.. _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 ] + +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. + +.. _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] + +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. + +.. _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 + +Print a list of current 'share types and extra specs' (Admin Only). + +.. _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 ] + +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. + +.. _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 + +Print a list of rate limits for a user. + +.. _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 ] + +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. + +.. _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 ] + +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. + +.. _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 ] + +List share instances. + +Optional arguments +------------------ + +``--share-id , --share_id `` + Filter results by share ID. + +.. _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 ] + +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. + +.. _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 + +Get list of security services associated with a given share network. + +Positional arguments +-------------------- + +```` + Share network name or ID. + +.. _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 ] + +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. + +.. _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 ] + +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. + +.. _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] + +Print a list of available 'share types'. + +Optional arguments +------------------ + +``--all`` + Display all share types (Admin only). + +.. _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. + diff --git a/doc/cli-ref-rst/source/monasca.rst b/doc/cli-ref-rst/source/monasca.rst new file mode 100644 index 0000000000..c79587ca7e --- /dev/null +++ b/doc/cli-ref-rst/source/monasca.rst @@ -0,0 +1,952 @@ +.. ## WARNING ###################################### +.. This file is automatically generated, do not edit +.. ################################################# + +============================== +Monitoring command-line client +============================== + +The monasca client is the command-line interface (CLI) for +the Monitoring API and its extensions. + +This chapter documents :command:`monasca` version ``1.0.27``. + +For help on a specific :command:`monasca` command, enter: + +.. code-block:: console + + $ monasca help COMMAND + +.. _monasca_command_usage: + +monasca usage +~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca [-j] [--version] [-d] [-v] [-k] [--cert-file CERT_FILE] + [--key-file KEY_FILE] [--os-cacert OS_CACERT] + [--keystone_timeout KEYSTONE_TIMEOUT] + [--os-username OS_USERNAME] [--os-password OS_PASSWORD] + [--os-user-domain-id OS_USER_DOMAIN_ID] + [--os-user-domain-name OS_USER_DOMAIN_NAME] + [--os-project-id OS_PROJECT_ID] + [--os-project-name OS_PROJECT_NAME] + [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] + [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] + [--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth] + [--monasca-api-url MONASCA_API_URL] + [--monasca-api-version MONASCA_API_VERSION] + [--os-service-type OS_SERVICE_TYPE] + [--os-endpoint-type OS_ENDPOINT_TYPE] + ... + + alarm-definition-create Create an alarm definition. + alarm-definition-delete Delete the alarm definition. + alarm-definition-list List alarm definitions for this tenant. + alarm-definition-patch Patch the alarm definition. + alarm-definition-show Describe the alarm definition. + alarm-definition-update Update the alarm definition. + alarm-delete Delete the alarm. + alarm-history Alarm state transition history. + alarm-history-list List alarms state history. + alarm-list List alarms for this tenant. + alarm-patch Patch the alarm state. + alarm-show Describe the alarm. + alarm-update Update the alarm state. + measurement-list List measurements for the specified metric. + metric-create Create metric. + metric-create-raw Create metric from raw json body. + metric-list List metrics for this tenant. + metric-statistics List measurement statistics for the specified + metric. + notification-create Create notification. + notification-delete Delete notification. + notification-list List notifications for this tenant. + notification-show Describe the notification. + notification-update Update notification. + bash-completion Prints all of the commands and options to stdout. + help Display help about this program or one of its + subcommands. + +.. _monasca_command_options: + +monasca optional arguments +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +``-j, --json`` + output raw json response + +``--version`` + Shows the client version and exits. + +``-d, --debug`` + Defaults to ``env[MONASCA_DEBUG]``. + +``-v, --verbose`` + Print more verbose output. + +``-k, --insecure`` + Explicitly allow the client to perform "insecure" + SSL (https) requests. The server's certificate + will not be verified against any certificate + authorities. This option should be used with + caution. + +``--cert-file CERT_FILE`` + Path of certificate file to use in SSL + connection. This file can optionally be prepended + with the private key. + +``--key-file KEY_FILE`` + Path of client key to use in SSL connection. This + option is not necessary if your key is prepended + to your cert file. + +``--os-cacert OS_CACERT`` + Specify a CA bundle file to use in verifying a + TLS (https) server certificate. Defaults to + ``env[OS_CACERT]``. Without either of these, the + client looks for the default system CA + certificates. + +``--keystone_timeout KEYSTONE_TIMEOUT`` + Number of seconds to wait for a response from + keystone. + +``--os-username OS_USERNAME`` + Defaults to ``env[OS_USERNAME]``. + +``--os-password OS_PASSWORD`` + Defaults to ``env[OS_PASSWORD]``. + +``--os-user-domain-id OS_USER_DOMAIN_ID`` + Defaults to ``env[OS_USER_DOMAIN_ID]``. + +``--os-user-domain-name OS_USER_DOMAIN_NAME`` + Defaults to ``env[OS_USER_DOMAIN_NAME]``. + +``--os-project-id OS_PROJECT_ID`` + Defaults to ``env[OS_PROJECT_ID]``. + +``--os-project-name OS_PROJECT_NAME`` + Defaults to ``env[OS_PROJECT_NAME]``. + +``--os-domain-id OS_DOMAIN_ID`` + Defaults to ``env[OS_DOMAIN_ID]``. + +``--os-domain-name OS_DOMAIN_NAME`` + Defaults to ``env[OS_DOMAIN_NAME]``. + +``--os-auth-url OS_AUTH_URL`` + Defaults to ``env[OS_AUTH_URL]``. + +``--os-region-name OS_REGION_NAME`` + Defaults to ``env[OS_REGION_NAME]``. + +``--os-auth-token OS_AUTH_TOKEN`` + Defaults to ``env[OS_AUTH_TOKEN]``. + +``--os-no-client-auth`` + Do not contact keystone for a token. Defaults to + ``env[OS_NO_CLIENT_AUTH]``. + +``--monasca-api-url MONASCA_API_URL`` + Defaults to ``env[MONASCA_API_URL]``. + +``--monasca-api-version MONASCA_API_VERSION`` + Defaults to ``env[MONASCA_API_VERSION]`` or 2_0 + +``--os-service-type OS_SERVICE_TYPE`` + Defaults to ``env[OS_SERVICE_TYPE]``. + +``--os-endpoint-type OS_ENDPOINT_TYPE`` + Defaults to ``env[OS_ENDPOINT_TYPE]``. + +.. _monasca_alarm-definition-create: + +monasca alarm-definition-create +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-definition-create [--description ] + [--severity ] + [--match-by ] + [--alarm-actions ] + [--ok-actions ] + [--undetermined-actions ] + + +Create an alarm definition. + +Positional arguments +-------------------- + +```` + Name of the alarm definition to create. + +```` + The alarm expression to evaluate. Quoted. + +Optional arguments +------------------ + +``--description `` + Description of the alarm. + +``--severity `` + Severity is one of [LOW, MEDIUM, HIGH, CRITICAL]. + +``--match-by `` + The metric dimensions to match to the alarm + dimensions. One or more dimension key names separated + by a comma. Key names need quoting when they contain + special chars [&,(,),{,},>,<] that confuse the CLI + parser. + +``--alarm-actions `` + The notification method to use when an alarm state is + ALARM. This param may be specified multiple times. + +``--ok-actions `` + The notification method to use when an alarm state is + OK. This param may be specified multiple times. + +``--undetermined-actions `` + The notification method to use when an alarm state is + UNDETERMINED. This param may be specified multiple + times. + +.. _monasca_alarm-definition-delete: + +monasca alarm-definition-delete +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-definition-delete + +Delete the alarm definition. + +Positional arguments +-------------------- + +```` + The ID of the alarm definition. + +.. _monasca_alarm-definition-list: + +monasca alarm-definition-list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-definition-list [--name ] + [--dimensions ] + [--offset ] + [--limit ] + +List alarm definitions for this tenant. + +Optional arguments +------------------ + +``--name `` + Name of the alarm definition. + +``--dimensions `` + key value pair used to specify a metric dimension. + This can be specified multiple times, or once with + parameters separated by a comma. Dimensions need + quoting when they contain special chars + [&,(,),{,},>,<] that confuse the CLI parser. + +``--offset `` + The offset used to paginate the return data. + +``--limit `` + The amount of data to be returned up to the API + maximum limit. + +.. _monasca_alarm-definition-patch: + +monasca alarm-definition-patch +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-definition-patch [--name ] + [--description ] + [--expression ] + [--alarm-actions ] + [--ok-actions ] + [--undetermined-actions ] + [--actions-enabled ] + [--severity ] + + +Patch the alarm definition. + +Positional arguments +-------------------- + +```` + The ID of the alarm definition. + +Optional arguments +------------------ + +``--name `` + Name of the alarm definition. + +``--description `` + Description of the alarm. + +``--expression `` + The alarm expression to evaluate. Quoted. + +``--alarm-actions `` + The notification method to use when an alarm state is + ALARM. This param may be specified multiple times. + +``--ok-actions `` + The notification method to use when an alarm state is + OK. This param may be specified multiple times. + +``--undetermined-actions `` + The notification method to use when an alarm state is + UNDETERMINED. This param may be specified multiple + times. + +``--actions-enabled `` + The actions-enabled boolean is one of [true,false] + +``--severity `` + Severity is one of [LOW, MEDIUM, HIGH, CRITICAL]. + +.. _monasca_alarm-definition-show: + +monasca alarm-definition-show +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-definition-show + +Describe the alarm definition. + +Positional arguments +-------------------- + +```` + The ID of the alarm definition. + +.. _monasca_alarm-definition-update: + +monasca alarm-definition-update +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-definition-update [--description ] + [--alarm-actions ] + [--ok-actions ] + [--undetermined-actions ] + [--match-by ] + [--severity ] + + + + +Update the alarm definition. + +Positional arguments +-------------------- + +```` + The ID of the alarm definition. + +```` + Name of the alarm definition. + +```` + The alarm expression to evaluate. Quoted. + +```` + The actions-enabled boolean is one of [true,false] + +Optional arguments +------------------ + +``--description `` + Description of the alarm. + +``--alarm-actions `` + The notification method to use when an alarm state is + ALARM. This param may be specified multiple times. + +``--ok-actions `` + The notification method to use when an alarm state is + OK. This param may be specified multiple times. + +``--undetermined-actions `` + The notification method to use when an alarm state is + UNDETERMINED. This param may be specified multiple + times. + +``--match-by `` + The metric dimensions to match to the alarm + dimensions. One or more dimension key names separated + by a comma. Key names need quoting when they contain + special chars [&,(,),{,},>,<] that confuse the CLI + parser. + +``--severity `` + Severity is one of [LOW, MEDIUM, HIGH, CRITICAL]. + +.. _monasca_alarm-delete: + +monasca alarm-delete +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-delete + +Delete the alarm. + +Positional arguments +-------------------- + +```` + The ID of the alarm. + +.. _monasca_alarm-history: + +monasca alarm-history +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-history [--offset ] + [--limit ] + + +Alarm state transition history. + +Positional arguments +-------------------- + +```` + The ID of the alarm. + +Optional arguments +------------------ + +``--offset `` + The offset used to paginate the return data. + +``--limit `` + The amount of data to be returned up to the API + maximum limit. + +.. _monasca_alarm-history-list: + +monasca alarm-history-list +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-history-list [--dimensions ] + [--starttime ] + [--endtime ] + [--offset ] + [--limit ] + +List alarms state history. + +Optional arguments +------------------ + +``--dimensions `` + key value pair used to specify a metric dimension. + This can be specified multiple times, or once with + parameters separated by a comma. Dimensions need + quoting when they contain special chars + [&,(,),{,},>,<] that confuse the CLI parser. + +``--starttime `` + measurements >= UTC time. format: + 2014-01-01T00:00:00Z. OR format: -120 (for previous 2 + hours) + +``--endtime `` + measurements <= UTC time. format: + 2014-01-01T00:00:00Z. + +``--offset `` + The offset used to paginate the return data. + +``--limit `` + The amount of data to be returned up to the API + maximum limit. + +.. _monasca_alarm-list: + +monasca alarm-list +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-list [--alarm-definition-id ] + [--metric-name ] + [--metric-dimensions ] + [--state ] + [--state-updated-start-time ] + [--lifecycle-state ] + [--link ] [--offset ] + [--limit ] + +List alarms for this tenant. + +Optional arguments +------------------ + +``--alarm-definition-id `` + The ID of the alarm definition. + +``--metric-name `` + Name of the metric. + +``--metric-dimensions `` + key value pair used to specify a metric dimension. + This can be specified multiple times, or once with + parameters separated by a comma. Dimensions need + quoting when they contain special chars + [&,(,),{,},>,<] that confuse the CLI parser. + +``--state `` + ALARM_STATE is one of [UNDETERMINED, OK, ALARM]. + +``--state-updated-start-time `` + Return all alarms whose state was updated on or after + the time specified + +``--lifecycle-state `` + The lifecycle state of the alarm + +``--link `` + The link to external data associated with the alarm + +``--offset `` + The offset used to paginate the return data. + +``--limit `` + The amount of data to be returned up to the API + maximum limit. + +.. _monasca_alarm-patch: + +monasca alarm-patch +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-patch [--state ] + [--lifecycle-state ] + [--link ] + + +Patch the alarm state. + +Positional arguments +-------------------- + +```` + The ID of the alarm. + +Optional arguments +------------------ + +``--state `` + ALARM_STATE is one of [UNDETERMINED, OK, ALARM]. + +``--lifecycle-state `` + The lifecycle state of the alarm + +``--link `` + A link to an external resource with information about + the alarm + +.. _monasca_alarm-show: + +monasca alarm-show +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-show + +Describe the alarm. + +Positional arguments +-------------------- + +```` + The ID of the alarm. + +.. _monasca_alarm-update: + +monasca alarm-update +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca alarm-update + +Update the alarm state. + +Positional arguments +-------------------- + +```` + The ID of the alarm. + +```` + ALARM_STATE is one of [UNDETERMINED, OK, ALARM]. + +```` + The lifecycle state of the alarm + +```` + A link to an external resource with information about the + alarm + +.. _monasca_measurement-list: + +monasca measurement-list +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca measurement-list [--dimensions ] + [--endtime ] + [--offset ] + [--limit ] [--merge_metrics] + + +List measurements for the specified metric. + +Positional arguments +-------------------- + +```` + Name of the metric to list measurements. + +```` + measurements >= UTC time. format: + 2014-01-01T00:00:00Z. OR Format: -120 (previous 120 + minutes + +Optional arguments +------------------ + +``--dimensions `` + key value pair used to specify a metric dimension. + This can be specified multiple times, or once with + parameters separated by a comma. Dimensions need + quoting when they contain special chars + [&,(,),{,},>,<] that confuse the CLI parser. + +``--endtime `` + measurements <= UTC time. format: + 2014-01-01T00:00:00Z. + +``--offset `` + The offset used to paginate the return data. + +``--limit `` + The amount of data to be returned up to the API + maximum limit. + +``--merge_metrics`` + Merge multiple metrics into a single result. + +.. _monasca_metric-create: + +monasca metric-create +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca metric-create [--dimensions ] + [--value-meta ] + [--time ] + [--project-id ] + + +Create metric. + +Positional arguments +-------------------- + +```` + Name of the metric to create. + +```` + Metric value. + +Optional arguments +------------------ + +``--dimensions `` + key value pair used to create a metric dimension. This + can be specified multiple times, or once with + parameters separated by a comma. Dimensions need + quoting when they contain special chars + [&,(,),{,},>,<] that confuse the CLI parser. + +``--value-meta `` + key value pair for extra information about a value. + This can be specified multiple times, or once with + parameters separated by a comma. value_meta need + quoting when they contain special chars + [&,(,),{,},>,<] that confuse the CLI parser. + +``--time `` + Metric timestamp in milliseconds. Default: current + timestamp. + +``--project-id `` + The Project ID to create metric on behalf of. Requires + monitoring-delegate role in keystone. + +.. _monasca_metric-create-raw: + +monasca metric-create-raw +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca metric-create-raw + +Create metric from raw json body. + +Positional arguments +-------------------- + +```` + The raw JSON body in single quotes. See api doc. + +.. _monasca_metric-list: + +monasca metric-list +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca metric-list [--name ] + [--dimensions ] + [--starttime ] + [--endtime ] + [--offset ] + [--limit ] + +List metrics for this tenant. + +Optional arguments +------------------ + +``--name `` + Name of the metric to list. + +``--dimensions `` + key value pair used to specify a metric dimension. + This can be specified multiple times, or once with + parameters separated by a comma. Dimensions need + quoting when they contain special chars + [&,(,),{,},>,<] that confuse the CLI parser. + +``--starttime `` + measurements >= UTC time. format: + 2014-01-01T00:00:00Z. OR Format: -120 (previous 120 + minutes + +``--endtime `` + measurements <= UTC time. format: + 2014-01-01T00:00:00Z. + +``--offset `` + The offset used to paginate the return data. + +``--limit `` + The amount of data to be returned up to the API + maximum limit. + +.. _monasca_metric-statistics: + +monasca metric-statistics +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca metric-statistics [--dimensions ] + [--endtime ] + [--period ] + [--offset ] + [--limit ] [--merge_metrics] + + +List measurement statistics for the specified metric. + +Positional arguments +-------------------- + +```` + Name of the metric to report measurement statistics. + +```` + Statistics is one or more (separated by commas) of + [AVG, MIN, MAX, COUNT, SUM]. + +```` + measurements >= UTC time. format: + 2014-01-01T00:00:00Z. OR Format: -120 (previous 120 + minutes + +Optional arguments +------------------ + +``--dimensions `` + key value pair used to specify a metric dimension. + This can be specified multiple times, or once with + parameters separated by a comma. Dimensions need + quoting when they contain special chars + [&,(,),{,},>,<] that confuse the CLI parser. + +``--endtime `` + measurements <= UTC time. format: + 2014-01-01T00:00:00Z. + +``--period `` + number of seconds per interval (default is 300) + +``--offset `` + The offset used to paginate the return data. + +``--limit `` + The amount of data to be returned up to the API + maximum limit. + +``--merge_metrics`` + Merge multiple metrics into a single result. + +.. _monasca_notification-create: + +monasca notification-create +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca notification-create
+ +Create notification. + +Positional arguments +-------------------- + +```` + Name of the notification to create. + +```` + The notification type. Type must be EMAIL, WEBHOOK, or + PAGERDUTY. + +``
`` + A valid EMAIL Address, URL, or SERVICE KEY + +.. _monasca_notification-delete: + +monasca notification-delete +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca notification-delete + +Delete notification. + +Positional arguments +-------------------- + +```` + The ID of the notification. + +.. _monasca_notification-list: + +monasca notification-list +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca notification-list [--offset ] + [--limit ] + +List notifications for this tenant. + +Optional arguments +------------------ + +``--offset `` + The offset used to paginate the return data. + +``--limit `` + The amount of data to be returned up to the API + maximum limit. + +.. _monasca_notification-show: + +monasca notification-show +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca notification-show + +Describe the notification. + +Positional arguments +-------------------- + +```` + The ID of the notification. If not specified returns all. + +.. _monasca_notification-update: + +monasca notification-update +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: monasca notification-update +
+ +Update notification. + +Positional arguments +-------------------- + +```` + The ID of the notification. + +```` + Name of the notification. + +```` + The notification type. Type must be either EMAIL, + WEBHOOK, or PAGERDUTY. + +``
`` + A valid EMAIL Address, URL, or SERVICE KEY + diff --git a/doc/cli-ref-rst/source/sahara.rst b/doc/cli-ref-rst/source/sahara.rst new file mode 100644 index 0000000000..a4beef4f36 --- /dev/null +++ b/doc/cli-ref-rst/source/sahara.rst @@ -0,0 +1,1202 @@ +.. ## WARNING ###################################### +.. This file is automatically generated, do not edit +.. ################################################# + +=========================================== +Data Processing service command-line client +=========================================== + +The sahara client is the command-line interface (CLI) for +the Data Processing service API and its extensions. + +This chapter documents :command:`sahara` version ``0.11.1``. + +For help on a specific :command:`sahara` command, enter: + +.. code-block:: console + + $ sahara help COMMAND + +.. _sahara_command_usage: + +sahara usage +~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara [--version] [--debug] [--os-cache] [--region-name ] + [--service-type ] + [--endpoint-type ] + [--sahara-api-version ] + [--bypass-url ] [--os-tenant-name OS_TENANT_NAME] + [--os-tenant-id OS_TENANT_ID] [--os-auth-system OS_AUTH_SYSTEM] + [--os-auth-token OS_AUTH_TOKEN] [--insecure] + [--os-cacert ] [--os-cert ] + [--os-key ] [--timeout ] + [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] + [--os-domain-name OS_DOMAIN_NAME] + [--os-project-id OS_PROJECT_ID] + [--os-project-name OS_PROJECT_NAME] + [--os-project-domain-id OS_PROJECT_DOMAIN_ID] + [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] + [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] + [--os-username OS_USERNAME] + [--os-user-domain-id OS_USER_DOMAIN_ID] + [--os-user-domain-name OS_USER_DOMAIN_NAME] + [--os-password OS_PASSWORD] + ... + +Subcommands +----------- + +``cluster-create`` + Create a cluster. + +``cluster-delete`` + Delete a cluster. + +``cluster-list`` + Print a list of available clusters. + +``cluster-scale`` + Scale a cluster. + +``cluster-show`` + Show details of a cluster. + +``cluster-template-create`` + Create a cluster template. + +``cluster-template-delete`` + Delete a cluster template. + +``cluster-template-list`` + Print a list of available cluster templates. + +``cluster-template-show`` + Show details of a cluster template. + +``cluster-template-update`` + Update a cluster template. + +``data-source-create`` + Create a data source that provides job input or + receives job output. + +``data-source-delete`` + Delete a data source. + +``data-source-list`` + Print a list of available data sources. + +``data-source-show`` + Show details of a data source. + +``data-source-update`` + Update a data source. + +``image-add-tag`` + Add a tag to an image. + +``image-list`` + Print a list of available images. + +``image-register`` + Register an image from the Image index. + +``image-remove-tag`` + Remove a tag from an image. + +``image-show`` + Show details of an image. + +``image-unregister`` + Unregister an image. + +``job-binary-create`` + Record a job binary. + +``job-binary-data-create`` + Store data in the internal DB. Use 'swift upload' + instead of this command. Use this command only if + Swift is not available. + +``job-binary-data-delete`` + Delete an internally stored job binary data. + +``job-binary-data-list`` + Print a list of internally stored job binary data. + +``job-binary-delete`` + Delete a job binary. + +``job-binary-list`` + Print a list of job binaries. + +``job-binary-show`` + Show details of a job binary. + +``job-binary-update`` + Update a job binary. + +``job-create`` + Create a job. + +``job-delete`` + Delete a job. + +``job-list`` + Print a list of jobs. + +``job-show`` + Show details of a job. + +``job-template-create`` + Create a job template. + +``job-template-delete`` + Delete a job template. + +``job-template-list`` + Print a list of job templates. + +``job-template-show`` + Show details of a job template. + +``job-type-list`` + Show supported job types. + +``node-group-template-create`` + Create a node group template. + +``node-group-template-delete`` + Delete a node group template. + +``node-group-template-list`` + Print a list of available node group templates. + +``node-group-template-show`` + Show details of a node group template. + +``node-group-template-update`` + Update a node group template. + +``plugin-list`` + Print a list of available plugins. + +``plugin-show`` + Show details of a plugin. + +``bash-completion`` + Prints arguments for bash-completion. Prints all of + the commands and options to stdout so that the + sahara.bash_completion script doesn't have to hard + code them. + +``help`` + Display help about this program or one of its + subcommands. + +.. _sahara_command_options: + +sahara optional arguments +~~~~~~~~~~~~~~~~~~~~~~~~~ + +``--version`` + show program's version number and exit + +``--debug`` + Print debugging output. + +``--os-cache`` + Use the auth token cache. Defaults to False if + ``env[OS_CACHE]`` is not set. + +``--region-name `` + Defaults to ``env[OS_REGION_NAME]``. + +``--service-type `` + Defaults to data-processing for all actions. + +``--endpoint-type `` + Defaults to ``env[SAHARA_ENDPOINT_TYPE]`` or + ``env[OS_ENDPOINT_TYPE]`` or publicURL. + +``--sahara-api-version `` + Accepts "api", defaults to ``env[SAHARA_API_VERSION]``. + +``--bypass-url `` + Use this API endpoint instead of the Service Catalog. + +``--os-tenant-name OS_TENANT_NAME`` + Defaults to ``env[OS_TENANT_NAME]``. + +``--os-tenant-id OS_TENANT_ID`` + Defaults to ``env[OS_TENANT_ID]``. + +``--os-auth-system OS_AUTH_SYSTEM`` + Defaults to ``env[OS_AUTH_SYSTEM]``. + +``--os-auth-token OS_AUTH_TOKEN`` + Defaults to ``env[OS_AUTH_TOKEN]``. + +``--insecure`` + Explicitly allow client to perform "insecure" TLS + (https) requests. The server's certificate will not be + verified against any certificate authorities. This + option should be used with caution. + +``--os-cacert `` + Specify a CA bundle file to use in verifying a TLS + (https) server certificate. Defaults to + ``env[OS_CACERT]``. + +``--os-cert `` + Defaults to ``env[OS_CERT]``. + +``--os-key `` + Defaults to ``env[OS_KEY]``. + +``--timeout `` + Set request timeout (in seconds). + +``--os-auth-url OS_AUTH_URL`` + Authentication URL + +``--os-domain-id OS_DOMAIN_ID`` + Domain ID to scope to + +``--os-domain-name OS_DOMAIN_NAME`` + Domain name to scope to + +``--os-project-id OS_PROJECT_ID`` + Project ID to scope to + +``--os-project-name OS_PROJECT_NAME`` + Project name to scope to + +``--os-project-domain-id OS_PROJECT_DOMAIN_ID`` + Domain ID containing project + +``--os-project-domain-name OS_PROJECT_DOMAIN_NAME`` + Domain name containing project + +``--os-trust-id OS_TRUST_ID`` + Trust ID + +``--os-user-id OS_USER_ID`` + User ID + +``--os-username OS_USERNAME, --os-user_name OS_USERNAME`` + Username + +``--os-user-domain-id OS_USER_DOMAIN_ID`` + User's domain id + +``--os-user-domain-name OS_USER_DOMAIN_NAME`` + User's domain name + +``--os-password OS_PASSWORD`` + User's password + +.. _sahara_cluster-create: + +sahara cluster-create +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-create [--json JSON] [--count COUNT] + +Create a cluster. + +Optional arguments +------------------ + +``--json JSON`` + JSON representation of cluster. + +``--count COUNT`` + Number of clusters to create. + +.. _sahara_cluster-delete: + +sahara cluster-delete +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-delete [--name NAME] [--id ] + +Delete a cluster. + +Optional arguments +------------------ + +``--name NAME`` + Name of the cluster. + +``--id `` + ID of the cluster to delete. + +.. _sahara_cluster-list: + +sahara cluster-list +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-list + +Print a list of available clusters. + +.. _sahara_cluster-scale: + +sahara cluster-scale +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-scale [--name NAME] [--id ] [--json JSON] + +Scale a cluster. + +Optional arguments +------------------ + +``--name NAME`` + Name of the cluster. + +``--id `` + ID of the cluster. + +``--json JSON`` + JSON representation of cluster scale. + +.. _sahara_cluster-show: + +sahara cluster-show +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-show [--name NAME] [--id ] + [--show-progress SHOW_PROGRESS] [--json] + +Show details of a cluster. + +Optional arguments +------------------ + +``--name NAME`` + Name of the cluster. + +``--id `` + ID of the cluster to show. + +``--show-progress SHOW_PROGRESS`` + Show provision progress events of the cluster. + +``--json`` + Print JSON representation of the cluster. + +.. _sahara_cluster-template-create: + +sahara cluster-template-create +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-template-create [--json JSON] + +Create a cluster template. + +Optional arguments +------------------ + +``--json JSON`` + JSON representation of cluster template. + +.. _sahara_cluster-template-delete: + +sahara cluster-template-delete +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-template-delete [--name NAME] [--id ] + +Delete a cluster template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the cluster template. + +``--id `` + ID of the cluster template to delete. + +.. _sahara_cluster-template-list: + +sahara cluster-template-list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-template-list + +Print a list of available cluster templates. + +.. _sahara_cluster-template-show: + +sahara cluster-template-show +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-template-show [--name NAME] [--id ] + [--json] + +Show details of a cluster template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the cluster template. + +``--id `` + ID of the cluster template to show. + +``--json`` + Print JSON representation of cluster template. + +.. _sahara_cluster-template-update: + +sahara cluster-template-update +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara cluster-template-update [--name NAME] [--id ] + [--json JSON] + +Update a cluster template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the cluster template to update. + +``--id `` + ID of the cluster template to update. + +``--json JSON`` + JSON representation of cluster template update. + +.. _sahara_data-source-create: + +sahara data-source-create +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara data-source-create --name NAME --type TYPE --url URL + [--description DESCRIPTION] [--user USER] + [--password PASSWORD] + +Create a data source that provides job input or receives job output. + +Optional arguments +------------------ + +``--name NAME`` + Name of the data source. + +``--type TYPE`` + Type of the data source. + +``--url URL`` + URL for the data source. + +``--description DESCRIPTION`` + Description of the data source. + +``--user USER`` + Username for accessing the data source URL. + +``--password PASSWORD`` + Password for accessing the data source URL. + +.. _sahara_data-source-delete: + +sahara data-source-delete +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara data-source-delete [--name NAME] [--id ID] + +Delete a data source. + +Optional arguments +------------------ + +``--name NAME`` + Name of the data source. + +``--id ID`` + ID of data source to delete. + +.. _sahara_data-source-list: + +sahara data-source-list +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara data-source-list + +Print a list of available data sources. + +.. _sahara_data-source-show: + +sahara data-source-show +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara data-source-show [--name NAME] [--id ID] + +Show details of a data source. + +Optional arguments +------------------ + +``--name NAME`` + Name of the data source. + +``--id ID`` + ID of the data source. + +.. _sahara_data-source-update: + +sahara data-source-update +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara data-source-update [--name NAME] [--id ID] [--json JSON] + +Update a data source. + +Optional arguments +------------------ + +``--name NAME`` + Name of the data source to update. + +``--id ID`` + ID of the data source to update. + +``--json JSON`` + JSON containing the data source fields to update. + +.. _sahara_image-add-tag: + +sahara image-add-tag +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara image-add-tag [--name NAME] [--id ] --tag + +Add a tag to an image. + +Optional arguments +------------------ + +``--name NAME`` + Name of the image. + +``--id `` + ID of image to tag. + +``--tag `` + Tag to add. + +.. _sahara_image-list: + +sahara image-list +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara image-list + +Print a list of available images. + +.. _sahara_image-register: + +sahara image-register +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara image-register --id [--username ] + [--description ] + +Register an image from the Image index. + +Optional arguments +------------------ + +``--id `` + ID of image, run "glance image-list" to see all IDs. + +``--username `` + Username of privileged user in the image. + +``--description `` + Description of the image. + +.. _sahara_image-remove-tag: + +sahara image-remove-tag +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara image-remove-tag [--name NAME] [--id ] --tag + +Remove a tag from an image. + +Optional arguments +------------------ + +``--name NAME`` + Name of the image. + +``--id `` + Image to tag. + +``--tag `` + Tag to remove. + +.. _sahara_image-show: + +sahara image-show +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara image-show [--name NAME] [--id ] + +Show details of an image. + +Optional arguments +------------------ + +``--name NAME`` + Name of the image. + +``--id `` + ID of the image. + +.. _sahara_image-unregister: + +sahara image-unregister +~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara image-unregister [--name NAME] [--id ] + +Unregister an image. + +Optional arguments +------------------ + +``--name NAME`` + Name of the image. + +``--id `` + ID of image to unregister. + +.. _sahara_job-binary-create: + +sahara job-binary-create +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-binary-create --name NAME --url URL + [--description DESCRIPTION] [--user USER] + [--password PASSWORD] + +Record a job binary. + +Optional arguments +------------------ + +``--name NAME`` + Name of the job binary. + +``--url URL`` + URL for the job binary. + +``--description DESCRIPTION`` + Description of the job binary. + +``--user USER`` + Username for accessing the job binary URL. + +``--password PASSWORD`` + Password for accessing the job binary URL. + +.. _sahara_job-binary-data-create: + +sahara job-binary-data-create +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-binary-data-create [--file FILE] [--name NAME] + +Store data in the internal DB. Use 'swift upload' instead of this command. Use +this command only if Swift is not available. + +Optional arguments +------------------ + +``--file FILE`` + Data to store. + +``--name NAME`` + Name of the job binary internal. + +.. _sahara_job-binary-data-delete: + +sahara job-binary-data-delete +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-binary-data-delete --id ID + +Delete an internally stored job binary data. + +Optional arguments +------------------ + +``--id ID`` + ID of internally stored job binary data. + +.. _sahara_job-binary-data-list: + +sahara job-binary-data-list +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-binary-data-list + +Print a list of internally stored job binary data. + +.. _sahara_job-binary-delete: + +sahara job-binary-delete +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-binary-delete [--name NAME] [--id ID] + +Delete a job binary. + +Optional arguments +------------------ + +``--name NAME`` + Name of the job binary. + +``--id ID`` + ID of the job binary to delete. + +.. _sahara_job-binary-list: + +sahara job-binary-list +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-binary-list + +Print a list of job binaries. + +.. _sahara_job-binary-show: + +sahara job-binary-show +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-binary-show [--name NAME] [--id ID] + +Show details of a job binary. + +Optional arguments +------------------ + +``--name NAME`` + Name of the job binary. + +``--id ID`` + ID of the job binary. + +.. _sahara_job-binary-update: + +sahara job-binary-update +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-binary-update [--name NAME] [--id ] + [--json JSON] + +Update a job binary. + +Optional arguments +------------------ + +``--name NAME`` + Name of the job binary to update. + +``--id `` + ID of the job binary to update. + +``--json JSON`` + JSON representation of job binary update. + +.. _sahara_job-create: + +sahara job-create +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-create --job-template JOB_TEMPLATE [--cluster CLUSTER] + [--input-data INPUT_DATA] [--output-data OUTPUT_DATA] + [--param name=value] [--arg ARG] + [--config name=value] [--json JSON] + +Create a job. + +Optional arguments +------------------ + +``--job-template JOB_TEMPLATE`` + ID of the job template to run. + +``--cluster CLUSTER`` + ID of the cluster to run the job in. + +``--input-data INPUT_DATA`` + ID of the input data source. + +``--output-data OUTPUT_DATA`` + ID of the output data source. + +``--param`` + name=value Parameters to add to the job, repeatable. + +``--arg ARG`` + Arguments to add to the job, repeatable. + +``--config`` + name=value Config parameters to add to the job, repeatable. + +``--json JSON`` + JSON representation of the job. + +.. _sahara_job-delete: + +sahara job-delete +~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-delete --id ID + +Delete a job. + +Optional arguments +------------------ + +``--id ID`` + ID of a job. + +.. _sahara_job-list: + +sahara job-list +~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-list + +Print a list of jobs. + +.. _sahara_job-show: + +sahara job-show +~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-show --id ID + +Show details of a job. + +Optional arguments +------------------ + +``--id ID`` + ID of the job. + +.. _sahara_job-template-create: + +sahara job-template-create +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-template-create [--name NAME] [--type TYPE] [--main MAIN] + [--lib LIB] [--description DESCRIPTION] + [--json JSON] + +Create a job template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the job template. + +``--type TYPE`` + Type of the job template. + +``--main MAIN`` + ID for job's main job-binary. + +``--lib LIB`` + ID of job's lib job-binary, repeatable. + +``--description DESCRIPTION`` + Description of the job template. + +``--json JSON`` + JSON representation of job template. + +.. _sahara_job-template-delete: + +sahara job-template-delete +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-template-delete [--name NAME] [--id ID] + +Delete a job template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the job template. + +``--id ID`` + ID of the job template. + +.. _sahara_job-template-list: + +sahara job-template-list +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-template-list + +Print a list of job templates. + +.. _sahara_job-template-show: + +sahara job-template-show +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-template-show [--name NAME] [--id ID] + +Show details of a job template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the job template. + +``--id ID`` + ID of the job template. + +.. _sahara_job-type-list: + +sahara job-type-list +~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara job-type-list [--type ] [--plugin ] + [--plugin-version ] + +Show supported job types. + +Optional arguments +------------------ + +``--type `` + Report only on this job type. + +``--plugin `` + Report only job types supported by this plugin. + +``--plugin-version `` + Report only on job types supported by this version of + a specified plugin. Only valid with :option:`--plugin`. + +.. _sahara_node-group-template-create: + +sahara node-group-template-create +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara node-group-template-create [--json JSON] + +Create a node group template. + +Optional arguments +------------------ + +``--json JSON`` + JSON representation of node group template. + +.. _sahara_node-group-template-delete: + +sahara node-group-template-delete +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara node-group-template-delete [--name NAME] [--id ] + +Delete a node group template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the node group template. + +``--id `` + ID of the node group template to delete. + +.. _sahara_node-group-template-list: + +sahara node-group-template-list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara node-group-template-list + +Print a list of available node group templates. + +.. _sahara_node-group-template-show: + +sahara node-group-template-show +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara node-group-template-show [--name NAME] [--id ] + [--json] + +Show details of a node group template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the node group template. + +``--id `` + ID of the node group template to show. + +``--json`` + Print JSON representation of node group template. + +.. _sahara_node-group-template-update: + +sahara node-group-template-update +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara node-group-template-update [--name NAME] [--id ] + [--json JSON] + +Update a node group template. + +Optional arguments +------------------ + +``--name NAME`` + Name of the node group template to update. + +``--id `` + ID of the node group template to update. + +``--json JSON`` + JSON representation of the node group template update. + +.. _sahara_plugin-list: + +sahara plugin-list +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara plugin-list + +Print a list of available plugins. + +.. _sahara_plugin-show: + +sahara plugin-show +~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: sahara plugin-show --name + +Show details of a plugin. + +Optional arguments +------------------ + +``--name `` + Name of the plugin. +