diff --git a/RELEASENOTES.rst b/RELEASENOTES.rst index 6befeac3c8..de13cefecc 100644 --- a/RELEASENOTES.rst +++ b/RELEASENOTES.rst @@ -41,6 +41,11 @@ Virtual Machine Image Guide * RST conversion finished. +Command-Line Interface Reference +-------------------------------- + +* RST conversion finished. + Architecture Design Guide ------------------------- diff --git a/doc-tools-check-languages.conf b/doc-tools-check-languages.conf index c787e75795..701ade1810 100644 --- a/doc-tools-check-languages.conf +++ b/doc-tools-check-languages.conf @@ -35,7 +35,6 @@ declare -A SPECIAL_BOOKS=( ["user-guide-admin"]="RST" # Do not translate ["cli-reference"]="skip" - ["cli-ref-rst"]="skip" ["common"]="skip" ["contributor-guide"]="skip" # Skip arch design while its being revised diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml deleted file mode 100644 index 36e7fe8432..0000000000 --- a/doc/cli-reference/bk-cli-reference.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - OpenStack Command-Line Interface Reference - - CLI Reference - - - - - - - - OpenStack Foundation - - - - 2014 - 2015 - OpenStack Foundation - - current - OpenStack - - - - Remaining licensing details are filled in by - the template. - - - - This guide documents the OpenStack command-line - clients. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/cli-reference/ch_cli.xml b/doc/cli-reference/ch_cli.xml deleted file mode 100644 index 59745e3374..0000000000 --- a/doc/cli-reference/ch_cli.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - OpenStack command-line clients overview - - - - - - - - - diff --git a/doc/cli-reference/ch_cli_neutron_misc_commands.xml b/doc/cli-reference/ch_cli_neutron_misc_commands.xml deleted file mode 100644 index c1a008dcf1..0000000000 --- a/doc/cli-reference/ch_cli_neutron_misc_commands.xml +++ /dev/null @@ -1,669 +0,0 @@ - - - - - - - - miscellaneous networking command-line client - -
- - neutron-debug command-line client - The neutron-debug client is an extension - to the neutron command-line interface (CLI) for the OpenStack - neutron-debug tool. This chapter documents - neutron-debug version 2.3.0. - For help on a specific neutron-debug - command, enter: - $ neutron-debug COMMAND -
- neutron-debug usage - [--os-password <auth-password>] - [--os-tenant-name <auth-tenant-name>] - [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] - [--os-region-name <region-name>] [--service-type <service-type>] - [--service-name <service-name>] - [--volume-service-name <volume-service-name>] - [--endpoint-type <endpoint-type>] - [--os-volume-api-version <volume-api-ver>] - [--os-cacert <ca-certificate>] [--retries <retries>] - <subcommand> ... - - - Subcommands - - probe-create - - - Create probe port - create port and interface within a network namespace. - - - - - probe-list - - - List all probes. - - - - - probe-clear - - - Clear all probes. - - - - - probe-delete - - - Delete probe - delete port then delete the namespace. - - - - - probe-exec - - - Execute commands in the namespace of the probe. - - - - - ping-all - - - ping-all is an all-in-one command to ping all fixed IPs in a specified network. - - - - -
-
- neutron-debug optional arguments - - - --version - - Show version number and exit. - - - - -v, --verbose, --debug - - Increase verbosity of output and show tracebacks on - errors. Can be repeated. - - - - -q, --quiet - - Suppress output except warnings and errors - - - - -h, --help - - Show this help message and exit - - - - --os-auth-strategy - <auth-strategy> - - Authentication strategy (Env: OS_AUTH_STRATEGY, - default keystone). For now, any other value will disable - the authentication - - - - --os-auth-url <auth-url> - - Authentication URL (Env: OS_AUTH_URL) - - - - --os-tenant-name - <auth-tenant-name> - - Authentication tenant name (Env: OS_TENANT_NAME) - - - - - --os-tenant-id - <auth-tenant-id> - - Authentication tenant name (Env: OS_TENANT_ID) - - - - - --os-username - <auth-username> - - Authentication username (Env: OS_USERNAME) - - - - --os-password - <auth-password> - - Authentication password (Env: OS_PASSWORD) - - - - --os-region-name - <auth-region-name> - - Authentication region name (Env: OS_REGION_NAME) - - - - - --os-token <token> - - Defaults to env[OS_TOKEN] - - - - - --endpoint-type - <endpoint-type> - - Defaults to env[OS_ENDPOINT_TYPE] or - public URL. - - - - --os-url <url> - - Defaults to env[OS_URL] - - - - - --os-cacert - <ca-certificate> - - Specify a CA bundle file to use in verifying a TLS - (HTTPS) server certificate. Defaults to - env[OS_CACERT] - - - - - --insecure - - Explicitly allow neutron-debug 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. - - - - --config-file CONFIG_FILE - - Config file for interface driver (You may also use - l3_agent.ini) - - - -
-
- neutron-debug probe-create command - usage: neutron-debug probe-create NET - Create probe port - create port and interface, then - place it into the created network namespace. - Positional arguments - - NET ID - - ID of the network in which the probe will be - created. - - - -
-
- neutron-debug probe-list command - usage: neutron-debug probe-list - List probes. -
-
- neutron-debug probe-clear command - usage: neutron-debug probe-clear - Clear all probes. -
-
- neutron-debug probe-delete command - usage: neutron-debug probe-delete <port-id> - -Remove a probe. - - Positional arguments - - <port-id> - - ID of the probe to delete. - - - -
-
- neutron-debug probe-exec command - usage: neutron-debug probe-exec <port-id> <command> - Execute commands in the namespace of the probe -
-
- neutron-debug ping-all command - usage: neutron-debug ping-all <port-id> --timeout <number - All-in-one command to ping all fixed IPs - in a specified network. A probe creation is not needed - for this command. A new probe is created automatically. It will, - however, need to be deleted manually when it is no longer needed. - When there are multiple networks, the newly created probe will be - attached to a random network and thus the ping will take - place from within that random network. - - Positional arguments - - <port-id> - - ID of the port to use. - - - - - Optional arguments - - --timeout <timeout in - seconds> - - Optional ping timeout. - - - -
-
- neutron-debug example - usage: neutron-debug create-probe < NET_ID> - Create a probe namespace within the network identified - by NET_ID. The namespace will have the name of qprobe-<UUID - of the probe port> - For the following examples to function, the security group rules - may need to be modified to allow the SSH (TCP port 22) or ping - (ICMP) traffic into network. - usage: neutron-debug probe-exec <probe ID> "ssh <IP of instance>" - SSH to an instance within the network. - usage: neutron-debug ping-all <network ID>" - Ping all instances on this network to verify they are - responding. - usage: neutron-debug probe-exec <probe_ID> dhcping <VM_MAC address> -s <IP of DHCP server>" - Ping the DHCP server for this network using dhcping to - verify it is working. -
-
-
- neutron-sanity-check command-line client - The neutron-sanity-check client is a tool - that checks various sanity about the Networking service. This chapter - documents neutron-sanity-check version 7.0.2. -
- neutron-sanity-check usage - usage: neutron-sanity-check [-h] [--arp_header_match] [--arp_responder] - [--config-dir DIR] [--config-file PATH] [--debug] - [--dibbler_version] [--dnsmasq_version] - [--ebtables_installed] [--icmpv6_header_match] - [--iproute2_vxlan] [--keepalived_ipv6_support] - [--log-config-append PATH] - [--log-date-format DATE_FORMAT] - [--log-dir LOG_DIR] [--log-file PATH] - [--log-format FORMAT] [--noarp_header_match] - [--noarp_responder] [--nodebug] - [--nodibbler_version] [--nodnsmasq_version] - [--noebtables_installed] [--noicmpv6_header_match] - [--noiproute2_vxlan] [--nokeepalived_ipv6_support] - [--nonova_notify] [--noovs_geneve] [--noovs_patch] - [--noovs_vxlan] [--noovsdb_native] - [--noread_netns] [--nouse-syslog] - [--nouse-syslog-rfc-format] [--nova_notify] - [--noverbose] [--novf_management] [--ovs_geneve] - [--ovs_patch] [--ovs_vxlan] [--ovsdb_native] - [--read_netns] [--state_path STATE_PATH] - [--syslog-log-facility SYSLOG_LOG_FACILITY] - [--use-syslog] [--use-syslog-rfc-format] - [--verbose] [--version] [--vf_management] -
-
- neutron-sanity-check optional arguments - - - -h, --help - - show this help message and exit - - - - --arp_header_match - - Check for ARP header match support - - - - --arp_responder - - Check for ARP responder support - - - - --config-dir DIR - - Path to a config directory to pull *.conf files from. - This file set is sorted, so as to provide a - predictable parse order if individual options are - over-ridden. The set is parsed after the file(s) - specified via previous --config-file, arguments hence - over-ridden options in the directory take precedence. - - - - --config-file PATH - - Path to a config file to use. Multiple config files - can be specified, with values in later files taking - precedence. The default files used are: None. - - - - --debug, -d - - Print debugging output (set logging level to DEBUG - instead of default INFO level). - - - - --dibbler_version - - Check minimal dibbler version - - - - --dnsmasq_version - - Check minimal dnsmasq version - - - - --ebtables_installed - - Check ebtables installation - - - - --icmpv6_header_match - - Check for ICMPv6 header match support - - - - --iproute2_vxlan - - Check for iproute2 vxlan support - - - - --keepalived_ipv6_support - - Check keepalived IPv6 support - - - - --log-config-append PATH, --log_config PATH - - The name of a logging configuration file. This file is - appended to any existing logging configuration files. - For details about logging configuration files, see the - Python logging module documentation. - - - - --log-date-format DATE_FORMAT - - Format string for %(asctime)s in log records. Default: None. - - - - --log-dir LOG_DIR, --logdir LOG_DIR - - (Optional) The base directory used for relative - --log-file paths. - - - - --log-file PATH, --logfile PATH - - (Optional) Name of log file to output to. If no - default is set, logging will go to stdout. - - - - --log-format FORMAT - - DEPRECATED. A logging.Formatter log message format - string which may use any of the available - logging.LogRecord attributes. This option is - deprecated. Please use logging_context_format_string - and logging_default_format_string instead. - - - - --noarp_header_match - - The inverse of --arp_header_match - - - - --noarp_responder - - The inverse of --arp_responder - - - - --nodebug - - The inverse of --debug - - - - --nodibbler_version - - The inverse of --dibbler_version - - - - --nodnsmasq_version - - The inverse of --dnsmasq_version - - - - --noebtables_installed - - The inverse of --ebtables_installed - - - - --noicmpv6_header_match - - The inverse of --icmpv6_header_match - - - - --noiproute2_vxlan - - The inverse of --iproute2_vxlan - - - - --nokeepalived_ipv6_support - - The inverse of --keepalived_ipv6_support - - - - --nonova_notify - - The inverse of --nova_notify - - - - --noovs_geneve - - The inverse of --ovs_geneve - - - - --noovs_patch - - The inverse of --ovs_patch - - - - --noovs_vxlan - - The inverse of --ovs_vxlan - - - - --noovsdb_native - - The inverse of --ovsdb_native - - - - --noread_netns - - The inverse of --read_netns - - - - --nouse-syslog - - The inverse of --use-syslog - - - - --nouse-syslog-rfc-format - - The inverse of --use-syslog-rfc-format - - - - --nova_notify - - Check for nova notification support - - - - --noverbose - - The inverse of --verbose - - - - --novf_management - - The inverse of --vf_management - - - - --ovs_geneve - - Check for OVS Geneve support - - - - --ovs_patch - - Check for patch port support - - - - --ovs_vxlan - - Check for OVS vxlan support - - - - --ovsdb_native - - Check ovsdb native interface support - - - - --read_netns - - Check netns permission settings - - - - --state_path STATE_PATH - - Where to store Neutron state files. This directory - must be writable by the agent. - - - - --syslog-log-facility SYSLOG_LOG_FACILITY - - Syslog facility to receive log lines. - - - - --use-syslog - - Use syslog for logging. Existing syslog format is - DEPRECATED and will be changed later to honor RFC5424. - - - - --use-syslog-rfc-format - - (Optional) Enables or disables syslog rfc5424 format - for logging. If enabled, prefixes the MSG part of the - syslog message with APP-NAME (RFC5424). The format - without the APP-NAME is deprecated in Kilo, and will - be removed in Mitaka, along with this option. - - - - --verbose, -v - - If set to false, will disable INFO logging level, - making WARNING the default. - - - - --version - - show program's version number and exit - - - - --vf_management - - Check for VF management support - - - -
-
- diff --git a/doc/cli-reference/generated/README.rst b/doc/cli-reference/generated/README.rst deleted file mode 100644 index 94f5b018f4..0000000000 --- a/doc/cli-reference/generated/README.rst +++ /dev/null @@ -1,9 +0,0 @@ -Generated files -+++++++++++++++ - -All files in this directory are generated from the output of the -python commands they describe using the ``openstack-auto-commands`` -tool from the openstack-doc-tools package. - -Do not change these files - change openstack-auto-commands and the -python commands itself. diff --git a/doc/cli-reference/generated/ch_cli_barbican_commands.xml b/doc/cli-reference/generated/ch_cli_barbican_commands.xml deleted file mode 100644 index 7fc808f5da..0000000000 --- a/doc/cli-reference/generated/ch_cli_barbican_commands.xml +++ /dev/null @@ -1,1054 +0,0 @@ - - - - - - - - Key management service command-line client - - The barbican client is the command-line - interface (CLI) for the Key management service API and its extensions. - - This chapter documents barbican version - 3.3.0. - - - For help on a specific barbican - command, enter: - - $ barbican COMMAND - -
- barbican usage - usage: barbican [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] - [--no-auth] [--os-identity-api-version <identity-api-version>] - [--os-auth-url <auth-url>] [--os-username <auth-user-name>] - [--os-user-id <auth-user-id>] [--os-password <auth-password>] - [--os-user-domain-id <auth-user-domain-id>] - [--os-user-domain-name <auth-user-domain-name>] - [--os-tenant-name <auth-tenant-name>] - [--os-tenant-id <tenant-id>] - [--os-project-id <auth-project-id>] - [--os-project-name <auth-project-name>] - [--os-project-domain-id <auth-project-domain-id>] - [--os-project-domain-name <auth-project-domain-name>] - [--os-auth-token <auth-token>] [--endpoint <barbican-url>] - [--interface <barbican-interface>] - [--service-type <barbican-service-type>] - [--service-name <barbican-service-name>] - [--region-name <barbican-region-name>] - [--barbican-api-version <barbican-api-version>] [--insecure] - [--os-cacert <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] -
-
- barbican 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 help message and exit. - - - - - --debug - - - Show tracebacks on errors. - - - - - --no-auth, -N - - - Do not use authentication. - - - - - --os-identity-api-version <identity-api-version> - - - Specify Identity API version to use. Defaults to - env[OS_IDENTITY_API_VERSION] or 3.0. - - - - - --os-auth-url <auth-url>, -A <auth-url> - - - Defaults to env[OS_AUTH_URL]. - - - - - --os-username <auth-user-name>, -U <auth-user-name> - - - Defaults to env[OS_USERNAME]. - - - - - --os-user-id <auth-user-id> - - - Defaults to env[OS_USER_ID]. - - - - - --os-password <auth-password>, -P <auth-password> - - - Defaults to env[OS_PASSWORD]. - - - - - --os-user-domain-id <auth-user-domain-id> - - - Defaults to env[OS_USER_DOMAIN_ID]. - - - - - --os-user-domain-name <auth-user-domain-name> - - - Defaults to env[OS_USER_DOMAIN_NAME]. - - - - - --os-tenant-name <auth-tenant-name>, -T <auth-tenant-name> - - - Defaults to env[OS_TENANT_NAME]. - - - - - --os-tenant-id <tenant-id>, -I <tenant-id> - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-project-id <auth-project-id> - - - Another way to specify tenant ID. This option is - mutually exclusive with --os-tenant-id. Defaults to - env[OS_PROJECT_ID]. - - - - - --os-project-name <auth-project-name> - - - Another way to specify tenant name. This option is - mutually exclusive with --os-tenant-name. Defaults to - env[OS_PROJECT_NAME]. - - - - - --os-project-domain-id <auth-project-domain-id> - - - Defaults to env[OS_PROJECT_DOMAIN_ID]. - - - - - --os-project-domain-name <auth-project-domain-name> - - - Defaults to env[OS_PROJECT_DOMAIN_NAME]. - - - - - --os-auth-token <auth-token> - - - Defaults to env[OS_AUTH_TOKEN]. - - - - - --endpoint <barbican-url>, -E <barbican-url> - - - Defaults to env[BARBICAN_ENDPOINT]. - - - - - --interface <barbican-interface> - - - Defaults to env[BARBICAN_INTERFACE]. - - - - - --service-type <barbican-service-type> - - - Defaults to env[BARBICAN_SERVICE_TYPE]. - - - - - --service-name <barbican-service-name> - - - Defaults to env[BARBICAN_SERVICE_NAME]. - - - - - --region-name <barbican-region-name> - - - Defaults to env[BARBICAN_REGION_NAME]. - - - - - --barbican-api-version <barbican-api-version> - - - Defaults to env[BARBICAN_API_VERSION]. - - - - - --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 <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - Set request timeout (in seconds). - - - - -
-
- barbican ca get - usage: barbican ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] [--prefix PREFIX] - URI - -Retrieve a CA by providing its URI. - - Positional arguments - - URI - - - The URI reference for the CA. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- barbican ca list - usage: barbican ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--limit LIMIT] [--offset OFFSET] [--name NAME] - -List cas. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --limit LIMIT, -l LIMIT - - - specify the limit to the number of items to list per - page (default: 10; maximum: 100) - - - - - --offset OFFSET, -o OFFSET - - - specify the page offset (default: 0) - - - - - --name NAME, -n NAME - - - specify the secret name (default: None) - - - - -
-
- barbican container create - usage: barbican container create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] [--name NAME] - [--type TYPE] [--secret SECRET] - -Store a container in Barbican. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME, -n NAME - - - a human-friendly name. - - - - - --type TYPE - - - type of container to create (default: generic). - - - - - --secret SECRET, -s SECRET - - - one secret to store in a container (can be set - multiple times). Example: --secret - "private_key=https://url.test/v1/secrets/1-2-3-4" - - - - -
-
- barbican container delete - usage: barbican container delete [-h] URI - -Delete a container by providing its href. - - Positional arguments - - URI - - - The URI reference for the container - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- barbican container get - usage: barbican container get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - URI - -Retrieve a container by providing its URI. - - Positional arguments - - URI - - - The URI reference for the container. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- barbican container list - usage: barbican container list [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--limit LIMIT] [--offset OFFSET] [--name NAME] - [--type TYPE] - -List containers. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --limit LIMIT, -l LIMIT - - - specify the limit to the number of items to list per - page (default: 10; maximum: 100) - - - - - --offset OFFSET, -o OFFSET - - - specify the page offset (default: 0) - - - - - --name NAME, -n NAME - - - specify the container name (default: None) - - - - - --type TYPE, -t TYPE - - - specify the type filter for the list (default: None). - - - - -
-
- barbican order create - usage: barbican order create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--name NAME] [--type TYPE] - [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] - [--mode MODE] - [--payload-content-type PAYLOAD_CONTENT_TYPE] - [--expiration EXPIRATION] - [--request-type REQUEST_TYPE] - [--subject-dn SUBJECT_DN] - [--source-container-ref SOURCE_CONTAINER_REF] - [--ca-id CA_ID] [--profile PROFILE] - [--request-file REQUEST_FILE] - -Create a new order. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME, -n NAME - - - a human-friendly name. - - - - - --type TYPE, -p TYPE - - - the type of the order to create. - - - - - --algorithm ALGORITHM, -a ALGORITHM - - - the algorithm to be used with the requested key - (default: aes). - - - - - --bit-length BIT_LENGTH, -b BIT_LENGTH - - - the bit length of the requested secret key (default: - 256). - - - - - --mode MODE, -m MODE - - - the algorithm mode to be used with the requested key - (default: cbc). - - - - - --payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE - - - the type/format of the secret to be generated - (default: application/octet-stream). - - - - - --expiration EXPIRATION, -x EXPIRATION - - - the expiration time for the secret in ISO 8601 format. - - - - - --request-type REQUEST_TYPE - - - the type of the certificate request. - - - - - --subject-dn SUBJECT_DN - - - the subject of the certificate. - - - - - --source-container-ref SOURCE_CONTAINER_REF - - - the source of the certificate when using stored-key - requests. - - - - - --ca-id CA_ID - - - the identifier of the CA to use for the certificate - request. - - - - - --profile PROFILE - - - the profile of certificate to use. - - - - - --request-file REQUEST_FILE - - - the file containing the CSR. - - - - -
-
- barbican order delete - usage: barbican order delete [-h] URI - -Delete an order by providing its href. - - Positional arguments - - URI - - - The URI reference for the order - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- barbican order get - usage: barbican order get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--prefix PREFIX] - URI - -Retrieve an order by providing its URI. - - Positional arguments - - URI - - - The URI reference order. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- barbican order list - usage: barbican order list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--limit LIMIT] [--offset OFFSET] - -List orders. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --limit LIMIT, -l LIMIT - - - specify the limit to the number of items to list per - page (default: 10; maximum: 100) - - - - - --offset OFFSET, -o OFFSET - - - specify the page offset (default: 0) - - - - -
-
- barbican secret delete - usage: barbican secret delete [-h] URI - -Delete a secret by providing its URI. - - Positional arguments - - URI - - - The URI reference for the secret - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- barbican secret get - usage: barbican secret get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--decrypt] [--payload] - [--payload_content_type PAYLOAD_CONTENT_TYPE] - URI - -Retrieve a secret by providing its URI. - - Positional arguments - - URI - - - The URI reference for the secret. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --decrypt, -d - - - if specified, retrieve the unencrypted secret data; - the data type can be specified with --payload-content- - type. - - - - - --payload, -p - - - if specified, retrieve the unencrypted secret data; - the data type can be specified with --payload-content- - type. If the user wishes to only retrieve the value of - the payload they must add "-f value" to format - returning only the value of the payload - - - - - --payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE - - - the content type of the decrypted secret (default: - text/plain. - - - - -
-
- barbican secret list - usage: barbican secret list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--limit LIMIT] [--offset OFFSET] [--name NAME] - [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] - [--mode MODE] - -List secrets. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --limit LIMIT, -l LIMIT - - - specify the limit to the number of items to list per - page (default: 10; maximum: 100) - - - - - --offset OFFSET, -o OFFSET - - - specify the page offset (default: 0) - - - - - --name NAME, -n NAME - - - specify the secret name (default: None) - - - - - --algorithm ALGORITHM, -a ALGORITHM - - - the algorithm filter for the list(default: None). - - - - - --bit-length BIT_LENGTH, -b BIT_LENGTH - - - the bit length filter for the list (default: 0). - - - - - --mode MODE, -m MODE - - - the algorithm mode filter for the list (default: - None). - - - - -
-
- barbican secret store - usage: barbican secret store [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--name NAME] - [--payload PAYLOAD] [--secret-type SECRET_TYPE] - [--payload-content-type PAYLOAD_CONTENT_TYPE] - [--payload-content-encoding PAYLOAD_CONTENT_ENCODING] - [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] - [--mode MODE] [--expiration EXPIRATION] - -Store a secret in Barbican. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME, -n NAME - - - a human-friendly name. - - - - - --payload PAYLOAD, -p PAYLOAD - - - the unencrypted secret; if provided, you must also - provide a payload_content_type - - - - - --secret-type SECRET_TYPE, -s SECRET_TYPE - - - the secret type; must be one of symmetric, public, - private, certificate, passphrase, opaque (default) - - - - - --payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE - - - the type/format of the provided secret data; - "text/plain" is assumed to be UTF-8; required when - --payload is supplied. - - - - - --payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING - - - required if --payload-content-type is "application - /octet-stream". - - - - - --algorithm ALGORITHM, -a ALGORITHM - - - the algorithm (default: aes). - - - - - --bit-length BIT_LENGTH, -b BIT_LENGTH - - - the bit length (default: 256). - - - - - --mode MODE, -m MODE - - - the algorithm mode; used only for reference (default: - cbc) - - - - - --expiration EXPIRATION, -x EXPIRATION - - - the expiration time for the secret in ISO 8601 format. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml b/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml deleted file mode 100644 index 065d68454c..0000000000 --- a/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml +++ /dev/null @@ -1,3756 +0,0 @@ - - - - - - - - Telemetry service command-line client - - The ceilometer client is the command-line - interface (CLI) for the Telemetry service API and its extensions. - - This chapter documents ceilometer version - 2.1.0. - - - For help on a specific ceilometer - command, enter: - - $ ceilometer COMMAND - -
- ceilometer usage - usage: ceilometer [--version] [-d] [-v] [--timeout TIMEOUT] - [--ceilometer-url <CEILOMETER_URL>] - [--ceilometer-api-version CEILOMETER_API_VERSION] - [--os-tenant-id <tenant-id>] - [--os-region-name <region-name>] - [--os-auth-token <auth-token>] - [--os-service-type <service-type>] - [--os-endpoint-type <endpoint-type>] [--os-cacert <cacert>] - [--os-insecure <insecure>] [--os-cert-file <cert-file>] - [--os-key-file <key-file>] [--os-cert <cert>] - [--os-key <key>] [--os-project-name <project-name>] - [--os-project-id <project-id>] - [--os-project-domain-id <project-domain-id>] - [--os-project-domain-name <project-domain-name>] - [--os-user-id <user-id>] - [--os-user-domain-id <user-domain-id>] - [--os-user-domain-name <user-domain-name>] - [--os-endpoint <endpoint>] [--os-auth-system <auth-system>] - [--os-username <username>] [--os-password <password>] - [--os-tenant-name <tenant-name>] [--os-token <token>] - [--os-auth-url <auth-url>] - <subcommand> ... - - Subcommands - - alarm-combination-create - - - Create a new alarm based on state of other - alarms. - - - - - alarm-combination-update - - - Update an existing alarm based on state of - other alarms. - - - - - alarm-create - - - Create a new alarm (Deprecated). Use alarm- - threshold-create instead. - - - - - alarm-delete - - - Delete an alarm. - - - - - alarm-event-create - - - Create a new alarm based on events. - - - - - alarm-event-update - - - Update an existing alarm based on events. - - - - - alarm-gnocchi-aggregation-by-metrics-threshold-create - - - Create a new alarm based on computed - statistics. - - - - - alarm-gnocchi-aggregation-by-metrics-threshold-update - - - Update an existing alarm based on computed - statistics. - - - - - alarm-gnocchi-aggregation-by-resources-threshold-create - - - Create a new alarm based on computed - statistics. - - - - - alarm-gnocchi-aggregation-by-resources-threshold-update - - - Update an existing alarm based on computed - statistics. - - - - - alarm-gnocchi-resources-threshold-create - - - Create a new alarm based on computed - statistics. - - - - - alarm-gnocchi-resources-threshold-update - - - Update an existing alarm based on computed - statistics. - - - - - alarm-history - - - Display the change history of an alarm. - - - - - alarm-list - - - List the user's alarms. - - - - - alarm-show - - - Show an alarm. - - - - - alarm-state-get - - - Get the state of an alarm. - - - - - alarm-state-set - - - Set the state of an alarm. - - - - - alarm-threshold-create - - - Create a new alarm based on computed - statistics. - - - - - alarm-threshold-update - - - Update an existing alarm based on computed - statistics. - - - - - alarm-update - - - Update an existing alarm (Deprecated). - - - - - capabilities - - - Print Ceilometer capabilities. - - - - - event-list - - - List events. - - - - - event-show - - - Show a particular event. - - - - - event-type-list - - - List event types. - - - - - meter-list - - - List the user's meters. - - - - - query-alarm-history - - - Query Alarm History. - - - - - query-alarms - - - Query Alarms. - - - - - query-samples - - - Query samples. - - - - - resource-list - - - List the resources. - - - - - resource-show - - - Show the resource. - - - - - sample-create - - - Create a sample. - - - - - sample-create-list - - - Create a sample list. - - - - - sample-list - - - List the samples (return OldSample objects if - -m/--meter is set). - - - - - sample-show - - - Show a sample. - - - - - statistics - - - List the statistics for a meter. - - - - - trait-description-list - - - List trait info for an event type. - - - - - trait-list - - - List all traits with name <trait_name> for - Event Type <event_type>. - - - - - bash-completion - - - Prints all of the commands and options to - stdout. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - -
-
- ceilometer optional arguments - - - --version - - - show program's version number and exit - - - - - -d, --debug - - - Defaults to env[CEILOMETERCLIENT_DEBUG]. - - - - - -v, --verbose - - - Print more verbose output. - - - - - --timeout TIMEOUT - - - Number of seconds to wait for a response. - - - - - --ceilometer-url <CEILOMETER_URL> - - - DEPRECATED, use --os-endpoint instead. - Defaults to env[CEILOMETER_URL]. - - - - - --ceilometer-api-version CEILOMETER_API_VERSION - - - Defaults to env[CEILOMETER_API_VERSION] or 2. - - - - - --os-tenant-id <tenant-id> - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-region-name <region-name> - - - Defaults to env[OS_REGION_NAME]. - - - - - --os-auth-token <auth-token> - - - Defaults to env[OS_AUTH_TOKEN]. - - - - - --os-service-type <service-type> - - - Defaults to env[OS_SERVICE_TYPE]. - - - - - --os-endpoint-type <endpoint-type> - - - Defaults to env[OS_ENDPOINT_TYPE]. - - - - - --os-cacert <cacert> - - - Defaults to env[OS_CACERT]. - - - - - --os-insecure <insecure> - - - Defaults to env[OS_INSECURE]. - - - - - --os-cert-file <cert-file> - - - Defaults to env[OS_CERT_FILE]. - - - - - --os-key-file <key-file> - - - Defaults to env[OS_KEY_FILE]. - - - - - --os-cert <cert> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --os-project-name <project-name> - - - Defaults to env[OS_PROJECT_NAME]. - - - - - --os-project-id <project-id> - - - Defaults to env[OS_PROJECT_ID]. - - - - - --os-project-domain-id <project-domain-id> - - - Defaults to env[OS_PROJECT_DOMAIN_ID]. - - - - - --os-project-domain-name <project-domain-name> - - - Defaults to env[OS_PROJECT_DOMAIN_NAME]. - - - - - --os-user-id <user-id> - - - Defaults to env[OS_USER_ID]. - - - - - --os-user-domain-id <user-domain-id> - - - Defaults to env[OS_USER_DOMAIN_ID]. - - - - - --os-user-domain-name <user-domain-name> - - - Defaults to env[OS_USER_DOMAIN_NAME]. - - - - - --os-endpoint <endpoint> - - - Defaults to env[OS_ENDPOINT]. - - - - - --os-auth-system <auth-system> - - - Defaults to env[OS_AUTH_SYSTEM]. - - - - - --os-username <username> - - - Defaults to env[OS_USERNAME]. - - - - - --os-password <password> - - - Defaults to env[OS_PASSWORD]. - - - - - --os-tenant-name <tenant-name> - - - Defaults to env[OS_TENANT_NAME]. - - - - - --os-token <token> - - - Defaults to env[OS_TOKEN]. - - - - - --os-auth-url <auth-url> - - - Defaults to env[OS_AUTH_URL]. - - - - -
-
- ceilometer alarm-combination-create - usage: ceilometer alarm-combination-create --name <NAME> - [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] - [--description <DESCRIPTION>] - [--state <STATE>] - [--severity <SEVERITY>] - [--enabled {True|False}] - [--alarm-action <Webhook URL>] - [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] - [--repeat-actions {True|False}] - --alarm_ids <ALARM IDS> - [--operator <OPERATOR>] - -Create a new alarm based on state of other alarms. - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - Required. - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --alarm_ids <ALARM IDS> - - - List of alarm IDs. Required. - - - - - --operator <OPERATOR> - - - Operator to compare with, one of: ['and', - 'or']. - - - - -
-
- ceilometer alarm-combination-update - usage: ceilometer alarm-combination-update [--name <NAME>] - [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] - [--description <DESCRIPTION>] - [--state <STATE>] - [--severity <SEVERITY>] - [--enabled {True|False}] - [--alarm-action <Webhook URL>] - [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] - [--repeat-actions {True|False}] - [--remove-time-constraint <Constraint names>] - [--alarm_ids <ALARM IDS>] - [--operator <OPERATOR>] - [<ALARM_ID>] - -Update an existing alarm based on state of other alarms. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm to update. - - - - - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --remove-time-constraint <Constraint names> - - - Name or list of names of the time constraints - to remove. - - - - - --alarm_ids <ALARM IDS> - - - List of alarm IDs. - - - - - --operator <OPERATOR> - - - Operator to compare with, one of: ['and', - 'or']. - - - - -
-
- ceilometer alarm-delete - usage: ceilometer alarm-delete [<ALARM_ID>] - -Delete an alarm. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm to delete. - - - - -
-
- ceilometer alarm-event-create - usage: ceilometer alarm-event-create --name <NAME> - [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] - [--description <DESCRIPTION>] - [--state <STATE>] [--severity <SEVERITY>] - [--enabled {True|False}] - [--alarm-action <Webhook URL>] - [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] - [--repeat-actions {True|False}] - [--event-type <EVENT_TYPE>] [-q <QUERY>] - -Create a new alarm based on events. - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - Required. - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --event-type <EVENT_TYPE> - - - Event type for event alarm. - - - - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list for filtering - events. data_type is optional, but if supplied - must be string, integer, float or datetime. - - - - -
-
- ceilometer alarm-event-update - usage: ceilometer alarm-event-update [--name <NAME>] - [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] - [--description <DESCRIPTION>] - [--state <STATE>] [--severity <SEVERITY>] - [--enabled {True|False}] - [--alarm-action <Webhook URL>] - [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] - [--repeat-actions {True|False}] - [--event-type <EVENT_TYPE>] [-q <QUERY>] - [<ALARM_ID>] - -Update an existing alarm based on events. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm to update. - - - - - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --event-type <EVENT_TYPE> - - - Event type for event alarm. - - - - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list for filtering - events. data_type is optional, but if supplied - must be string, integer, float or datetime. - - - - -
-
- ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-create - usage: ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-create - --name <NAME> [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] - [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] - [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] - [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] - [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] - --threshold <THRESHOLD> -m <METRICS> - -Create a new alarm based on computed statistics. - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - Required. - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --granularity <GRANULARITY> - - - Length of each period (seconds) to evaluate - over. - - - - - --evaluation-periods <COUNT> - - - Number of periods to evaluate over. - - - - - --aggregation-method <AGGREATION> - - - Aggregation method to use, one of: ['last', - 'min', 'median', 'sum', 'std', 'first', - 'mean', 'count', 'moving-average', 'max', - '1pct', '2pct', '3pct', '4pct', '5pct', - '6pct', '7pct', '8pct', '9pct', '10pct', - '11pct', '12pct', '13pct', '14pct', '15pct', - '16pct', '17pct', '18pct', '19pct', '20pct', - '21pct', '22pct', '23pct', '24pct', '25pct', - '26pct', '27pct', '28pct', '29pct', '30pct', - '31pct', '32pct', '33pct', '34pct', '35pct', - '36pct', '37pct', '38pct', '39pct', '40pct', - '41pct', '42pct', '43pct', '44pct', '45pct', - '46pct', '47pct', '48pct', '49pct', '50pct', - '51pct', '52pct', '53pct', '54pct', '55pct', - '56pct', '57pct', '58pct', '59pct', '60pct', - '61pct', '62pct', '63pct', '64pct', '65pct', - '66pct', '67pct', '68pct', '69pct', '70pct', - '71pct', '72pct', '73pct', '74pct', '75pct', - '76pct', '77pct', '78pct', '79pct', '80pct', - '81pct', '82pct', '83pct', '84pct', '85pct', - '86pct', '87pct', '88pct', '89pct', '90pct', - '91pct', '92pct', '93pct', '94pct', '95pct', - '96pct', '97pct', '98pct', '99pct']. - - - - - --comparison-operator <OPERATOR> - - - Operator to compare with, one of: ['lt', 'le', - 'eq', 'ne', 'ge', 'gt']. - - - - - --threshold <THRESHOLD> - - - Threshold to evaluate against. Required. - - - - - -m <METRICS>, --metrics <METRICS> - - - Metric to evaluate against. Required. - - - - -
-
- ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-update - usage: ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-update - [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] - [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] - [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] - [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] - [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] - [--threshold <THRESHOLD>] [-m <METRICS>] - [--remove-time-constraint <Constraint names>] - [<ALARM_ID>] - -Update an existing alarm based on computed statistics. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm to update. - - - - - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --granularity <GRANULARITY> - - - Length of each period (seconds) to evaluate - over. - - - - - --evaluation-periods <COUNT> - - - Number of periods to evaluate over. - - - - - --aggregation-method <AGGREATION> - - - Aggregation method to use, one of: ['last', - 'min', 'median', 'sum', 'std', 'first', - 'mean', 'count', 'moving-average', 'max', - '1pct', '2pct', '3pct', '4pct', '5pct', - '6pct', '7pct', '8pct', '9pct', '10pct', - '11pct', '12pct', '13pct', '14pct', '15pct', - '16pct', '17pct', '18pct', '19pct', '20pct', - '21pct', '22pct', '23pct', '24pct', '25pct', - '26pct', '27pct', '28pct', '29pct', '30pct', - '31pct', '32pct', '33pct', '34pct', '35pct', - '36pct', '37pct', '38pct', '39pct', '40pct', - '41pct', '42pct', '43pct', '44pct', '45pct', - '46pct', '47pct', '48pct', '49pct', '50pct', - '51pct', '52pct', '53pct', '54pct', '55pct', - '56pct', '57pct', '58pct', '59pct', '60pct', - '61pct', '62pct', '63pct', '64pct', '65pct', - '66pct', '67pct', '68pct', '69pct', '70pct', - '71pct', '72pct', '73pct', '74pct', '75pct', - '76pct', '77pct', '78pct', '79pct', '80pct', - '81pct', '82pct', '83pct', '84pct', '85pct', - '86pct', '87pct', '88pct', '89pct', '90pct', - '91pct', '92pct', '93pct', '94pct', '95pct', - '96pct', '97pct', '98pct', '99pct']. - - - - - --comparison-operator <OPERATOR> - - - Operator to compare with, one of: ['lt', 'le', - 'eq', 'ne', 'ge', 'gt']. - - - - - --threshold <THRESHOLD> - - - Threshold to evaluate against. - - - - - -m <METRICS>, --metrics <METRICS> - - - Metric to evaluate against. - - - - - --remove-time-constraint <Constraint names> - - - Name or list of names of the time constraints - to remove. - - - - -
-
- ceilometer alarm-gnocchi-aggregation-by-resources-threshold-create - usage: ceilometer alarm-gnocchi-aggregation-by-resources-threshold-create - --name <NAME> [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] - [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] - [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] - [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] - [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] - --threshold <THRESHOLD> -m <METRIC> --resource-type <RESOURCE_TYPE> - --query <QUERY> - -Create a new alarm based on computed statistics. - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - Required. - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --granularity <GRANULARITY> - - - Length of each period (seconds) to evaluate - over. - - - - - --evaluation-periods <COUNT> - - - Number of periods to evaluate over. - - - - - --aggregation-method <AGGREATION> - - - Aggregation method to use, one of: ['last', - 'min', 'median', 'sum', 'std', 'first', - 'mean', 'count', 'moving-average', 'max', - '1pct', '2pct', '3pct', '4pct', '5pct', - '6pct', '7pct', '8pct', '9pct', '10pct', - '11pct', '12pct', '13pct', '14pct', '15pct', - '16pct', '17pct', '18pct', '19pct', '20pct', - '21pct', '22pct', '23pct', '24pct', '25pct', - '26pct', '27pct', '28pct', '29pct', '30pct', - '31pct', '32pct', '33pct', '34pct', '35pct', - '36pct', '37pct', '38pct', '39pct', '40pct', - '41pct', '42pct', '43pct', '44pct', '45pct', - '46pct', '47pct', '48pct', '49pct', '50pct', - '51pct', '52pct', '53pct', '54pct', '55pct', - '56pct', '57pct', '58pct', '59pct', '60pct', - '61pct', '62pct', '63pct', '64pct', '65pct', - '66pct', '67pct', '68pct', '69pct', '70pct', - '71pct', '72pct', '73pct', '74pct', '75pct', - '76pct', '77pct', '78pct', '79pct', '80pct', - '81pct', '82pct', '83pct', '84pct', '85pct', - '86pct', '87pct', '88pct', '89pct', '90pct', - '91pct', '92pct', '93pct', '94pct', '95pct', - '96pct', '97pct', '98pct', '99pct']. - - - - - --comparison-operator <OPERATOR> - - - Operator to compare with, one of: ['lt', 'le', - 'eq', 'ne', 'ge', 'gt']. - - - - - --threshold <THRESHOLD> - - - Threshold to evaluate against. Required. - - - - - -m <METRIC>, --metric <METRIC> - - - Metric to evaluate against. Required. - - - - - --resource-type <RESOURCE_TYPE> - - - Resource_type to evaluate against. Required. - - - - - --query <QUERY> - - - Gnocchi resources search query filter - Required. - - - - -
-
- ceilometer alarm-gnocchi-aggregation-by-resources-threshold-update - usage: ceilometer alarm-gnocchi-aggregation-by-resources-threshold-update - [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] - [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] - [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] - [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>] - [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>] - [--threshold <THRESHOLD>] [-m <METRIC>] - [--resource-type <RESOURCE_TYPE>] [--query <QUERY>] - [--remove-time-constraint <Constraint names>] - [<ALARM_ID>] - -Update an existing alarm based on computed statistics. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm to update. - - - - - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --granularity <GRANULARITY> - - - Length of each period (seconds) to evaluate - over. - - - - - --evaluation-periods <COUNT> - - - Number of periods to evaluate over. - - - - - --aggregation-method <AGGREATION> - - - Aggregation method to use, one of: ['last', - 'min', 'median', 'sum', 'std', 'first', - 'mean', 'count', 'moving-average', 'max', - '1pct', '2pct', '3pct', '4pct', '5pct', - '6pct', '7pct', '8pct', '9pct', '10pct', - '11pct', '12pct', '13pct', '14pct', '15pct', - '16pct', '17pct', '18pct', '19pct', '20pct', - '21pct', '22pct', '23pct', '24pct', '25pct', - '26pct', '27pct', '28pct', '29pct', '30pct', - '31pct', '32pct', '33pct', '34pct', '35pct', - '36pct', '37pct', '38pct', '39pct', '40pct', - '41pct', '42pct', '43pct', '44pct', '45pct', - '46pct', '47pct', '48pct', '49pct', '50pct', - '51pct', '52pct', '53pct', '54pct', '55pct', - '56pct', '57pct', '58pct', '59pct', '60pct', - '61pct', '62pct', '63pct', '64pct', '65pct', - '66pct', '67pct', '68pct', '69pct', '70pct', - '71pct', '72pct', '73pct', '74pct', '75pct', - '76pct', '77pct', '78pct', '79pct', '80pct', - '81pct', '82pct', '83pct', '84pct', '85pct', - '86pct', '87pct', '88pct', '89pct', '90pct', - '91pct', '92pct', '93pct', '94pct', '95pct', - '96pct', '97pct', '98pct', '99pct']. - - - - - --comparison-operator <OPERATOR> - - - Operator to compare with, one of: ['lt', 'le', - 'eq', 'ne', 'ge', 'gt']. - - - - - --threshold <THRESHOLD> - - - Threshold to evaluate against. - - - - - -m <METRIC>, --metric <METRIC> - - - Metric to evaluate against. - - - - - --resource-type <RESOURCE_TYPE> - - - Resource_type to evaluate against. - - - - - --query <QUERY> - - - Gnocchi resources search query filter - - - - - --remove-time-constraint <Constraint names> - - - Name or list of names of the time constraints - to remove. - - - - -
-
- ceilometer alarm-gnocchi-resources-threshold-create - usage: ceilometer alarm-gnocchi-resources-threshold-create --name <NAME> - [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] - [--description <DESCRIPTION>] - [--state <STATE>] - [--severity <SEVERITY>] - [--enabled {True|False}] - [--alarm-action <Webhook URL>] - [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] - [--repeat-actions {True|False}] - [--granularity <GRANULARITY>] - [--evaluation-periods <COUNT>] - [--aggregation-method <AGGREATION>] - [--comparison-operator <OPERATOR>] - --threshold - <THRESHOLD> -m - <METRIC> - --resource-type - <RESOURCE_TYPE> - --resource-id - <RESOURCE_ID> - -Create a new alarm based on computed statistics. - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - Required. - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --granularity <GRANULARITY> - - - Length of each period (seconds) to evaluate - over. - - - - - --evaluation-periods <COUNT> - - - Number of periods to evaluate over. - - - - - --aggregation-method <AGGREATION> - - - Aggregation method to use, one of: ['last', - 'min', 'median', 'sum', 'std', 'first', - 'mean', 'count', 'moving-average', 'max', - '1pct', '2pct', '3pct', '4pct', '5pct', - '6pct', '7pct', '8pct', '9pct', '10pct', - '11pct', '12pct', '13pct', '14pct', '15pct', - '16pct', '17pct', '18pct', '19pct', '20pct', - '21pct', '22pct', '23pct', '24pct', '25pct', - '26pct', '27pct', '28pct', '29pct', '30pct', - '31pct', '32pct', '33pct', '34pct', '35pct', - '36pct', '37pct', '38pct', '39pct', '40pct', - '41pct', '42pct', '43pct', '44pct', '45pct', - '46pct', '47pct', '48pct', '49pct', '50pct', - '51pct', '52pct', '53pct', '54pct', '55pct', - '56pct', '57pct', '58pct', '59pct', '60pct', - '61pct', '62pct', '63pct', '64pct', '65pct', - '66pct', '67pct', '68pct', '69pct', '70pct', - '71pct', '72pct', '73pct', '74pct', '75pct', - '76pct', '77pct', '78pct', '79pct', '80pct', - '81pct', '82pct', '83pct', '84pct', '85pct', - '86pct', '87pct', '88pct', '89pct', '90pct', - '91pct', '92pct', '93pct', '94pct', '95pct', - '96pct', '97pct', '98pct', '99pct']. - - - - - --comparison-operator <OPERATOR> - - - Operator to compare with, one of: ['lt', 'le', - 'eq', 'ne', 'ge', 'gt']. - - - - - --threshold <THRESHOLD> - - - Threshold to evaluate against. Required. - - - - - -m <METRIC>, --metric <METRIC> - - - Metric to evaluate against. Required. - - - - - --resource-type <RESOURCE_TYPE> - - - Resource_type to evaluate against. Required. - - - - - --resource-id <RESOURCE_ID> - - - Resource id to evaluate against Required. - - - - -
-
- ceilometer alarm-gnocchi-resources-threshold-update - usage: ceilometer alarm-gnocchi-resources-threshold-update [--name <NAME>] - [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] - [--description <DESCRIPTION>] - [--state <STATE>] - [--severity <SEVERITY>] - [--enabled {True|False}] - [--alarm-action <Webhook URL>] - [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] - [--repeat-actions {True|False}] - [--granularity <GRANULARITY>] - [--evaluation-periods <COUNT>] - [--aggregation-method <AGGREATION>] - [--comparison-operator <OPERATOR>] - [--threshold <THRESHOLD>] - [-m <METRIC>] - [--resource-type <RESOURCE_TYPE>] - [--resource-id <RESOURCE_ID>] - [--remove-time-constraint <Constraint names>] - [<ALARM_ID>] - -Update an existing alarm based on computed statistics. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm to update. - - - - - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --granularity <GRANULARITY> - - - Length of each period (seconds) to evaluate - over. - - - - - --evaluation-periods <COUNT> - - - Number of periods to evaluate over. - - - - - --aggregation-method <AGGREATION> - - - Aggregation method to use, one of: ['last', - 'min', 'median', 'sum', 'std', 'first', - 'mean', 'count', 'moving-average', 'max', - '1pct', '2pct', '3pct', '4pct', '5pct', - '6pct', '7pct', '8pct', '9pct', '10pct', - '11pct', '12pct', '13pct', '14pct', '15pct', - '16pct', '17pct', '18pct', '19pct', '20pct', - '21pct', '22pct', '23pct', '24pct', '25pct', - '26pct', '27pct', '28pct', '29pct', '30pct', - '31pct', '32pct', '33pct', '34pct', '35pct', - '36pct', '37pct', '38pct', '39pct', '40pct', - '41pct', '42pct', '43pct', '44pct', '45pct', - '46pct', '47pct', '48pct', '49pct', '50pct', - '51pct', '52pct', '53pct', '54pct', '55pct', - '56pct', '57pct', '58pct', '59pct', '60pct', - '61pct', '62pct', '63pct', '64pct', '65pct', - '66pct', '67pct', '68pct', '69pct', '70pct', - '71pct', '72pct', '73pct', '74pct', '75pct', - '76pct', '77pct', '78pct', '79pct', '80pct', - '81pct', '82pct', '83pct', '84pct', '85pct', - '86pct', '87pct', '88pct', '89pct', '90pct', - '91pct', '92pct', '93pct', '94pct', '95pct', - '96pct', '97pct', '98pct', '99pct']. - - - - - --comparison-operator <OPERATOR> - - - Operator to compare with, one of: ['lt', 'le', - 'eq', 'ne', 'ge', 'gt']. - - - - - --threshold <THRESHOLD> - - - Threshold to evaluate against. - - - - - -m <METRIC>, --metric <METRIC> - - - Metric to evaluate against. - - - - - --resource-type <RESOURCE_TYPE> - - - Resource_type to evaluate against. - - - - - --resource-id <RESOURCE_ID> - - - Resource id to evaluate against - - - - - --remove-time-constraint <Constraint names> - - - Name or list of names of the time constraints - to remove. - - - - -
-
- ceilometer alarm-history - usage: ceilometer alarm-history [-q <QUERY>] [<ALARM_ID>] - -Display the change history of an alarm. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm for which history is shown. - - - - - - Optional arguments - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, float, or boolean. - - - - -
-
- ceilometer alarm-list - usage: ceilometer alarm-list [-q <QUERY>] - -List the user's alarms. - - Optional arguments - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, float, or boolean. - - - - -
-
- ceilometer alarm-show - usage: ceilometer alarm-show [<ALARM_ID>] - -Show an alarm. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm to show. - - - - -
-
- ceilometer alarm-state-get - usage: ceilometer alarm-state-get [<ALARM_ID>] - -Get the state of an alarm. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm state to show. - - - - -
-
- ceilometer alarm-state-set - usage: ceilometer alarm-state-set --state <STATE> [<ALARM_ID>] - -Set the state of an alarm. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm state to set. - - - - - - Optional arguments - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', 'insufficient - data']. Required. - - - - -
-
- ceilometer alarm-threshold-create - usage: ceilometer alarm-threshold-create --name <NAME> - [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] - [--description <DESCRIPTION>] - [--state <STATE>] - [--severity <SEVERITY>] - [--enabled {True|False}] - [--alarm-action <Webhook URL>] - [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] - [--repeat-actions {True|False}] -m - <METRIC> [--period <PERIOD>] - [--evaluation-periods <COUNT>] - [--statistic <STATISTIC>] - [--comparison-operator <OPERATOR>] - --threshold <THRESHOLD> [-q <QUERY>] - -Create a new alarm based on computed statistics. - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - Required. - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - -m <METRIC>, --meter-name <METRIC> - - - Metric to evaluate against. Required. - - - - - --period <PERIOD> - - - Length of each period (seconds) to evaluate - over. - - - - - --evaluation-periods <COUNT> - - - Number of periods to evaluate over. - - - - - --statistic <STATISTIC> - - - Statistic to evaluate, one of: ['max', 'min', - 'avg', 'sum', 'count']. - - - - - --comparison-operator <OPERATOR> - - - Operator to compare with, one of: ['lt', 'le', - 'eq', 'ne', 'ge', 'gt']. - - - - - --threshold <THRESHOLD> - - - Threshold to evaluate against. Required. - - - - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, float, or boolean. - - - - -
-
- ceilometer alarm-threshold-update - usage: ceilometer alarm-threshold-update [--name <NAME>] - [--project-id <ALARM_PROJECT_ID>] - [--user-id <ALARM_USER_ID>] - [--description <DESCRIPTION>] - [--state <STATE>] - [--severity <SEVERITY>] - [--enabled {True|False}] - [--alarm-action <Webhook URL>] - [--ok-action <Webhook URL>] - [--insufficient-data-action <Webhook URL>] - [--time-constraint <Time Constraint>] - [--repeat-actions {True|False}] - [--remove-time-constraint <Constraint names>] - [-m <METRIC>] [--period <PERIOD>] - [--evaluation-periods <COUNT>] - [--statistic <STATISTIC>] - [--comparison-operator <OPERATOR>] - [--threshold <THRESHOLD>] - [-q <QUERY>] - [<ALARM_ID>] - -Update an existing alarm based on computed statistics. - - Positional arguments - - <ALARM_ID> - - - ID of the alarm to update. - - - - - - Optional arguments - - --name <NAME> - - - Name of the alarm (must be unique per tenant). - - - - - --project-id <ALARM_PROJECT_ID> - - - Tenant to associate with alarm (configurable - by admin users only). - - - - - --user-id <ALARM_USER_ID> - - - User to associate with alarm (configurable by - admin users only). - - - - - --description <DESCRIPTION> - - - Free text description of the alarm. - - - - - --state <STATE> - - - State of the alarm, one of: ['ok', 'alarm', - 'insufficient data'] - - - - - --severity <SEVERITY> - - - Severity of the alarm, one of: ['low', - 'moderate', 'critical'] - - - - - --enabled {True|False} - - - True if alarm evaluation/actioning is enabled. - - - - - --alarm-action <Webhook URL> - - - URL to invoke when state transitions to alarm. - May be used multiple times. Defaults to None. - - - - - --ok-action <Webhook URL> - - - URL to invoke when state transitions to OK. - May be used multiple times. Defaults to None. - - - - - --insufficient-data-action <Webhook URL> - - - URL to invoke when state transitions to - insufficient data. May be used multiple times. - Defaults to None. - - - - - --time-constraint <Time Constraint> - - - Only evaluate the alarm if the time at - evaluation is within this time constraint. - Start point(s) of the constraint are specified - with a cron expression, whereas its duration - is given in seconds. Can be specified multiple - times for multiple time constraints, format - is: name=<CONSTRAINT_NAME>;start=<CRON>;durati - on=<SECONDS>;[description=<DESCRIPTION>;[timez - one=<IANA Timezone>]] Defaults to None. - - - - - --repeat-actions {True|False} - - - True if actions should be repeatedly notified - while alarm remains in target state. Defaults - to False. - - - - - --remove-time-constraint <Constraint names> - - - Name or list of names of the time constraints - to remove. - - - - - -m <METRIC>, --meter-name <METRIC> - - - Metric to evaluate against. - - - - - --period <PERIOD> - - - Length of each period (seconds) to evaluate - over. - - - - - --evaluation-periods <COUNT> - - - Number of periods to evaluate over. - - - - - --statistic <STATISTIC> - - - Statistic to evaluate, one of: ['max', 'min', - 'avg', 'sum', 'count']. - - - - - --comparison-operator <OPERATOR> - - - Operator to compare with, one of: ['lt', 'le', - 'eq', 'ne', 'ge', 'gt']. - - - - - --threshold <THRESHOLD> - - - Threshold to evaluate against. - - - - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, float, or boolean. - - - - -
-
- ceilometer capabilities - usage: ceilometer capabilities - -Print Ceilometer capabilities. - -
-
- ceilometer event-list - usage: ceilometer event-list [-q <QUERY>] [--no-traits] [-l <NUMBER>] - -List events. - - Optional arguments - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, floator datetime. - - - - - --no-traits - - - If specified, traits will not be printed. - - - - - -l <NUMBER>, --limit <NUMBER> - - - Maximum number of events to return. - - - - -
-
- ceilometer event-show - usage: ceilometer event-show <message_id> - -Show a particular event. - - Positional arguments - - <message_id> - - - The ID of the event. Should be a UUID. - - - - -
-
- ceilometer event-type-list - usage: ceilometer event-type-list - -List event types. - -
-
- ceilometer meter-list - usage: ceilometer meter-list [-q <QUERY>] [-l <NUMBER>] - -List the user's meters. - - Optional arguments - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, float, or boolean. - - - - - -l <NUMBER>, --limit <NUMBER> - - - Maximum number of meters to return. - - - - -
-
- ceilometer query-alarm-history - usage: ceilometer query-alarm-history [-f <FILTER>] [-o <ORDERBY>] - [-l <LIMIT>] - -Query Alarm History. - - Optional arguments - - -f <FILTER>, --filter <FILTER> - - - {complex_op: [{simple_op: {field_name: - value}}]} The complex_op is one of: ['and', - 'or'], simple_op is one of: ['=', '!=', '<', - '<=', '>', '>=']. - - - - - -o <ORDERBY>, --orderby <ORDERBY> - - - [{field_name: direction}, {field_name: - direction}] The direction is one of: ['asc', - 'desc']. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Maximum number of alarm history items to - return. - - - - -
-
- ceilometer query-alarms - usage: ceilometer query-alarms [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>] - -Query Alarms. - - Optional arguments - - -f <FILTER>, --filter <FILTER> - - - {complex_op: [{simple_op: {field_name: - value}}]} The complex_op is one of: ['and', - 'or'], simple_op is one of: ['=', '!=', '<', - '<=', '>', '>=']. - - - - - -o <ORDERBY>, --orderby <ORDERBY> - - - [{field_name: direction}, {field_name: - direction}] The direction is one of: ['asc', - 'desc']. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Maximum number of alarms to return. - - - - -
-
- ceilometer query-samples - usage: ceilometer query-samples [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>] - -Query samples. - - Optional arguments - - -f <FILTER>, --filter <FILTER> - - - {complex_op: [{simple_op: {field_name: - value}}]} The complex_op is one of: ['and', - 'or'], simple_op is one of: ['=', '!=', '<', - '<=', '>', '>=']. - - - - - -o <ORDERBY>, --orderby <ORDERBY> - - - [{field_name: direction}, {field_name: - direction}] The direction is one of: ['asc', - 'desc']. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Maximum number of samples to return. - - - - -
-
- ceilometer resource-list - usage: ceilometer resource-list [-q <QUERY>] [--meter-links] [-l <NUMBER>] - -List the resources. - - Optional arguments - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, float, or boolean. - - - - - --meter-links - - - If specified, meter links will be generated. - - - - - -l <NUMBER>, --limit <NUMBER> - - - Maximum number of resources to return. - - - - -
-
- ceilometer resource-show - usage: ceilometer resource-show <RESOURCE_ID> - -Show the resource. - - Positional arguments - - <RESOURCE_ID> - - - ID of the resource to show. - - - - -
-
- ceilometer sample-create - usage: ceilometer sample-create [--project-id <SAMPLE_PROJECT_ID>] - [--user-id <SAMPLE_USER_ID>] -r <RESOURCE_ID> - -m <METER_NAME> --meter-type <METER_TYPE> - --meter-unit <METER_UNIT> --sample-volume - <SAMPLE_VOLUME> - [--resource-metadata <RESOURCE_METADATA>] - [--timestamp <TIMESTAMP>] [--direct <DIRECT>] - -Create a sample. - - Optional arguments - - --project-id <SAMPLE_PROJECT_ID> - - - Tenant to associate with sample (configurable - by admin users only). - - - - - --user-id <SAMPLE_USER_ID> - - - User to associate with sample (configurable by - admin users only). - - - - - -r <RESOURCE_ID>, --resource-id <RESOURCE_ID> - - - ID of the resource. Required. - - - - - -m <METER_NAME>, --meter-name <METER_NAME> - - - The meter name. Required. - - - - - --meter-type <METER_TYPE> - - - The meter type. Required. - - - - - --meter-unit <METER_UNIT> - - - The meter unit. Required. - - - - - --sample-volume <SAMPLE_VOLUME> - - - The sample volume. Required. - - - - - --resource-metadata <RESOURCE_METADATA> - - - Resource metadata. Provided value should be a - set of key-value pairs e.g. {"key":"value"}. - - - - - --timestamp <TIMESTAMP> - - - The sample timestamp. - - - - - --direct <DIRECT> - - - Post sample to storage directly. Defaults to - False. - - - - -
-
- ceilometer sample-create-list - usage: ceilometer sample-create-list [--direct <DIRECT>] <SAMPLES_LIST> - -Create a sample list. - - Positional arguments - - <SAMPLES_LIST> - - - Json array with samples to create. - - - - - - Optional arguments - - --direct <DIRECT> - - - Post samples to storage directly. Defaults to False. - - - - -
-
- ceilometer sample-list - usage: ceilometer sample-list [-q <QUERY>] [-m <NAME>] [-l <NUMBER>] - -List the samples (return OldSample objects if -m/--meter is set). - - Optional arguments - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, float, or boolean. - - - - - -m <NAME>, --meter <NAME> - - - Name of meter to show samples for. - - - - - -l <NUMBER>, --limit <NUMBER> - - - Maximum number of samples to return. - - - - -
-
- ceilometer sample-show - usage: ceilometer sample-show <SAMPLE_ID> - -Show a sample. - - Positional arguments - - <SAMPLE_ID> - - - ID (aka message ID) of the sample to show. - - - - -
-
- ceilometer statistics - usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>] - [-a <FUNC>[<-<PARAM>]] - -List the statistics for a meter. - - Optional arguments - - -q <QUERY>, --query <QUERY> - - - key[op]data_type::value; list. data_type is - optional, but if supplied must be string, - integer, float, or boolean. - - - - - -m <NAME>, --meter <NAME> - - - Name of meter to list statistics for. - Required. - - - - - -p <PERIOD>, --period <PERIOD> - - - Period in seconds over which to group samples. - - - - - -g <FIELD>, --groupby <FIELD> - - - Field for group by. - - - - - -a <FUNC>[<-<PARAM>], --aggregate <FUNC>[<-<PARAM>] - - - Function for data aggregation. Available - aggregates are: count, cardinality, min, max, - sum, stddev, avg. Defaults to []. - - - - -
-
- ceilometer trait-description-list - usage: ceilometer trait-description-list -e <EVENT_TYPE> - -List trait info for an event type. - - Optional arguments - - -e <EVENT_TYPE>, --event_type <EVENT_TYPE> - - - Type of the event for which traits will be - shown. Required. - - - - -
-
- ceilometer trait-list - usage: ceilometer trait-list -e <EVENT_TYPE> -t <TRAIT_NAME> - -List all traits with name <trait_name> for Event Type <event_type>. - - Optional arguments - - -e <EVENT_TYPE>, --event_type <EVENT_TYPE> - - - Type of the event for which traits will - listed. Required. - - - - - -t <TRAIT_NAME>, --trait_name <TRAIT_NAME> - - - The name of the trait to list. Required. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_cinder_commands.xml b/doc/cli-reference/generated/ch_cli_cinder_commands.xml deleted file mode 100644 index e62b22d75d..0000000000 --- a/doc/cli-reference/generated/ch_cli_cinder_commands.xml +++ /dev/null @@ -1,7117 +0,0 @@ - - - - - - - - Block Storage service command-line client - - The cinder client is the command-line - interface (CLI) for the Block Storage service API and its extensions. - - This chapter documents cinder version - 1.5.0. - - - For help on a specific cinder - command, enter: - - $ cinder COMMAND - -
- cinder usage - usage: cinder [--version] [-d] [--os-auth-system <auth-system>] - [--service-type <service-type>] [--service-name <service-name>] - [--volume-service-name <volume-service-name>] - [--os-endpoint-type <os-endpoint-type>] - [--endpoint-type <endpoint-type>] - [--os-volume-api-version <volume-api-ver>] - [--bypass-url <bypass-url>] [--retries <retries>] - [--os-auth-strategy <auth-strategy>] - [--os-username <auth-user-name>] [--os-password <auth-password>] - [--os-tenant-name <auth-tenant-name>] - [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] - [--os-user-id <auth-user-id>] - [--os-user-domain-id <auth-user-domain-id>] - [--os-user-domain-name <auth-user-domain-name>] - [--os-project-id <auth-project-id>] - [--os-project-name <auth-project-name>] - [--os-project-domain-id <auth-project-domain-id>] - [--os-project-domain-name <auth-project-domain-name>] - [--os-region-name <region-name>] [--os-token <token>] - [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>] - [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] - <subcommand> ... - - Subcommands - - absolute-limits - - - Lists absolute limits for a user. - - - - - availability-zone-list - - - Lists all availability zones. - - - - - backup-create - - - Creates a volume backup. - - - - - backup-delete - - - Removes a backup. - - - - - backup-export - - - Export backup metadata record. - - - - - backup-import - - - Import backup metadata record. - - - - - backup-list - - - Lists all backups. - - - - - backup-reset-state - - - Explicitly updates the backup state. - - - - - backup-restore - - - Restores a backup. - - - - - backup-show - - - Shows backup details. - - - - - cgsnapshot-create - - - Creates a cgsnapshot. - - - - - cgsnapshot-delete - - - Removes one or more cgsnapshots. - - - - - cgsnapshot-list - - - Lists all cgsnapshots. - - - - - cgsnapshot-show - - - Shows cgsnapshot details. - - - - - consisgroup-create - - - Creates a consistency group. - - - - - consisgroup-create-from-src - - - Creates a consistency group from a cgsnapshot or a - source CG. - - - - - consisgroup-delete - - - Removes one or more consistency groups. - - - - - consisgroup-list - - - Lists all consistencygroups. - - - - - consisgroup-show - - - Shows details of a consistency group. - - - - - consisgroup-update - - - Updates a consistencygroup. - - - - - create - - - Creates a volume. - - - - - credentials - - - Shows user credentials returned from auth. - - - - - delete - - - Removes one or more volumes. - - - - - encryption-type-create - - - Creates encryption type for a volume type. Admin only. - - - - - encryption-type-delete - - - Deletes encryption type for a volume type. Admin only. - - - - - encryption-type-list - - - Shows encryption type details for volume types. Admin - only. - - - - - encryption-type-show - - - Shows encryption type details for a volume type. Admin - only. - - - - - encryption-type-update - - - Update encryption type information for a volume type - (Admin Only). - - - - - endpoints - - - Discovers endpoints registered by authentication - service. - - - - - extend - - - Attempts to extend size of an existing volume. - - - - - extra-specs-list - - - Lists current volume types and extra specs. - - - - - force-delete - - - Attempts force-delete of volume, regardless of state. - - - - - get-capabilities - - - Show backend volume stats and properties. Admin only. - - - - - get-pools - - - Show pool information for backends. Admin only. - - - - - image-metadata - - - Sets or deletes volume image metadata. - - - - - image-metadata-show - - - Shows volume image metadata. - - - - - list - - - Lists all volumes. - - - - - manage - - - Manage an existing volume. - - - - - metadata - - - Sets or deletes volume metadata. - - - - - metadata-show - - - Shows volume metadata. - - - - - metadata-update-all - - - Updates volume metadata. - - - - - migrate - - - Migrates volume to a new host. - - - - - qos-associate - - - Associates qos specs with specified volume type. - - - - - qos-create - - - Creates a qos specs. - - - - - qos-delete - - - Deletes a specified qos specs. - - - - - qos-disassociate - - - Disassociates qos specs from specified volume type. - - - - - qos-disassociate-all - - - Disassociates qos specs from all its associations. - - - - - qos-get-association - - - Lists all associations for specified qos specs. - - - - - qos-key - - - Sets or unsets specifications for a qos spec. - - - - - qos-list - - - Lists qos specs. - - - - - qos-show - - - Shows qos specs details. - - - - - quota-class-show - - - Lists quotas for a quota class. - - - - - quota-class-update - - - Updates quotas for a quota class. - - - - - quota-defaults - - - Lists default quotas for a tenant. - - - - - quota-delete - - - Delete the quotas for a tenant. - - - - - quota-show - - - Lists quotas for a tenant. - - - - - quota-update - - - Updates quotas for a tenant. - - - - - quota-usage - - - Lists quota usage for a tenant. - - - - - rate-limits - - - Lists rate limits for a user. - - - - - readonly-mode-update - - - Updates volume read-only access-mode flag. - - - - - rename - - - Renames a volume. - - - - - replication-disable - - - Disables volume replication on a given volume. - - - - - replication-enable - - - Enables volume replication on a given volume. - - - - - replication-failover - - - Failover a volume to a secondary target - - - - - replication-list-targets - - - List replication targets available for a volume. - - - - - replication-promote - - - Promote a secondary volume to primary for a - relationship. - - - - - replication-reenable - - - Sync the secondary volume with primary for a - relationship. - - - - - reset-state - - - Explicitly updates the volume state in the Cinder - database. - - - - - retype - - - Changes the volume type for a volume. - - - - - service-disable - - - Disables the service. - - - - - service-enable - - - Enables the service. - - - - - service-list - - - Lists all services. Filter by host and service binary. - - - - - set-bootable - - - Update bootable status of a volume. - - - - - show - - - Shows volume details. - - - - - snapshot-create - - - Creates a snapshot. - - - - - snapshot-delete - - - Removes one or more snapshots. - - - - - snapshot-list - - - Lists all snapshots. - - - - - snapshot-metadata - - - Sets or deletes snapshot metadata. - - - - - snapshot-metadata-show - - - Shows snapshot metadata. - - - - - snapshot-metadata-update-all - - - Updates snapshot metadata. - - - - - snapshot-rename - - - Renames a snapshot. - - - - - snapshot-reset-state - - - Explicitly updates the snapshot state. - - - - - snapshot-show - - - Shows snapshot details. - - - - - transfer-accept - - - Accepts a volume transfer. - - - - - transfer-create - - - Creates a volume transfer. - - - - - transfer-delete - - - Undoes a transfer. - - - - - transfer-list - - - Lists all transfers. - - - - - transfer-show - - - Shows transfer details. - - - - - type-access-add - - - Adds volume type access for the given project. - - - - - type-access-list - - - Print access information about the given volume type. - - - - - type-access-remove - - - Removes volume type access for the given project. - - - - - type-create - - - Creates a volume type. - - - - - type-default - - - List the default volume type. - - - - - type-delete - - - Deletes a volume type. - - - - - type-key - - - Sets or unsets extra_spec for a volume type. - - - - - type-list - - - Lists available 'volume types'. (Admin only will see - private types) - - - - - type-show - - - Show volume type details. - - - - - type-update - - - Updates volume type name ,description and/or - is_public. - - - - - unmanage - - - Stop managing a volume. - - - - - upload-to-image - - - Uploads volume to Image Service as an image. - - - - - bash-completion - - - Prints arguments for bash_completion. - - - - - help - - - Shows help about this program or one of its - subcommands. - - - - - list-extensions - - - Lists all available os-api extensions. - - - - -
-
- cinder optional arguments - - - --version - - - show program's version number and exit - - - - - -d, --debug - - - Shows debugging output. - - - - - --os-auth-system <auth-system> - - - Defaults to env[OS_AUTH_SYSTEM]. - - - - - --service-type <service-type> - - - Service type. For most actions, default is volume. - - - - - --service-name <service-name> - - - Service name. Default=env[CINDER_SERVICE_NAME]. - - - - - --volume-service-name <volume-service-name> - - - Volume service name. - Default=env[CINDER_VOLUME_SERVICE_NAME]. - - - - - --os-endpoint-type <os-endpoint-type> - - - Endpoint type, which is publicURL or internalURL. - Default=env[OS_ENDPOINT_TYPE] or nova - env[CINDER_ENDPOINT_TYPE] or publicURL. - - - - - --endpoint-type <endpoint-type> - - - DEPRECATED! Use --os-endpoint-type. - - - - - --os-volume-api-version <volume-api-ver> - - - Block Storage API version. Valid values are 1 or 2. - Default=env[OS_VOLUME_API_VERSION]. - - - - - --bypass-url <bypass-url> - - - Use this API endpoint instead of the Service Catalog. - Defaults to env[CINDERCLIENT_BYPASS_URL]. - - - - - --retries <retries> - - - Number of retries. - - - - - --os-auth-strategy <auth-strategy> - - - Authentication strategy (Env: OS_AUTH_STRATEGY, - default keystone). For now, any other value will - disable the authentication. - - - - - --os-username <auth-user-name> - - - OpenStack user name. Default=env[OS_USERNAME]. - - - - - --os-password <auth-password> - - - Password for OpenStack user. Default=env[OS_PASSWORD]. - - - - - --os-tenant-name <auth-tenant-name> - - - Tenant name. Default=env[OS_TENANT_NAME]. - - - - - --os-tenant-id <auth-tenant-id> - - - ID for the tenant. Default=env[OS_TENANT_ID]. - - - - - --os-auth-url <auth-url> - - - URL for the authentication service. - Default=env[OS_AUTH_URL]. - - - - - --os-user-id <auth-user-id> - - - Authentication user ID (Env: OS_USER_ID). - - - - - --os-user-domain-id <auth-user-domain-id> - - - OpenStack user domain ID. Defaults to - env[OS_USER_DOMAIN_ID]. - - - - - --os-user-domain-name <auth-user-domain-name> - - - OpenStack user domain name. Defaults to - env[OS_USER_DOMAIN_NAME]. - - - - - --os-project-id <auth-project-id> - - - Another way to specify tenant ID. This option is - mutually exclusive with --os-tenant-id. Defaults to - env[OS_PROJECT_ID]. - - - - - --os-project-name <auth-project-name> - - - Another way to specify tenant name. This option is - mutually exclusive with --os-tenant-name. Defaults to - env[OS_PROJECT_NAME]. - - - - - --os-project-domain-id <auth-project-domain-id> - - - Defaults to env[OS_PROJECT_DOMAIN_ID]. - - - - - --os-project-domain-name <auth-project-domain-name> - - - Defaults to env[OS_PROJECT_DOMAIN_NAME]. - - - - - --os-region-name <region-name> - - - Region name. Default=env[OS_REGION_NAME]. - - - - - --os-token <token> - - - Defaults to env[OS_TOKEN]. - - - - - --os-url <url> - - - Defaults to env[OS_URL]. - - - - - --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 <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - Set request timeout (in seconds). - - - - -
- -
- Block Storage API v1 commands -
- cinder absolute-limits - usage: cinder absolute-limits - -Lists absolute limits for a user. - -
-
- cinder availability-zone-list - usage: cinder availability-zone-list - -Lists all availability zones. - -
-
- cinder backup-create - usage: cinder backup-create [--container <container>] [--name <name>] - [--description <description>] [--incremental] - [--force] - <volume> - -Creates a volume backup. - - Positional arguments - - <volume> - - - Name or ID of volume to backup. - - - - - - Optional arguments - - --container <container> - - - Backup container name. Default=None. - - - - - --name <name> - - - Backup name. Default=None. - - - - - --description <description> - - - Backup description. Default=None. - - - - - --incremental - - - Incremental backup. Default=False. - - - - - --force - - - Allows or disallows backup of a volume when the volume - is attached to an instance. If set to True, backs up - the volume whether its status is "available" or "in- - use". The backup of an "in-use" volume means your data - is crash consistent. Default=False. - - - - -
-
- cinder backup-delete - usage: cinder backup-delete <backup> - -Removes a backup. - - Positional arguments - - <backup> - - - Name or ID of backup to delete. - - - - -
-
- cinder backup-export - usage: cinder backup-export <backup> - -Export backup metadata record. - - Positional arguments - - <backup> - - - ID of the backup to export. - - - - -
-
- cinder backup-import - usage: cinder backup-import <backup_service> <backup_url> - -Import backup metadata record. - - Positional arguments - - <backup_service> - - - Backup service to use for importing the backup. - - - - - <backup_url> - - - Backup URL for importing the backup metadata. - - - - -
-
- cinder backup-list - usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>] - [--status <status>] [--volume-id <volume-id>] - [--marker <marker>] [--limit <limit>] - [--sort <key>[:<direction>]] - -Lists all backups. - - Optional arguments - - --all-tenants [<all_tenants>] - - - Shows details for all tenants. Admin only. - - - - - --name <name> - - - Filters results by a name. Default=None. - - - - - --status <status> - - - Filters results by a status. Default=None. - - - - - --volume-id <volume-id> - - - Filters results by a volume ID. Default=None. - - - - - --marker <marker> - - - Begin returning backups that appear later in the - backup list than that represented by this id. - Default=None. - - - - - --limit <limit> - - - Maximum number of backups to return. Default=None. - - - - - --sort <key>[:<direction>] - - - Comma-separated list of sort keys and directions in - the form of <key>[:<asc|desc>]. Valid keys: id, - status, size, availability_zone, name, bootable, - created_at. Default=None. - - - - -
-
- cinder backup-reset-state - usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...] - -Explicitly updates the backup state. - - Positional arguments - - <backup> - - - Name or ID of the backup to modify. - - - - - - Optional arguments - - --state <state> - - - The state to assign to the backup. Valid values are - "available", "error", "creating", "deleting", and - "error_deleting". Default=available. - - - - -
-
- cinder backup-restore - usage: cinder backup-restore [--volume <volume>] <backup> - -Restores a backup. - - Positional arguments - - <backup> - - - ID of backup to restore. - - - - - - Optional arguments - - --volume <volume> - - - Name or ID of volume to which to restore. Default=None. - - - - -
-
- cinder backup-show - usage: cinder backup-show <backup> - -Shows backup details. - - Positional arguments - - <backup> - - - Name or ID of backup. - - - - -
-
- cinder cgsnapshot-create - usage: cinder cgsnapshot-create [--name <name>] [--description <description>] - <consistencygroup> - -Creates a cgsnapshot. - - Positional arguments - - <consistencygroup> - - - Name or ID of a consistency group. - - - - - - Optional arguments - - --name <name> - - - Cgsnapshot name. Default=None. - - - - - --description <description> - - - Cgsnapshot description. Default=None. - - - - -
-
- cinder cgsnapshot-delete - usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...] - -Removes one or more cgsnapshots. - - Positional arguments - - <cgsnapshot> - - - Name or ID of one or more cgsnapshots to be deleted. - - - - -
-
- cinder cgsnapshot-list - usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] - [--consistencygroup-id <consistencygroup_id>] - -Lists all cgsnapshots. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - - --status <status> - - - Filters results by a status. Default=None. - - - - - --consistencygroup-id <consistencygroup_id> - - - Filters results by a consistency group ID. - Default=None. - - - - -
-
- cinder cgsnapshot-show - usage: cinder cgsnapshot-show <cgsnapshot> - -Shows cgsnapshot details. - - Positional arguments - - <cgsnapshot> - - - Name or ID of cgsnapshot. - - - - -
-
- cinder consisgroup-create - usage: cinder consisgroup-create [--name <name>] [--description <description>] - [--availability-zone <availability-zone>] - <volume-types> - -Creates a consistency group. - - Positional arguments - - <volume-types> - - - Volume types. - - - - - - Optional arguments - - --name <name> - - - Name of a consistency group. - - - - - --description <description> - - - Description of a consistency group. Default=None. - - - - - --availability-zone <availability-zone> - - - Availability zone for volume. Default=None. - - - - -
-
- cinder consisgroup-create-from-src - usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] - [--source-cg <source-cg>] - [--name <name>] - [--description <description>] - -Creates a consistency group from a cgsnapshot or a source CG. - - Optional arguments - - --cgsnapshot <cgsnapshot> - - - Name or ID of a cgsnapshot. Default=None. - - - - - --source-cg <source-cg> - - - Name or ID of a source CG. Default=None. - - - - - --name <name> - - - Name of a consistency group. Default=None. - - - - - --description <description> - - - Description of a consistency group. Default=None. - - - - -
-
- cinder consisgroup-delete - usage: cinder consisgroup-delete [--force] - <consistencygroup> [<consistencygroup> ...] - -Removes one or more consistency groups. - - Positional arguments - - <consistencygroup> - - - Name or ID of one or more consistency groups to be - deleted. - - - - - - Optional arguments - - --force - - - Allows or disallows consistency groups to be deleted. If - the consistency group is empty, it can be deleted - without the force flag. If the consistency group is not - empty, the force flag is required for it to be deleted. - - - - -
-
- cinder consisgroup-list - usage: cinder consisgroup-list [--all-tenants [<0|1>]] - -Lists all consistencygroups. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - -
-
- cinder consisgroup-show - usage: cinder consisgroup-show <consistencygroup> - -Shows details of a consistency group. - - Positional arguments - - <consistencygroup> - - - Name or ID of a consistency group. - - - - -
-
- cinder consisgroup-update - usage: cinder consisgroup-update [--name <name>] [--description <description>] - [--add-volumes <uuid1,uuid2,......>] - [--remove-volumes <uuid3,uuid4,......>] - <consistencygroup> - -Updates a consistencygroup. - - Positional arguments - - <consistencygroup> - - - Name or ID of a consistency group. - - - - - - Optional arguments - - --name <name> - - - New name for consistency group. Default=None. - - - - - --description <description> - - - New description for consistency group. Default=None. - - - - - --add-volumes <uuid1,uuid2,......> - - - UUID of one or more volumes to be added to the - consistency group, separated by commas. Default=None. - - - - - --remove-volumes <uuid3,uuid4,......> - - - UUID of one or more volumes to be removed from the - consistency group, separated by commas. Default=None. - - - - -
-
- cinder create - usage: cinder create [--consisgroup-id <consistencygroup-id>] - [--snapshot-id <snapshot-id>] - [--source-volid <source-volid>] - [--source-replica <source-replica>] - [--image-id <image-id>] [--image <image>] [--name <name>] - [--description <description>] - [--volume-type <volume-type>] - [--availability-zone <availability-zone>] - [--metadata [<key=value> [<key=value> ...]]] - [--hint <key=value>] [--allow-multiattach] - [<size>] - -Creates a volume. - - Positional arguments - - <size> - - - Size of volume, in GiBs. (Required unless snapshot-id - /source-volid is specified). - - - - - - Optional arguments - - --consisgroup-id <consistencygroup-id> - - - ID of a consistency group where the new volume belongs - to. Default=None. - - - - - --snapshot-id <snapshot-id> - - - Creates volume from snapshot ID. Default=None. - - - - - --source-volid <source-volid> - - - Creates volume from volume ID. Default=None. - - - - - --source-replica <source-replica> - - - Creates volume from replicated volume ID. - Default=None. - - - - - --image-id <image-id> - - - Creates volume from image ID. Default=None. - - - - - --image <image> - - - Creates a volume from image (ID or name). - Default=None. - - - - - --name <name> - - - Volume name. Default=None. - - - - - --description <description> - - - Volume description. Default=None. - - - - - --volume-type <volume-type> - - - Volume type. Default=None. - - - - - --availability-zone <availability-zone> - - - Availability zone for volume. Default=None. - - - - - --metadata [<key=value> [<key=value> ...]] - - - Metadata key and value pairs. Default=None. - - - - - --hint <key=value> - - - Scheduler hint, like in nova. - - - - - --allow-multiattach - - - Allow volume to be attached more than once. - Default=False - - - - -
-
- cinder credentials - usage: cinder credentials - -Shows user credentials returned from auth. - -
-
- cinder delete - usage: cinder delete <volume> [<volume> ...] - -Removes one or more volumes. - - Positional arguments - - <volume> - - - Name or ID of volume or volumes to delete. - - - - -
-
- cinder encryption-type-create - usage: cinder encryption-type-create [--cipher <cipher>] - [--key_size <key_size>] - [--control_location <control_location>] - <volume_type> <provider> - -Creates encryption type for a volume type. Admin only. - - Positional arguments - - <volume_type> - - - Name or ID of volume type. - - - - - <provider> - - - The class that provides encryption support. For - example, LuksEncryptor. - - - - - - Optional arguments - - --cipher <cipher> - - - The encryption algorithm or mode. For example, aes- - xts-plain64. Default=None. - - - - - --key_size <key_size> - - - Size of encryption key, in bits. For example, 128 or - 256. Default=None. - - - - - --control_location <control_location> - - - Notional service where encryption is performed. Valid - values are "front-end" or "back-end." For example, - front-end=Nova. Default is "front-end." - - - - -
-
- cinder encryption-type-delete - usage: cinder encryption-type-delete <volume_type> - -Deletes encryption type for a volume type. Admin only. - - Positional arguments - - <volume_type> - - - Name or ID of volume type. - - - - -
-
- cinder encryption-type-list - usage: cinder encryption-type-list - -Shows encryption type details for volume types. Admin only. - -
-
- cinder encryption-type-show - usage: cinder encryption-type-show <volume_type> - -Shows encryption type details for a volume type. Admin only. - - Positional arguments - - <volume_type> - - - Name or ID of volume type. - - - - -
-
- cinder encryption-type-update - usage: cinder encryption-type-update [--provider <provider>] - [--cipher [<cipher>]] - [--key-size [<key-size>]] - [--control-location <control-location>] - <volume-type> - -Update encryption type information for a volume type (Admin Only). - - Positional arguments - - <volume-type> - - - Name or ID of the volume type - - - - - - Optional arguments - - --provider <provider> - - - Class providing encryption support (e.g. - LuksEncryptor) (Optional) - - - - - --cipher [<cipher>] - - - Encryption algorithm/mode to use (e.g., aes-xts- - plain64). Provide parameter without value to set to - provider default. (Optional) - - - - - --key-size [<key-size>] - - - Size of the encryption key, in bits (e.g., 128, 256). - Provide parameter without value to set to provider - default. (Optional) - - - - - --control-location <control-location> - - - Notional service where encryption is performed (e.g., - front-end=Nova). Values: 'front-end', 'back-end' - (Optional) - - - - -
-
- cinder endpoints - usage: cinder endpoints - -Discovers endpoints registered by authentication service. - -
-
- cinder extend - usage: cinder extend <volume> <new_size> - -Attempts to extend size of an existing volume. - - Positional arguments - - <volume> - - - Name or ID of volume to extend. - - - - - <new_size> - - - New size of volume, in GiBs. - - - - -
-
- cinder extra-specs-list - usage: cinder extra-specs-list - -Lists current volume types and extra specs. - -
-
- cinder force-delete - usage: cinder force-delete <volume> [<volume> ...] - -Attempts force-delete of volume, regardless of state. - - Positional arguments - - <volume> - - - Name or ID of volume or volumes to delete. - - - - -
-
- cinder get-capabilities - usage: cinder get-capabilities <host> - -Show backend volume stats and properties. Admin only. - - Positional arguments - - <host> - - - Cinder host to show backend volume stats and properties; takes the - form: host@backend-name - - - - -
-
- cinder get-pools - usage: cinder get-pools [--detail] - -Show pool information for backends. Admin only. - - Optional arguments - - --detail - - - Show detailed information about pools. - - - - -
-
- cinder image-metadata - usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...] - -Sets or deletes volume image metadata. - - Positional arguments - - <volume> - - - Name or ID of volume for which to update metadata. - - - - - <action> - - - The action. Valid values are 'set' or 'unset.' - - - - - <key=value> - - - Metadata key and value pair to set or unset. For unset, specify - only the key. - - - - -
-
- cinder image-metadata-show - usage: cinder image-metadata-show <volume> - -Shows volume image metadata. - - Positional arguments - - <volume> - - - ID of volume. - - - - -
-
- cinder list - usage: cinder list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] - [--migration_status <migration_status>] - [--metadata [<key=value> [<key=value> ...]]] - [--marker <marker>] [--limit <limit>] - [--sort <key>[:<direction>]] [--tenant [<tenant>]] - -Lists all volumes. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - - --name <name> - - - Filters results by a name. Default=None. - - - - - --status <status> - - - Filters results by a status. Default=None. - - - - - --migration_status <migration_status> - - - Filters results by a migration status. Default=None. - Admin only. - - - - - --metadata [<key=value> [<key=value> ...]] - - - Filters results by a metadata key and value pair. - Default=None. - - - - - --marker <marker> - - - Begin returning volumes that appear later in the - volume list than that represented by this volume id. - Default=None. - - - - - --limit <limit> - - - Maximum number of volumes to return. Default=None. - - - - - --sort <key>[:<direction>] - - - Comma-separated list of sort keys and directions in - the form of <key>[:<asc|desc>]. Valid keys: id, - status, size, availability_zone, name, bootable, - created_at. Default=None. - - - - - --tenant [<tenant>] - - - Display information from single tenant (Admin only). - - - - -
-
- cinder list-extensions - usage: cinder list-extensions - -Lists all available os-api extensions. - -
-
- cinder manage - usage: cinder manage [--id-type <id-type>] [--name <name>] - [--description <description>] - [--volume-type <volume-type>] - [--availability-zone <availability-zone>] - [--metadata [<key=value> [<key=value> ...]]] [--bootable] - <host> <identifier> - -Manage an existing volume. - - Positional arguments - - <host> - - - Cinder host on which the existing volume resides; - takes the form: host@backend-name#pool - - - - - <identifier> - - - Name or other Identifier for existing volume - - - - - - Optional arguments - - --id-type <id-type> - - - Type of backend device identifier provided, typically - source-name or source-id (Default=source-name) - - - - - --name <name> - - - Volume name (Default=None) - - - - - --description <description> - - - Volume description (Default=None) - - - - - --volume-type <volume-type> - - - Volume type (Default=None) - - - - - --availability-zone <availability-zone> - - - Availability zone for volume (Default=None) - - - - - --metadata [<key=value> [<key=value> ...]] - - - Metadata key=value pairs (Default=None) - - - - - --bootable - - - Specifies that the newly created volume should be - marked as bootable - - - - -
-
- cinder metadata - usage: cinder metadata <volume> <action> <key=value> [<key=value> ...] - -Sets or deletes volume metadata. - - Positional arguments - - <volume> - - - Name or ID of volume for which to update metadata. - - - - - <action> - - - The action. Valid values are "set" or "unset." - - - - - <key=value> - - - Metadata key and value pair to set or unset. For unset, specify - only the key. - - - - -
-
- cinder metadata-show - usage: cinder metadata-show <volume> - -Shows volume metadata. - - Positional arguments - - <volume> - - - ID of volume. - - - - -
-
- cinder metadata-update-all - usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...] - -Updates volume metadata. - - Positional arguments - - <volume> - - - ID of volume for which to update metadata. - - - - - <key=value> - - - Metadata key and value pair or pairs to update. - - - - -
-
- cinder migrate - usage: cinder migrate [--force-host-copy [<True|False>]] - [--lock-volume [<True|False>]] - <volume> <host> - -Migrates volume to a new host. - - Positional arguments - - <volume> - - - ID of volume to migrate. - - - - - <host> - - - Destination host. Takes the form: host@backend- - name#pool - - - - - - Optional arguments - - --force-host-copy [<True|False>] - - - Enables or disables generic host-based force- - migration, which bypasses driver optimizations. - Default=False. - - - - - --lock-volume [<True|False>] - - - Enables or disables the termination of volume - migration caused by other commands. This option - applies to the available volume. True means it locks - the volume state and does not allow the migration to - be aborted. The volume status will be in maintenance - during the migration. False means it allows the volume - migration to be aborted. The volume status is still in - the original status. Default=False. - - - - -
-
- cinder qos-associate - usage: cinder qos-associate <qos_specs> <volume_type_id> - -Associates qos specs with specified volume type. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications. - - - - - <volume_type_id> - - - ID of volume type with which to associate QoS - specifications. - - - - -
-
- cinder qos-create - usage: cinder qos-create <name> <key=value> [<key=value> ...] - -Creates a qos specs. - - Positional arguments - - <name> - - - Name of new QoS specifications. - - - - - <key=value> - - - QoS specifications. - - - - -
-
- cinder qos-delete - usage: cinder qos-delete [--force [<True|False>]] <qos_specs> - -Deletes a specified qos specs. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications to delete. - - - - - - Optional arguments - - --force [<True|False>] - - - Enables or disables deletion of in-use QoS - specifications. Default=False. - - - - -
-
- cinder qos-disassociate - usage: cinder qos-disassociate <qos_specs> <volume_type_id> - -Disassociates qos specs from specified volume type. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications. - - - - - <volume_type_id> - - - ID of volume type with which to associate QoS - specifications. - - - - -
-
- cinder qos-disassociate-all - usage: cinder qos-disassociate-all <qos_specs> - -Disassociates qos specs from all its associations. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications on which to operate. - - - - -
-
- cinder qos-get-association - usage: cinder qos-get-association <qos_specs> - -Lists all associations for specified qos specs. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications. - - - - -
-
- cinder qos-key - usage: cinder qos-key <qos_specs> <action> key=value [key=value ...] - -Sets or unsets specifications for a qos spec. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications. - - - - - <action> - - - The action. Valid values are "set" or "unset." - - - - - key=value - - - Metadata key and value pair to set or unset. For unset, specify - only the key. - - - - -
-
- cinder qos-list - usage: cinder qos-list - -Lists qos specs. - -
-
- cinder qos-show - usage: cinder qos-show <qos_specs> - -Shows qos specs details. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications to show. - - - - -
-
- cinder quota-class-show - usage: cinder quota-class-show <class> - -Lists quotas for a quota class. - - Positional arguments - - <class> - - - Name of quota class for which to list quotas. - - - - -
-
- cinder quota-class-update - usage: cinder quota-class-update [--volumes <volumes>] - [--snapshots <snapshots>] - [--gigabytes <gigabytes>] - [--volume-type <volume_type_name>] - <class_name> - -Updates quotas for a quota class. - - Positional arguments - - <class_name> - - - Name of quota class for which to set quotas. - - - - - - Optional arguments - - --volumes <volumes> - - - The new "volumes" quota value. Default=None. - - - - - --snapshots <snapshots> - - - The new "snapshots" quota value. Default=None. - - - - - --gigabytes <gigabytes> - - - The new "gigabytes" quota value. Default=None. - - - - - --volume-type <volume_type_name> - - - Volume type. Default=None. - - - - -
-
- cinder quota-defaults - usage: cinder quota-defaults <tenant_id> - -Lists default quotas for a tenant. - - Positional arguments - - <tenant_id> - - - ID of tenant for which to list quota defaults. - - - - -
-
- cinder quota-delete - usage: cinder quota-delete <tenant_id> - -Delete the quotas for a tenant. - - Positional arguments - - <tenant_id> - - - UUID of tenant to delete the quotas for. - - - - -
-
- cinder quota-show - usage: cinder quota-show <tenant_id> - -Lists quotas for a tenant. - - Positional arguments - - <tenant_id> - - - ID of tenant for which to list quotas. - - - - -
-
- cinder quota-update - usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] - [--gigabytes <gigabytes>] [--backups <backups>] - [--backup-gigabytes <backup_gigabytes>] - [--consistencygroups <consistencygroups>] - [--volume-type <volume_type_name>] - [--per-volume-gigabytes <per_volume_gigabytes>] - <tenant_id> - -Updates quotas for a tenant. - - Positional arguments - - <tenant_id> - - - ID of tenant for which to set quotas. - - - - - - Optional arguments - - --volumes <volumes> - - - The new "volumes" quota value. Default=None. - - - - - --snapshots <snapshots> - - - The new "snapshots" quota value. Default=None. - - - - - --gigabytes <gigabytes> - - - The new "gigabytes" quota value. Default=None. - - - - - --backups <backups> - - - The new "backups" quota value. Default=None. - - - - - --backup-gigabytes <backup_gigabytes> - - - The new "backup_gigabytes" quota value. Default=None. - - - - - --consistencygroups <consistencygroups> - - - The new "consistencygroups" quota value. Default=None. - - - - - --volume-type <volume_type_name> - - - Volume type. Default=None. - - - - - --per-volume-gigabytes <per_volume_gigabytes> - - - Set max volume size limit. Default=None. - - - - -
-
- cinder quota-usage - usage: cinder quota-usage <tenant_id> - -Lists quota usage for a tenant. - - Positional arguments - - <tenant_id> - - - ID of tenant for which to list quota usage. - - - - -
-
- cinder rate-limits - usage: cinder rate-limits - -Lists rate limits for a user. - -
-
- cinder readonly-mode-update - usage: cinder readonly-mode-update <volume> <True|true|False|false> - -Updates volume read-only access-mode flag. - - Positional arguments - - <volume> - - - ID of volume to update. - - - - - <True|true|False|false> - - - Enables or disables update of volume to read-only - access mode. - - - - -
-
- cinder rename - usage: cinder rename [--description <description>] <volume> [<name>] - -Renames a volume. - - Positional arguments - - <volume> - - - Name or ID of volume to rename. - - - - - <name> - - - New name for volume. - - - - - - Optional arguments - - --description <description> - - - Volume description. Default=None. - - - - -
-
- cinder replication-disable - usage: cinder replication-disable <volume> - -Disables volume replication on a given volume. - - Positional arguments - - <volume> - - - ID of volume to disable replication. - - - - -
-
- cinder replication-enable - usage: cinder replication-enable <volume> - -Enables volume replication on a given volume. - - Positional arguments - - <volume> - - - ID of volume to enable replication. - - - - -
-
- cinder replication-failover - usage: cinder replication-failover <volume> <secondary> - -Failover a volume to a secondary target - - Positional arguments - - <volume> - - - ID of volume to failover. - - - - - <secondary> - - - A unqiue identifier that represents a failover target. - - - - -
-
- cinder replication-list-targets - usage: cinder replication-list-targets <volume> - -List replication targets available for a volume. - - Positional arguments - - <volume> - - - ID of volume to list available replication targets. - - - - -
-
- cinder replication-promote - usage: cinder replication-promote <volume> - -Promote a secondary volume to primary for a relationship. - - Positional arguments - - <volume> - - - Name or ID of the volume to promote. The volume should have the - replica volume created with source-replica argument. - - - - -
-
- cinder replication-reenable - usage: cinder replication-reenable <volume> - -Sync the secondary volume with primary for a relationship. - - Positional arguments - - <volume> - - - Name or ID of the volume to reenable replication. The replication- - status of the volume should be inactive. - - - - -
-
- cinder reset-state - usage: cinder reset-state [--state <state>] [--attach-status <attach-status>] - [--reset-migration-status] - <volume> [<volume> ...] - -Explicitly updates the volume state in the Cinder database. Note that this -does not affect whether the volume is actually attached to the Nova compute -host or instance and can result in an unusable volume. Being a database change -only, this has no impact on the true state of the volume and may not match the -actual state. This can render a volume unusable in the case of change to the -'available' state. - - Positional arguments - - <volume> - - - Name or ID of volume to modify. - - - - - - Optional arguments - - --state <state> - - - The state to assign to the volume. Valid values are - "available", "error", "creating", "deleting", "in- - use", "attaching", "detaching", "error_deleting" and - "maintenance". NOTE: This command simply changes the - state of the Volume in the DataBase with no regard to - actual status, exercise caution when using. - Default=available. - - - - - --attach-status <attach-status> - - - The attach status to assign to the volume in the - DataBase, with no regard to the actual status. Valid - values are "attached" and "detached". Default=None, - that means the status is unchanged. - - - - - --reset-migration-status - - - Clears the migration status of the volume in the - DataBase that indicates the volume is source or - destination of volume migration, with no regard to the - actual status. - - - - -
-
- cinder retype - usage: cinder retype [--migration-policy <never|on-demand>] - <volume> <volume-type> - -Changes the volume type for a volume. - - Positional arguments - - <volume> - - - Name or ID of volume for which to modify type. - - - - - <volume-type> - - - New volume type. - - - - - - Optional arguments - - --migration-policy <never|on-demand> - - - Migration policy during retype of volume. - - - - -
-
- cinder service-disable - usage: cinder service-disable [--reason <reason>] <hostname> <binary> - -Disables the service. - - Positional arguments - - <hostname> - - - Host name. - - - - - <binary> - - - Service binary. - - - - - - Optional arguments - - --reason <reason> - - - Reason for disabling service. - - - - -
-
- cinder service-enable - usage: cinder service-enable <hostname> <binary> - -Enables the service. - - Positional arguments - - <hostname> - - - Host name. - - - - - <binary> - - - Service binary. - - - - -
-
- cinder service-list - usage: cinder service-list [--host <hostname>] [--binary <binary>] - -Lists all services. Filter by host and service binary. - - Optional arguments - - --host <hostname> - - - Host name. Default=None. - - - - - --binary <binary> - - - Service binary. Default=None. - - - - -
-
- cinder set-bootable - usage: cinder set-bootable <volume> <True|true|False|false> - -Update bootable status of a volume. - - Positional arguments - - <volume> - - - ID of the volume to update. - - - - - <True|true|False|false> - - - Flag to indicate whether volume is bootable. - - - - -
-
- cinder show - usage: cinder show <volume> - -Shows volume details. - - Positional arguments - - <volume> - - - Name or ID of volume. - - - - -
-
- cinder snapshot-create - usage: cinder snapshot-create [--force [<True|False>]] [--name <name>] - [--description <description>] - [--metadata [<key=value> [<key=value> ...]]] - <volume> - -Creates a snapshot. - - Positional arguments - - <volume> - - - Name or ID of volume to snapshot. - - - - - - Optional arguments - - --force [<True|False>] - - - Allows or disallows snapshot of a volume when the - volume is attached to an instance. If set to True, - ignores the current status of the volume when - attempting to snapshot it rather than forcing it to be - available. Default=False. - - - - - --name <name> - - - Snapshot name. Default=None. - - - - - --description <description> - - - Snapshot description. Default=None. - - - - - --metadata [<key=value> [<key=value> ...]] - - - Snapshot metadata key and value pairs. Default=None. - - - - -
-
- cinder snapshot-delete - usage: cinder snapshot-delete <snapshot> [<snapshot> ...] - -Removes one or more snapshots. - - Positional arguments - - <snapshot> - - - Name or ID of the snapshot(s) to delete. - - - - -
-
- cinder snapshot-list - usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>] - [--status <status>] [--volume-id <volume-id>] - [--marker <marker>] [--limit <limit>] - [--sort <key>[:<direction>]] - -Lists all snapshots. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - - --name <name> - - - Filters results by a name. Default=None. - - - - - --status <status> - - - Filters results by a status. Default=None. - - - - - --volume-id <volume-id> - - - Filters results by a volume ID. Default=None. - - - - - --marker <marker> - - - Begin returning snapshots that appear later in the - snapshot list than that represented by this id. - Default=None. - - - - - --limit <limit> - - - Maximum number of snapshots to return. Default=None. - - - - - --sort <key>[:<direction>] - - - Comma-separated list of sort keys and directions in - the form of <key>[:<asc|desc>]. Valid keys: id, - status, size, availability_zone, name, bootable, - created_at. Default=None. - - - - -
-
- cinder snapshot-metadata - usage: cinder snapshot-metadata <snapshot> <action> <key=value> - [<key=value> ...] - -Sets or deletes snapshot metadata. - - Positional arguments - - <snapshot> - - - ID of snapshot for which to update metadata. - - - - - <action> - - - The action. Valid values are "set" or "unset." - - - - - <key=value> - - - Metadata key and value pair to set or unset. For unset, specify - only the key. - - - - -
-
- cinder snapshot-metadata-show - usage: cinder snapshot-metadata-show <snapshot> - -Shows snapshot metadata. - - Positional arguments - - <snapshot> - - - ID of snapshot. - - - - -
-
- cinder snapshot-metadata-update-all - usage: cinder snapshot-metadata-update-all <snapshot> <key=value> - [<key=value> ...] - -Updates snapshot metadata. - - Positional arguments - - <snapshot> - - - ID of snapshot for which to update metadata. - - - - - <key=value> - - - Metadata key and value pair to update. - - - - -
-
- cinder snapshot-rename - usage: cinder snapshot-rename [--description <description>] - <snapshot> [<name>] - -Renames a snapshot. - - Positional arguments - - <snapshot> - - - Name or ID of snapshot. - - - - - <name> - - - New name for snapshot. - - - - - - Optional arguments - - --description <description> - - - Snapshot description. Default=None. - - - - -
-
- cinder snapshot-reset-state - usage: cinder snapshot-reset-state [--state <state>] - <snapshot> [<snapshot> ...] - -Explicitly updates the snapshot state. - - Positional arguments - - <snapshot> - - - Name or ID of snapshot to modify. - - - - - - Optional arguments - - --state <state> - - - The state to assign to the snapshot. Valid values are - "available", "error", "creating", "deleting", and - "error_deleting". NOTE: This command simply changes the - state of the Snapshot in the DataBase with no regard to - actual status, exercise caution when using. - Default=available. - - - - -
-
- cinder snapshot-show - usage: cinder snapshot-show <snapshot> - -Shows snapshot details. - - Positional arguments - - <snapshot> - - - Name or ID of snapshot. - - - - -
-
- cinder transfer-accept - usage: cinder transfer-accept <transfer> <auth_key> - -Accepts a volume transfer. - - Positional arguments - - <transfer> - - - ID of transfer to accept. - - - - - <auth_key> - - - Authentication key of transfer to accept. - - - - -
-
- cinder transfer-create - usage: cinder transfer-create [--name <name>] <volume> - -Creates a volume transfer. - - Positional arguments - - <volume> - - - Name or ID of volume to transfer. - - - - - - Optional arguments - - --name <name> - - - Transfer name. Default=None. - - - - -
-
- cinder transfer-delete - usage: cinder transfer-delete <transfer> - -Undoes a transfer. - - Positional arguments - - <transfer> - - - Name or ID of transfer to delete. - - - - -
-
- cinder transfer-list - usage: cinder transfer-list [--all-tenants [<0|1>]] - -Lists all transfers. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - -
-
- cinder transfer-show - usage: cinder transfer-show <transfer> - -Shows transfer details. - - Positional arguments - - <transfer> - - - Name or ID of transfer to accept. - - - - -
-
- cinder type-access-add - usage: cinder type-access-add --volume-type <volume_type> --project-id - <project_id> - -Adds volume type access for the given project. - - Optional arguments - - --volume-type <volume_type> - - - Volume type name or ID to add access for the given - project. - - - - - --project-id <project_id> - - - Project ID to add volume type access for. - - - - -
-
- cinder type-access-list - usage: cinder type-access-list --volume-type <volume_type> - -Print access information about the given volume type. - - Optional arguments - - --volume-type <volume_type> - - - Filter results by volume type name or ID. - - - - -
-
- cinder type-access-remove - usage: cinder type-access-remove --volume-type <volume_type> --project-id - <project_id> - -Removes volume type access for the given project. - - Optional arguments - - --volume-type <volume_type> - - - Volume type name or ID to remove access for the given - project. - - - - - --project-id <project_id> - - - Project ID to remove volume type access for. - - - - -
-
- cinder type-create - usage: cinder type-create [--description <description>] - [--is-public <is-public>] - <name> - -Creates a volume type. - - Positional arguments - - <name> - - - Name of new volume type. - - - - - - Optional arguments - - --description <description> - - - Description of new volume type. - - - - - --is-public <is-public> - - - Make type accessible to the public (default true). - - - - -
-
- cinder type-default - usage: cinder type-default - -List the default volume type. - -
-
- cinder type-delete - usage: cinder type-delete <id> - -Deletes a volume type. - - Positional arguments - - <id> - - - ID of volume type to delete. - - - - -
-
- cinder type-key - usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...] - -Sets or unsets extra_spec for a volume type. - - Positional arguments - - <vtype> - - - Name or ID of volume type. - - - - - <action> - - - The action. Valid values are "set" or "unset." - - - - - <key=value> - - - The extra specs key and value pair to set or unset. For unset, - specify only the key. - - - - -
-
- cinder type-list - usage: cinder type-list - -Lists available 'volume types'. (Admin only will see private types) - -
-
- cinder type-show - usage: cinder type-show <volume_type> - -Show volume type details. - - Positional arguments - - <volume_type> - - - Name or ID of the volume type. - - - - -
-
- cinder type-update - usage: cinder type-update [--name <name>] [--description <description>] - [--is-public <is-public>] - <id> - -Updates volume type name ,description and/or is_public. - - Positional arguments - - <id> - - - ID of the volume type. - - - - - - Optional arguments - - --name <name> - - - Name of the volume type. - - - - - --description <description> - - - Description of the volume type. - - - - - --is-public <is-public> - - - Make type accessible to the public or not. - - - - -
-
- cinder unmanage - usage: cinder unmanage <volume> - -Stop managing a volume. - - Positional arguments - - <volume> - - - Name or ID of the volume to unmanage. - - - - -
-
- cinder upload-to-image - usage: cinder upload-to-image [--force [<True|False>]] - [--container-format <container-format>] - [--disk-format <disk-format>] - <volume> <image-name> - -Uploads volume to Image Service as an image. - - Positional arguments - - <volume> - - - Name or ID of volume to snapshot. - - - - - <image-name> - - - The new image name. - - - - - - Optional arguments - - --force [<True|False>] - - - Enables or disables upload of a volume that is - attached to an instance. Default=False. - - - - - --container-format <container-format> - - - Container format type. Default is bare. - - - - - --disk-format <disk-format> - - - Disk format type. Default is raw. - - - - -
-
- -
- Block Storage API v2 commands - - You can select an API version to use by adding the - --os-volume-api-version parameter or by setting - the corresponding environment variable: -$ export OS_VOLUME_API_VERSION=2 - -
- cinder absolute-limits (v2) - usage: cinder --os-volume-api-version 2 absolute-limits - -Lists absolute limits for a user. - -
-
- cinder availability-zone-list (v2) - usage: cinder --os-volume-api-version 2 availability-zone-list - -Lists all availability zones. - -
-
- cinder backup-create (v2) - usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>] - [--description <description>] [--incremental] - [--force] - <volume> - -Creates a volume backup. - - Positional arguments - - <volume> - - - Name or ID of volume to backup. - - - - - - Optional arguments - - --container <container> - - - Backup container name. Default=None. - - - - - --name <name> - - - Backup name. Default=None. - - - - - --description <description> - - - Backup description. Default=None. - - - - - --incremental - - - Incremental backup. Default=False. - - - - - --force - - - Allows or disallows backup of a volume when the volume - is attached to an instance. If set to True, backs up - the volume whether its status is "available" or "in- - use". The backup of an "in-use" volume means your data - is crash consistent. Default=False. - - - - -
-
- cinder backup-delete (v2) - usage: cinder --os-volume-api-version 2 backup-delete <backup> - -Removes a backup. - - Positional arguments - - <backup> - - - Name or ID of backup to delete. - - - - -
-
- cinder backup-export (v2) - usage: cinder --os-volume-api-version 2 backup-export <backup> - -Export backup metadata record. - - Positional arguments - - <backup> - - - ID of the backup to export. - - - - -
-
- cinder backup-import (v2) - usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url> - -Import backup metadata record. - - Positional arguments - - <backup_service> - - - Backup service to use for importing the backup. - - - - - <backup_url> - - - Backup URL for importing the backup metadata. - - - - -
-
- cinder backup-list (v2) - usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>] - [--status <status>] [--volume-id <volume-id>] - [--marker <marker>] [--limit <limit>] - [--sort <key>[:<direction>]] - -Lists all backups. - - Optional arguments - - --all-tenants [<all_tenants>] - - - Shows details for all tenants. Admin only. - - - - - --name <name> - - - Filters results by a name. Default=None. - - - - - --status <status> - - - Filters results by a status. Default=None. - - - - - --volume-id <volume-id> - - - Filters results by a volume ID. Default=None. - - - - - --marker <marker> - - - Begin returning backups that appear later in the - backup list than that represented by this id. - Default=None. - - - - - --limit <limit> - - - Maximum number of backups to return. Default=None. - - - - - --sort <key>[:<direction>] - - - Comma-separated list of sort keys and directions in - the form of <key>[:<asc|desc>]. Valid keys: id, - status, size, availability_zone, name, bootable, - created_at. Default=None. - - - - -
-
- cinder backup-reset-state (v2) - usage: cinder --os-volume-api-version 2 backup-reset-state [--state <state>] <backup> [<backup> ...] - -Explicitly updates the backup state. - - Positional arguments - - <backup> - - - Name or ID of the backup to modify. - - - - - - Optional arguments - - --state <state> - - - The state to assign to the backup. Valid values are - "available", "error", "creating", "deleting", and - "error_deleting". Default=available. - - - - -
-
- cinder backup-restore (v2) - usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup> - -Restores a backup. - - Positional arguments - - <backup> - - - ID of backup to restore. - - - - - - Optional arguments - - --volume <volume> - - - Name or ID of volume to which to restore. Default=None. - - - - -
-
- cinder backup-show (v2) - usage: cinder --os-volume-api-version 2 backup-show <backup> - -Shows backup details. - - Positional arguments - - <backup> - - - Name or ID of backup. - - - - -
-
- cinder cgsnapshot-create (v2) - usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>] - <consistencygroup> - -Creates a cgsnapshot. - - Positional arguments - - <consistencygroup> - - - Name or ID of a consistency group. - - - - - - Optional arguments - - --name <name> - - - Cgsnapshot name. Default=None. - - - - - --description <description> - - - Cgsnapshot description. Default=None. - - - - -
-
- cinder cgsnapshot-delete (v2) - usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...] - -Removes one or more cgsnapshots. - - Positional arguments - - <cgsnapshot> - - - Name or ID of one or more cgsnapshots to be deleted. - - - - -
-
- cinder cgsnapshot-list (v2) - usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] - [--consistencygroup-id <consistencygroup_id>] - -Lists all cgsnapshots. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - - --status <status> - - - Filters results by a status. Default=None. - - - - - --consistencygroup-id <consistencygroup_id> - - - Filters results by a consistency group ID. - Default=None. - - - - -
-
- cinder cgsnapshot-show (v2) - usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot> - -Shows cgsnapshot details. - - Positional arguments - - <cgsnapshot> - - - Name or ID of cgsnapshot. - - - - -
-
- cinder consisgroup-create (v2) - usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>] - [--availability-zone <availability-zone>] - <volume-types> - -Creates a consistency group. - - Positional arguments - - <volume-types> - - - Volume types. - - - - - - Optional arguments - - --name <name> - - - Name of a consistency group. - - - - - --description <description> - - - Description of a consistency group. Default=None. - - - - - --availability-zone <availability-zone> - - - Availability zone for volume. Default=None. - - - - -
-
- cinder consisgroup-create-from-src (v2) - usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] - [--source-cg <source-cg>] - [--name <name>] - [--description <description>] - -Creates a consistency group from a cgsnapshot or a source CG. - - Optional arguments - - --cgsnapshot <cgsnapshot> - - - Name or ID of a cgsnapshot. Default=None. - - - - - --source-cg <source-cg> - - - Name or ID of a source CG. Default=None. - - - - - --name <name> - - - Name of a consistency group. Default=None. - - - - - --description <description> - - - Description of a consistency group. Default=None. - - - - -
-
- cinder consisgroup-delete (v2) - usage: cinder --os-volume-api-version 2 consisgroup-delete [--force] - <consistencygroup> [<consistencygroup> ...] - -Removes one or more consistency groups. - - Positional arguments - - <consistencygroup> - - - Name or ID of one or more consistency groups to be - deleted. - - - - - - Optional arguments - - --force - - - Allows or disallows consistency groups to be deleted. If - the consistency group is empty, it can be deleted - without the force flag. If the consistency group is not - empty, the force flag is required for it to be deleted. - - - - -
-
- cinder consisgroup-list (v2) - usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]] - -Lists all consistencygroups. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - -
-
- cinder consisgroup-show (v2) - usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup> - -Shows details of a consistency group. - - Positional arguments - - <consistencygroup> - - - Name or ID of a consistency group. - - - - -
-
- cinder consisgroup-update (v2) - usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>] - [--add-volumes <uuid1,uuid2,......>] - [--remove-volumes <uuid3,uuid4,......>] - <consistencygroup> - -Updates a consistencygroup. - - Positional arguments - - <consistencygroup> - - - Name or ID of a consistency group. - - - - - - Optional arguments - - --name <name> - - - New name for consistency group. Default=None. - - - - - --description <description> - - - New description for consistency group. Default=None. - - - - - --add-volumes <uuid1,uuid2,......> - - - UUID of one or more volumes to be added to the - consistency group, separated by commas. Default=None. - - - - - --remove-volumes <uuid3,uuid4,......> - - - UUID of one or more volumes to be removed from the - consistency group, separated by commas. Default=None. - - - - -
-
- cinder create (v2) - usage: cinder --os-volume-api-version 2 create [--consisgroup-id <consistencygroup-id>] - [--snapshot-id <snapshot-id>] - [--source-volid <source-volid>] - [--source-replica <source-replica>] - [--image-id <image-id>] [--image <image>] [--name <name>] - [--description <description>] - [--volume-type <volume-type>] - [--availability-zone <availability-zone>] - [--metadata [<key=value> [<key=value> ...]]] - [--hint <key=value>] [--allow-multiattach] - [<size>] - -Creates a volume. - - Positional arguments - - <size> - - - Size of volume, in GiBs. (Required unless snapshot-id - /source-volid is specified). - - - - - - Optional arguments - - --consisgroup-id <consistencygroup-id> - - - ID of a consistency group where the new volume belongs - to. Default=None. - - - - - --snapshot-id <snapshot-id> - - - Creates volume from snapshot ID. Default=None. - - - - - --source-volid <source-volid> - - - Creates volume from volume ID. Default=None. - - - - - --source-replica <source-replica> - - - Creates volume from replicated volume ID. - Default=None. - - - - - --image-id <image-id> - - - Creates volume from image ID. Default=None. - - - - - --image <image> - - - Creates a volume from image (ID or name). - Default=None. - - - - - --name <name> - - - Volume name. Default=None. - - - - - --description <description> - - - Volume description. Default=None. - - - - - --volume-type <volume-type> - - - Volume type. Default=None. - - - - - --availability-zone <availability-zone> - - - Availability zone for volume. Default=None. - - - - - --metadata [<key=value> [<key=value> ...]] - - - Metadata key and value pairs. Default=None. - - - - - --hint <key=value> - - - Scheduler hint, like in nova. - - - - - --allow-multiattach - - - Allow volume to be attached more than once. - Default=False - - - - -
-
- cinder credentials (v2) - usage: cinder --os-volume-api-version 2 credentials - -Shows user credentials returned from auth. - -
-
- cinder delete (v2) - usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...] - -Removes one or more volumes. - - Positional arguments - - <volume> - - - Name or ID of volume or volumes to delete. - - - - -
-
- cinder encryption-type-create (v2) - usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher <cipher>] - [--key_size <key_size>] - [--control_location <control_location>] - <volume_type> <provider> - -Creates encryption type for a volume type. Admin only. - - Positional arguments - - <volume_type> - - - Name or ID of volume type. - - - - - <provider> - - - The class that provides encryption support. For - example, LuksEncryptor. - - - - - - Optional arguments - - --cipher <cipher> - - - The encryption algorithm or mode. For example, aes- - xts-plain64. Default=None. - - - - - --key_size <key_size> - - - Size of encryption key, in bits. For example, 128 or - 256. Default=None. - - - - - --control_location <control_location> - - - Notional service where encryption is performed. Valid - values are "front-end" or "back-end." For example, - front-end=Nova. Default is "front-end." - - - - -
-
- cinder encryption-type-delete (v2) - usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type> - -Deletes encryption type for a volume type. Admin only. - - Positional arguments - - <volume_type> - - - Name or ID of volume type. - - - - -
-
- cinder encryption-type-list (v2) - usage: cinder --os-volume-api-version 2 encryption-type-list - -Shows encryption type details for volume types. Admin only. - -
-
- cinder encryption-type-show (v2) - usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type> - -Shows encryption type details for a volume type. Admin only. - - Positional arguments - - <volume_type> - - - Name or ID of volume type. - - - - -
-
- cinder encryption-type-update (v2) - usage: cinder --os-volume-api-version 2 encryption-type-update [--provider <provider>] - [--cipher [<cipher>]] - [--key-size [<key-size>]] - [--control-location <control-location>] - <volume-type> - -Update encryption type information for a volume type (Admin Only). - - Positional arguments - - <volume-type> - - - Name or ID of the volume type - - - - - - Optional arguments - - --provider <provider> - - - Class providing encryption support (e.g. - LuksEncryptor) (Optional) - - - - - --cipher [<cipher>] - - - Encryption algorithm/mode to use (e.g., aes-xts- - plain64). Provide parameter without value to set to - provider default. (Optional) - - - - - --key-size [<key-size>] - - - Size of the encryption key, in bits (e.g., 128, 256). - Provide parameter without value to set to provider - default. (Optional) - - - - - --control-location <control-location> - - - Notional service where encryption is performed (e.g., - front-end=Nova). Values: 'front-end', 'back-end' - (Optional) - - - - -
-
- cinder endpoints (v2) - usage: cinder --os-volume-api-version 2 endpoints - -Discovers endpoints registered by authentication service. - -
-
- cinder extend (v2) - usage: cinder --os-volume-api-version 2 extend <volume> <new_size> - -Attempts to extend size of an existing volume. - - Positional arguments - - <volume> - - - Name or ID of volume to extend. - - - - - <new_size> - - - New size of volume, in GiBs. - - - - -
-
- cinder extra-specs-list (v2) - usage: cinder --os-volume-api-version 2 extra-specs-list - -Lists current volume types and extra specs. - -
-
- cinder force-delete (v2) - usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...] - -Attempts force-delete of volume, regardless of state. - - Positional arguments - - <volume> - - - Name or ID of volume or volumes to delete. - - - - -
-
- cinder get-capabilities (v2) - usage: cinder --os-volume-api-version 2 get-capabilities <host> - -Show backend volume stats and properties. Admin only. - - Positional arguments - - <host> - - - Cinder host to show backend volume stats and properties; takes the - form: host@backend-name - - - - -
-
- cinder get-pools (v2) - usage: cinder --os-volume-api-version 2 get-pools [--detail] - -Show pool information for backends. Admin only. - - Optional arguments - - --detail - - - Show detailed information about pools. - - - - -
-
- cinder image-metadata (v2) - usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...] - -Sets or deletes volume image metadata. - - Positional arguments - - <volume> - - - Name or ID of volume for which to update metadata. - - - - - <action> - - - The action. Valid values are 'set' or 'unset.' - - - - - <key=value> - - - Metadata key and value pair to set or unset. For unset, specify - only the key. - - - - -
-
- cinder image-metadata-show (v2) - usage: cinder --os-volume-api-version 2 image-metadata-show <volume> - -Shows volume image metadata. - - Positional arguments - - <volume> - - - ID of volume. - - - - -
-
- cinder list (v2) - usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] - [--migration_status <migration_status>] - [--metadata [<key=value> [<key=value> ...]]] - [--marker <marker>] [--limit <limit>] - [--sort <key>[:<direction>]] [--tenant [<tenant>]] - -Lists all volumes. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - - --name <name> - - - Filters results by a name. Default=None. - - - - - --status <status> - - - Filters results by a status. Default=None. - - - - - --migration_status <migration_status> - - - Filters results by a migration status. Default=None. - Admin only. - - - - - --metadata [<key=value> [<key=value> ...]] - - - Filters results by a metadata key and value pair. - Default=None. - - - - - --marker <marker> - - - Begin returning volumes that appear later in the - volume list than that represented by this volume id. - Default=None. - - - - - --limit <limit> - - - Maximum number of volumes to return. Default=None. - - - - - --sort <key>[:<direction>] - - - Comma-separated list of sort keys and directions in - the form of <key>[:<asc|desc>]. Valid keys: id, - status, size, availability_zone, name, bootable, - created_at. Default=None. - - - - - --tenant [<tenant>] - - - Display information from single tenant (Admin only). - - - - -
-
- cinder list-extensions (v2) - usage: cinder --os-volume-api-version 2 list-extensions - -Lists all available os-api extensions. - -
-
- cinder manage (v2) - usage: cinder --os-volume-api-version 2 manage [--id-type <id-type>] [--name <name>] - [--description <description>] - [--volume-type <volume-type>] - [--availability-zone <availability-zone>] - [--metadata [<key=value> [<key=value> ...]]] [--bootable] - <host> <identifier> - -Manage an existing volume. - - Positional arguments - - <host> - - - Cinder host on which the existing volume resides; - takes the form: host@backend-name#pool - - - - - <identifier> - - - Name or other Identifier for existing volume - - - - - - Optional arguments - - --id-type <id-type> - - - Type of backend device identifier provided, typically - source-name or source-id (Default=source-name) - - - - - --name <name> - - - Volume name (Default=None) - - - - - --description <description> - - - Volume description (Default=None) - - - - - --volume-type <volume-type> - - - Volume type (Default=None) - - - - - --availability-zone <availability-zone> - - - Availability zone for volume (Default=None) - - - - - --metadata [<key=value> [<key=value> ...]] - - - Metadata key=value pairs (Default=None) - - - - - --bootable - - - Specifies that the newly created volume should be - marked as bootable - - - - -
-
- cinder metadata (v2) - usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...] - -Sets or deletes volume metadata. - - Positional arguments - - <volume> - - - Name or ID of volume for which to update metadata. - - - - - <action> - - - The action. Valid values are "set" or "unset." - - - - - <key=value> - - - Metadata key and value pair to set or unset. For unset, specify - only the key. - - - - -
-
- cinder metadata-show (v2) - usage: cinder --os-volume-api-version 2 metadata-show <volume> - -Shows volume metadata. - - Positional arguments - - <volume> - - - ID of volume. - - - - -
-
- cinder metadata-update-all (v2) - usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...] - -Updates volume metadata. - - Positional arguments - - <volume> - - - ID of volume for which to update metadata. - - - - - <key=value> - - - Metadata key and value pair or pairs to update. - - - - -
-
- cinder migrate (v2) - usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]] - [--lock-volume [<True|False>]] - <volume> <host> - -Migrates volume to a new host. - - Positional arguments - - <volume> - - - ID of volume to migrate. - - - - - <host> - - - Destination host. Takes the form: host@backend- - name#pool - - - - - - Optional arguments - - --force-host-copy [<True|False>] - - - Enables or disables generic host-based force- - migration, which bypasses driver optimizations. - Default=False. - - - - - --lock-volume [<True|False>] - - - Enables or disables the termination of volume - migration caused by other commands. This option - applies to the available volume. True means it locks - the volume state and does not allow the migration to - be aborted. The volume status will be in maintenance - during the migration. False means it allows the volume - migration to be aborted. The volume status is still in - the original status. Default=False. - - - - -
-
- cinder qos-associate (v2) - usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id> - -Associates qos specs with specified volume type. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications. - - - - - <volume_type_id> - - - ID of volume type with which to associate QoS - specifications. - - - - -
-
- cinder qos-create (v2) - usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...] - -Creates a qos specs. - - Positional arguments - - <name> - - - Name of new QoS specifications. - - - - - <key=value> - - - QoS specifications. - - - - -
-
- cinder qos-delete (v2) - usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs> - -Deletes a specified qos specs. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications to delete. - - - - - - Optional arguments - - --force [<True|False>] - - - Enables or disables deletion of in-use QoS - specifications. Default=False. - - - - -
-
- cinder qos-disassociate (v2) - usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id> - -Disassociates qos specs from specified volume type. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications. - - - - - <volume_type_id> - - - ID of volume type with which to associate QoS - specifications. - - - - -
-
- cinder qos-disassociate-all (v2) - usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs> - -Disassociates qos specs from all its associations. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications on which to operate. - - - - -
-
- cinder qos-get-association (v2) - usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs> - -Lists all associations for specified qos specs. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications. - - - - -
-
- cinder qos-key (v2) - usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...] - -Sets or unsets specifications for a qos spec. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications. - - - - - <action> - - - The action. Valid values are "set" or "unset." - - - - - key=value - - - Metadata key and value pair to set or unset. For unset, specify - only the key. - - - - -
-
- cinder qos-list (v2) - usage: cinder --os-volume-api-version 2 qos-list - -Lists qos specs. - -
-
- cinder qos-show (v2) - usage: cinder --os-volume-api-version 2 qos-show <qos_specs> - -Shows qos specs details. - - Positional arguments - - <qos_specs> - - - ID of QoS specifications to show. - - - - -
-
- cinder quota-class-show (v2) - usage: cinder --os-volume-api-version 2 quota-class-show <class> - -Lists quotas for a quota class. - - Positional arguments - - <class> - - - Name of quota class for which to list quotas. - - - - -
-
- cinder quota-class-update (v2) - usage: cinder --os-volume-api-version 2 quota-class-update [--volumes <volumes>] - [--snapshots <snapshots>] - [--gigabytes <gigabytes>] - [--volume-type <volume_type_name>] - <class_name> - -Updates quotas for a quota class. - - Positional arguments - - <class_name> - - - Name of quota class for which to set quotas. - - - - - - Optional arguments - - --volumes <volumes> - - - The new "volumes" quota value. Default=None. - - - - - --snapshots <snapshots> - - - The new "snapshots" quota value. Default=None. - - - - - --gigabytes <gigabytes> - - - The new "gigabytes" quota value. Default=None. - - - - - --volume-type <volume_type_name> - - - Volume type. Default=None. - - - - -
-
- cinder quota-defaults (v2) - usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id> - -Lists default quotas for a tenant. - - Positional arguments - - <tenant_id> - - - ID of tenant for which to list quota defaults. - - - - -
-
- cinder quota-delete (v2) - usage: cinder --os-volume-api-version 2 quota-delete <tenant_id> - -Delete the quotas for a tenant. - - Positional arguments - - <tenant_id> - - - UUID of tenant to delete the quotas for. - - - - -
-
- cinder quota-show (v2) - usage: cinder --os-volume-api-version 2 quota-show <tenant_id> - -Lists quotas for a tenant. - - Positional arguments - - <tenant_id> - - - ID of tenant for which to list quotas. - - - - -
-
- cinder quota-update (v2) - usage: cinder --os-volume-api-version 2 quota-update [--volumes <volumes>] [--snapshots <snapshots>] - [--gigabytes <gigabytes>] [--backups <backups>] - [--backup-gigabytes <backup_gigabytes>] - [--consistencygroups <consistencygroups>] - [--volume-type <volume_type_name>] - [--per-volume-gigabytes <per_volume_gigabytes>] - <tenant_id> - -Updates quotas for a tenant. - - Positional arguments - - <tenant_id> - - - ID of tenant for which to set quotas. - - - - - - Optional arguments - - --volumes <volumes> - - - The new "volumes" quota value. Default=None. - - - - - --snapshots <snapshots> - - - The new "snapshots" quota value. Default=None. - - - - - --gigabytes <gigabytes> - - - The new "gigabytes" quota value. Default=None. - - - - - --backups <backups> - - - The new "backups" quota value. Default=None. - - - - - --backup-gigabytes <backup_gigabytes> - - - The new "backup_gigabytes" quota value. Default=None. - - - - - --consistencygroups <consistencygroups> - - - The new "consistencygroups" quota value. Default=None. - - - - - --volume-type <volume_type_name> - - - Volume type. Default=None. - - - - - --per-volume-gigabytes <per_volume_gigabytes> - - - Set max volume size limit. Default=None. - - - - -
-
- cinder quota-usage (v2) - usage: cinder --os-volume-api-version 2 quota-usage <tenant_id> - -Lists quota usage for a tenant. - - Positional arguments - - <tenant_id> - - - ID of tenant for which to list quota usage. - - - - -
-
- cinder rate-limits (v2) - usage: cinder --os-volume-api-version 2 rate-limits - -Lists rate limits for a user. - -
-
- cinder readonly-mode-update (v2) - usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false> - -Updates volume read-only access-mode flag. - - Positional arguments - - <volume> - - - ID of volume to update. - - - - - <True|true|False|false> - - - Enables or disables update of volume to read-only - access mode. - - - - -
-
- cinder rename (v2) - usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>] - -Renames a volume. - - Positional arguments - - <volume> - - - Name or ID of volume to rename. - - - - - <name> - - - New name for volume. - - - - - - Optional arguments - - --description <description> - - - Volume description. Default=None. - - - - -
-
- cinder replication-disable (v2) - usage: cinder --os-volume-api-version 2 replication-disable <volume> - -Disables volume replication on a given volume. - - Positional arguments - - <volume> - - - ID of volume to disable replication. - - - - -
-
- cinder replication-enable (v2) - usage: cinder --os-volume-api-version 2 replication-enable <volume> - -Enables volume replication on a given volume. - - Positional arguments - - <volume> - - - ID of volume to enable replication. - - - - -
-
- cinder replication-failover (v2) - usage: cinder --os-volume-api-version 2 replication-failover <volume> <secondary> - -Failover a volume to a secondary target - - Positional arguments - - <volume> - - - ID of volume to failover. - - - - - <secondary> - - - A unqiue identifier that represents a failover target. - - - - -
-
- cinder replication-list-targets (v2) - usage: cinder --os-volume-api-version 2 replication-list-targets <volume> - -List replication targets available for a volume. - - Positional arguments - - <volume> - - - ID of volume to list available replication targets. - - - - -
-
- cinder replication-promote (v2) - usage: cinder --os-volume-api-version 2 replication-promote <volume> - -Promote a secondary volume to primary for a relationship. - - Positional arguments - - <volume> - - - Name or ID of the volume to promote. The volume should have the - replica volume created with source-replica argument. - - - - -
-
- cinder replication-reenable (v2) - usage: cinder --os-volume-api-version 2 replication-reenable <volume> - -Sync the secondary volume with primary for a relationship. - - Positional arguments - - <volume> - - - Name or ID of the volume to reenable replication. The replication- - status of the volume should be inactive. - - - - -
-
- cinder reset-state (v2) - usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>] - [--reset-migration-status] - <volume> [<volume> ...] - -Explicitly updates the volume state in the Cinder database. Note that this -does not affect whether the volume is actually attached to the Nova compute -host or instance and can result in an unusable volume. Being a database change -only, this has no impact on the true state of the volume and may not match the -actual state. This can render a volume unusable in the case of change to the -'available' state. - - Positional arguments - - <volume> - - - Name or ID of volume to modify. - - - - - - Optional arguments - - --state <state> - - - The state to assign to the volume. Valid values are - "available", "error", "creating", "deleting", "in- - use", "attaching", "detaching", "error_deleting" and - "maintenance". NOTE: This command simply changes the - state of the Volume in the DataBase with no regard to - actual status, exercise caution when using. - Default=available. - - - - - --attach-status <attach-status> - - - The attach status to assign to the volume in the - DataBase, with no regard to the actual status. Valid - values are "attached" and "detached". Default=None, - that means the status is unchanged. - - - - - --reset-migration-status - - - Clears the migration status of the volume in the - DataBase that indicates the volume is source or - destination of volume migration, with no regard to the - actual status. - - - - -
-
- cinder retype (v2) - usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>] - <volume> <volume-type> - -Changes the volume type for a volume. - - Positional arguments - - <volume> - - - Name or ID of volume for which to modify type. - - - - - <volume-type> - - - New volume type. - - - - - - Optional arguments - - --migration-policy <never|on-demand> - - - Migration policy during retype of volume. - - - - -
-
- cinder service-disable (v2) - usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary> - -Disables the service. - - Positional arguments - - <hostname> - - - Host name. - - - - - <binary> - - - Service binary. - - - - - - Optional arguments - - --reason <reason> - - - Reason for disabling service. - - - - -
-
- cinder service-enable (v2) - usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary> - -Enables the service. - - Positional arguments - - <hostname> - - - Host name. - - - - - <binary> - - - Service binary. - - - - -
-
- cinder service-list (v2) - usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>] - -Lists all services. Filter by host and service binary. - - Optional arguments - - --host <hostname> - - - Host name. Default=None. - - - - - --binary <binary> - - - Service binary. Default=None. - - - - -
-
- cinder set-bootable (v2) - usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false> - -Update bootable status of a volume. - - Positional arguments - - <volume> - - - ID of the volume to update. - - - - - <True|true|False|false> - - - Flag to indicate whether volume is bootable. - - - - -
-
- cinder show (v2) - usage: cinder --os-volume-api-version 2 show <volume> - -Shows volume details. - - Positional arguments - - <volume> - - - Name or ID of volume. - - - - -
-
- cinder snapshot-create (v2) - usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>] - [--description <description>] - [--metadata [<key=value> [<key=value> ...]]] - <volume> - -Creates a snapshot. - - Positional arguments - - <volume> - - - Name or ID of volume to snapshot. - - - - - - Optional arguments - - --force [<True|False>] - - - Allows or disallows snapshot of a volume when the - volume is attached to an instance. If set to True, - ignores the current status of the volume when - attempting to snapshot it rather than forcing it to be - available. Default=False. - - - - - --name <name> - - - Snapshot name. Default=None. - - - - - --description <description> - - - Snapshot description. Default=None. - - - - - --metadata [<key=value> [<key=value> ...]] - - - Snapshot metadata key and value pairs. Default=None. - - - - -
-
- cinder snapshot-delete (v2) - usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...] - -Removes one or more snapshots. - - Positional arguments - - <snapshot> - - - Name or ID of the snapshot(s) to delete. - - - - -
-
- cinder snapshot-list (v2) - usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>] - [--status <status>] [--volume-id <volume-id>] - [--marker <marker>] [--limit <limit>] - [--sort <key>[:<direction>]] - -Lists all snapshots. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - - --name <name> - - - Filters results by a name. Default=None. - - - - - --status <status> - - - Filters results by a status. Default=None. - - - - - --volume-id <volume-id> - - - Filters results by a volume ID. Default=None. - - - - - --marker <marker> - - - Begin returning snapshots that appear later in the - snapshot list than that represented by this id. - Default=None. - - - - - --limit <limit> - - - Maximum number of snapshots to return. Default=None. - - - - - --sort <key>[:<direction>] - - - Comma-separated list of sort keys and directions in - the form of <key>[:<asc|desc>]. Valid keys: id, - status, size, availability_zone, name, bootable, - created_at. Default=None. - - - - -
-
- cinder snapshot-metadata (v2) - usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value> - [<key=value> ...] - -Sets or deletes snapshot metadata. - - Positional arguments - - <snapshot> - - - ID of snapshot for which to update metadata. - - - - - <action> - - - The action. Valid values are "set" or "unset." - - - - - <key=value> - - - Metadata key and value pair to set or unset. For unset, specify - only the key. - - - - -
-
- cinder snapshot-metadata-show (v2) - usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot> - -Shows snapshot metadata. - - Positional arguments - - <snapshot> - - - ID of snapshot. - - - - -
-
- cinder snapshot-metadata-update-all (v2) - usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value> - [<key=value> ...] - -Updates snapshot metadata. - - Positional arguments - - <snapshot> - - - ID of snapshot for which to update metadata. - - - - - <key=value> - - - Metadata key and value pair to update. - - - - -
-
- cinder snapshot-rename (v2) - usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>] - <snapshot> [<name>] - -Renames a snapshot. - - Positional arguments - - <snapshot> - - - Name or ID of snapshot. - - - - - <name> - - - New name for snapshot. - - - - - - Optional arguments - - --description <description> - - - Snapshot description. Default=None. - - - - -
-
- cinder snapshot-reset-state (v2) - usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>] - <snapshot> [<snapshot> ...] - -Explicitly updates the snapshot state. - - Positional arguments - - <snapshot> - - - Name or ID of snapshot to modify. - - - - - - Optional arguments - - --state <state> - - - The state to assign to the snapshot. Valid values are - "available", "error", "creating", "deleting", and - "error_deleting". NOTE: This command simply changes the - state of the Snapshot in the DataBase with no regard to - actual status, exercise caution when using. - Default=available. - - - - -
-
- cinder snapshot-show (v2) - usage: cinder --os-volume-api-version 2 snapshot-show <snapshot> - -Shows snapshot details. - - Positional arguments - - <snapshot> - - - Name or ID of snapshot. - - - - -
-
- cinder transfer-accept (v2) - usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key> - -Accepts a volume transfer. - - Positional arguments - - <transfer> - - - ID of transfer to accept. - - - - - <auth_key> - - - Authentication key of transfer to accept. - - - - -
-
- cinder transfer-create (v2) - usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume> - -Creates a volume transfer. - - Positional arguments - - <volume> - - - Name or ID of volume to transfer. - - - - - - Optional arguments - - --name <name> - - - Transfer name. Default=None. - - - - -
-
- cinder transfer-delete (v2) - usage: cinder --os-volume-api-version 2 transfer-delete <transfer> - -Undoes a transfer. - - Positional arguments - - <transfer> - - - Name or ID of transfer to delete. - - - - -
-
- cinder transfer-list (v2) - usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]] - -Lists all transfers. - - Optional arguments - - --all-tenants [<0|1>] - - - Shows details for all tenants. Admin only. - - - - -
-
- cinder transfer-show (v2) - usage: cinder --os-volume-api-version 2 transfer-show <transfer> - -Shows transfer details. - - Positional arguments - - <transfer> - - - Name or ID of transfer to accept. - - - - -
-
- cinder type-access-add (v2) - usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id - <project_id> - -Adds volume type access for the given project. - - Optional arguments - - --volume-type <volume_type> - - - Volume type name or ID to add access for the given - project. - - - - - --project-id <project_id> - - - Project ID to add volume type access for. - - - - -
-
- cinder type-access-list (v2) - usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type> - -Print access information about the given volume type. - - Optional arguments - - --volume-type <volume_type> - - - Filter results by volume type name or ID. - - - - -
-
- cinder type-access-remove (v2) - usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id - <project_id> - -Removes volume type access for the given project. - - Optional arguments - - --volume-type <volume_type> - - - Volume type name or ID to remove access for the given - project. - - - - - --project-id <project_id> - - - Project ID to remove volume type access for. - - - - -
-
- cinder type-create (v2) - usage: cinder --os-volume-api-version 2 type-create [--description <description>] - [--is-public <is-public>] - <name> - -Creates a volume type. - - Positional arguments - - <name> - - - Name of new volume type. - - - - - - Optional arguments - - --description <description> - - - Description of new volume type. - - - - - --is-public <is-public> - - - Make type accessible to the public (default true). - - - - -
-
- cinder type-default (v2) - usage: cinder --os-volume-api-version 2 type-default - -List the default volume type. - -
-
- cinder type-delete (v2) - usage: cinder --os-volume-api-version 2 type-delete <id> - -Deletes a volume type. - - Positional arguments - - <id> - - - ID of volume type to delete. - - - - -
-
- cinder type-key (v2) - usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...] - -Sets or unsets extra_spec for a volume type. - - Positional arguments - - <vtype> - - - Name or ID of volume type. - - - - - <action> - - - The action. Valid values are "set" or "unset." - - - - - <key=value> - - - The extra specs key and value pair to set or unset. For unset, - specify only the key. - - - - -
-
- cinder type-list (v2) - usage: cinder --os-volume-api-version 2 type-list - -Lists available 'volume types'. (Admin only will see private types) - -
-
- cinder type-show (v2) - usage: cinder --os-volume-api-version 2 type-show <volume_type> - -Show volume type details. - - Positional arguments - - <volume_type> - - - Name or ID of the volume type. - - - - -
-
- cinder type-update (v2) - usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] - [--is-public <is-public>] - <id> - -Updates volume type name ,description and/or is_public. - - Positional arguments - - <id> - - - ID of the volume type. - - - - - - Optional arguments - - --name <name> - - - Name of the volume type. - - - - - --description <description> - - - Description of the volume type. - - - - - --is-public <is-public> - - - Make type accessible to the public or not. - - - - -
-
- cinder unmanage (v2) - usage: cinder --os-volume-api-version 2 unmanage <volume> - -Stop managing a volume. - - Positional arguments - - <volume> - - - Name or ID of the volume to unmanage. - - - - -
-
- cinder upload-to-image (v2) - usage: cinder --os-volume-api-version 2 upload-to-image [--force [<True|False>]] - [--container-format <container-format>] - [--disk-format <disk-format>] - <volume> <image-name> - -Uploads volume to Image Service as an image. - - Positional arguments - - <volume> - - - Name or ID of volume to snapshot. - - - - - <image-name> - - - The new image name. - - - - - - Optional arguments - - --force [<True|False>] - - - Enables or disables upload of a volume that is - attached to an instance. Default=False. - - - - - --container-format <container-format> - - - Container format type. Default is bare. - - - - - --disk-format <disk-format> - - - Disk format type. Default is raw. - - - - -
-
- diff --git a/doc/cli-reference/generated/ch_cli_cloudkitty_commands.xml b/doc/cli-reference/generated/ch_cli_cloudkitty_commands.xml deleted file mode 100644 index dcc1aef932..0000000000 --- a/doc/cli-reference/generated/ch_cli_cloudkitty_commands.xml +++ /dev/null @@ -1,1303 +0,0 @@ - - - - - - - - Rating service command-line client - - The cloudkitty client is the command-line - interface (CLI) for the Rating service API and its extensions. - - This chapter documents cloudkitty version - 0.4.1. - - - For help on a specific cloudkitty - command, enter: - - $ cloudkitty COMMAND - -
- cloudkitty usage - usage: cloudkitty [--version] [-d] [-v] [--timeout TIMEOUT] - [--cloudkitty-url <CLOUDKITTY_URL>] - [--cloudkitty-api-version CLOUDKITTY_API_VERSION] - [--os-tenant-id <tenant-id>] - [--os-region-name <region-name>] - [--os-auth-token <auth-token>] - [--os-service-type <service-type>] - [--os-endpoint-type <endpoint-type>] [--os-cacert <cacert>] - [--os-insecure <insecure>] [--os-cert-file <cert-file>] - [--os-key-file <key-file>] [--os-cert <cert>] - [--os-key <key>] [--os-project-name <project-name>] - [--os-project-id <project-id>] - [--os-user-domain-id <user-domain-id>] - [--os-user-domain-name <user-domain-name>] - [--os-endpoint <endpoint>] [--os-auth-system <auth-system>] - [--os-username <username>] [--os-password <password>] - [--os-tenant-name <tenant-name>] [--os-token <token>] - [--os-auth-url <auth-url>] - <subcommand> ... - - Subcommands - - module-disable - - - Disable a module. - - - - - module-enable - - - Enable a module. - - - - - module-list - - - List the samples for this meters. - - - - - collector-mapping-create - - - - - - - collector-mapping-delete - - - - - - - collector-mapping-get - - - - - - - collector-mapping-list - - - - - - - collector-state-disable - - - - - - - collector-state-enable - - - - - - - collector-state-get - - - - - - - report-tenant-list - - - - - - - total-get - - - - - - - storage-dataframe-list - - - - - - - hashmap-field-create - - - Create a field. - - - - - hashmap-field-delete - - - Delete a field. - - - - - hashmap-field-list - - - Create a field. - - - - - hashmap-group-create - - - Create a group. - - - - - hashmap-group-delete - - - Delete a group. - - - - - hashmap-group-list - - - List groups. - - - - - hashmap-mapping-create - - - Create a mapping. - - - - - hashmap-mapping-delete - - - Delete a mapping. - - - - - hashmap-mapping-list - - - List mappings. - - - - - hashmap-mapping-update - - - Update a mapping. - - - - - hashmap-service-create - - - Create a service. - - - - - hashmap-service-delete - - - Delete a service. - - - - - hashmap-service-list - - - List services. - - - - - hashmap-threshold-create - - - Create a mapping. - - - - - hashmap-threshold-delete - - - Delete a threshold. - - - - - hashmap-threshold-get - - - Get a threshold. - - - - - hashmap-threshold-group - - - Get a threshold group. - - - - - hashmap-threshold-list - - - List thresholds. - - - - - hashmap-threshold-update - - - Update a threshold. - - - - - bash-completion - - - Prints all of the commands and options to - stdout. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - -
-
- cloudkitty optional arguments - - - --version - - - show program's version number and exit - - - - - -d, --debug - - - Defaults to env[CLOUDKITTYCLIENT_DEBUG]. - - - - - -v, --verbose - - - Print more verbose output. - - - - - --timeout TIMEOUT - - - Number of seconds to wait for a response. - - - - - --cloudkitty-url <CLOUDKITTY_URL> - - - DEPRECATED, use --os-endpoint instead. - Defaults to env[CLOUDKITTY_URL]. - - - - - --cloudkitty-api-version CLOUDKITTY_API_VERSION - - - Defaults to env[CLOUDKITTY_API_VERSION] or 1. - - - - - --os-tenant-id <tenant-id> - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-region-name <region-name> - - - Defaults to env[OS_REGION_NAME]. - - - - - --os-auth-token <auth-token> - - - Defaults to env[OS_AUTH_TOKEN]. - - - - - --os-service-type <service-type> - - - Defaults to env[OS_SERVICE_TYPE]. - - - - - --os-endpoint-type <endpoint-type> - - - Defaults to env[OS_ENDPOINT_TYPE]. - - - - - --os-cacert <cacert> - - - Defaults to env[OS_CACERT]. - - - - - --os-insecure <insecure> - - - Defaults to env[OS_INSECURE]. - - - - - --os-cert-file <cert-file> - - - Defaults to env[OS_CERT_FILE]. - - - - - --os-key-file <key-file> - - - Defaults to env[OS_KEY_FILE]. - - - - - --os-cert <cert> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --os-project-name <project-name> - - - Defaults to env[OS_PROJECT_NAME]. - - - - - --os-project-id <project-id> - - - Defaults to env[OS_PROJECT_ID]. - - - - - --os-user-domain-id <user-domain-id> - - - Defaults to env[OS_USER_DOMAIN_ID]. - - - - - --os-user-domain-name <user-domain-name> - - - Defaults to env[OS_USER_DOMAIN_NAME]. - - - - - --os-endpoint <endpoint> - - - Defaults to env[OS_ENDPOINT]. - - - - - --os-auth-system <auth-system> - - - Defaults to env[OS_AUTH_SYSTEM]. - - - - - --os-username <username> - - - Defaults to env[OS_USERNAME]. - - - - - --os-password <password> - - - Defaults to env[OS_PASSWORD]. - - - - - --os-tenant-name <tenant-name> - - - Defaults to env[OS_TENANT_NAME]. - - - - - --os-token <token> - - - Defaults to env[OS_TOKEN]. - - - - - --os-auth-url <auth-url> - - - Defaults to env[OS_AUTH_URL]. - - - - -
-
- cloudkitty collector-mapping-create - usage: cloudkitty collector-mapping-create --collector COLLECTOR --service - SERVICE - - - Optional arguments - - --collector COLLECTOR - - - Map a service to this collector. Required. - - - - - --service SERVICE - - - Map a collector to this service. Required. - - - - -
-
- cloudkitty collector-mapping-delete - usage: cloudkitty collector-mapping-delete --service SERVICE - - - Optional arguments - - --service SERVICE - - - Filter on this service. Required. - - - - -
-
- cloudkitty collector-mapping-get - usage: cloudkitty collector-mapping-get --service SERVICE - - - Optional arguments - - --service SERVICE - - - Which service to get the mapping for. Required. - - - - -
-
- cloudkitty collector-mapping-list - usage: cloudkitty collector-mapping-list [--collector COLLECTOR] - - - Optional arguments - - --collector COLLECTOR - - - Collector name to filter on. Defaults to None. - - - - -
-
- cloudkitty collector-state-disable - usage: cloudkitty collector-state-disable --name NAME - - - Optional arguments - - --name NAME - - - Name of the collector. Required. - - - - -
-
- cloudkitty collector-state-enable - usage: cloudkitty collector-state-enable --name NAME - - - Optional arguments - - --name NAME - - - Name of the collector. Required. - - - - -
-
- cloudkitty collector-state-get - usage: cloudkitty collector-state-get --name NAME - - - Optional arguments - - --name NAME - - - Name of the collector. Required. - - - - -
-
- cloudkitty hashmap-field-create - usage: cloudkitty hashmap-field-create -n NAME -s SERVICE_ID - -Create a field. - - Optional arguments - - -n NAME, --name NAME - - - Field name Required. - - - - - -s SERVICE_ID, --service-id SERVICE_ID - - - Service id Required. - - - - -
-
- cloudkitty hashmap-field-delete - usage: cloudkitty hashmap-field-delete -f FIELD_ID - -Delete a field. - - Optional arguments - - -f FIELD_ID, --field-id FIELD_ID - - - Field uuid Required. - - - - -
-
- cloudkitty hashmap-field-list - usage: cloudkitty hashmap-field-list -s SERVICE_ID - -Create a field. - - Optional arguments - - -s SERVICE_ID, --service-id SERVICE_ID - - - Service id Required. - - - - -
-
- cloudkitty hashmap-group-create - usage: cloudkitty hashmap-group-create -n NAME - -Create a group. - - Optional arguments - - -n NAME, --name NAME - - - Group name Required. - - - - -
-
- cloudkitty hashmap-group-delete - usage: cloudkitty hashmap-group-delete -g GROUP_ID [-r RECURSIVE] - -Delete a group. - - Optional arguments - - -g GROUP_ID, --group-id GROUP_ID - - - Group uuid Required. - - - - - -r RECURSIVE, --recursive RECURSIVE - - - Delete the group's mappings Defaults to False. - - - - -
-
- cloudkitty hashmap-group-list - usage: cloudkitty hashmap-group-list - -List groups. - -
-
- cloudkitty hashmap-mapping-create - usage: cloudkitty hashmap-mapping-create -c COST [-v VALUE] [-t TYPE] - [-s SERVICE_ID] [-f FIELD_ID] - [-g GROUP_ID] - -Create a mapping. - - Optional arguments - - -c COST, --cost COST - - - Mapping cost Required. - - - - - -v VALUE, --value VALUE - - - Mapping value - - - - - -t TYPE, --type TYPE - - - Mapping type (flat, rate) - - - - - -s SERVICE_ID, --service-id SERVICE_ID - - - Service id - - - - - -f FIELD_ID, --field-id FIELD_ID - - - Field id - - - - - -g GROUP_ID, --group-id GROUP_ID - - - Group id - - - - -
-
- cloudkitty hashmap-mapping-delete - usage: cloudkitty hashmap-mapping-delete -m MAPPING_ID - -Delete a mapping. - - Optional arguments - - -m MAPPING_ID, --mapping-id MAPPING_ID - - - Mapping uuid Required. - - - - -
-
- cloudkitty hashmap-mapping-list - usage: cloudkitty hashmap-mapping-list [-s SERVICE_ID] [-f FIELD_ID] - [-g GROUP_ID] - -List mappings. - - Optional arguments - - -s SERVICE_ID, --service-id SERVICE_ID - - - Service id - - - - - -f FIELD_ID, --field-id FIELD_ID - - - Field id - - - - - -g GROUP_ID, --group-id GROUP_ID - - - Group id - - - - -
-
- cloudkitty hashmap-mapping-update - usage: cloudkitty hashmap-mapping-update -m MAPPING_ID [-c COST] [-v VALUE] - [-t TYPE] [-g GROUP_ID] - -Update a mapping. - - Optional arguments - - -m MAPPING_ID, --mapping-id MAPPING_ID - - - Mapping id Required. - - - - - -c COST, --cost COST - - - Mapping cost - - - - - -v VALUE, --value VALUE - - - Mapping value - - - - - -t TYPE, --type TYPE - - - Mapping type (flat, rate) - - - - - -g GROUP_ID, --group-id GROUP_ID - - - Group id - - - - -
-
- cloudkitty hashmap-service-create - usage: cloudkitty hashmap-service-create -n NAME - -Create a service. - - Optional arguments - - -n NAME, --name NAME - - - Service name Required. - - - - -
-
- cloudkitty hashmap-service-delete - usage: cloudkitty hashmap-service-delete -s SERVICE_ID - -Delete a service. - - Optional arguments - - -s SERVICE_ID, --service-id SERVICE_ID - - - Service uuid Required. - - - - -
-
- cloudkitty hashmap-service-list - usage: cloudkitty hashmap-service-list - -List services. - -
-
- cloudkitty hashmap-threshold-create - usage: cloudkitty hashmap-threshold-create -l LEVEL -c COST [-m MAP_TYPE] - [-s SERVICE_ID] [-f FIELD_ID] - [-g GROUP_ID] - -Create a mapping. - - Optional arguments - - -l LEVEL, --level LEVEL - - - Threshold level Required. - - - - - -c COST, --cost COST - - - Threshold cost Required. - - - - - -m MAP_TYPE, --map-type MAP_TYPE - - - Threshold type (flat, rate) - - - - - -s SERVICE_ID, --service-id SERVICE_ID - - - Service id - - - - - -f FIELD_ID, --field-id FIELD_ID - - - Field id - - - - - -g GROUP_ID, --group-id GROUP_ID - - - Group id - - - - -
-
- cloudkitty hashmap-threshold-delete - usage: cloudkitty hashmap-threshold-delete -t THRESHOLD_ID - -Delete a threshold. - - Optional arguments - - -t THRESHOLD_ID, --threshold-id THRESHOLD_ID - - - Threshold uuid Required. - - - - -
-
- cloudkitty hashmap-threshold-get - usage: cloudkitty hashmap-threshold-get -t THRESHOLD_ID - -Get a threshold. - - Optional arguments - - -t THRESHOLD_ID, --threshold-id THRESHOLD_ID - - - Threshold uuid Required. - - - - -
-
- cloudkitty hashmap-threshold-group - usage: cloudkitty hashmap-threshold-group -t THRESHOLD_ID - -Get a threshold group. - - Optional arguments - - -t THRESHOLD_ID, --threshold-id THRESHOLD_ID - - - Threshold uuid Required. - - - - -
-
- cloudkitty hashmap-threshold-list - usage: cloudkitty hashmap-threshold-list [-s SERVICE_ID] [-f FIELD_ID] - [-g GROUP_ID] - [--no-group {True,False}] - -List thresholds. - - Optional arguments - - -s SERVICE_ID, --service-id SERVICE_ID - - - Service id - - - - - -f FIELD_ID, --field-id FIELD_ID - - - Field id - - - - - -g GROUP_ID, --group-id GROUP_ID - - - Group id - - - - - --no-group {True,False} - - - If True, list only orhpaned thresholds - - - - -
-
- cloudkitty hashmap-threshold-update - usage: cloudkitty hashmap-threshold-update -t THRESHOLD_ID [-l LEVEL] - [-c COST] [-m MAP_TYPE] - [-g GROUP_ID] - -Update a threshold. - - Optional arguments - - -t THRESHOLD_ID, --threshold-id THRESHOLD_ID - - - Threshold id Required. - - - - - -l LEVEL, --level LEVEL - - - Threshold level - - - - - -c COST, --cost COST - - - Threshold cost - - - - - -m MAP_TYPE, --map-type MAP_TYPE - - - Threshold type (flat, rate) - - - - - -g GROUP_ID, --group-id GROUP_ID - - - Group id - - - - -
-
- cloudkitty module-disable - usage: cloudkitty module-disable -n NAME - -Disable a module. - - Optional arguments - - -n NAME, --name NAME - - - Module name Required. - - - - -
-
- cloudkitty module-enable - usage: cloudkitty module-enable -n NAME - -Enable a module. - - Optional arguments - - -n NAME, --name NAME - - - Module name Required. - - - - -
-
- cloudkitty module-list - usage: cloudkitty module-list - -List the samples for this meters. - -
-
- cloudkitty report-tenant-list - usage: cloudkitty report-tenant-list - - -
-
- cloudkitty storage-dataframe-list - usage: cloudkitty storage-dataframe-list --begin BEGIN --end END - [--tenant TENANT] - [--resource-type RESOURCE_TYPE] - - - Optional arguments - - --begin BEGIN - - - Starting date/time (YYYY-MM-ddThh:mm:ss) - Required. - - - - - --end END - - - Ending date/time (YYYY-MM-ddThh:mm:ss) - Required. - - - - - --tenant TENANT - - - Tenant ID Defaults to None. - - - - - --resource-type RESOURCE_TYPE - - - Resource type (compute, image, ...) Defaults - to None. - - - - -
-
- cloudkitty total-get - usage: cloudkitty total-get [-t TOTAL_TENANT_ID] [-b BEGIN] [-e END] - - - Optional arguments - - -t TOTAL_TENANT_ID, --tenant-id TOTAL_TENANT_ID - - - Tenant id - - - - - -b BEGIN, --begin BEGIN - - - Begin timestamp - - - - - -e END, --end END - - - End timestamp - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_designate_commands.xml b/doc/cli-reference/generated/ch_cli_designate_commands.xml deleted file mode 100644 index 37baac7d4c..0000000000 --- a/doc/cli-reference/generated/ch_cli_designate_commands.xml +++ /dev/null @@ -1,1394 +0,0 @@ - - - - - - - - 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 designate version - 1.5.0. - - - For help on a specific designate - command, enter: - - $ designate COMMAND - -
- designate usage - 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 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 - usage: designate diagnostics-ping [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate domain-create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate domain-delete [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate domain-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--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 - usage: designate domain-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List Domains - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- designate domain-servers-list - usage: designate domain-servers-list [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate domain-update [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate quota-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--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 - usage: designate quota-reset [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--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 - usage: designate quota-update [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--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 - usage: designate record-create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate record-delete [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate record-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--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 - usage: designate record-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--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 - usage: designate record-update [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate report-count-all [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate report-count-domains [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -Get counts for total domains - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- designate report-count-records - usage: designate report-count-records [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -Get counts for total records - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- designate report-count-tenants - usage: designate report-count-tenants [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -Get counts for total tenants - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- designate report-tenant-domains - usage: designate report-tenant-domains [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate report-tenants-all [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate server-create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] --name NAME - -Create Server - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME - - - Server name - - - - -
-
- designate server-delete - usage: designate server-delete [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - id - -Delete Server - - Positional arguments - - id - - - Server ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- designate server-get - usage: designate server-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - id - -Get Server - - Positional arguments - - id - - - Server ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- designate server-list - usage: designate server-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List Servers - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- designate server-update - usage: designate server-update [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--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 - usage: designate sync-all [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--prefix PREFIX] - -Sync Everything - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- designate sync-domain - usage: designate sync-domain [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--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 - usage: designate sync-record [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--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 - usage: designate touch-domain [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--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-reference/generated/ch_cli_glance_commands.xml b/doc/cli-reference/generated/ch_cli_glance_commands.xml deleted file mode 100644 index c8270ed08e..0000000000 --- a/doc/cli-reference/generated/ch_cli_glance_commands.xml +++ /dev/null @@ -1,2919 +0,0 @@ - - - - - - - - Image service command-line client - - The glance client is the command-line - interface (CLI) for the Image service API and its extensions. - - This chapter documents glance version - 1.2.0. - - - For help on a specific glance - command, enter: - - $ glance COMMAND - -
- glance usage - usage: glance [--version] [-d] [-v] [--get-schema] [--no-ssl-compression] [-f] - [--os-image-url OS_IMAGE_URL] - [--os-image-api-version OS_IMAGE_API_VERSION] [--insecure] - [--os-cacert <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] - [--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-user-name OS_USERNAME] - [--os-user-domain-id OS_USER_DOMAIN_ID] - [--os-user-domain-name OS_USER_DOMAIN_NAME] - [--os-password OS_PASSWORD] [--key-file OS_KEY] - [--ca-file OS_CACERT] [--cert-file OS_CERT] - [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] - [--os-region-name OS_REGION_NAME] - [--os-auth-token OS_AUTH_TOKEN] - [--os-service-type OS_SERVICE_TYPE] - [--os-endpoint-type OS_ENDPOINT_TYPE] - <subcommand> ... -
-
- glance optional arguments - - - --version - - - show program's version number and exit - - - - - -d, --debug - - - Defaults to env[GLANCECLIENT_DEBUG]. - - - - - -v, --verbose - - - Print more verbose output. - - - - - --get-schema - - - Ignores cached copy and forces retrieval of schema - that generates portions of the help text. Ignored with - API version 1. - - - - - --no-ssl-compression - - - DEPRECATED! This option is deprecated and not used - anymore. SSL compression should be disabled by default - by the system SSL library. - - - - - -f, --force - - - Prevent select actions from requesting user - confirmation. - - - - - --os-image-url OS_IMAGE_URL - - - Defaults to env[OS_IMAGE_URL]. If the provided image - url contains a version number and `--os-image-api- - version` is omitted the version of the URL will be - picked as the image api version to use. - - - - - --os-image-api-version OS_IMAGE_API_VERSION - - - Defaults to env[OS_IMAGE_API_VERSION] or 2. - - - - - --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 <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - 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-user-name OS_USERNAME, --os-username 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 - - - - - --key-file OS_KEY - - - DEPRECATED! Use --os-key. - - - - - --ca-file OS_CACERT - - - DEPRECATED! Use --os-cacert. - - - - - --cert-file OS_CERT - - - DEPRECATED! Use --os-cert. - - - - - --os-tenant-id OS_TENANT_ID - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-tenant-name OS_TENANT_NAME - - - Defaults to env[OS_TENANT_NAME]. - - - - - --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-service-type OS_SERVICE_TYPE - - - Defaults to env[OS_SERVICE_TYPE]. - - - - - --os-endpoint-type OS_ENDPOINT_TYPE - - - Defaults to env[OS_ENDPOINT_TYPE]. - - - - -
- -
- Image service API v1 commands -
- glance image-create (v1) - usage: glance --os-image-api-version 1 image-create [--id <IMAGE_ID>] [--name <NAME>] [--store <STORE>] - [--disk-format <DISK_FORMAT>] - [--container-format <CONTAINER_FORMAT>] - [--owner <TENANT_ID>] [--size <SIZE>] - [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>] - [--location <IMAGE_URL>] [--file <FILE>] - [--checksum <CHECKSUM>] [--copy-from <IMAGE_URL>] - [--is-public {True,False}] - [--is-protected {True,False}] - [--property <key=value>] [--human-readable] - [--progress] - -Create a new image. - - Optional arguments - - --id <IMAGE_ID> - - - ID of image to reserve. - - - - - --name <NAME> - - - Name of image. - - - - - --store <STORE> - - - Store to upload image to. - - - - - --disk-format <DISK_FORMAT> - - - Disk format of image. Acceptable formats: ami, ari, - aki, vhd, vmdk, raw, qcow2, vdi, and iso. - - - - - --container-format <CONTAINER_FORMAT> - - - Container format of image. Acceptable formats: ami, - ari, aki, bare, and ovf. - - - - - --owner <TENANT_ID> - - - Tenant who should own image. - - - - - --size <SIZE> - - - Size of image data (in bytes). Only used with '-- - location' and '--copy_from'. - - - - - --min-disk <DISK_GB> - - - Minimum size of disk needed to boot image (in - gigabytes). - - - - - --min-ram <DISK_RAM> - - - Minimum amount of ram needed to boot image (in - megabytes). - - - - - --location <IMAGE_URL> - - - URL where the data for this image already resides. For - example, if the image data is stored in swift, you - could specify 'swift+http://tenant%3Aaccount:key@auth_ - url/v2.0/container/obj'. (Note: '%3A' is ':' URL - encoded.) - - - - - --file <FILE> - - - Local file that contains disk image to be uploaded - during creation. Alternatively, images can be passed - to the client via stdin. - - - - - --checksum <CHECKSUM> - - - Hash of image data used Glance can use for - verification. Provide a md5 checksum here. - - - - - --copy-from <IMAGE_URL> - - - Similar to '--location' in usage, but this indicates - that the Glance server should immediately copy the - data and store it in its configured image store. - - - - - --is-public {True,False} - - - Make image accessible to the public. - - - - - --is-protected {True,False} - - - Prevent image from being deleted. - - - - - --property <key=value> - - - Arbitrary property to associate with image. May be - used multiple times. - - - - - --human-readable - - - Print image size in a human-friendly format. - - - - - --progress - - - Show upload progress bar. - - - - -
-
- glance image-delete (v1) - usage: glance --os-image-api-version 1 image-delete <IMAGE> [<IMAGE> ...] - -Delete specified image(s). - - Positional arguments - - <IMAGE> - - - Name or ID of image(s) to delete. - - - - -
-
- glance image-download (v1) - usage: glance --os-image-api-version 1 image-download [--file <FILE>] [--progress] <IMAGE> - -Download a specific image. - - Positional arguments - - <IMAGE> - - - Name or ID of image to download. - - - - - - Optional arguments - - --file <FILE> - - - Local file to save downloaded image data to. If this is not - specified and there is no redirection the image data will be - not be saved. - - - - - --progress - - - Show download progress bar. - - - - -
-
- glance image-list (v1) - usage: glance --os-image-api-version 1 image-list [--name <NAME>] [--status <STATUS>] - [--changes-since <CHANGES_SINCE>] - [--container-format <CONTAINER_FORMAT>] - [--disk-format <DISK_FORMAT>] [--size-min <SIZE>] - [--size-max <SIZE>] [--property-filter <KEY=VALUE>] - [--page-size <SIZE>] [--human-readable] - [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}] - [--sort-dir {asc,desc}] [--is-public {True,False}] - [--owner <TENANT_ID>] [--all-tenants] - -List images you can access. - - Optional arguments - - --name <NAME> - - - Filter images to those that have this name. - - - - - --status <STATUS> - - - Filter images to those that have this status. - - - - - --changes-since <CHANGES_SINCE> - - - Filter images to those that changed since the given - time, which will include the deleted images. - - - - - --container-format <CONTAINER_FORMAT> - - - Filter images to those that have this container - format. Acceptable formats: ami, ari, aki, bare, and - ovf. - - - - - --disk-format <DISK_FORMAT> - - - Filter images to those that have this disk format. - Acceptable formats: ami, ari, aki, vhd, vmdk, raw, - qcow2, vdi, and iso. - - - - - --size-min <SIZE> - - - Filter images to those with a size greater than this. - - - - - --size-max <SIZE> - - - Filter images to those with a size less than this. - - - - - --property-filter <KEY=VALUE> - - - Filter images by a user-defined image property. - - - - - --page-size <SIZE> - - - Number of images to request in each paginated request. - - - - - --human-readable - - - Print image size in a human-friendly format. - - - - - --sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at} - - - Sort image list by specified field. - - - - - --sort-dir {asc,desc} - - - Sort image list in specified direction. - - - - - --is-public {True,False} - - - Allows the user to select a listing of public or non - public images. - - - - - --owner <TENANT_ID> - - - Display only images owned by this tenant id. Filtering - occurs on the client side so may be inefficient. This - option is mainly intended for admin use. Use an empty - string ('') to list images with no owner. Note: This - option overrides the --is-public argument if present. - Note: the v2 API supports more efficient server-side - owner based filtering. - - - - - --all-tenants - - - Allows the admin user to list all images irrespective - of the image's owner or is_public value. - - - - -
-
- glance image-show (v1) - usage: glance --os-image-api-version 1 image-show [--human-readable] [--max-column-width <integer>] - <IMAGE> - -Describe a specific image. - - Positional arguments - - <IMAGE> - - - Name or ID of image to describe. - - - - - - Optional arguments - - --human-readable - - - Print image size in a human-friendly format. - - - - - --max-column-width <integer> - - - The max column width of the printed table. - - - - -
-
- glance image-update (v1) - usage: glance --os-image-api-version 1 image-update [--name <NAME>] [--disk-format <DISK_FORMAT>] - [--container-format <CONTAINER_FORMAT>] - [--owner <TENANT_ID>] [--size <SIZE>] - [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>] - [--location <IMAGE_URL>] [--file <FILE>] - [--checksum <CHECKSUM>] [--copy-from <IMAGE_URL>] - [--is-public {True,False}] - [--is-protected {True,False}] - [--property <key=value>] [--purge-props] - [--human-readable] [--progress] - <IMAGE> - -Update a specific image. - - Positional arguments - - <IMAGE> - - - Name or ID of image to modify. - - - - - - Optional arguments - - --name <NAME> - - - Name of image. - - - - - --disk-format <DISK_FORMAT> - - - Disk format of image. Acceptable formats: ami, ari, - aki, vhd, vmdk, raw, qcow2, vdi, and iso. - - - - - --container-format <CONTAINER_FORMAT> - - - Container format of image. Acceptable formats: ami, - ari, aki, bare, and ovf. - - - - - --owner <TENANT_ID> - - - Tenant who should own image. - - - - - --size <SIZE> - - - Size of image data (in bytes). - - - - - --min-disk <DISK_GB> - - - Minimum size of disk needed to boot image (in - gigabytes). - - - - - --min-ram <DISK_RAM> - - - Minimum amount of ram needed to boot image (in - megabytes). - - - - - --location <IMAGE_URL> - - - URL where the data for this image already resides. For - example, if the image data is stored in swift, you - could specify 'swift+http://tenant%3Aaccount:key@auth_ - url/v2.0/container/obj'. (Note: '%3A' is ':' URL - encoded.) This option only works for images in - 'queued' status. - - - - - --file <FILE> - - - Local file that contains disk image to be uploaded - during update. Alternatively, images can be passed to - the client via stdin. - - - - - --checksum <CHECKSUM> - - - Hash of image data used Glance can use for - verification. - - - - - --copy-from <IMAGE_URL> - - - Similar to '--location' in usage, but this indicates - that the Glance server should immediately copy the - data and store it in its configured image store. This - option only works for images in 'queued' status. - - - - - --is-public {True,False} - - - Make image accessible to the public. - - - - - --is-protected {True,False} - - - Prevent image from being deleted. - - - - - --property <key=value> - - - Arbitrary property to associate with image. May be - used multiple times. - - - - - --purge-props - - - If this flag is present, delete all image properties - not explicitly set in the update request. Otherwise, - those properties not referenced are preserved. - - - - - --human-readable - - - Print image size in a human-friendly format. - - - - - --progress - - - Show upload progress bar. - - - - -
-
- glance member-create (v1) - usage: glance --os-image-api-version 1 member-create [--can-share] <IMAGE> <TENANT_ID> - -Share a specific image with a tenant. - - Positional arguments - - <IMAGE> - - - Image to add member to. - - - - - <TENANT_ID> - - - Tenant to add as member. - - - - - - Optional arguments - - --can-share - - - Allow the specified tenant to share this image. - - - - -
-
- glance member-delete (v1) - usage: glance --os-image-api-version 1 member-delete <IMAGE> <TENANT_ID> - -Remove a shared image from a tenant. - - Positional arguments - - <IMAGE> - - - Image from which to remove member. - - - - - <TENANT_ID> - - - Tenant to remove as member. - - - - -
-
- glance member-list (v1) - usage: glance --os-image-api-version 1 member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>] - -Describe sharing permissions by image or tenant. - - Optional arguments - - --image-id <IMAGE_ID> - - - Filter results by an image ID. - - - - - --tenant-id <TENANT_ID> - - - Filter results by a tenant ID. - - - - -
- -
- -
- Image service API v2 commands - - You can select an API version to use by adding the - --os-image-api-version parameter or by setting - the corresponding environment variable: -$ export OS_IMAGE_API_VERSION=2 - -
- glance explain (v2) - usage: glance --os-image-api-version 2 explain <MODEL> - -Describe a specific model. - - Positional arguments - - <MODEL> - - - Name of model to describe. - - - - -
-
- glance image-create (v2) - usage: glance --os-image-api-version 2 image-create [--architecture <ARCHITECTURE>] - [--protected [True|False]] [--name <NAME>] - [--instance-uuid <INSTANCE_UUID>] - [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>] - [--kernel-id <KERNEL_ID>] - [--tags <TAGS> [<TAGS> ...]] - [--os-version <OS_VERSION>] - [--disk-format <DISK_FORMAT>] [--self <SELF>] - [--os-distro <OS_DISTRO>] [--id <ID>] - [--owner <OWNER>] [--ramdisk-id <RAMDISK_ID>] - [--min-ram <MIN_RAM>] - [--container-format <CONTAINER_FORMAT>] - [--property <key=value>] [--file <FILE>] - [--progress] - -Create a new image. - - Optional arguments - - --architecture <ARCHITECTURE> - - - Operating system architecture as specified in - http://docs.openstack.org/trunk/openstack- - compute/admin/content/adding-images.html - - - - - --protected [True|False] - - - If true, image will not be deletable. - - - - - --name <NAME> - - - Descriptive name for the image - - - - - --instance-uuid <INSTANCE_UUID> - - - ID of instance used to create this image. - - - - - --min-disk <MIN_DISK> - - - Amount of disk space (in GB) required to boot image. - - - - - --visibility <VISIBILITY> - - - Scope of image accessibility Valid values: public, - private - - - - - --kernel-id <KERNEL_ID> - - - ID of image stored in Glance that should be used as - the kernel when booting an AMI-style image. - - - - - --tags <TAGS> [<TAGS> ...] - - - List of strings related to the image - - - - - --os-version <OS_VERSION> - - - Operating system version as specified by the - distributor - - - - - --disk-format <DISK_FORMAT> - - - Format of the disk Valid values: ami, ari, aki, vhd, - vmdk, raw, qcow2, vdi, iso - - - - - --self <SELF> - - - (READ-ONLY) - - - - - --os-distro <OS_DISTRO> - - - Common name of operating system distribution as - specified in http://docs.openstack.org/trunk - /openstack-compute/admin/content/adding-images.html - - - - - --id <ID> - - - An identifier for the image - - - - - --owner <OWNER> - - - Owner of the image - - - - - --ramdisk-id <RAMDISK_ID> - - - ID of image stored in Glance that should be used as - the ramdisk when booting an AMI-style image. - - - - - --min-ram <MIN_RAM> - - - Amount of ram (in MB) required to boot image. - - - - - --container-format <CONTAINER_FORMAT> - - - Format of the container Valid values: ami, ari, aki, - bare, ovf, ova - - - - - --property <key=value> - - - Arbitrary property to associate with image. May be - used multiple times. - - - - - --file <FILE> - - - Local file that contains disk image to be uploaded - during creation. Must be present if images are not - passed to the client via stdin. - - - - - --progress - - - Show upload progress bar. - - - - -
-
- glance image-deactivate (v2) - usage: glance --os-image-api-version 2 image-deactivate <IMAGE_ID> - -Deactivate specified image. - - Positional arguments - - <IMAGE_ID> - - - ID of image to deactivate. - - - - -
-
- glance image-delete (v2) - usage: glance --os-image-api-version 2 image-delete <IMAGE_ID> [<IMAGE_ID> ...] - -Delete specified image. - - Positional arguments - - <IMAGE_ID> - - - ID of image(s) to delete. - - - - -
-
- glance image-download (v2) - usage: glance --os-image-api-version 2 image-download [--file <FILE>] [--progress] <IMAGE_ID> - -Download a specific image. - - Positional arguments - - <IMAGE_ID> - - - ID of image to download. - - - - - - Optional arguments - - --file <FILE> - - - Local file to save downloaded image data to. If this is not - specified and there is no redirection the image data will be - not be saved. - - - - - --progress - - - Show download progress bar. - - - - -
-
- glance image-list (v2) - usage: glance --os-image-api-version 2 image-list [--limit <LIMIT>] [--page-size <SIZE>] - [--visibility <VISIBILITY>] - [--member-status <MEMBER_STATUS>] [--owner <OWNER>] - [--property-filter <KEY=VALUE>] - [--checksum <CHECKSUM>] [--tag <TAG>] - [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}] - [--sort-dir {asc,desc}] [--sort <key>[:<direction>]] - -List images you can access. - - Optional arguments - - --limit <LIMIT> - - - Maximum number of images to get. - - - - - --page-size <SIZE> - - - Number of images to request in each paginated request. - - - - - --visibility <VISIBILITY> - - - The visibility of the images to display. - - - - - --member-status <MEMBER_STATUS> - - - The status of images to display. - - - - - --owner <OWNER> - - - Display images owned by <OWNER>. - - - - - --property-filter <KEY=VALUE> - - - Filter images by a user-defined image property. - - - - - --checksum <CHECKSUM> - - - Displays images that match the checksum. - - - - - --tag <TAG> - - - Filter images by a user-defined tag. - - - - - --sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at} - - - Sort image list by specified fields. - - - - - --sort-dir {asc,desc} - - - Sort image list in specified directions. - - - - - --sort <key>[:<direction>] - - - Comma-separated list of sort keys and directions in - the form of <key>[:<asc|desc>]. Valid keys: name, - status, container_format, disk_format, size, id, - created_at, updated_at. OPTIONAL. - - - - -
-
- glance image-reactivate (v2) - usage: glance --os-image-api-version 2 image-reactivate <IMAGE_ID> - -Reactivate specified image. - - Positional arguments - - <IMAGE_ID> - - - ID of image to reactivate. - - - - -
-
- glance image-show (v2) - usage: glance --os-image-api-version 2 image-show [--human-readable] [--max-column-width <integer>] - <IMAGE_ID> - -Describe a specific image. - - Positional arguments - - <IMAGE_ID> - - - ID of image to describe. - - - - - - Optional arguments - - --human-readable - - - Print image size in a human-friendly format. - - - - - --max-column-width <integer> - - - The max column width of the printed table. - - - - -
-
- glance image-tag-delete (v2) - usage: glance --os-image-api-version 2 image-tag-delete <IMAGE_ID> <TAG_VALUE> - -Delete the tag associated with the given image. - - Positional arguments - - <IMAGE_ID> - - - ID of the image from which to delete tag. - - - - - <TAG_VALUE> - - - Value of the tag. - - - - -
-
- glance image-tag-update (v2) - usage: glance --os-image-api-version 2 image-tag-update <IMAGE_ID> <TAG_VALUE> - -Update an image with the given tag. - - Positional arguments - - <IMAGE_ID> - - - Image to be updated with the given tag. - - - - - <TAG_VALUE> - - - Value of the tag. - - - - -
-
- glance image-update (v2) - usage: glance --os-image-api-version 2 image-update [--architecture <ARCHITECTURE>] - [--protected [True|False]] [--name <NAME>] - [--instance-uuid <INSTANCE_UUID>] - [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>] - [--kernel-id <KERNEL_ID>] - [--os-version <OS_VERSION>] - [--disk-format <DISK_FORMAT>] [--self <SELF>] - [--os-distro <OS_DISTRO>] [--owner <OWNER>] - [--ramdisk-id <RAMDISK_ID>] [--min-ram <MIN_RAM>] - [--container-format <CONTAINER_FORMAT>] - [--property <key=value>] [--remove-property key] - <IMAGE_ID> - -Update an existing image. - - Positional arguments - - <IMAGE_ID> - - - ID of image to update. - - - - - - Optional arguments - - --architecture <ARCHITECTURE> - - - Operating system architecture as specified in - http://docs.openstack.org/trunk/openstack- - compute/admin/content/adding-images.html - - - - - --protected [True|False] - - - If true, image will not be deletable. - - - - - --name <NAME> - - - Descriptive name for the image - - - - - --instance-uuid <INSTANCE_UUID> - - - ID of instance used to create this image. - - - - - --min-disk <MIN_DISK> - - - Amount of disk space (in GB) required to boot image. - - - - - --visibility <VISIBILITY> - - - Scope of image accessibility Valid values: public, - private - - - - - --kernel-id <KERNEL_ID> - - - ID of image stored in Glance that should be used as - the kernel when booting an AMI-style image. - - - - - --os-version <OS_VERSION> - - - Operating system version as specified by the - distributor - - - - - --disk-format <DISK_FORMAT> - - - Format of the disk Valid values: ami, ari, aki, vhd, - vmdk, raw, qcow2, vdi, iso - - - - - --self <SELF> - - - (READ-ONLY) - - - - - --os-distro <OS_DISTRO> - - - Common name of operating system distribution as - specified in http://docs.openstack.org/trunk - /openstack-compute/admin/content/adding-images.html - - - - - --owner <OWNER> - - - Owner of the image - - - - - --ramdisk-id <RAMDISK_ID> - - - ID of image stored in Glance that should be used as - the ramdisk when booting an AMI-style image. - - - - - --min-ram <MIN_RAM> - - - Amount of ram (in MB) required to boot image. - - - - - --container-format <CONTAINER_FORMAT> - - - Format of the container Valid values: ami, ari, aki, - bare, ovf, ova - - - - - --property <key=value> - - - Arbitrary property to associate with image. May be - used multiple times. - - - - - --remove-property - - - key - Name of arbitrary property to remove from the image. - - - - -
-
- glance image-upload (v2) - usage: glance --os-image-api-version 2 image-upload [--file <FILE>] [--size <IMAGE_SIZE>] [--progress] - <IMAGE_ID> - -Upload data for a specific image. - - Positional arguments - - <IMAGE_ID> - - - ID of image to upload data to. - - - - - - Optional arguments - - --file <FILE> - - - Local file that contains disk image to be uploaded. - Alternatively, images can be passed to the client via - stdin. - - - - - --size <IMAGE_SIZE> - - - Size in bytes of image to be uploaded. Default is to - get size from provided data object but this is - supported in case where size cannot be inferred. - - - - - --progress - - - Show upload progress bar. - - - - -
-
- glance location-add (v2) - usage: glance --os-image-api-version 2 location-add --url <URL> [--metadata <STRING>] <ID> - -Add a location (and related metadata) to an image. - - Positional arguments - - <ID> - - - ID of image to which the location is to be added. - - - - - - Optional arguments - - --url <URL> - - - URL of location to add. - - - - - --metadata <STRING> - - - Metadata associated with the location. Must be a valid - JSON object (default: {}) - - - - -
-
- glance location-delete (v2) - usage: glance --os-image-api-version 2 location-delete --url <URL> <ID> - -Remove locations (and related metadata) from an image. - - Positional arguments - - <ID> - - - ID of image whose locations are to be removed. - - - - - - Optional arguments - - --url <URL> - - - URL of location to remove. May be used multiple times. - - - - -
-
- glance location-update (v2) - usage: glance --os-image-api-version 2 location-update --url <URL> [--metadata <STRING>] <ID> - -Update metadata of an image's location. - - Positional arguments - - <ID> - - - ID of image whose location is to be updated. - - - - - - Optional arguments - - --url <URL> - - - URL of location to update. - - - - - --metadata <STRING> - - - Metadata associated with the location. Must be a valid - JSON object (default: {}) - - - - -
-
- glance md-namespace-create (v2) - usage: glance --os-image-api-version 2 md-namespace-create <NAMESPACE> <unavailable> - -Create a new metadata definitions namespace. - - Positional arguments - - <NAMESPACE> - - - Name of the namespace. - - - - - <unavailable> - - - Please run with connection parameters set to retrieve the - schema for generating help for this command - - - - -
-
- glance md-namespace-delete (v2) - usage: glance --os-image-api-version 2 md-namespace-delete <NAMESPACE> - -Delete specified metadata definitions namespace with its contents. - - Positional arguments - - <NAMESPACE> - - - Name of namespace to delete. - - - - -
-
- glance md-namespace-import (v2) - usage: glance --os-image-api-version 2 md-namespace-import [--file <FILEPATH>] - -Import a metadata definitions namespace from file or standard input. - - Optional arguments - - --file <FILEPATH> - - - Path to file with namespace schema to import. - Alternatively, namespaces schema can be passed to the - client via stdin. - - - - -
-
- glance md-namespace-list (v2) - usage: glance --os-image-api-version 2 md-namespace-list [--resource-types <RESOURCE_TYPES>] - [--visibility <VISIBILITY>] - [--page-size <SIZE>] - -List metadata definitions namespaces. - - Optional arguments - - --resource-types <RESOURCE_TYPES> - - - Resource type to filter namespaces. - - - - - --visibility <VISIBILITY> - - - Visibility parameter to filter namespaces. - - - - - --page-size <SIZE> - - - Number of namespaces to request in each paginated - request. - - - - -
-
- glance md-namespace-objects-delete (v2) - usage: glance --os-image-api-version 2 md-namespace-objects-delete <NAMESPACE> - -Delete all metadata definitions objects inside a specific namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - -
-
- glance md-namespace-properties-delete (v2) - usage: glance --os-image-api-version 2 md-namespace-properties-delete <NAMESPACE> - -Delete all metadata definitions property inside a specific namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - -
-
- glance md-namespace-resource-type-list (v2) - usage: glance --os-image-api-version 2 md-namespace-resource-type-list <NAMESPACE> - -List resource types associated to specific namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - -
-
- glance md-namespace-show (v2) - usage: glance --os-image-api-version 2 md-namespace-show [--resource-type <RESOURCE_TYPE>] - [--max-column-width <integer>] - <NAMESPACE> - -Describe a specific metadata definitions namespace. Lists also the namespace -properties, objects and resource type associations. - - Positional arguments - - <NAMESPACE> - - - Name of namespace to describe. - - - - - - Optional arguments - - --resource-type <RESOURCE_TYPE> - - - Applies prefix of given resource type associated to a - namespace to all properties of a namespace. - - - - - --max-column-width <integer> - - - The max column width of the printed table. - - - - -
-
- glance md-namespace-tags-delete (v2) - usage: glance --os-image-api-version 2 md-namespace-tags-delete <NAMESPACE> - -Delete all metadata definitions tags inside a specific namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - -
-
- glance md-namespace-update (v2) - usage: glance --os-image-api-version 2 md-namespace-update <NAMESPACE> <unavailable> - -Update an existing metadata definitions namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace to update. - - - - - <unavailable> - - - Please run with connection parameters set to retrieve the - schema for generating help for this command - - - - -
-
- glance md-object-create (v2) - usage: glance --os-image-api-version 2 md-object-create --name <NAME> --schema <SCHEMA> <NAMESPACE> - -Create a new metadata definitions object inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the object will belong. - - - - - - Optional arguments - - --name <NAME> - - - Internal name of an object. - - - - - --schema <SCHEMA> - - - Valid JSON schema of an object. - - - - -
-
- glance md-object-delete (v2) - usage: glance --os-image-api-version 2 md-object-delete <NAMESPACE> <OBJECT> - -Delete a specific metadata definitions object inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the object belongs. - - - - - <OBJECT> - - - Name of an object. - - - - -
-
- glance md-object-list (v2) - usage: glance --os-image-api-version 2 md-object-list <NAMESPACE> - -List metadata definitions objects inside a specific namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - -
-
- glance md-object-property-show (v2) - usage: glance --os-image-api-version 2 md-object-property-show [--max-column-width <integer>] - <NAMESPACE> <OBJECT> <PROPERTY> - -Describe a specific metadata definitions property inside an object. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the object belongs. - - - - - <OBJECT> - - - Name of an object. - - - - - <PROPERTY> - - - Name of a property. - - - - - - Optional arguments - - --max-column-width <integer> - - - The max column width of the printed table. - - - - -
-
- glance md-object-show (v2) - usage: glance --os-image-api-version 2 md-object-show [--max-column-width <integer>] - <NAMESPACE> <OBJECT> - -Describe a specific metadata definitions object inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the object belongs. - - - - - <OBJECT> - - - Name of an object. - - - - - - Optional arguments - - --max-column-width <integer> - - - The max column width of the printed table. - - - - -
-
- glance md-object-update (v2) - usage: glance --os-image-api-version 2 md-object-update [--name <NAME>] [--schema <SCHEMA>] - <NAMESPACE> <OBJECT> - -Update metadata definitions object inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the object belongs. - - - - - <OBJECT> - - - Name of an object. - - - - - - Optional arguments - - --name <NAME> - - - New name of an object. - - - - - --schema <SCHEMA> - - - Valid JSON schema of an object. - - - - -
-
- glance md-property-create (v2) - usage: glance --os-image-api-version 2 md-property-create --name <NAME> --title <TITLE> --schema - <SCHEMA> - <NAMESPACE> - -Create a new metadata definitions property inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the property will belong. - - - - - - Optional arguments - - --name <NAME> - - - Internal name of a property. - - - - - --title <TITLE> - - - Property name displayed to the user. - - - - - --schema <SCHEMA> - - - Valid JSON schema of a property. - - - - -
-
- glance md-property-delete (v2) - usage: glance --os-image-api-version 2 md-property-delete <NAMESPACE> <PROPERTY> - -Delete a specific metadata definitions property inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the property belongs. - - - - - <PROPERTY> - - - Name of a property. - - - - -
-
- glance md-property-list (v2) - usage: glance --os-image-api-version 2 md-property-list <NAMESPACE> - -List metadata definitions properties inside a specific namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - -
-
- glance md-property-show (v2) - usage: glance --os-image-api-version 2 md-property-show [--max-column-width <integer>] - <NAMESPACE> <PROPERTY> - -Describe a specific metadata definitions property inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the property belongs. - - - - - <PROPERTY> - - - Name of a property. - - - - - - Optional arguments - - --max-column-width <integer> - - - The max column width of the printed table. - - - - -
-
- glance md-property-update (v2) - usage: glance --os-image-api-version 2 md-property-update [--name <NAME>] [--title <TITLE>] - [--schema <SCHEMA>] - <NAMESPACE> <PROPERTY> - -Update metadata definitions property inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace the property belongs. - - - - - <PROPERTY> - - - Name of a property. - - - - - - Optional arguments - - --name <NAME> - - - New name of a property. - - - - - --title <TITLE> - - - Property name displayed to the user. - - - - - --schema <SCHEMA> - - - Valid JSON schema of a property. - - - - -
-
- glance md-resource-type-associate (v2) - usage: glance --os-image-api-version 2 md-resource-type-associate <NAMESPACE> <unavailable> - -Associate resource type with a metadata definitions namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - - <unavailable> - - - Please run with connection parameters set to retrieve the - schema for generating help for this command - - - - -
-
- glance md-resource-type-deassociate (v2) - usage: glance --os-image-api-version 2 md-resource-type-deassociate <NAMESPACE> <RESOURCE_TYPE> - -Deassociate resource type with a metadata definitions namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - - <RESOURCE_TYPE> - - - Name of resource type. - - - - -
-
- glance md-resource-type-list (v2) - usage: glance --os-image-api-version 2 md-resource-type-list - -List available resource type names. -Run `glance --os-image-api-version 1 help md-resource-type-list` for v1 help - -
-
- glance md-tag-create (v2) - usage: glance --os-image-api-version 2 md-tag-create --name <NAME> <NAMESPACE> - -Add a new metadata definitions tag inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of the namespace the tag will belong to. - - - - - - Optional arguments - - --name <NAME> - - - The name of the new tag to add. - - - - -
-
- glance md-tag-create-multiple (v2) - usage: glance --os-image-api-version 2 md-tag-create-multiple --names <NAMES> [--delim <DELIM>] - <NAMESPACE> - -Create new metadata definitions tags inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of the namespace the tags will belong to. - - - - - - Optional arguments - - --names <NAMES> - - - A comma separated list of tag names. - - - - - --delim <DELIM> - - - The delimiter used to separate the names (if none is - provided then the default is a comma). - - - - -
-
- glance md-tag-delete (v2) - usage: glance --os-image-api-version 2 md-tag-delete <NAMESPACE> <TAG> - -Delete a specific metadata definitions tag inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of the namespace to which the tag belongs. - - - - - <TAG> - - - Name of the tag. - - - - -
-
- glance md-tag-list (v2) - usage: glance --os-image-api-version 2 md-tag-list <NAMESPACE> - -List metadata definitions tags inside a specific namespace. - - Positional arguments - - <NAMESPACE> - - - Name of namespace. - - - - -
-
- glance md-tag-show (v2) - usage: glance --os-image-api-version 2 md-tag-show <NAMESPACE> <TAG> - -Describe a specific metadata definitions tag inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of the namespace to which the tag belongs. - - - - - <TAG> - - - Name of the tag. - - - - -
-
- glance md-tag-update (v2) - usage: glance --os-image-api-version 2 md-tag-update --name <NAME> <NAMESPACE> <TAG> - -Rename a metadata definitions tag inside a namespace. - - Positional arguments - - <NAMESPACE> - - - Name of the namespace to which the tag belongs. - - - - - <TAG> - - - Name of the old tag. - - - - - - Optional arguments - - --name <NAME> - - - New name of the new tag. - - - - -
-
- glance member-create (v2) - usage: glance --os-image-api-version 2 member-create <IMAGE_ID> <MEMBER_ID> - -Create member for a given image. - - Positional arguments - - <IMAGE_ID> - - - Image with which to create member. - - - - - <MEMBER_ID> - - - Tenant to add as member. - - - - -
-
- glance member-delete (v2) - usage: glance --os-image-api-version 2 member-delete <IMAGE_ID> <MEMBER_ID> - -Delete image member. - - Positional arguments - - <IMAGE_ID> - - - Image from which to remove member. - - - - - <MEMBER_ID> - - - Tenant to remove as member. - - - - -
-
- glance member-list (v2) - usage: glance --os-image-api-version 2 member-list --image-id <IMAGE_ID> - -Describe sharing permissions by image. - - Optional arguments - - --image-id <IMAGE_ID> - - - Image to display members of. - - - - -
-
- glance member-update (v2) - usage: glance --os-image-api-version 2 member-update <IMAGE_ID> <MEMBER_ID> <MEMBER_STATUS> - -Update the status of a member for a given image. - - Positional arguments - - <IMAGE_ID> - - - Image from which to update member. - - - - - <MEMBER_ID> - - - Tenant to update. - - - - - <MEMBER_STATUS> - - - Updated status of member. Valid Values: accepted, rejected, - pending - - - - -
-
- glance task-create (v2) - usage: glance --os-image-api-version 2 task-create [--type <TYPE>] [--input <STRING>] - -Create a new task. - - Optional arguments - - --type <TYPE> - - - Type of Task. Please refer to Glance schema or - documentation to see which tasks are supported. - - - - - --input <STRING> - - - Parameters of the task to be launched - - - - -
-
- glance task-list (v2) - usage: glance --os-image-api-version 2 task-list [--sort-key {id,type,status}] [--sort-dir {asc,desc}] - [--page-size <SIZE>] [--type <TYPE>] - [--status <STATUS>] - -List tasks you can access. - - Optional arguments - - --sort-key {id,type,status} - - - Sort task list by specified field. - - - - - --sort-dir {asc,desc} - - - Sort task list in specified direction. - - - - - --page-size <SIZE> - - - Number of tasks to request in each paginated request. - - - - - --type <TYPE> - - - Filter tasks to those that have this type. - - - - - --status <STATUS> - - - Filter tasks to those that have this status. - - - - -
-
- glance task-show (v2) - usage: glance --os-image-api-version 2 task-show <TASK_ID> - -Describe a specific task. - - Positional arguments - - <TASK_ID> - - - ID of task to describe. - - - - -
-
- - diff --git a/doc/cli-reference/generated/ch_cli_gnocchi_commands.xml b/doc/cli-reference/generated/ch_cli_gnocchi_commands.xml deleted file mode 100644 index 76e478b806..0000000000 --- a/doc/cli-reference/generated/ch_cli_gnocchi_commands.xml +++ /dev/null @@ -1,1559 +0,0 @@ - - - - - - - - A time series storage and resources index service command-line client - - The gnocchi client is the command-line - interface (CLI) for the A time series storage and resources index service API and its extensions. - - This chapter documents gnocchi version - 2.1.0. - - - For help on a specific gnocchi - command, enter: - - $ gnocchi COMMAND - -
- gnocchi usage - usage: gnocchi [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] - [--os-region-name <auth-region-name>] - [--os-interface <interface>] - [--gnocchi-api-version GNOCCHI_API_VERSION] [--insecure] - [--os-cacert <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>] - [--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-default-domain-id OS_DEFAULT_DOMAIN_ID] - [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME] - [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] - [--os-user-domain-id OS_USER_DOMAIN_ID] - [--os-user-domain-name OS_USER_DOMAIN_NAME] - [--os-password OS_PASSWORD] [--gnocchi-endpoint <endpoint>] -
-
- gnocchi 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 help message and exit. - - - - - --debug - - - Show tracebacks on errors. - - - - - --os-region-name <auth-region-name> - - - Authentication region name (Env: OS_REGION_NAME) - - - - - --os-interface <interface> - - - Select an interface type. Valid interface types: - [admin, public, internal]. (Env: OS_INTERFACE) - - - - - --gnocchi-api-version GNOCCHI_API_VERSION - - - Defaults to env[GNOCCHI_API_VERSION] or 1. - - - - - --os-auth-type <name>, --os-auth-plugin <name> - - - Authentication type to use - - - - - --gnocchi-endpoint <endpoint> - - - Gnocchi endpoint (Env: GNOCCHI_ENDPOINT) - - - - -
-
- gnocchi archive-policy - Command "archive-policy" matches: - archive-policy create - archive-policy delete - archive-policy list - archive-policy show - archive-policy-rule create - archive-policy-rule delete - archive-policy-rule list - archive-policy-rule show - - -
-
- gnocchi archive-policy create - usage: gnocchi archive-policy create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [-b BACK_WINDOW] [-m AGGREGATION_METHODS] - -d <DEFINITION> - name - -Create an archive policy - - Positional arguments - - name - - - name of the archive policy - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -b BACK_WINDOW, --back-window BACK_WINDOW - - - back window of the archive policy - - - - - -m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS - - - aggregation method of the archive policy - - - - - -d <DEFINITION>, --definition <DEFINITION> - - - two attributes (separated by ',') of an archive policy - definition with its name and value separated with a - ':' - - - - -
-
- gnocchi archive-policy delete - usage: gnocchi archive-policy delete [-h] name - -Delete an archive policy - - Positional arguments - - name - - - Name of the archive policy - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi archive-policy list - usage: gnocchi archive-policy list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List archive policies - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi archive-policy show - usage: gnocchi archive-policy show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - name - -Show an archive policy - - Positional arguments - - name - - - Name of the archive policy - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi archive-policy-rule - Command "archive-policy-rule" matches: - archive-policy-rule create - archive-policy-rule delete - archive-policy-rule list - archive-policy-rule show - - -
-
- gnocchi archive-policy-rule create - usage: gnocchi archive-policy-rule create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] -a - ARCHIVE_POLICY_NAME -m - METRIC_PATTERN - name - -Create an archive policy rule - - Positional arguments - - name - - - Rule name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME - - - Archive policy name - - - - - -m METRIC_PATTERN, --metric-pattern METRIC_PATTERN - - - Wildcard of metric name to match - - - - -
-
- gnocchi archive-policy-rule delete - usage: gnocchi archive-policy-rule delete [-h] name - -Delete an archive policy rule - - Positional arguments - - name - - - Name of the archive policy rule - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi archive-policy-rule list - usage: gnocchi archive-policy-rule list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List archive policy rules - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi archive-policy-rule show - usage: gnocchi archive-policy-rule show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - name - -Show an archive policy rule - - Positional arguments - - name - - - Name of the archive policy rule - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi benchmark measures add - usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--workers WORKERS] --count COUNT - [--batch BATCH] - [--timestamp-start TIMESTAMP_START] - [--timestamp-end TIMESTAMP_END] - metric - -Do benchmark testing of adding measurements - - Positional arguments - - metric - - - ID or name of the metric - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - - --workers WORKERS, -w WORKERS - - - Number of workers to use - - - - - --count COUNT, -n COUNT - - - Number of total measures to send - - - - - --batch BATCH, -b BATCH - - - Number of measures to send in each batch - - - - - --timestamp-start TIMESTAMP_START, -s TIMESTAMP_START - - - First timestamp to use - - - - - --timestamp-end TIMESTAMP_END, -e TIMESTAMP_END - - - Last timestamp to use - - - - -
-
- gnocchi benchmark measures show - usage: gnocchi benchmark measures show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--resource-id RESOURCE_ID] - [--aggregation AGGREGATION] - [--start START] [--stop STOP] - [--workers WORKERS] --count COUNT - metric - -Do benchmark testing of measurements show - - Positional arguments - - metric - - - ID or name of the metric - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - - --aggregation AGGREGATION - - - aggregation to retrieve - - - - - --start START - - - beginning of the period - - - - - --stop STOP - - - end of the period - - - - - --workers WORKERS, -w WORKERS - - - Number of workers to use - - - - - --count COUNT, -n COUNT - - - Number of total measures to send - - - - -
-
- gnocchi benchmark metric create - usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--archive-policy-name ARCHIVE_POLICY_NAME] - [--workers WORKERS] --count COUNT - [--keep] - -Do benchmark testing of metric creation - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - - --archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME - - - name of the archive policy - - - - - --workers WORKERS, -w WORKERS - - - Number of workers to use - - - - - --count COUNT, -n COUNT - - - Number of metrics to create - - - - - --keep, -k - - - Keep created metrics - - - - -
-
- gnocchi benchmark metric show - usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--workers WORKERS] --count COUNT - metric [metric ...] - -Do benchmark testing of metric show - - Positional arguments - - metric - - - ID or name of the metrics - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - - --workers WORKERS, -w WORKERS - - - Number of workers to use - - - - - --count COUNT, -n COUNT - - - Number of metrics to get - - - - -
-
- gnocchi capabilities list - usage: gnocchi capabilities list [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -List capabilities - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi measures add - usage: gnocchi measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metric - -Add measurements to a metric - - Positional arguments - - metric - - - ID or name of the metric - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - - -m MEASURE, --measure MEASURE - - - timestamp and value of a measure separated with a '@' - - - - -
-
- gnocchi measures aggregation - usage: gnocchi measures aggregation [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] -m - METRIC [METRIC ...] - [--aggregation AGGREGATION] - [--start START] [--stop STOP] - [--needed-overlap NEEDED_OVERLAP] - [--query QUERY] - [--resource-type RESOURCE_TYPE] - -Get measurements of aggregated metrics - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -m METRIC [METRIC ...], --metric METRIC [METRIC ...] - - - metrics IDs or metric name - - - - - --aggregation AGGREGATION - - - aggregation to retrieve - - - - - --start START - - - beginning of the period - - - - - --stop STOP - - - end of the period - - - - - --needed-overlap NEEDED_OVERLAP - - - percent of datapoints in each metrics required - - - - - --query QUERY - - - Query - - - - - --resource-type RESOURCE_TYPE - - - Resource type to query - - - - -
-
- gnocchi measures show - usage: gnocchi measures show [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--resource-id RESOURCE_ID] - [--aggregation AGGREGATION] [--start START] - [--stop STOP] - metric - -Get measurements of a metric - - Positional arguments - - metric - - - ID or name of the metric - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - - --aggregation AGGREGATION - - - aggregation to retrieve - - - - - --start START - - - beginning of the period - - - - - --stop STOP - - - end of the period - - - - -
-
- gnocchi metric create - usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - [--archive-policy-name ARCHIVE_POLICY_NAME] - [METRIC_NAME] - -Create a metric - - Positional arguments - - METRIC_NAME - - - Name of the metric - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - - --archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME - - - name of the archive policy - - - - -
-
- gnocchi metric delete - usage: gnocchi metric delete [-h] [--resource-id RESOURCE_ID] - metric [metric ...] - -Delete a metric - - Positional arguments - - metric - - - IDs or names of the metric - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - -
-
- gnocchi metric list - usage: gnocchi metric list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List metrics - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi metric show - usage: gnocchi metric show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--resource-id RESOURCE_ID] - metric - -Show a metric - - Positional arguments - - metric - - - ID or name of the metric - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resource-id RESOURCE_ID, -r RESOURCE_ID - - - ID of the resource - - - - -
-
- gnocchi resource create - usage: gnocchi resource create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--type RESOURCE_TYPE] [-a ATTRIBUTE] - [-m ADD_METRIC] [-n CREATE_METRIC] - [-d DELETE_METRIC] - resource_id - -Create a resource - - Positional arguments - - resource_id - - - ID of the resource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type RESOURCE_TYPE, -t RESOURCE_TYPE - - - Type of resource - - - - - -a ATTRIBUTE, --attribute ATTRIBUTE - - - name and value of a attribute separated with a ':' - - - - - -m ADD_METRIC, --add-metric ADD_METRIC - - - name:id of a metric to add - - - - - -n CREATE_METRIC, --create-metric CREATE_METRIC - - - name:archive_policy_name of a metric to create - - - - - -d DELETE_METRIC, --delete-metric DELETE_METRIC - - - Name of a metric to delete - - - - -
-
- gnocchi resource delete - usage: gnocchi resource delete [-h] resource_id - -Delete a resource - - Positional arguments - - resource_id - - - ID of the resource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- gnocchi resource history - usage: gnocchi resource history [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--details] [--limit <LIMIT>] - [--marker <MARKER>] [--sort <SORT>] - [--type RESOURCE_TYPE] - resource_id - -Show the history of a resource - - Positional arguments - - resource_id - - - ID of a resource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --details - - - Show all attributes of generic resources - - - - - --limit <LIMIT> - - - Number of resources to return (Default is server - default) - - - - - --marker <MARKER> - - - Last item of the previous listing. Return the next - results after this value - - - - - --sort <SORT> - - - Sort of resource attribute (example: user_id:desc- - nullslast - - - - - --type RESOURCE_TYPE, -t RESOURCE_TYPE - - - Type of resource - - - - -
-
- gnocchi resource list - usage: gnocchi resource list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--details] [--history] [--limit <LIMIT>] - [--marker <MARKER>] [--sort <SORT>] - [--type RESOURCE_TYPE] - -List resources - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --details - - - Show all attributes of generic resources - - - - - --history - - - Show history of the resources - - - - - --limit <LIMIT> - - - Number of resources to return (Default is server - default) - - - - - --marker <MARKER> - - - Last item of the previous listing. Return the next - results after this value - - - - - --sort <SORT> - - - Sort of resource attribute (example: user_id:desc- - nullslast - - - - - --type RESOURCE_TYPE, -t RESOURCE_TYPE - - - Type of resource - - - - -
-
- gnocchi resource search - usage: gnocchi resource search [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--details] [--history] [--limit <LIMIT>] - [--marker <MARKER>] [--sort <SORT>] - [--type RESOURCE_TYPE] [--query QUERY] - -Search resources with specified query rules - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --details - - - Show all attributes of generic resources - - - - - --history - - - Show history of the resources - - - - - --limit <LIMIT> - - - Number of resources to return (Default is server - default) - - - - - --marker <MARKER> - - - Last item of the previous listing. Return the next - results after this value - - - - - --sort <SORT> - - - Sort of resource attribute (example: user_id:desc- - nullslast - - - - - --type RESOURCE_TYPE, -t RESOURCE_TYPE - - - Type of resource - - - - - --query QUERY - - - Query - - - - -
-
- gnocchi resource show - usage: gnocchi resource show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--type RESOURCE_TYPE] - resource_id - -Show a resource - - Positional arguments - - resource_id - - - ID of a resource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type RESOURCE_TYPE, -t RESOURCE_TYPE - - - Type of resource - - - - -
-
- gnocchi resource update - usage: gnocchi resource update [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--type RESOURCE_TYPE] [-a ATTRIBUTE] - [-m ADD_METRIC] [-n CREATE_METRIC] - [-d DELETE_METRIC] - resource_id - -Update a resource - - Positional arguments - - resource_id - - - ID of the resource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type RESOURCE_TYPE, -t RESOURCE_TYPE - - - Type of resource - - - - - -a ATTRIBUTE, --attribute ATTRIBUTE - - - name and value of a attribute separated with a ':' - - - - - -m ADD_METRIC, --add-metric ADD_METRIC - - - name:id of a metric to add - - - - - -n CREATE_METRIC, --create-metric CREATE_METRIC - - - name:archive_policy_name of a metric to create - - - - - -d DELETE_METRIC, --delete-metric DELETE_METRIC - - - Name of a metric to delete - - - - -
-
- gnocchi status - usage: gnocchi status [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - -Show the status of measurements processing - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_heat_commands.xml b/doc/cli-reference/generated/ch_cli_heat_commands.xml deleted file mode 100644 index 07bd90faf0..0000000000 --- a/doc/cli-reference/generated/ch_cli_heat_commands.xml +++ /dev/null @@ -1,2449 +0,0 @@ - - - - - - - - Orchestration command-line client - - The heat client is the command-line - interface (CLI) for the Orchestration API and its extensions. - - This chapter documents heat version - 0.8.0. - - - For help on a specific heat - command, enter: - - $ heat COMMAND - -
- heat usage - usage: heat [--version] [-d] [-v] [--api-timeout API_TIMEOUT] - [--os-no-client-auth] [--heat-url HEAT_URL] - [--heat-api-version HEAT_API_VERSION] [--include-password] [-k] - [--os-cert OS_CERT] [--cert-file OS_CERT] [--os-key OS_KEY] - [--key-file OS_KEY] [--os-cacert <ca-certificate-file>] - [--ca-file OS_CACERT] [--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-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-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] - [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] - [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] - [--os-service-type OS_SERVICE_TYPE] - [--os-endpoint-type OS_ENDPOINT_TYPE] - <subcommand> ... - - Subcommands - - action-check - - - Check that stack resources are in expected states. - - - - - action-resume - - - Resume the stack. - - - - - action-suspend - - - Suspend the stack. - - - - - build-info - - - Retrieve build information. - - - - - config-create - - - Create a software configuration. - - - - - config-delete - - - Delete a software configuration. - - - - - config-show - - - View details of a software configuration. - - - - - deployment-create - - - Create a software deployment. - - - - - deployment-delete - - - Delete a software deployment. - - - - - deployment-list - - - List software deployments. - - - - - deployment-metadata-show - - - Get deployment configuration metadata for the - specified server. - - - - - deployment-output-show - - - Show a specific deployment output. - - - - - deployment-show - - - Show the details of a software deployment. - - - - - event - - - DEPRECATED! Use event-show instead. - - - - - event-list - - - List events for a stack. - - - - - event-show - - - Describe the event. - - - - - hook-clear - - - Clear hooks on a given stack. - - - - - hook-poll - - - List resources with pending hook for a stack. - - - - - output-list - - - Show available outputs. - - - - - output-show - - - Show a specific stack output. - - - - - resource-list - - - Show list of resources belonging to a stack. - - - - - resource-metadata - - - List resource metadata. - - - - - resource-show - - - Describe the resource. - - - - - resource-signal - - - Send a signal to a resource. - - - - - resource-template - - - DEPRECATED! Use resource-type-template instead. - - - - - resource-type-list - - - List the available resource types. - - - - - resource-type-show - - - Show the resource type. - - - - - resource-type-template - - - Generate a template based on a resource type. - - - - - service-list - - - List the Heat engines. - - - - - snapshot-delete - - - Delete a snapshot of a stack. - - - - - snapshot-list - - - List the snapshots of a stack. - - - - - snapshot-show - - - Show a snapshot of a stack. - - - - - stack-abandon - - - Abandon the stack. - - - - - stack-adopt - - - Adopt a stack. - - - - - stack-cancel-update - - - Cancel currently running update of the stack. - - - - - stack-create - - - Create the stack. - - - - - stack-delete - - - Delete the stack(s). - - - - - stack-list - - - List the user's stacks. - - - - - stack-preview - - - Preview the stack. - - - - - stack-restore - - - Restore a snapshot of a stack. - - - - - stack-show - - - Describe the stack. - - - - - stack-snapshot - - - Make a snapshot of a stack. - - - - - stack-update - - - Update the stack. - - - - - template-function-list - - - List the available functions. - - - - - template-show - - - Get the template for the specified stack. - - - - - template-validate - - - Validate a template with parameters. - - - - - template-version-list - - - List the available template versions. - - - - - bash-completion - - - Prints all of the commands and options to stdout. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - -
-
- heat optional arguments - - - --version - - - Shows the client version and exits. - - - - - -d, --debug - - - Defaults to env[HEATCLIENT_DEBUG]. - - - - - -v, --verbose - - - Print more verbose output. - - - - - --api-timeout API_TIMEOUT - - - Number of seconds to wait for an API response, - defaults to system socket timeout - - - - - --os-no-client-auth - - - Do not contact keystone for a token. Defaults to - env[OS_NO_CLIENT_AUTH]. - - - - - --heat-url HEAT_URL - - - Defaults to env[HEAT_URL]. - - - - - --heat-api-version HEAT_API_VERSION - - - Defaults to env[HEAT_API_VERSION] or 1. - - - - - --include-password - - - Send os-username and os-password to heat. - - - - - -k, --insecure - - - Explicitly allow heatclient 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. - - - - - --os-cert OS_CERT - - - Path of certificate file to use in SSL connection. - This file can optionally be prepended with the private - key. - - - - - --cert-file OS_CERT - - - DEPRECATED! Use --os-cert. - - - - - --os-key OS_KEY - - - Path of client key to use in SSL connection. This - option is not necessary if your key is prepended to - your cert file. - - - - - --key-file OS_KEY - - - DEPRECATED! Use --os-key. - - - - - --os-cacert <ca-certificate-file> - - - Path of CA TLS certificate(s) used to verify the - remote server's certificate. Without this option - glance looks for the default system CA certificates. - - - - - --ca-file OS_CACERT - - - DEPRECATED! Use --os-cacert. - - - - - --os-username OS_USERNAME - - - Defaults to env[OS_USERNAME]. - - - - - --os-user-id OS_USER_ID - - - 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-project-id OS_PROJECT_ID - - - Another way to specify tenant ID. This option is - mutually exclusive with --os-tenant-id. Defaults to - env[OS_PROJECT_ID]. - - - - - --os-project-name OS_PROJECT_NAME - - - Another way to specify tenant name. This option is - mutually exclusive with --os-tenant-name. Defaults to - env[OS_PROJECT_NAME]. - - - - - --os-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-password OS_PASSWORD - - - Defaults to env[OS_PASSWORD]. - - - - - --os-tenant-id OS_TENANT_ID - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-tenant-name OS_TENANT_NAME - - - Defaults to env[OS_TENANT_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-service-type OS_SERVICE_TYPE - - - Defaults to env[OS_SERVICE_TYPE]. - - - - - --os-endpoint-type OS_ENDPOINT_TYPE - - - Defaults to env[OS_ENDPOINT_TYPE]. - - - - -
-
- heat action-check - usage: heat action-check <NAME or ID> - -Check that stack resources are in expected states. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to check. - - - - -
-
- heat action-resume - usage: heat action-resume <NAME or ID> - -Resume the stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to resume. - - - - -
-
- heat action-suspend - usage: heat action-suspend <NAME or ID> - -Suspend the stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to suspend. - - - - -
-
- heat build-info - usage: heat build-info - -Retrieve build information. - -
-
- heat config-create - usage: heat config-create [-f <FILE or URL>] [-c <FILE or URL>] - [-g <GROUP_NAME>] - <CONFIG_NAME> - -Create a software configuration. - - Positional arguments - - <CONFIG_NAME> - - - Name of the configuration to create. - - - - - - Optional arguments - - -f <FILE or URL>, --definition-file <FILE or URL> - - - Path to JSON/YAML containing map defining <inputs>, - <outputs>, and <options>. - - - - - -c <FILE or URL>, --config-file <FILE or URL> - - - Path to configuration script/data. - - - - - -g <GROUP_NAME>, --group <GROUP_NAME> - - - Group name of configuration tool expected by the - config. - - - - -
-
- heat config-delete - usage: heat config-delete <ID> [<ID> ...] - -Delete a software configuration. - - Positional arguments - - <ID> - - - IDs of the configurations to delete. - - - - -
-
- heat config-show - usage: heat config-show [-c] <ID> - -View details of a software configuration. - - Positional arguments - - <ID> - - - ID of the config. - - - - - - Optional arguments - - -c, --config-only - - - Only display the value of the <config> property. - - - - -
-
- heat deployment-create - usage: heat deployment-create [-i <KEY=VALUE>] [-a <ACTION>] [-c <CONFIG>] -s - <SERVER> [-t <TRANSPORT>] - [--container <CONTAINER_NAME>] - [--timeout <TIMEOUT>] - <DEPLOY_NAME> - -Create a software deployment. - - Positional arguments - - <DEPLOY_NAME> - - - Name of the derived config associated with this - deployment. This is used to apply a sort order to the - list of configurations currently deployed to the - server. - - - - - - Optional arguments - - -i <KEY=VALUE>, --input-value <KEY=VALUE> - - - Input value to set on the deployment. This can be - specified multiple times. - - - - - -a <ACTION>, --action <ACTION> - - - Name of action for this deployment. Can be a custom - action, or one of: CREATE, UPDATE, DELETE, SUSPEND, - RESUME - - - - - -c <CONFIG>, --config <CONFIG> - - - ID of the configuration to deploy. - - - - - -s <SERVER>, --server <SERVER> - - - ID of the server being deployed to. - - - - - -t <TRANSPORT>, --signal-transport <TRANSPORT> - - - How the server should signal to heat with the - deployment output values. TEMP_URL_SIGNAL will create - a Swift TempURL to be signaled via HTTP PUT. NO_SIGNAL - will result in the resource going to the COMPLETE - state without waiting for any signal. - - - - - --container <CONTAINER_NAME> - - - Optional name of container to store TEMP_URL_SIGNAL - objects in. If not specified a container will be - created with a name derived from the DEPLOY_NAME - - - - - --timeout <TIMEOUT> - - - Deployment timeout in minutes. - - - - -
-
- heat deployment-delete - usage: heat deployment-delete <ID> [<ID> ...] - -Delete a software deployment. - - Positional arguments - - <ID> - - - IDs of the deployments to delete. - - - - -
-
- heat deployment-list - usage: heat deployment-list [-s <SERVER>] - -List software deployments. - - Optional arguments - - -s <SERVER>, --server <SERVER> - - - ID of the server to fetch deployments for. - - - - -
-
- heat deployment-metadata-show - usage: heat deployment-metadata-show <ID> - -Get deployment configuration metadata for the specified server. - - Positional arguments - - <ID> - - - ID of the server to fetch deployments for. - - - - -
-
- heat deployment-output-show - usage: heat deployment-output-show [-a] [-F <FORMAT>] <ID> [<OUTPUT NAME>] - -Show a specific deployment output. - - Positional arguments - - <ID> - - - ID deployment to show the output for. - - - - - <OUTPUT NAME> - - - Name of an output to display. - - - - - - Optional arguments - - -a, --all - - - Display all deployment outputs. - - - - - -F <FORMAT>, --format <FORMAT> - - - The output value format, one of: raw, json - - - - -
-
- heat deployment-show - usage: heat deployment-show <ID> - -Show the details of a software deployment. - - Positional arguments - - <ID> - - - ID of the deployment. - - - - -
-
- heat event-list - usage: heat event-list [-r <RESOURCE>] [-f <KEY1=VALUE1;KEY2=VALUE2...>] - [-l <LIMIT>] [-m <ID>] [-n <DEPTH>] [-F <FORMAT>] - <NAME or ID> - -List events for a stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to show the events for. - - - - - - Optional arguments - - -r <RESOURCE>, --resource <RESOURCE> - - - Name of the resource to filter events by. - - - - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned events. This - can be specified multiple times, or once with - parameters separated by a semicolon. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of events returned. - - - - - -m <ID>, --marker <ID> - - - Only return events that appear after the given event - ID. - - - - - -n <DEPTH>, --nested-depth <DEPTH> - - - Depth of nested stacks from which to display events. - Note this cannot be specified with --resource. - - - - - -F <FORMAT>, --format <FORMAT> - - - The output value format, one of: log, table - - - - -
-
- heat event-show - usage: heat event-show <NAME or ID> <RESOURCE> <EVENT> - -Describe the event. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to show the events for. - - - - - <RESOURCE> - - - Name of the resource the event belongs to. - - - - - <EVENT> - - - ID of event to display details for. - - - - -
-
- heat hook-clear - usage: heat hook-clear [--pre-create] [--pre-update] - <NAME or ID> <RESOURCE> [<RESOURCE> ...] - -Clear hooks on a given stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of the stack these resources belong to. - - - - - <RESOURCE> - - - Resource names with hooks to clear. Resources in nested stacks - can be set using slash as a separator: - nested_stack/another/my_resource. You can use wildcards to - match multiple stacks or resources: - nested_stack/an*/*_resource - - - - - - Optional arguments - - --pre-create - - - Clear the pre-create hooks (optional) - - - - - --pre-update - - - Clear the pre-update hooks (optional) - - - - -
-
- heat hook-poll - usage: heat hook-poll [-n <DEPTH>] <NAME or ID> - -List resources with pending hook for a stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to show the pending hooks for. - - - - - - Optional arguments - - -n <DEPTH>, --nested-depth <DEPTH> - - - Depth of nested stacks from which to display hooks. - - - - -
-
- heat output-list - usage: heat output-list <NAME or ID> - -Show available outputs. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to query. - - - - -
-
- heat output-show - usage: heat output-show [-a] [-F <FORMAT>] <NAME or ID> [<OUTPUT NAME>] - -Show a specific stack output. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to query. - - - - - <OUTPUT NAME> - - - Name of an output to display. - - - - - - Optional arguments - - -a, --all - - - Display all stack outputs. - - - - - -F <FORMAT>, --format <FORMAT> - - - The output value format, one of: json, raw - - - - -
-
- heat resource-list - usage: heat resource-list [-n <DEPTH>] [--with-detail] <NAME or ID> - -Show list of resources belonging to a stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to show the resources for. - - - - - - Optional arguments - - -n <DEPTH>, --nested-depth <DEPTH> - - - Depth of nested stacks from which to display - resources. - - - - - --with-detail - - - Enable detail information presented for each resource - in resources list. - - - - -
-
- heat resource-metadata - usage: heat resource-metadata <NAME or ID> <RESOURCE> - -List resource metadata. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to show the resource metadata for. - - - - - <RESOURCE> - - - Name of the resource to show the metadata for. - - - - -
-
- heat resource-show - usage: heat resource-show [-a <ATTRIBUTE>] <NAME or ID> <RESOURCE> - -Describe the resource. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to show the resource for. - - - - - <RESOURCE> - - - Name of the resource to show the details for. - - - - - - Optional arguments - - -a <ATTRIBUTE>, --with-attr <ATTRIBUTE> - - - Attribute to show, it can be specified multiple times. - - - - -
-
- heat resource-signal - usage: heat resource-signal [-D <DATA>] [-f <FILE>] <NAME or ID> <RESOURCE> - -Send a signal to a resource. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack the resource belongs to. - - - - - <RESOURCE> - - - Name of the resource to signal. - - - - - - Optional arguments - - -D <DATA>, --data <DATA> - - - JSON Data to send to the signal handler. - - - - - -f <FILE>, --data-file <FILE> - - - File containing JSON data to send to the signal - handler. - - - - -
-
- heat resource-type-list - usage: heat resource-type-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] - -List the available resource types. - - Optional arguments - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned resource types. - This can be specified multiple times, or once with - parameters separated by a semicolon. It can be any of - name, version and support_status - - - - -
-
- heat resource-type-show - usage: heat resource-type-show <RESOURCE_TYPE> - -Show the resource type. - - Positional arguments - - <RESOURCE_TYPE> - - - Resource type to get the details for. - - - - -
-
- heat resource-type-template - usage: heat resource-type-template [-t <TEMPLATE_TYPE>] [-F <FORMAT>] - <RESOURCE_TYPE> - -Generate a template based on a resource type. - - Positional arguments - - <RESOURCE_TYPE> - - - Resource type to generate a template for. - - - - - - Optional arguments - - -t <TEMPLATE_TYPE>, --template-type <TEMPLATE_TYPE> - - - Template type to generate, hot or cfn. - - - - - -F <FORMAT>, --format <FORMAT> - - - The template output format, one of: yaml, json. - - - - -
-
- heat service-list - usage: heat service-list - -List the Heat engines. - -
-
- heat snapshot-delete - usage: heat snapshot-delete <NAME or ID> <SNAPSHOT> - -Delete a snapshot of a stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of the stack containing the snapshot. - - - - - <SNAPSHOT> - - - The ID of the snapshot to delete. - - - - -
-
- heat snapshot-list - usage: heat snapshot-list <NAME or ID> - -List the snapshots of a stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of the stack containing the snapshots. - - - - -
-
- heat snapshot-show - usage: heat snapshot-show <NAME or ID> <SNAPSHOT> - -Show a snapshot of a stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of the stack containing the snapshot. - - - - - <SNAPSHOT> - - - The ID of the snapshot to show. - - - - -
-
- heat stack-abandon - usage: heat stack-abandon [-O <FILE>] <NAME or ID> - -Abandon the stack. This will delete the record of the stack from Heat, but -will not delete any of the underlying resources. Prints an adoptable JSON -representation of the stack to stdout or a file on success. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to abandon. - - - - - - Optional arguments - - -O <FILE>, --output-file <FILE> - - - file to output abandon result. If the option is - specified, the result will be output into <FILE>. - - - - -
-
- heat stack-adopt - usage: heat stack-adopt [-e <FILE or URL>] [-c <TIMEOUT>] [-t <TIMEOUT>] - [-a <FILE or URL>] [-r] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] - <STACK_NAME> - -Adopt a stack. - - Positional arguments - - <STACK_NAME> - - - Name of the stack to adopt. - - - - - - Optional arguments - - -e <FILE or URL>, --environment-file <FILE or URL> - - - Path to the environment, it can be specified multiple - times. - - - - - -c <TIMEOUT>, --create-timeout <TIMEOUT> - - - Stack creation timeout in minutes. DEPRECATED use - --timeout instead. - - - - - -t <TIMEOUT>, --timeout <TIMEOUT> - - - Stack creation timeout in minutes. - - - - - -a <FILE or URL>, --adopt-file <FILE or URL> - - - Path to adopt stack data file. - - - - - -r, --enable-rollback - - - Enable rollback on create/update failure. - - - - - -P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...> - - - Parameter values used to create the stack. This can be - specified multiple times, or once with parameters - separated by a semicolon. - - - - -
-
- heat stack-cancel-update - usage: heat stack-cancel-update <NAME or ID> - -Cancel currently running update of the stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to cancel update for. - - - - -
-
- heat stack-create - usage: heat stack-create [-f <FILE>] [-e <FILE or URL>] - [--pre-create <RESOURCE>] [-u <URL>] [-o <URL>] - [-c <TIMEOUT>] [-t <TIMEOUT>] [-r] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] - [--poll [SECONDS]] [--tags <TAG1,TAG2>] - <STACK_NAME> - -Create the stack. - - Positional arguments - - <STACK_NAME> - - - Name of the stack to create. - - - - - - Optional arguments - - -f <FILE>, --template-file <FILE> - - - Path to the template. - - - - - -e <FILE or URL>, --environment-file <FILE or URL> - - - Path to the environment, it can be specified multiple - times. - - - - - --pre-create <RESOURCE> - - - Name of a resource to set a pre-create hook to. - Resources in nested stacks can be set using slash as a - separator: nested_stack/another/my_resource. You can - use wildcards to match multiple stacks or resources: - nested_stack/an*/*_resource. This can be specified - multiple times - - - - - -u <URL>, --template-url <URL> - - - URL of template. - - - - - -o <URL>, --template-object <URL> - - - URL to retrieve template object (e.g. from swift). - - - - - -c <TIMEOUT>, --create-timeout <TIMEOUT> - - - Stack creation timeout in minutes. DEPRECATED use - --timeout instead. - - - - - -t <TIMEOUT>, --timeout <TIMEOUT> - - - Stack creation timeout in minutes. - - - - - -r, --enable-rollback - - - Enable rollback on create/update failure. - - - - - -P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...> - - - Parameter values used to create the stack. This can be - specified multiple times, or once with parameters - separated by a semicolon. - - - - - -Pf <KEY=FILE>, --parameter-file <KEY=FILE> - - - Parameter values from file used to create the stack. - This can be specified multiple times. Parameter value - would be the content of the file - - - - - --poll [SECONDS] - - - Poll and report events until stack completes. Optional - poll interval in seconds can be provided as argument, - default 5. - - - - - --tags <TAG1,TAG2> - - - A list of tags to associate with the stack. - - - - -
-
- heat stack-delete - usage: heat stack-delete <NAME or ID> [<NAME or ID> ...] - -Delete the stack(s). - - Positional arguments - - <NAME or ID> - - - Name or ID of stack(s) to delete. - - - - -
-
- heat stack-list - usage: heat stack-list [-s] [-n] [-a] [-f <KEY1=VALUE1;KEY2=VALUE2...>] - [-t <TAG1,TAG2...>] [--tags-any <TAG1,TAG2...>] - [--not-tags <TAG1,TAG2...>] - [--not-tags-any <TAG1,TAG2...>] [-l <LIMIT>] [-m <ID>] - [-k <KEY1,KEY2...>] [-d [asc|desc]] [-g] [-o] - -List the user's stacks. - - Optional arguments - - -s, --show-deleted - - - Include soft-deleted stacks in the stack listing. - - - - - -n, --show-nested - - - Include nested stacks in the stack listing. - - - - - -a, --show-hidden - - - Include hidden stacks in the stack listing. - - - - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned stacks. This - can be specified multiple times, or once with - parameters separated by a semicolon. - - - - - -t <TAG1,TAG2...>, --tags <TAG1,TAG2...> - - - Show stacks containing these tags, combine multiple - tags using the boolean AND expression - - - - - --tags-any <TAG1,TAG2...> - - - Show stacks containing these tags, combine multiple - tags using the boolean OR expression - - - - - --not-tags <TAG1,TAG2...> - - - Show stacks not containing these tags, combine - multiple tags using the boolean AND expression - - - - - --not-tags-any <TAG1,TAG2...> - - - Show stacks not containing these tags, combine - multiple tags using the boolean OR expression - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of stacks returned. - - - - - -m <ID>, --marker <ID> - - - Only return stacks that appear after the given stack - ID. - - - - - -k <KEY1,KEY2...>, --sort-keys <KEY1,KEY2...> - - - List of keys for sorting the returned stacks. This can - be specified multiple times or once with keys - separated by semicolons. Valid sorting keys include - "stack_name", "stack_status", "creation_time" and - "updated_time". - - - - - -d [asc|desc], --sort-dir [asc|desc] - - - Sorting direction (either "asc" or "desc") for the - sorting keys. - - - - - -g, --global-tenant - - - Display stacks from all tenants. Operation only - authorized for users who match the policy in heat's - policy.json. - - - - - -o, --show-owner - - - Display stack owner information. This is automatically - enabled when using --global-tenant. - - - - -
-
- heat stack-preview - usage: heat stack-preview [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] - [-t <TIMEOUT>] [-r] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] - [--tags <TAG1,TAG2>] - <STACK_NAME> - -Preview the stack. - - Positional arguments - - <STACK_NAME> - - - Name of the stack to preview. - - - - - - Optional arguments - - -f <FILE>, --template-file <FILE> - - - Path to the template. - - - - - -e <FILE or URL>, --environment-file <FILE or URL> - - - Path to the environment, it can be specified multiple - times. - - - - - -u <URL>, --template-url <URL> - - - URL of template. - - - - - -o <URL>, --template-object <URL> - - - URL to retrieve template object (e.g. from swift) - - - - - -t <TIMEOUT>, --timeout <TIMEOUT> - - - Stack creation timeout in minutes. This is only used - duringvalidation in preview. - - - - - -r, --enable-rollback - - - Enable rollback on failure. This option is not used - duringpreview and exists only for symmetry with stack- - create. - - - - - -P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...> - - - Parameter values used to preview the stack. This can - be specified multiple times, or once with parameters - separated by semicolon. - - - - - -Pf <KEY=FILE>, --parameter-file <KEY=FILE> - - - Parameter values from file used to create the stack. - This can be specified multiple times. Parameter value - would be the content of the file - - - - - --tags <TAG1,TAG2> - - - A list of tags to associate with the stack. - - - - -
-
- heat stack-restore - usage: heat stack-restore <NAME or ID> <SNAPSHOT> - -Restore a snapshot of a stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of the stack containing the snapshot. - - - - - <SNAPSHOT> - - - The ID of the snapshot to restore. - - - - -
-
- heat stack-show - usage: heat stack-show <NAME or ID> - -Describe the stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to describe. - - - - -
-
- heat stack-snapshot - usage: heat stack-snapshot [-n <NAME>] <NAME or ID> - -Make a snapshot of a stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to snapshot. - - - - - - Optional arguments - - -n <NAME>, --name <NAME> - - - If specified, the name given to the snapshot. - - - - -
-
- heat stack-update - usage: heat stack-update [-f <FILE>] [-e <FILE or URL>] - [--pre-update <RESOURCE>] [-u <URL>] [-o <URL>] - [-t <TIMEOUT>] [-r] [--rollback <VALUE>] [-y] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>] - [-x] [-c <PARAMETER>] [--tags <TAG1,TAG2>] - <NAME or ID> - -Update the stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to update. - - - - - - Optional arguments - - -f <FILE>, --template-file <FILE> - - - Path to the template. - - - - - -e <FILE or URL>, --environment-file <FILE or URL> - - - Path to the environment, it can be specified multiple - times. - - - - - --pre-update <RESOURCE> - - - Name of a resource to set a pre-update hook to. - Resources in nested stacks can be set using slash as a - separator: nested_stack/another/my_resource. You can - use wildcards to match multiple stacks or resources: - nested_stack/an*/*_resource. This can be specified - multiple times - - - - - -u <URL>, --template-url <URL> - - - URL of template. - - - - - -o <URL>, --template-object <URL> - - - URL to retrieve template object (e.g. from swift). - - - - - -t <TIMEOUT>, --timeout <TIMEOUT> - - - Stack update timeout in minutes. - - - - - -r, --enable-rollback - - - DEPRECATED! Use --rollback argument instead. Enable - rollback on stack update failure. NOTE: default - behavior is now to use the rollback value of existing - stack. - - - - - --rollback <VALUE> - - - Set rollback on update failure. Values ('1', 't', - 'true', 'on', 'y', 'yes') set rollback to enabled. - Values ('0', 'f', 'false', 'off', 'n', 'no') set - rollback to disabled. Default is to use the value of - existing stack to be updated. - - - - - -y, --dry-run - - - Do not actually perform the stack update, but show - what would be changed - - - - - -P <KEY1=VALUE1;KEY2=VALUE2...>, --parameters <KEY1=VALUE1;KEY2=VALUE2...> - - - Parameter values used to create the stack. This can be - specified multiple times, or once with parameters - separated by a semicolon. - - - - - -Pf <KEY=FILE>, --parameter-file <KEY=FILE> - - - Parameter values from file used to create the stack. - This can be specified multiple times. Parameter value - would be the content of the file - - - - - -x, --existing - - - Re-use the template, parameters and environment of the - current stack. If the template argument is omitted - then the existing template is used. If no - --environment-file is specified then the existing - environment is used. Parameters specified in - --parameters will patch over the existing values in - the current stack. Parameters omitted will keep the - existing values. - - - - - -c <PARAMETER>, --clear-parameter <PARAMETER> - - - Remove the parameters from the set of parameters of - current stack for the stack-update. The default value - in the template will be used. This can be specified - multiple times. - - - - - --tags <TAG1,TAG2> - - - An updated list of tags to associate with the stack. - - - - -
-
- heat template-function-list - usage: heat template-function-list <TEMPLATE_VERSION> - -List the available functions. - - Positional arguments - - <TEMPLATE_VERSION> - - - Template version to get the functions for. - - - - -
-
- heat template-show - usage: heat template-show <NAME or ID> - -Get the template for the specified stack. - - Positional arguments - - <NAME or ID> - - - Name or ID of stack to get the template for. - - - - -
-
- heat template-validate - usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>] - [-o <URL>] [-n] - -Validate a template with parameters. - - Optional arguments - - -u <URL>, --template-url <URL> - - - URL of template. - - - - - -f <FILE>, --template-file <FILE> - - - Path to the template. - - - - - -e <FILE or URL>, --environment-file <FILE or URL> - - - Path to the environment, it can be specified multiple - times. - - - - - -o <URL>, --template-object <URL> - - - URL to retrieve template object (e.g. from swift). - - - - - -n, --show-nested - - - Resolve parameters from nested templates as well. - - - - -
-
- heat template-version-list - usage: heat template-version-list - -List the available template versions. - -
- diff --git a/doc/cli-reference/generated/ch_cli_ironic_commands.xml b/doc/cli-reference/generated/ch_cli_ironic_commands.xml deleted file mode 100644 index cf965fd891..0000000000 --- a/doc/cli-reference/generated/ch_cli_ironic_commands.xml +++ /dev/null @@ -1,1840 +0,0 @@ - - - - - - - - Bare Metal service command-line client - - The ironic client is the command-line - interface (CLI) for the Bare Metal service API and its extensions. - - This chapter documents ironic version - 1.0.0. - - - For help on a specific ironic - command, enter: - - $ ironic COMMAND - -
- ironic usage - usage: ironic [--insecure] [--os-cacert <ca-certificate>] - [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] - [--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-project-domain-id OS_PROJECT_DOMAIN_ID] - [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--version] - [--debug] [-v] [--cert-file OS_CERT] [--key-file OS_KEY] - [--ca-file OS_CACERT] [--os-username OS_USERNAME] - [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] - [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] - [--os-region-name OS_REGION_NAME] - [--os-auth-token OS_AUTH_TOKEN] [--ironic-url IRONIC_URL] - [--ironic-api-version IRONIC_API_VERSION] - [--os-service-type OS_SERVICE_TYPE] [--os-endpoint OS_ENDPOINT] - [--os-endpoint-type OS_ENDPOINT_TYPE] - [--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL] - <subcommand> ... - - Subcommands - - chassis-create - - - Create a new chassis. - - - - - chassis-delete - - - Delete a chassis. - - - - - chassis-list - - - List the chassis. - - - - - chassis-node-list - - - List the nodes contained in a chassis. - - - - - chassis-show - - - Show detailed information about a chassis. - - - - - chassis-update - - - Update information about a chassis. - - - - - node-create - - - Register a new node with the Ironic service. - - - - - node-delete - - - Unregister a node from the Ironic service. - - - - - node-get-boot-device - - - Get the current boot device for a node. - - - - - node-get-console - - - Get the connection information for a node's console, - if enabled. - - - - - node-get-supported-boot-devices - - - Get the supported boot devices for a node. - - - - - node-get-vendor-passthru-methods - - - Get the vendor passthru methods for a node. - - - - - node-list - - - List the nodes which are registered with the Ironic - service. - - - - - node-port-list - - - List the ports associated with a node. - - - - - node-set-boot-device - - - Set the boot device for a node. - - - - - node-set-console-mode - - - Enable or disable serial console access for a node. - - - - - node-set-maintenance - - - Enable or disable maintenance mode for a node. - - - - - node-set-power-state - - - Power a node on or off or reboot. - - - - - node-set-provision-state - - - Initiate a provisioning state change for a node. - - - - - node-show - - - Show detailed information about a node. - - - - - node-show-states - - - Show information about the node's states. - - - - - node-update - - - Update information about a registered node. - - - - - node-validate - - - Validate a node's driver interfaces. - - - - - node-vendor-passthru - - - Call a vendor-passthru extension for a node. - - - - - port-create - - - Create a new port. - - - - - port-delete - - - Delete a port. - - - - - port-list - - - List the ports. - - - - - port-show - - - Show detailed information about a port. - - - - - port-update - - - Update information about a port. - - - - - driver-get-vendor-passthru-methods - - - Get the vendor passthru methods for a driver. - - - - - driver-list - - - List the enabled drivers. - - - - - driver-properties - - - Get properties of a driver. - - - - - driver-show - - - Show information about a driver. - - - - - driver-vendor-passthru - - - Call a vendor-passthru extension for a driver. - - - - - bash-completion - - - Prints all of the commands and options for bash- - completion. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - -
-
- ironic optional arguments - - - --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 <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - Set request timeout (in seconds). - - - - - --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 - - - Another way to specify tenant ID. This option is - mutually exclusive with --os-tenant-id. Defaults to - env[OS_PROJECT_ID]. - - - - - --os-project-name OS_PROJECT_NAME - - - Another way to specify tenant name. This option is - mutually exclusive with --os-tenant-name. Defaults to - env[OS_PROJECT_NAME]. - - - - - --os-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]. - - - - - --version - - - show program's version number and exit - - - - - --debug - - - Defaults to env[IRONICCLIENT_DEBUG] - - - - - -v, --verbose - - - Print more verbose output - - - - - --cert-file OS_CERT - - - DEPRECATED! Use --os-cert. - - - - - --key-file OS_KEY - - - DEPRECATED! Use --os-key. - - - - - --ca-file OS_CACERT - - - DEPRECATED! Use --os-cacert. - - - - - --os-username OS_USERNAME - - - Defaults to env[OS_USERNAME] - - - - - --os-password OS_PASSWORD - - - Defaults to env[OS_PASSWORD] - - - - - --os-tenant-id OS_TENANT_ID - - - Defaults to env[OS_TENANT_ID] - - - - - --os-tenant-name OS_TENANT_NAME - - - Defaults to env[OS_TENANT_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] - - - - - --ironic-url IRONIC_URL - - - Defaults to env[IRONIC_URL] - - - - - --ironic-api-version IRONIC_API_VERSION - - - Accepts 1.x (where "x" is microversion) or "latest", - Defaults to env[IRONIC_API_VERSION] or 1 - - - - - --os-service-type OS_SERVICE_TYPE - - - Defaults to env[OS_SERVICE_TYPE] or "baremetal" - - - - - --os-endpoint OS_ENDPOINT - - - Specify an endpoint to use instead of retrieving one - from the service catalog (via authentication). - Defaults to env[OS_SERVICE_ENDPOINT]. - - - - - --os-endpoint-type OS_ENDPOINT_TYPE - - - Defaults to env[OS_ENDPOINT_TYPE] or "publicURL" - - - - - --max-retries MAX_RETRIES - - - Maximum number of retries in case of conflict error - (HTTP 409). Defaults to env[IRONIC_MAX_RETRIES] or 5. - Use 0 to disable retrying. - - - - - --retry-interval RETRY_INTERVAL - - - Amount of time (in seconds) between retries in case of - conflict error (HTTP 409). Defaults to - env[IRONIC_RETRY_INTERVAL] or 2. - - - - -
-
- ironic chassis-create - usage: ironic chassis-create [-d <description>] [-e <key=value>] - -Create a new chassis. - - Optional arguments - - -d <description>, --description <description> - - - Description of the chassis. - - - - - -e <key=value>, --extra <key=value> - - - Record arbitrary key/value metadata. Can be specified - multiple times. - - - - -
-
- ironic chassis-delete - usage: ironic chassis-delete <chassis> [<chassis> ...] - -Delete a chassis. - - Positional arguments - - <chassis> - - - UUID of the chassis. - - - - -
-
- ironic chassis-list - usage: ironic chassis-list [--detail] [--limit <limit>] [--marker <chassis>] - [--sort-key <field>] [--sort-dir <direction>] - [--fields <field> [<field> ...]] - -List the chassis. - - Optional arguments - - --detail - - - Show detailed information about the chassis. - - - - - --limit <limit> - - - Maximum number of chassis to return per request, 0 for - no limit. Default is the maximum number used by the - Ironic API Service. - - - - - --marker <chassis> - - - Chassis UUID (for example, of the last chassis in the - list from a previous request). Returns the list of - chassis after this UUID. - - - - - --sort-key <field> - - - Chassis field that will be used for sorting. - - - - - --sort-dir <direction> - - - Sort direction: "asc" (the default) or "desc". - - - - - --fields <field> [<field> ...] - - - One or more chassis fields. Only these fields will be - fetched from the server. Can not be used when '-- - detail' is specified. - - - - -
-
- ironic chassis-node-list - usage: ironic chassis-node-list [--detail] [--limit <limit>] [--marker <node>] - [--sort-key <field>] [--sort-dir <direction>] - [--fields <field> [<field> ...]] - [--maintenance <boolean>] - [--associated <boolean>] - [--provision-state <provision-state>] - <chassis> - -List the nodes contained in a chassis. - - Positional arguments - - <chassis> - - - UUID of the chassis. - - - - - - Optional arguments - - --detail - - - Show detailed information about the nodes. - - - - - --limit <limit> - - - Maximum number of nodes to return per request, 0 for - no limit. Default is the maximum number used by the - Ironic API Service. - - - - - --marker <node> - - - Node UUID (for example, of the last node in the list - from a previous request). Returns the list of nodes - after this UUID. - - - - - --sort-key <field> - - - Node field that will be used for sorting. - - - - - --sort-dir <direction> - - - Sort direction: "asc" (the default) or "desc". - - - - - --fields <field> [<field> ...] - - - One or more node fields. Only these fields will be - fetched from the server. Can not be used when '-- - detail' is specified. - - - - - --maintenance <boolean> - - - List nodes in maintenance mode: 'true' or 'false'. - - - - - --associated <boolean> - - - List nodes by instance association: 'true' or 'false'. - - - - - --provision-state <provision-state> - - - List nodes in specified provision state. - - - - -
-
- ironic chassis-show - usage: ironic chassis-show [--fields <field> [<field> ...]] <chassis> - -Show detailed information about a chassis. - - Positional arguments - - <chassis> - - - UUID of the chassis. - - - - - - Optional arguments - - --fields <field> [<field> ...] - - - One or more chassis fields. Only these fields will be - fetched from the server. - - - - -
-
- ironic chassis-update - usage: ironic chassis-update <chassis> <op> <path=value> [<path=value> ...] - -Update information about a chassis. - - Positional arguments - - <chassis> - - - UUID of the chassis. - - - - - <op> - - - Operation: 'add', 'replace', or 'remove'. - - - - - <path=value> - - - Attribute to add, replace, or remove. Can be specified - multiple times. For 'remove', only <path> is necessary. - - - - -
-
- ironic driver-get-vendor-passthru-methods - usage: ironic driver-get-vendor-passthru-methods <driver> - -Get the vendor passthru methods for a driver. - - Positional arguments - - <driver> - - - Name of the driver. - - - - -
-
- ironic driver-list - usage: ironic driver-list - -List the enabled drivers. - -
-
- ironic driver-properties - usage: ironic driver-properties <driver> - -Get properties of a driver. - - Positional arguments - - <driver> - - - Name of the driver. - - - - -
-
- ironic driver-show - usage: ironic driver-show <driver> - -Show information about a driver. - - Positional arguments - - <driver> - - - Name of the driver. - - - - -
-
- ironic driver-vendor-passthru - usage: ironic driver-vendor-passthru [--http-method <http-method>] - <driver> <method> - [<arg=value> [<arg=value> ...]] - -Call a vendor-passthru extension for a driver. - - Positional arguments - - <driver> - - - Name of the driver. - - - - - <method> - - - Vendor-passthru method to be called. - - - - - <arg=value> - - - Argument to be passed to the vendor-passthru method. - Can be specified multiple times. - - - - - - Optional arguments - - --http-method <http-method> - - - The HTTP method to use in the request. Valid HTTP - methods are: 'POST', 'PUT', 'GET', 'DELETE', and - 'PATCH'. Defaults to 'POST'. - - - - -
-
- ironic node-create - usage: ironic node-create [-c <chassis>] -d <driver> [-i <key=value>] - [-p <key=value>] [-e <key=value>] [-u <uuid>] - [-n <name>] - -Register a new node with the Ironic service. - - Optional arguments - - -c <chassis>, --chassis <chassis> - - - UUID of the chassis that this node belongs to. - - - - - -d <driver>, --driver <driver> - - - Driver used to control the node [REQUIRED]. - - - - - -i <key=value>, --driver-info <key=value> - - - Key/value pair used by the driver, such as out-of-band - management credentials. Can be specified multiple - times. - - - - - -p <key=value>, --properties <key=value> - - - Key/value pair describing the physical characteristics - of the node. This is exported to Nova and used by the - scheduler. Can be specified multiple times. - - - - - -e <key=value>, --extra <key=value> - - - Record arbitrary key/value metadata. Can be specified - multiple times. - - - - - -u <uuid>, --uuid <uuid> - - - Unique UUID for the node. - - - - - -n <name>, --name <name> - - - Unique name for the node. - - - - -
-
- ironic node-delete - usage: ironic node-delete <node> [<node> ...] - -Unregister a node from the Ironic service. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - -
-
- ironic node-get-boot-device - usage: ironic node-get-boot-device <node> - -Get the current boot device for a node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - -
-
- ironic node-get-console - usage: ironic node-get-console <node> - -Get the connection information for a node's console, if enabled. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - -
-
- ironic node-get-supported-boot-devices - usage: ironic node-get-supported-boot-devices <node> - -Get the supported boot devices for a node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - -
-
- ironic node-get-vendor-passthru-methods - usage: ironic node-get-vendor-passthru-methods <node> - -Get the vendor passthru methods for a node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - -
-
- ironic node-list - usage: ironic node-list [--limit <limit>] [--marker <node>] - [--sort-key <field>] [--sort-dir <direction>] - [--maintenance <boolean>] [--associated <boolean>] - [--provision-state <provision-state>] [--detail] - [--fields <field> [<field> ...]] - -List the nodes which are registered with the Ironic service. - - Optional arguments - - --limit <limit> - - - Maximum number of nodes to return per request, 0 for - no limit. Default is the maximum number used by the - Ironic API Service. - - - - - --marker <node> - - - Node UUID (for example, of the last node in the list - from a previous request). Returns the list of nodes - after this UUID. - - - - - --sort-key <field> - - - Node field that will be used for sorting. - - - - - --sort-dir <direction> - - - Sort direction: "asc" (the default) or "desc". - - - - - --maintenance <boolean> - - - List nodes in maintenance mode: 'true' or 'false'. - - - - - --associated <boolean> - - - List nodes by instance association: 'true' or 'false'. - - - - - --provision-state <provision-state> - - - List nodes in specified provision state. - - - - - --detail - - - Show detailed information about the nodes. - - - - - --fields <field> [<field> ...] - - - One or more node fields. Only these fields will be - fetched from the server. Can not be used when '-- - detail' is specified. - - - - -
-
- ironic node-port-list - usage: ironic node-port-list [--detail] [--limit <limit>] [--marker <port>] - [--sort-key <field>] [--sort-dir <direction>] - [--fields <field> [<field> ...]] - <node> - -List the ports associated with a node. - - Positional arguments - - <node> - - - UUID of the node. - - - - - - Optional arguments - - --detail - - - Show detailed information about the ports. - - - - - --limit <limit> - - - Maximum number of ports to return per request, 0 for - no limit. Default is the maximum number used by the - Ironic API Service. - - - - - --marker <port> - - - Port UUID (for example, of the last port in the list - from a previous request). Returns the list of ports - after this UUID. - - - - - --sort-key <field> - - - Port field that will be used for sorting. - - - - - --sort-dir <direction> - - - Sort direction: "asc" (the default) or "desc". - - - - - --fields <field> [<field> ...] - - - One or more port fields. Only these fields will be - fetched from the server. Can not be used when '-- - detail' is specified. - - - - -
-
- ironic node-set-boot-device - usage: ironic node-set-boot-device [--persistent] <node> <boot-device> - -Set the boot device for a node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - <boot-device> - - - 'pxe', 'disk', 'cdrom', 'bios', or 'safe'. - - - - - - Optional arguments - - --persistent - - - Make changes persistent for all future boots. - - - - -
-
- ironic node-set-console-mode - usage: ironic node-set-console-mode <node> <enabled> - -Enable or disable serial console access for a node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - <enabled> - - - Enable or disable console access for a node: 'true' or 'false'. - - - - -
-
- ironic node-set-maintenance - usage: ironic node-set-maintenance [--reason <reason>] - <node> <maintenance-mode> - -Enable or disable maintenance mode for a node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - <maintenance-mode> - - - 'true' or 'false'; 'on' or 'off'. - - - - - - Optional arguments - - --reason <reason> - - - Reason for setting maintenance mode to 'true' or 'on'; - not valid when setting to 'false' or 'off'. - - - - -
-
- ironic node-set-power-state - usage: ironic node-set-power-state <node> <power-state> - -Power a node on or off or reboot. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - <power-state> - - - 'on', 'off', or 'reboot'. - - - - -
-
- ironic node-set-provision-state - usage: ironic node-set-provision-state [--config-drive <config-drive>] - <node> <provision-state> - -Initiate a provisioning state change for a node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - <provision-state> - - - Supported states: 'active', 'deleted', 'rebuild', - 'inspect', 'provide', 'manage' or 'abort' - - - - - - Optional arguments - - --config-drive <config-drive> - - - A gzipped, base64-encoded configuration drive string - OR the path to the configuration drive file OR the - path to a directory containing the config drive files. - In case it's a directory, a config drive will be - generated from it. This parameter is only valid when - setting provision state to 'active'. - - - - -
-
- ironic node-show - usage: ironic node-show [--instance] [--fields <field> [<field> ...]] <id> - -Show detailed information about a node. - - Positional arguments - - <id> - - - Name or UUID of the node (or instance UUID if - --instance is specified). - - - - - - Optional arguments - - --instance <id> - - - is an instance UUID. - - - - - --fields <field> [<field> ...] - - - One or more node fields. Only these fields will be - fetched from the server. - - - - -
-
- ironic node-show-states - usage: ironic node-show-states <node> - -Show information about the node's states. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - -
-
- ironic node-update - usage: ironic node-update <node> <op> <path=value> [<path=value> ...] - -Update information about a registered node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - <op> - - - Operation: 'add', 'replace', or 'remove'. - - - - - <path=value> - - - Attribute to add, replace, or remove. Can be specified - multiple times. For 'remove', only <path> is necessary. - - - - -
-
- ironic node-validate - usage: ironic node-validate <node> - -Validate a node's driver interfaces. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - -
-
- ironic node-vendor-passthru - usage: ironic node-vendor-passthru [--http-method <http-method>] - <node> <method> - [<arg=value> [<arg=value> ...]] - -Call a vendor-passthru extension for a node. - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - <method> - - - Vendor-passthru method to be called. - - - - - <arg=value> - - - Argument to be passed to the vendor-passthru method. - Can be specified multiple times. - - - - - - Optional arguments - - --http-method <http-method> - - - The HTTP method to use in the request. Valid HTTP - methods are: 'POST', 'PUT', 'GET', 'DELETE', and - 'PATCH'. Defaults to 'POST'. - - - - -
-
- ironic port-create - usage: ironic port-create -a <address> -n <node> [-e <key=value>] - -Create a new port. - - Optional arguments - - -a <address>, --address <address> - - - MAC address for this port. - - - - - -n <node>, --node <node>, --node_uuid <node> - - - UUID of the node that this port belongs to. - - - - - -e <key=value>, --extra <key=value> - - - Record arbitrary key/value metadata. Can be specified - multiple times. - - - - -
-
- ironic port-delete - usage: ironic port-delete <port> [<port> ...] - -Delete a port. - - Positional arguments - - <port> - - - UUID of the port. - - - - -
-
- ironic port-list - usage: ironic port-list [--detail] [--address <mac-address>] [--limit <limit>] - [--marker <port>] [--sort-key <field>] - [--sort-dir <direction>] - [--fields <field> [<field> ...]] - -List the ports. - - Optional arguments - - --detail - - - Show detailed information about ports. - - - - - --address <mac-address> - - - Only show information for the port with this MAC - address. - - - - - --limit <limit> - - - Maximum number of ports to return per request, 0 for - no limit. Default is the maximum number used by the - Ironic API Service. - - - - - --marker <port> - - - Port UUID (for example, of the last port in the list - from a previous request). Returns the list of ports - after this UUID. - - - - - --sort-key <field> - - - Port field that will be used for sorting. - - - - - --sort-dir <direction> - - - Sort direction: "asc" (the default) or "desc". - - - - - --fields <field> [<field> ...] - - - One or more port fields. Only these fields will be - fetched from the server. Can not be used when '-- - detail' is specified. - - - - -
-
- ironic port-show - usage: ironic port-show [--address] [--fields <field> [<field> ...]] <id> - -Show detailed information about a port. - - Positional arguments - - <id> - - - UUID of the port (or MAC address if --address is - specified). - - - - - - Optional arguments - - --address <id> - - - is the MAC address (instead of the UUID) of the - port. - - - - - --fields <field> [<field> ...] - - - One or more port fields. Only these fields will be - fetched from the server. - - - - -
-
- ironic port-update - usage: ironic port-update <port> <op> <path=value> [<path=value> ...] - -Update information about a port. - - Positional arguments - - <port> - - - UUID of the port. - - - - - <op> - - - Operation: 'add', 'replace', or 'remove'. - - - - - <path=value> - - - Attribute to add, replace, or remove. Can be specified - multiple times. For 'remove', only <path> is necessary. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_keystone_commands.xml b/doc/cli-reference/generated/ch_cli_keystone_commands.xml deleted file mode 100644 index 7200415d2b..0000000000 --- a/doc/cli-reference/generated/ch_cli_keystone_commands.xml +++ /dev/null @@ -1,1389 +0,0 @@ - - - - - - - - Identity service command-line client - - - The keystone CLI is deprecated in favor of - python-openstackclient. For more information on - python-openstackclient, please see - and - . - For a Python library, continue - using python-keystoneclient. - - - The keystone client is the command-line - interface (CLI) for the Identity service API and its extensions. - - This chapter documents keystone version - 2.0.0. - - - For help on a specific keystone - command, enter: - - $ keystone COMMAND - -
- keystone usage - usage: keystone [--version] [--debug] [--os-username <auth-user-name>] - [--os-password <auth-password>] - [--os-tenant-name <auth-tenant-name>] - [--os-tenant-id <tenant-id>] [--os-auth-url <auth-url>] - [--os-region-name <region-name>] - [--os-identity-api-version <identity-api-version>] - [--os-token <service-token>] - [--os-endpoint <service-endpoint>] [--os-cache] - [--force-new-token] [--stale-duration <seconds>] [--insecure] - [--os-cacert <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] - <subcommand> ... - - Subcommands - - catalog - - - List service catalog, possibly filtered by - service. - - - - - ec2-credentials-create - - - Create EC2-compatible credentials for user per - tenant. - - - - - ec2-credentials-delete - - - Delete EC2-compatible credentials. - - - - - ec2-credentials-get - - - Display EC2-compatible credentials. - - - - - ec2-credentials-list - - - List EC2-compatible credentials for a user. - - - - - endpoint-create - - - Create a new endpoint associated with a service. - - - - - endpoint-delete - - - Delete a service endpoint. - - - - - endpoint-get - - - Find endpoint filtered by a specific attribute or - service type. - - - - - endpoint-list - - - List configured service endpoints. - - - - - password-update - - - Update own password. - - - - - role-create - - - Create new role. - - - - - role-delete - - - Delete role. - - - - - role-get - - - Display role details. - - - - - role-list - - - List all roles. - - - - - service-create - - - Add service to Service Catalog. - - - - - service-delete - - - Delete service from Service Catalog. - - - - - service-get - - - Display service from Service Catalog. - - - - - service-list - - - List all services in Service Catalog. - - - - - tenant-create - - - Create new tenant. - - - - - tenant-delete - - - Delete tenant. - - - - - tenant-get - - - Display tenant details. - - - - - tenant-list - - - List all tenants. - - - - - tenant-update - - - Update tenant name, description, enabled status. - - - - - token-get - - - Display the current user token. - - - - - user-create - - - Create new user. - - - - - user-delete - - - Delete user. - - - - - user-get - - - Display user details. - - - - - user-list - - - List users. - - - - - user-password-update - - - Update user password. - - - - - user-role-add - - - Add role to user. - - - - - user-role-list - - - List roles granted to a user. - - - - - user-role-remove - - - Remove role from user. - - - - - user-update - - - Update user's name, email, and enabled status. - - - - - discover - - - Discover Keystone servers, supported API versions - and extensions. - - - - - bootstrap - - - Grants a new role to a new user on a new tenant, - after creating each. - - - - - bash-completion - - - Prints all of the commands and options to stdout. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - -
-
- keystone optional arguments - - - --version - - - Shows the client version and exits. - - - - - --debug - - - Prints debugging output onto the console, this - includes the curl request and response calls. - Helpful for debugging and understanding the API - calls. - - - - - --os-username <auth-user-name> - - - Name used for authentication with the OpenStack - Identity service. Defaults to env[OS_USERNAME]. - - - - - --os-password <auth-password> - - - Password used for authentication with the - OpenStack Identity service. Defaults to - env[OS_PASSWORD]. - - - - - --os-tenant-name <auth-tenant-name> - - - Tenant to request authorization on. Defaults to - env[OS_TENANT_NAME]. - - - - - --os-tenant-id <tenant-id> - - - Tenant to request authorization on. Defaults to - env[OS_TENANT_ID]. - - - - - --os-auth-url <auth-url> - - - Specify the Identity endpoint to use for - authentication. Defaults to env[OS_AUTH_URL]. - - - - - --os-region-name <region-name> - - - Specify the region to use. Defaults to - env[OS_REGION_NAME]. - - - - - --os-identity-api-version <identity-api-version> - - - Specify Identity API version to use. Defaults to - env[OS_IDENTITY_API_VERSION] or 2.0. - - - - - --os-token <service-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 <service-endpoint> - - - Specify an endpoint to use instead of retrieving - one from the service catalog (via authentication). - Defaults to env[OS_SERVICE_ENDPOINT]. - - - - - --os-cache - - - Use the auth token cache. Defaults to - env[OS_CACHE]. - - - - - --force-new-token - - - If the keyring is available and in use, token will - always be stored and fetched from the keyring - until the token has expired. Use this option to - request a new token and replace the existing one - in the keyring. - - - - - --stale-duration <seconds> - - - Stale duration (in seconds) used to determine - whether a token has expired when retrieving it - from keyring. This is useful in mitigating process - or network delays. Default is 30 seconds. - - - - - --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 <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - Set request timeout (in seconds). - - - - -
-
- keystone bootstrap - usage: keystone bootstrap [--user-name <user-name>] --pass <password> - [--role-name <role-name>] - [--tenant-name <tenant-name>] - -Grants a new role to a new user on a new tenant, after creating each. - - Arguments - - --user-name <user-name> - - - The name of the user to be created (default="admin"). - - - - - --pass <password> - - - The password for the new user. - - - - - --role-name <role-name> - - - The name of the role to be created and granted to the - user (default="admin"). - - - - - --tenant-name <tenant-name> - - - The name of the tenant to be created - (default="admin"). - - - - -
-
- keystone catalog - usage: keystone catalog [--service <service-type>] - -List service catalog, possibly filtered by service. - - Arguments - - --service <service-type> - - - Service type to return. - - - - -
-
- keystone discover - usage: keystone discover - -Discover Keystone servers, supported API versions and extensions. - -
-
- keystone ec2-credentials-create - usage: keystone ec2-credentials-create [--user-id <user-id>] - [--tenant-id <tenant-id>] - -Create EC2-compatible credentials for user per tenant. - - Arguments - - --user-id <user-id> - - - User ID for which to create credentials. If not - specified, the authenticated user will be used. - - - - - --tenant-id <tenant-id> - - - Tenant ID for which to create credentials. If not - specified, the authenticated tenant ID will be used. - - - - -
-
- keystone ec2-credentials-delete - usage: keystone ec2-credentials-delete [--user-id <user-id>] --access - <access-key> - -Delete EC2-compatible credentials. - - Arguments - - --user-id <user-id> - - - User ID. - - - - - --access <access-key> - - - Access Key. - - - - -
-
- keystone ec2-credentials-get - usage: keystone ec2-credentials-get [--user-id <user-id>] --access - <access-key> - -Display EC2-compatible credentials. - - Arguments - - --user-id <user-id> - - - User ID. - - - - - --access <access-key> - - - Access Key. - - - - -
-
- keystone ec2-credentials-list - usage: keystone ec2-credentials-list [--user-id <user-id>] - -List EC2-compatible credentials for a user. - - Arguments - - --user-id <user-id> - - - User ID. - - - - -
-
- keystone endpoint-create - usage: keystone endpoint-create [--region <endpoint-region>] --service - <service> --publicurl <public-url> - [--adminurl <admin-url>] - [--internalurl <internal-url>] - -Create a new endpoint associated with a service. - - Arguments - - --region <endpoint-region> - - - Endpoint region. - - - - - --service <service>, --service-id <service>, --service_id <service> - - - Name or ID of service associated with endpoint. - - - - - --publicurl <public-url> - - - Public URL endpoint. - - - - - --adminurl <admin-url> - - - Admin URL endpoint. - - - - - --internalurl <internal-url> - - - Internal URL endpoint. - - - - -
-
- keystone endpoint-delete - usage: keystone endpoint-delete <endpoint-id> - -Delete a service endpoint. - - Arguments - - <endpoint-id> - - - ID of endpoint to delete. - - - - -
-
- keystone endpoint-get - usage: keystone endpoint-get --service <service-type> - [--endpoint-type <endpoint-type>] - [--attr <service-attribute>] [--value <value>] - -Find endpoint filtered by a specific attribute or service type. - - Arguments - - --service <service-type> - - - Service type to select. - - - - - --endpoint-type <endpoint-type> - - - Endpoint type to select. - - - - - --attr <service-attribute> - - - Service attribute to match for selection. - - - - - --value <value> - - - Value of attribute to match. - - - - -
-
- keystone endpoint-list - usage: keystone endpoint-list - -List configured service endpoints. - -
-
- keystone password-update - usage: keystone password-update [--current-password <current-password>] - [--new-password <new-password>] - -Update own password. - - Arguments - - --current-password <current-password> - - - Current password, Defaults to the password as set by - --os-password or env[OS_PASSWORD]. - - - - - --new-password <new-password> - - - Desired new password. - - - - -
-
- keystone role-create - usage: keystone role-create --name <role-name> - -Create new role. - - Arguments - - --name <role-name> - - - Name of new role. - - - - -
-
- keystone role-delete - usage: keystone role-delete <role> - -Delete role. - - Arguments - - <role> - - - Name or ID of role to delete. - - - - -
-
- keystone role-get - usage: keystone role-get <role> - -Display role details. - - Arguments - - <role> - - - Name or ID of role to display. - - - - -
-
- keystone role-list - usage: keystone role-list - -List all roles. - -
-
- keystone service-create - usage: keystone service-create --type <type> [--name <name>] - [--description <service-description>] - -Add service to Service Catalog. - - Arguments - - --type <type> - - - Service type (one of: identity, compute, network, - image, object-store, or other service identifier - string). - - - - - --name <name> - - - Name of new service (must be unique). - - - - - --description <service-description> - - - Description of service. - - - - -
-
- keystone service-delete - usage: keystone service-delete <service> - -Delete service from Service Catalog. - - Arguments - - <service> - - - Name or ID of service to delete. - - - - -
-
- keystone service-get - usage: keystone service-get <service> - -Display service from Service Catalog. - - Arguments - - <service> - - - Name or ID of service to display. - - - - -
-
- keystone service-list - usage: keystone service-list - -List all services in Service Catalog. - -
-
- keystone tenant-create - usage: keystone tenant-create --name <tenant-name> - [--description <tenant-description>] - [--enabled <true|false>] - -Create new tenant. - - Arguments - - --name <tenant-name> - - - New tenant name (must be unique). - - - - - --description <tenant-description> - - - Description of new tenant. Default is none. - - - - - --enabled <true|false> - - - Initial tenant enabled status. Default is true. - - - - -
-
- keystone tenant-delete - usage: keystone tenant-delete <tenant> - -Delete tenant. - - Arguments - - <tenant> - - - Name or ID of tenant to delete. - - - - -
-
- keystone tenant-get - usage: keystone tenant-get <tenant> - -Display tenant details. - - Arguments - - <tenant> - - - Name or ID of tenant to display. - - - - -
-
- keystone tenant-list - usage: keystone tenant-list - -List all tenants. - -
-
- keystone tenant-update - usage: keystone tenant-update [--name <tenant_name>] - [--description <tenant-description>] - [--enabled <true|false>] - <tenant> - -Update tenant name, description, enabled status. - - Arguments - - --name <tenant_name> - - - Desired new name of tenant. - - - - - --description <tenant-description> - - - Desired new description of tenant. - - - - - --enabled <true|false> - - - Enable or disable tenant. - - - - - <tenant> - - - Name or ID of tenant to update. - - - - -
-
- keystone token-get - usage: keystone token-get [--wrap <integer>] - -Display the current user token. - - Arguments - - --wrap <integer> - - - Wrap PKI tokens to a specified length, or 0 to disable. - - - - -
-
- keystone user-create - usage: keystone user-create --name <user-name> [--tenant <tenant>] - [--pass [<pass>]] [--email <email>] - [--enabled <true|false>] - -Create new user. - - Arguments - - --name <user-name> - - - New user name (must be unique). - - - - - --tenant <tenant>, --tenant-id <tenant> - - - New user default tenant. - - - - - --pass [<pass>] - - - New user password; required for some auth backends. - - - - - --email <email> - - - New user email address. - - - - - --enabled <true|false> - - - Initial user enabled status. Default is true. - - - - -
-
- keystone user-delete - usage: keystone user-delete <user> - -Delete user. - - Arguments - - <user> - - - Name or ID of user to delete. - - - - -
-
- keystone user-get - usage: keystone user-get <user> - -Display user details. - - Arguments - - <user> - - - Name or ID of user to display. - - - - -
-
- keystone user-list - usage: keystone user-list [--tenant <tenant>] - -List users. - - Arguments - - --tenant <tenant>, --tenant-id <tenant> - - - Tenant; lists all users if not specified. - - - - -
-
- keystone user-password-update - usage: keystone user-password-update [--pass <password>] <user> - -Update user password. - - Arguments - - --pass <password> - - - Desired new password. - - - - - <user> - - - Name or ID of user to update password. - - - - -
-
- keystone user-role-add - usage: keystone user-role-add --user <user> --role <role> [--tenant <tenant>] - -Add role to user. - - Arguments - - --user <user>, --user-id <user>, --user_id <user> - - - Name or ID of user. - - - - - --role <role>, --role-id <role>, --role_id <role> - - - Name or ID of role. - - - - - --tenant <tenant>, --tenant-id <tenant> - - - Name or ID of tenant. - - - - -
-
- keystone user-role-list - usage: keystone user-role-list [--user <user>] [--tenant <tenant>] - -List roles granted to a user. - - Arguments - - --user <user>, --user-id <user> - - - List roles granted to specified user. - - - - - --tenant <tenant>, --tenant-id <tenant> - - - List only roles granted on specified tenant. - - - - -
-
- keystone user-role-remove - usage: keystone user-role-remove --user <user> --role <role> - [--tenant <tenant>] - -Remove role from user. - - Arguments - - --user <user>, --user-id <user>, --user_id <user> - - - Name or ID of user. - - - - - --role <role>, --role-id <role>, --role_id <role> - - - Name or ID of role. - - - - - --tenant <tenant>, --tenant-id <tenant> - - - Name or ID of tenant. - - - - -
-
- keystone user-update - usage: keystone user-update [--name <user-name>] [--email <email>] - [--enabled <true|false>] - <user> - -Update user's name, email, and enabled status. - - Arguments - - --name <user-name> - - - Desired new user name. - - - - - --email <email> - - - Desired new email address. - - - - - --enabled <true|false> - - - Enable or disable user. - - - - - <user> - - - Name or ID of user to update. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_magnum_commands.xml b/doc/cli-reference/generated/ch_cli_magnum_commands.xml deleted file mode 100644 index f011d74892..0000000000 --- a/doc/cli-reference/generated/ch_cli_magnum_commands.xml +++ /dev/null @@ -1,1669 +0,0 @@ - - - - - - - - Containers service command-line client - - The magnum client is the command-line - interface (CLI) for the Containers service API and its extensions. - - This chapter documents magnum version - 1.1.0. - - - For help on a specific magnum - command, enter: - - $ magnum COMMAND - -
- magnum usage - usage: magnum [--version] [--debug] [--os-cache] - [--os-region-name <region-name>] - [--os-tenant-id <auth-tenant-id>] - [--service-type <service-type>] - [--endpoint-type <endpoint-type>] - [--magnum-api-version <magnum-api-ver>] - [--os-cacert <ca-certificate>] [--bypass-url <bypass-url>] - [--os-auth-system <auth-system>] [--os-username <username>] - [--os-password <password>] [--os-tenant-name <tenant-name>] - [--os-token <token>] [--os-auth-url <auth-url>] - <subcommand> ... - - Subcommands - - baymodel-create - - - Create a baymodel. - - - - - baymodel-delete - - - Delete specified baymodel. - - - - - baymodel-list - - - Print a list of bay models. - - - - - baymodel-show - - - Show details about the given baymodel. - - - - - baymodel-update - - - Updates one or more baymodel attributes. - - - - - bay-create - - - Create a bay. - - - - - bay-delete - - - Delete specified bay. - - - - - bay-list - - - Print a list of available bays. - - - - - bay-show - - - Show details about the given bay. - - - - - bay-update - - - Update information about the given bay. - - - - - ca-show - - - Show details about the CA certificate for a bay. - - - - - ca-sign - - - Generate the CA certificate for a bay. - - - - - container-create - - - Create a container. - - - - - container-delete - - - Delete specified containers. - - - - - container-exec - - - Execute command in a container. - - - - - container-list - - - Print a list of available containers. - - - - - container-logs - - - Get logs of a container. - - - - - container-pause - - - Pause specified containers. - - - - - container-reboot - - - Reboot specified containers. - - - - - container-show - - - Show details of a container. - - - - - container-start - - - Start specified containers. - - - - - container-stop - - - Stop specified containers. - - - - - container-unpause - - - Unpause specified containers. - - - - - service-list - - - Print a list of magnum services. - - - - - node-create - - - Create a node. - - - - - node-list - - - Print a list of configured nodes. - - - - - pod-create - - - Create a pod. - - - - - pod-delete - - - Delete specified pod. - - - - - pod-list - - - Print a list of registered pods. - - - - - pod-show - - - Show details about the given pod. - - - - - pod-update - - - Update information about the given pod. - - - - - rc-create - - - Create a replication controller. - - - - - rc-delete - - - Delete specified replication controller. - - - - - rc-list - - - Print a list of registered replication controllers. - - - - - rc-show - - - Show details about the given replication controller. - - - - - rc-update - - - Update information about the given replication - controller. - - - - - coe-service-create - - - Create a coe service. - - - - - coe-service-delete - - - Delete specified coe service(s). - - - - - coe-service-list - - - Print a list of coe services. - - - - - coe-service-show - - - Show details about the given coe service. - - - - - coe-service-update - - - Update information about the given coe service. - - - - - bash-completion - - - Prints arguments for bash-completion. Prints all of - the commands and options to stdout so that the - magnum.bash_completion script doesn't have to hard - code them. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - -
-
- magnum 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. - - - - - --os-region-name <region-name> - - - Region name. Default=env[OS_REGION_NAME]. - - - - - --os-tenant-id <auth-tenant-id> - - - Defaults to env[OS_TENANT_ID]. - - - - - --service-type <service-type> - - - Defaults to container for all actions. - - - - - --endpoint-type <endpoint-type> - - - Defaults to env[MAGNUM_ENDPOINT_TYPE] or publicURL. - - - - - --magnum-api-version <magnum-api-ver> - - - Accepts "api", defaults to env[MAGNUM_API_VERSION]. - - - - - --os-cacert <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --bypass-url <bypass-url> - - - Use this API endpoint instead of the Service Catalog. - - - - -
-
- magnum common authentication arguments - - - --os-auth-system <auth-system> - - - Defaults to env[OS_AUTH_SYSTEM]. - - - - - --os-username <username> - - - Defaults to env[OS_USERNAME]. - - - - - --os-password <password> - - - Defaults to env[OS_PASSWORD]. - - - - - --os-tenant-name <tenant-name> - - - Defaults to env[OS_TENANT_NAME]. - - - - - --os-token <token> - - - Defaults to env[OS_TOKEN]. - - - - - --os-auth-url <auth-url> - - - Defaults to env[OS_AUTH_URL]. - - - - -
-
- magnum bay-create - usage: magnum bay-create [--name <name>] --baymodel <baymodel> - [--node-count <node-count>] - [--master-count <master-count>] - [--discovery-url <discovery-url>] - [--timeout <timeout>] - -Create a bay. - - Optional arguments - - --name <name> - - - Name of the bay to create. - - - - - --baymodel <baymodel> - - - ID or name of the baymodel. - - - - - --node-count <node-count> - - - The bay node count. - - - - - --master-count <master-count> - - - The number of master nodes for the bay. - - - - - --discovery-url <discovery-url> - - - Specifies custom discovery url for node discovery. - - - - - --timeout <timeout> - - - The timeout for bay creation in minutes. Set to 0 for - no timeout. The default is no timeout. - - - - -
-
- magnum bay-delete - usage: magnum bay-delete <bay> [<bay> ...] - -Delete specified bay. - - Positional arguments - - <bay> - - - ID or name of the (bay)s to delete. - - - - -
-
- magnum bay-list - usage: magnum bay-list - -Print a list of available bays. - -
-
- magnum bay-show - usage: magnum bay-show <bay> - -Show details about the given bay. - - Positional arguments - - <bay> - - - ID or name of the bay to show. - - - - -
-
- magnum bay-update - usage: magnum bay-update <bay> <op> <path=value> [<path=value> ...] - -Update information about the given bay. - - Positional arguments - - <bay> - - - UUID or name of bay - - - - - <op> - - - Operations: 'add', 'replace' or 'remove' - - - - - <path=value> - - - Attributes to add/replace or remove (only PATH is necessary on - remove) - - - - -
-
- magnum baymodel-create - usage: magnum baymodel-create [--name <name>] --image-id <image-id> - --keypair-id <keypair-id> --external-network-id - <external-network-id> --coe <coe> - [--fixed-network <fixed-network>] - [--network-driver <network-driver>] - [--ssh-authorized-key <ssh-authorized-key>] - [--dns-nameserver <dns-nameserver>] - [--flavor-id <flavor-id>] - [--master-flavor-id <master-flavor-id>] - [--docker-volume-size <docker-volume-size>] - [--http-proxy <http-proxy>] - [--https-proxy <https-proxy>] - [--no-proxy <no-proxy>] - [--labels <KEY1=VALUE1,KEY2=VALUE2...>] - [--tls-disabled] [--public] - -Create a baymodel. - - Optional arguments - - --name <name> - - - Name of the bay to create. - - - - - --image-id <image-id> - - - The name or UUID of the base image to customize for - the bay. - - - - - --keypair-id <keypair-id> - - - The name or UUID of the SSH keypair to load into the - Bay nodes. - - - - - --external-network-id <external-network-id> - - - The external Neutron network ID to connect to this bay - model. - - - - - --coe <coe> - - - Specify the Container Orchestration Engine to use. - - - - - --fixed-network <fixed-network> - - - The private Neutron network name to connect to this - bay model. - - - - - --network-driver <network-driver> - - - The network driver name for instantiating container - networks. - - - - - --ssh-authorized-key <ssh-authorized-key> - - - The SSH authorized key to use - - - - - --dns-nameserver <dns-nameserver> - - - The DNS nameserver to use for this Bay. - - - - - --flavor-id <flavor-id> - - - The nova flavor id to use when launching the bay. - - - - - --master-flavor-id <master-flavor-id> - - - The nova flavor id to use when launching the master - node of the bay. - - - - - --docker-volume-size <docker-volume-size> - - - Specify the number of size in GB for the docker volume - to use. - - - - - --http-proxy <http-proxy> - - - The http_proxy address to use for nodes in bay. - - - - - --https-proxy <https-proxy> - - - The https_proxy address to use for nodes in bay. - - - - - --no-proxy <no-proxy> - - - The no_proxy address to use for nodes in bay. - - - - - --labels <KEY1=VALUE1,KEY2=VALUE2...> - - - Arbitrary labels in the form of key=value pairs to - associate with a baymodel. May be used multiple times. - - - - - --tls-disabled - - - Disable TLS in the Bay. - - - - - --public - - - Make baymodel public. - - - - -
-
- magnum baymodel-delete - usage: magnum baymodel-delete <baymodels> [<baymodels> ...] - -Delete specified baymodel. - - Positional arguments - - <baymodels> - - - ID or name of the (baymodel)s to delete. - - - - -
-
- magnum baymodel-list - usage: magnum baymodel-list - -Print a list of bay models. - -
-
- magnum baymodel-show - usage: magnum baymodel-show <baymodel> - -Show details about the given baymodel. - - Positional arguments - - <baymodel> - - - ID of the baymodel to show. - - - - -
-
- magnum baymodel-update - usage: magnum baymodel-update <baymodel> <op> <path=value> [<path=value> ...] - -Updates one or more baymodel attributes. - - Positional arguments - - <baymodel> - - - UUID or name of baymodel - - - - - <op> - - - Operations: 'add', 'replace' or 'remove' - - - - - <path=value> - - - Attributes to add/replace or remove (only PATH is necessary on - remove) - - - - -
-
- magnum ca-show - usage: magnum ca-show --bay <bay> - -Show details about the CA certificate for a bay. - - Optional arguments - - --bay <bay> - - - ID or name of the bay. - - - - -
-
- magnum ca-sign - usage: magnum ca-sign [--csr <csr>] --bay <bay> - -Generate the CA certificate for a bay. - - Optional arguments - - --csr <csr> - - - File path of the csr file to send to Magnum to get signed. - - - - - --bay <bay> - - - ID or name of the bay. - - - - -
-
- magnum coe-service-create - usage: magnum coe-service-create [--manifest-url <manifest-url>] - [--manifest <manifest>] --bay <bay> - -Create a coe service. - - Optional arguments - - --manifest-url <manifest-url> - - - Name/URL of the serivce file to use for creating - services. - - - - - --manifest <manifest> - - - File path of the service file to use for creating - services. - - - - - --bay <bay> - - - Id or name of the bay. - - - - -
-
- magnum coe-service-delete - usage: magnum coe-service-delete <services> [<services> ...] <bay> - -Delete specified coe service(s). - - Positional arguments - - <services> - - - ID or name of the (service)s to delete. - - - - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum coe-service-list - usage: magnum coe-service-list <bay> - -Print a list of coe services. - - Positional arguments - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum coe-service-show - usage: magnum coe-service-show <service> <bay> - -Show details about the given coe service. - - Positional arguments - - <service> - - - ID or name of the service to show. - - - - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum coe-service-update - usage: magnum coe-service-update <service> <bay> <op> <path=value> - [<path=value> ...] - -Update information about the given coe service. - - Positional arguments - - <service> - - - UUID or name of service - - - - - <bay> - - - UUID or Name of Bay - - - - - <op> - - - Operations: 'add', 'replace' or 'remove' - - - - - <path=value> - - - Attributes to add/replace or remove (only PATH is necessary on - remove) - - - - -
-
- magnum container-create - usage: magnum container-create [--name <name>] --image <image> --bay <bay> - [--command <command>] [--memory <memory>] - -Create a container. - - Optional arguments - - --name <name> - - - name of the container - - - - - --image <image> - - - name or ID of the image - - - - - --bay <bay> - - - ID or name of the bay. - - - - - --command <command> - - - Send command to the container - - - - - --memory <memory> - - - The container memory size (format: <number><optional - unit>, where unit = b, k, m or g) - - - - -
-
- magnum container-delete - usage: magnum container-delete <container> [<container> ...] - -Delete specified containers. - - Positional arguments - - <container> - - - ID or name of the (container)s to delete. - - - - -
-
- magnum container-exec - usage: magnum container-exec --command <command> <container> - -Execute command in a container. - - Positional arguments - - <container> - - - ID or name of the container to start. - - - - - - Optional arguments - - --command <command> - - - The command to execute - - - - -
-
- magnum container-list - usage: magnum container-list - -Print a list of available containers. - -
-
- magnum container-logs - usage: magnum container-logs <container> - -Get logs of a container. - - Positional arguments - - <container> - - - ID or name of the container to start. - - - - -
-
- magnum container-pause - usage: magnum container-pause <container> [<container> ...] - -Pause specified containers. - - Positional arguments - - <container> - - - ID or name of the (container)s to start. - - - - -
-
- magnum container-reboot - usage: magnum container-reboot <container> [<container> ...] - -Reboot specified containers. - - Positional arguments - - <container> - - - ID or name of the (container)s to start. - - - - -
-
- magnum container-show - usage: magnum container-show [--json] <container> - -Show details of a container. - - Positional arguments - - <container> - - - ID or name of the container to show. - - - - - - Optional arguments - - --json - - - Print JSON representation of the container. - - - - -
-
- magnum container-start - usage: magnum container-start <container> [<container> ...] - -Start specified containers. - - Positional arguments - - <container> - - - ID of the (container)s to start. - - - - -
-
- magnum container-stop - usage: magnum container-stop <container> [<container> ...] - -Stop specified containers. - - Positional arguments - - <container> - - - ID or name of the (container)s to start. - - - - -
-
- magnum container-unpause - usage: magnum container-unpause <container> [<container> ...] - -Unpause specified containers. - - Positional arguments - - <container> - - - ID or name of the (container)s to start. - - - - -
-
- magnum node-create - usage: magnum node-create [--type <type>] [--image-id <image-id>] - -Create a node. - - Optional arguments - - --type <type> - - - Type of node to create (virt or bare). - - - - - --image-id <image-id> - - - The name or UUID of the base image to use for the - node. - - - - -
-
- magnum node-list - usage: magnum node-list - -Print a list of configured nodes. - -
-
- magnum pod-create - usage: magnum pod-create [--manifest-url <manifest-url>] - [--manifest <manifest>] --bay <bay> - -Create a pod. - - Optional arguments - - --manifest-url <manifest-url> - - - Name/URL of the pod file to use for creating PODs. - - - - - --manifest <manifest> - - - File path of the pod file to use for creating PODs. - - - - - --bay <bay> - - - ID or name of the bay. - - - - -
-
- magnum pod-delete - usage: magnum pod-delete <pods> [<pods> ...] <bay> - -Delete specified pod. - - Positional arguments - - <pods> - - - ID or name of the (pod)s to delete. - - - - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum pod-list - usage: magnum pod-list <bay> - -Print a list of registered pods. - - Positional arguments - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum pod-show - usage: magnum pod-show <pod> <bay> - -Show details about the given pod. - - Positional arguments - - <pod> - - - ID or name of the pod to show. - - - - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum pod-update - usage: magnum pod-update <pod-id> <bay> <op> <path=value> [<path=value> ...] - -Update information about the given pod. - - Positional arguments - - <pod-id> - - - UUID or name of pod - - - - - <bay> - - - UUID or Name of Bay - - - - - <op> - - - Operations: 'add', 'replace' or 'remove' - - - - - <path=value> - - - Attributes to add/replace or remove (only PATH is necessary on - remove) - - - - -
-
- magnum rc-create - usage: magnum rc-create [--manifest-url <manifest-url>] - [--manifest <manifest>] --bay <bay> - -Create a replication controller. - - Optional arguments - - --manifest-url <manifest-url> - - - Name/URL of the replication controller file to use for - creating replication controllers. - - - - - --manifest <manifest> - - - File path of the replication controller file to use - for creating replication controllers. - - - - - --bay <bay> - - - ID or name of the bay. - - - - -
-
- magnum rc-delete - usage: magnum rc-delete <rcs> [<rcs> ...] <bay> - -Delete specified replication controller. - - Positional arguments - - <rcs> - - - ID or name of the replication (controller)s to delete. - - - - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum rc-list - usage: magnum rc-list <bay> - -Print a list of registered replication controllers. - - Positional arguments - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum rc-show - usage: magnum rc-show <rc> <bay> - -Show details about the given replication controller. - - Positional arguments - - <rc> - - - ID or name of the replication controller to show. - - - - - <bay> - - - UUID or Name of Bay - - - - -
-
- magnum rc-update - usage: magnum rc-update <rc> <bay> <op> <path=value> [<path=value> ...] - -Update information about the given replication controller. - - Positional arguments - - <rc> - - - UUID or name of replication controller - - - - - <bay> - - - UUID or Name of Bay - - - - - <op> - - - Operations: 'add', 'replace' or 'remove' - - - - - <path=value> - - - Attributes to add/replace or remove (only PATH is necessary on - remove) - - - - -
-
- magnum service-list - usage: magnum service-list - -Print a list of magnum services. - -
- diff --git a/doc/cli-reference/generated/ch_cli_manila_commands.xml b/doc/cli-reference/generated/ch_cli_manila_commands.xml deleted file mode 100644 index 2c2842b696..0000000000 --- a/doc/cli-reference/generated/ch_cli_manila_commands.xml +++ /dev/null @@ -1,3884 +0,0 @@ - - - - - - - - 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 manila version - 1.6.0. - - - For help on a specific manila - command, enter: - - $ manila COMMAND - -
- manila usage - usage: manila [--version] [-d] [--os-cache] [--os-reset-cache] - [--os-user-id <auth-user-id>] [--os-username <auth-user-name>] - [--os-password <auth-password>] - [--os-tenant-name <auth-tenant-name>] - [--os-project-name <auth-project-name>] - [--os-tenant-id <auth-tenant-id>] - [--os-project-id <auth-project-id>] - [--os-user-domain-id <auth-user-domain-id>] - [--os-user-domain-name <auth-user-domain-name>] - [--os-project-domain-id <auth-project-domain-id>] - [--os-project-domain-name <auth-project-domain-name>] - [--os-auth-url <auth-url>] [--os-region-name <region-name>] - [--service-type <service-type>] [--service-name <service-name>] - [--share-service-name <share-service-name>] - [--endpoint-type <endpoint-type>] - [--os-share-api-version <share-api-ver>] - [--os-cacert <ca-certificate>] [--retries <retries>] - [--os-cert <certificate>] - <subcommand> ... - - 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 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 <auth-user-id> - - - Defaults to env [OS_USER_ID]. - - - - - --os-username <auth-user-name> - - - Defaults to env[OS_USERNAME]. - - - - - --os-password <auth-password> - - - Defaults to env[OS_PASSWORD]. - - - - - --os-tenant-name <auth-tenant-name> - - - Defaults to env[OS_TENANT_NAME]. - - - - - --os-project-name <auth-project-name> - - - Another way to specify tenant name. This option is - mutually exclusive with --os-tenant-name. Defaults to - env[OS_PROJECT_NAME]. - - - - - --os-tenant-id <auth-tenant-id> - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-project-id <auth-project-id> - - - Another way to specify tenant ID. This option is - mutually exclusive with --os-tenant-id. Defaults to - env[OS_PROJECT_ID]. - - - - - --os-user-domain-id <auth-user-domain-id> - - - OpenStack user domain ID. Defaults to - env[OS_USER_DOMAIN_ID]. - - - - - --os-user-domain-name <auth-user-domain-name> - - - OpenStack user domain name. Defaults to - env[OS_USER_DOMAIN_NAME]. - - - - - --os-project-domain-id <auth-project-domain-id> - - - Defaults to env[OS_PROJECT_DOMAIN_ID]. - - - - - --os-project-domain-name <auth-project-domain-name> - - - Defaults to env[OS_PROJECT_DOMAIN_NAME]. - - - - - --os-auth-url <auth-url> - - - Defaults to env[OS_AUTH_URL]. - - - - - --os-region-name <region-name> - - - Defaults to env[OS_REGION_NAME]. - - - - - --service-type <service-type> - - - Defaults to compute for most actions. - - - - - --service-name <service-name> - - - Defaults to env[MANILA_SERVICE_NAME]. - - - - - --share-service-name <share-service-name> - - - Defaults to env[MANILA_share_service_name]. - - - - - --endpoint-type <endpoint-type> - - - Defaults to env[MANILA_ENDPOINT_TYPE] or publicURL. - - - - - --os-share-api-version <share-api-ver> - - - Accepts 1.x to override default to - env[OS_SHARE_API_VERSION]. - - - - - --os-cacert <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --retries <retries> - - - Number of retries. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - -
-
- manila absolute-limits - usage: manila absolute-limits - -Print a list of absolute limits for a user. - -
-
- manila access-allow - usage: manila access-allow [--access-level <access_level>] - <share> <access_type> <access_to> - -Allow access to the share. - - Positional arguments - - <share> - - - Name or ID of the NAS share to modify. - - - - - <access_type> - - - Access rule type (only "ip", "user"(user or group), - and "cert" are supported). - - - - - <access_to> - - - Value that defines access. - - - - - - Optional arguments - - --access-level <access_level>, --access_level <access_level> - - - Share access level ("rw" and "ro" access levels are - supported). Defaults to None. - - - - -
-
- manila access-deny - usage: manila access-deny <share> <id> - -Deny access to a share. - - Positional arguments - - <share> - - - Name or ID of the NAS share to modify. - - - - - <id> - - - ID of the access rule to be deleted. - - - - -
-
- manila access-list - usage: manila access-list <share> - -Show access list for share. - - Positional arguments - - <share> - - - Name or ID of the share. - - - - -
-
- manila api-version - usage: manila api-version - -Display the API version information. - -
-
- manila cg-create - usage: manila cg-create [--name <name>] [--description <description>] - [--share-types <share_types>] - [--share-network <share_network>] - [--source-cgsnapshot-id <source_cgsnapshot_id>] - -Creates a new consistency group. - - Optional arguments - - --name <name> - - - Optional consistency group name. (Default=None) - - - - - --description <description> - - - Optional consistency group description. (Default=None) - - - - - --share-types <share_types>, --share_types <share_types> - - - Optional list of share types. (Default=None) - - - - - --share-network <share_network>, --share_network <share_network> - - - Specify share-network name or id. - - - - - --source-cgsnapshot-id <source_cgsnapshot_id>, --source_cgsnapshot_id <source_cgsnapshot_id> - - - Optional snapshot ID to create the share from. - (Default=None) - - - - -
-
- manila cg-delete - usage: manila cg-delete [--force] - <consistency_group> [<consistency_group> ...] - -Remove one or more consistency groups. - - Positional arguments - - <consistency_group> - - - Name or ID of the consistency group(s). - - - - - - Optional arguments - - --force - - - Attempt to force delete the consistency group - (Default=False). - - - - -
-
- manila cg-list - usage: manila cg-list [--all-tenants [<0|1>]] [--limit <limit>] - [--offset <offset>] - -List consistency groups with filters. - - Optional arguments - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin only). - - - - - --limit <limit> - - - Maximum number of consistency groups to return. - (Default=None) - - - - - --offset <offset> - - - Start position of consistency group listing. - - - - -
-
- manila cg-reset-state - usage: manila cg-reset-state [--state <state>] <consistency_group> - -Explicitly update the state of a consistency group. - - Positional arguments - - <consistency_group> - - - Name or ID of the consistency group state to modify. - - - - - - Optional arguments - - --state <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 - usage: manila cg-show <consistency_group> - -Show details about a consistency group. - - Positional arguments - - <consistency_group> - - - Name or ID of the consistency group. - - - - -
-
- manila cg-snapshot-create - usage: manila cg-snapshot-create [--name <name>] [--description <description>] - <consistency_group> - -Creates a new consistency group snapshot. - - Positional arguments - - <consistency_group> - - - Name or ID of the consistency group. - - - - - - Optional arguments - - --name <name> - - - Optional consistency group snapshot name. - (Default=None) - - - - - --description <description> - - - Optional consistency group snapshot description. - (Default=None) - - - - -
-
- manila cg-snapshot-delete - usage: manila cg-snapshot-delete [--force] <cg_snapshot> [<cg_snapshot> ...] - -Remove one or more consistency group snapshots. - - Positional arguments - - <cg_snapshot> - - - 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 - usage: manila cg-snapshot-list [--all-tenants [<0|1>]] [--limit <limit>] - [--offset <offset>] [--detailed DETAILED] - -List consistency group snapshots with filters. - - Optional arguments - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin only). - - - - - --limit <limit> - - - Maximum number of consistency group snapshots to - return.(Default=None) - - - - - --offset <offset> - - - Start position of consistency group snapshot listing. - - - - - --detailed DETAILED - - - Show detailed information about snapshots. - - - - -
-
- manila cg-snapshot-members - usage: manila cg-snapshot-members [--limit <limit>] [--offset <offset>] - <cg_snapshot> - -Get member details for a consistency group snapshot. - - Positional arguments - - <cg_snapshot> - - - Name or ID of the consistency group snapshot. - - - - - - Optional arguments - - --limit <limit> - - - Maximum number of shares to return. (Default=None) - - - - - --offset <offset> - - - Start position of security services listing. - - - - -
-
- manila cg-snapshot-reset-state - usage: manila cg-snapshot-reset-state [--state <state>] <cg_snapshot> - -Explicitly update the state of a consistency group. - - Positional arguments - - <cg_snapshot> - - - Name or ID of the consistency group snapshot. - - - - - - Optional arguments - - --state <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 - usage: manila cg-snapshot-show <cg_snapshot> - -Show details about a consistency group snapshot. - - Positional arguments - - <cg_snapshot> - - - Name or ID of the consistency group snapshot. - - - - -
-
- manila cg-snapshot-update - usage: manila cg-snapshot-update [--name <name>] [--description <description>] - <cg_snapshot> - -Update a consistency group snapshot. - - Positional arguments - - <cg_snapshot> - - - Name or ID of the cg snapshot to update. - - - - - - Optional arguments - - --name <name> - - - Optional new name for the cg snapshot. (Default=None - - - - - --description <description> - - - Optional cg snapshot description. (Default=None) - - - - -
-
- manila cg-update - usage: manila cg-update [--name <name>] [--description <description>] - <consistency_group> - -Update a consistency group. - - Positional arguments - - <consistency_group> - - - Name or ID of the consistency group to update. - - - - - - Optional arguments - - --name <name> - - - Optional new name for the consistency group. - (Default=None) - - - - - --description <description> - - - Optional consistency group description. (Default=None) - - - - -
-
- manila create - usage: manila create [--snapshot-id <snapshot-id>] [--name <name>] - [--metadata [<key=value> [<key=value> ...]]] - [--share-network <network-info>] - [--description <description>] [--share-type <share-type>] - [--public] [--availability-zone <availability-zone>] - [--consistency-group <consistency-group>] - <share_protocol> <size> - -Creates a new share (NFS, CIFS, GlusterFS or HDFS). - - Positional arguments - - <share_protocol> - - - Share type (NFS, CIFS, GlusterFS or HDFS). - - - - - <size> - - - Share size in GiB. - - - - - - Optional arguments - - --snapshot-id <snapshot-id> - - - Optional snapshot ID to create the share from. - (Default=None) - - - - - --name <name> - - - Optional share name. (Default=None) - - - - - --metadata [<key=value> [<key=value> ...]] - - - Metadata key=value pairs (Optional, Default=None). - - - - - --share-network <network-info> - - - Optional network info ID or name. - - - - - --description <description> - - - Optional share description. (Default=None) - - - - - --share-type <share-type>, --share_type <share-type>, --volume-type <share-type>, --volume_type <share-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>, --availability_zone <availability-zone>, --az <availability-zone> - - - Availability zone in which share should be created. - - - - - --consistency-group <consistency-group>, --consistency_group <consistency-group>, --cg <consistency-group> - - - Optional consistency group name or ID in which to - create the share. (Default=None) - - - - -
-
- manila credentials - usage: manila credentials - -Show user credentials returned from auth. - -
-
- manila delete - usage: manila delete [--consistency-group <consistency-group>] - <share> [<share> ...] - -Remove one or more shares. - - Positional arguments - - <share> - - - Name or ID of the share(s). - - - - - - Optional arguments - - --consistency-group <consistency-group>, --consistency_group <consistency-group>, --cg <consistency-group> - - - Optional consistency group name or ID which contains - the share. (Default=None) - - - - -
-
- manila endpoints - usage: manila endpoints - -Discover endpoints that get returned from the authenticate services. - -
-
- manila extend - usage: manila extend <share> <new_size> - -Increases the size of an existing share. - - Positional arguments - - <share> - - - Name or ID of share to extend. - - - - - <new_size> - - - New size of share, in GiBs. - - - - -
-
- manila extra-specs-list - usage: manila extra-specs-list - -Print a list of current 'share types and extra specs' (Admin Only). - -
-
- manila force-delete - usage: manila force-delete <share> [<share> ...] - -Attempt force-delete of share, regardless of state. - - Positional arguments - - <share> - - - Name or ID of the share(s) to force delete. - - - - -
-
- manila list - usage: manila list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] - [--share-server-id <share_server_id>] - [--metadata [<key=value> [<key=value> ...]]] - [--extra-specs [<key=value> [<key=value> ...]]] - [--share-type <share_type>] [--limit <limit>] - [--offset <offset>] [--sort-key <sort_key>] - [--sort-dir <sort_dir>] [--snapshot <snapshot>] - [--host <host>] [--share-network <share_network>] - [--project-id <project_id>] [--public] - [--consistency-group <consistency_group>] - [--columns <columns>] - -List NAS shares with filters. - - Optional arguments - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin only). - - - - - --name <name> - - - Filter results by name. - - - - - --status <status> - - - Filter results by status. - - - - - --share-server-id <share_server_id>, --share-server_id <share_server_id>, --share_server-id <share_server_id>, --share_server_id <share_server_id> - - - Filter results by share server ID. - - - - - --metadata [<key=value> [<key=value> ...]] - - - Filters results by a metadata key and value. OPTIONAL: - Default=None - - - - - --extra-specs [<key=value> [<key=value> ...]], --extra_specs [<key=value> [<key=value> ...]] - - - Filters results by a extra specs key and value of - share type that was used for share creation. OPTIONAL: - Default=None - - - - - --share-type <share_type>, --volume-type--share_type <share_type>, --share-type-id <share_type>, --volume-type-id <share_type>, --share-type_id <share_type>, --share_type-id <share_type>, --share_type_id <share_type>, --volume_type <share_type>, --volume_type_id <share_type> - - - Filter results by a share type id or name that was - used for share creation. - - - - - --limit <limit> - - - Maximum number of shares to return. OPTIONAL: - Default=None. - - - - - --offset <offset> - - - Set offset to define start point of share listing. - OPTIONAL: Default=None. - - - - - --sort-key <sort_key>, --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_dir <sort_dir> - - - Sort direction, available values are ('asc', 'desc'). - OPTIONAL: Default=None. - - - - - --snapshot <snapshot> - - - Filer results by snapshot name or id, that was used - for share. - - - - - --host <host> - - - Filter results by host. - - - - - --share-network <share_network>, --share_network <share_network> - - - Filter results by share-network name or id. - - - - - --project-id <project_id>, --project_id <project_id> - - - Filter results by project id. Useful with set key - '--all-tenants'. - - - - - --public - - - Add public shares from all tenants to result. - - - - - --consistency-group <consistency_group>, --consistency_group <consistency_group>, --cg <consistency_group> - - - Filter results by consistency group name or ID. - - - - - --columns <columns> - - - Comma separated list of columns to be displayed e.g. - --columns "export_location,is public" - - - - -
-
- manila list-extensions - usage: manila list-extensions - -List all the os-api extensions that are available. - -
-
- manila manage - usage: manila manage [--name <name>] [--description <description>] - [--share_type <share-type>] - [--driver_options [<key=value> [<key=value> ...]]] - [--public] - <service_host> <protocol> <export_path> - -Manage share not handled by Manila. - - Positional arguments - - <service_host> - - - manage-share service host: some.host@driver#pool - - - - - <protocol> - - - Protocol of the share to manage, such as NFS or CIFS. - - - - - <export_path> - - - Share export path, NFS share such as: - 10.0.0.1:/foo_path, CIFS share such as: - \\10.0.0.1\foo_name_of_cifs_share - - - - - - Optional arguments - - --name <name> - - - Optional share name. (Default=None) - - - - - --description <description> - - - Optional share description. (Default=None) - - - - - --share_type <share-type>, --share-type <share-type> - - - Optional share type assigned to share. (Default=None) - - - - - --driver_options [<key=value> [<key=value> ...]], --driver-options [<key=value> [<key=value> ...]] - - - 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 - usage: manila metadata <share> <action> <key=value> [<key=value> ...] - -Set or delete metadata on a share. - - Positional arguments - - <share> - - - Name or ID of the share to update metadata on. - - - - - <action> - - - Actions: 'set' or 'unset'. - - - - - <key=value> - - - Metadata to set or unset (key is only necessary on unset). - - - - -
-
- manila metadata-show - usage: manila metadata-show <share> - -Show metadata of given share. - - Positional arguments - - <share> - - - Name or ID of the share. - - - - -
-
- manila metadata-update-all - usage: manila metadata-update-all <share> <key=value> [<key=value> ...] - -Update all metadata of a share. - - Positional arguments - - <share> - - - Name or ID of the share to update metadata on. - - - - - <key=value> - - - Metadata entry or entries to update. - - - - -
-
- manila migrate - usage: manila migrate [--force-host-copy <True|False>] <share> <host#pool> - -Migrates share to a new host. - - Positional arguments - - <share> - - - Name or ID of share to migrate. - - - - - <host#pool> - - - Destination host and pool. - - - - - - Optional arguments - - --force-host-copy <True|False> - - - Enables or disables generic host-based force- - migration, which bypasses driver optimizations. - Default=False. - - - - -
-
- manila pool-list - usage: manila pool-list [--host <host>] [--backend <backend>] [--pool <pool>] - -List all backend storage pools known to the scheduler (Admin only). - - Optional arguments - - --host <host> - - - Filter results by host name. Regular expressions are - supported. - - - - - --backend <backend> - - - Filter results by backend name. Regular expressions are - supported. - - - - - --pool <pool> - - - Filter results by pool name. Regular expressions are - supported. - - - - -
-
- manila quota-class-show - usage: manila quota-class-show <class> - -List the quotas for a quota class. - - Positional arguments - - <class> - - - Name of quota class to list the quotas for. - - - - -
-
- manila quota-class-update - usage: manila quota-class-update [--shares <shares>] [--snapshots <snapshots>] - [--gigabytes <gigabytes>] - [--snapshot-gigabytes <snapshot_gigabytes>] - [--share-networks <share-networks>] - <class-name> - -Update the quotas for a quota class. - - Positional arguments - - <class-name> - - - Name of quota class to set the quotas for. - - - - - - Optional arguments - - --shares <shares> - - - New value for the "shares" quota. - - - - - --snapshots <snapshots> - - - New value for the "snapshots" quota. - - - - - --gigabytes <gigabytes> - - - New value for the "gigabytes" quota. - - - - - --snapshot-gigabytes <snapshot_gigabytes>, --snapshot_gigabytes <snapshot_gigabytes> - - - New value for the "snapshot_gigabytes" quota. - - - - - --share-networks <share-networks>, --share_networks <share-networks> - - - New value for the "share_networks" quota. - - - - -
-
- manila quota-defaults - usage: manila quota-defaults [--tenant <tenant-id>] - -List the default quotas for a tenant. - - Optional arguments - - --tenant <tenant-id> - - - ID of tenant to list the default quotas for. - - - - -
-
- manila quota-delete - usage: manila quota-delete [--tenant <tenant-id>] [--user <user-id>] - -Delete quota for a tenant/user. The quota will revert back to default. - - Optional arguments - - --tenant <tenant-id> - - - ID of tenant to delete quota for. - - - - - --user <user-id> - - - ID of user to delete quota for. - - - - -
-
- manila quota-show - usage: manila quota-show [--tenant <tenant-id>] [--user <user-id>] - -List the quotas for a tenant/user. - - Optional arguments - - --tenant <tenant-id> - - - ID of tenant to list the quotas for. - - - - - --user <user-id> - - - ID of user to list the quotas for. - - - - -
-
- manila quota-update - usage: manila quota-update [--user <user-id>] [--shares <shares>] - [--snapshots <snapshots>] [--gigabytes <gigabytes>] - [--snapshot-gigabytes <snapshot_gigabytes>] - [--share-networks <share-networks>] [--force] - <tenant_id> - -Update the quotas for a tenant/user. - - Positional arguments - - <tenant_id> - - - UUID of tenant to set the quotas for. - - - - - - Optional arguments - - --user <user-id> - - - ID of user to set the quotas for. - - - - - --shares <shares> - - - New value for the "shares" quota. - - - - - --snapshots <snapshots> - - - New value for the "snapshots" quota. - - - - - --gigabytes <gigabytes> - - - New value for the "gigabytes" quota. - - - - - --snapshot-gigabytes <snapshot_gigabytes>, --snapshot_gigabytes <snapshot_gigabytes> - - - New value for the "snapshot_gigabytes" quota. - - - - - --share-networks <share-networks> - - - New value for the "share_networks" quota. - - - - - --force - - - Whether force update the quota even if the already - used and reserved exceeds the new quota. - - - - -
-
- manila rate-limits - usage: manila rate-limits - -Print a list of rate limits for a user. - -
-
- manila reset-state - usage: manila reset-state [--state <state>] <share> - -Explicitly update the state of a share. - - Positional arguments - - <share> - - - Name or ID of the share to modify. - - - - - - Optional arguments - - --state <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 - usage: manila security-service-create [--dns-ip <dns_ip>] [--server <server>] - [--domain <domain>] [--user <user>] - [--password <password>] [--name <name>] - [--description <description>] - <type> - -Create security service used by tenant. - - Positional arguments - - <type> - - - Security service type: 'ldap', 'kerberos' or - 'active_directory'. - - - - - - Optional arguments - - --dns-ip <dns_ip> - - - DNS IP address used inside tenant's network. - - - - - --server <server> - - - Security service IP address or hostname. - - - - - --domain <domain> - - - Security service domain. - - - - - --user <user> - - - Security service user or group used by tenant. - - - - - --password <password> - - - Password used by user. - - - - - --name <name> - - - Security service name. - - - - - --description <description> - - - Security service description. - - - - -
-
- manila security-service-delete - usage: manila security-service-delete <security-service> - -Delete security service. - - Positional arguments - - <security-service> - - - Security service name or ID to delete. - - - - -
-
- manila security-service-list - usage: manila security-service-list [--all-tenants [<0|1>]] - [--share-network <share_network>] - [--status <status>] [--name <name>] - [--type <type>] [--user <user>] - [--dns-ip <dns_ip>] [--server <server>] - [--domain <domain>] [--detailed [<0|1>]] - [--offset <offset>] [--limit <limit>] - -Get a list of security services. - - Optional arguments - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin only). - - - - - --share-network <share_network>, --share_network <share_network> - - - Filter results by share network id or name. - - - - - --status <status> - - - Filter results by status. - - - - - --name <name> - - - Filter results by name. - - - - - --type <type> - - - Filter results by type. - - - - - --user <user> - - - Filter results by user or group used by tenant. - - - - - --dns-ip <dns_ip>, --dns_ip <dns_ip> - - - Filter results by DNS IP address used inside tenant's - network. - - - - - --server <server> - - - Filter results by security service IP address or - hostname. - - - - - --domain <domain> - - - Filter results by domain. - - - - - --detailed [<0|1>] - - - Show detailed information about filtered security - services. - - - - - --offset <offset> - - - Start position of security services listing. - - - - - --limit <limit> - - - Number of security services to return per request. - - - - -
-
- manila security-service-show - usage: manila security-service-show <security-service> - -Show security service. - - Positional arguments - - <security-service> - - - Security service name or ID to show. - - - - -
-
- manila security-service-update - usage: manila security-service-update [--dns-ip <dns-ip>] [--server <server>] - [--domain <domain>] [--user <user>] - [--password <password>] [--name <name>] - [--description <description>] - <security-service> - -Update security service. - - Positional arguments - - <security-service> - - - Security service name or ID to update. - - - - - - Optional arguments - - --dns-ip <dns-ip> - - - DNS IP address used inside tenant's network. - - - - - --server <server> - - - Security service IP address or hostname. - - - - - --domain <domain> - - - Security service domain. - - - - - --user <user> - - - Security service user or group used by tenant. - - - - - --password <password> - - - Password used by user. - - - - - --name <name> - - - Security service name. - - - - - --description <description> - - - Security service description. - - - - -
-
- manila service-disable - usage: manila service-disable <hostname> <binary> - -Disables 'manila-share' or 'manila-scheduler' services. - - Positional arguments - - <hostname> - - - Host name as 'foo_host@bar_backend'. - - - - - <binary> - - - Service binary, could be 'manila-share' or 'manila-scheduler'. - - - - -
-
- manila service-enable - usage: manila service-enable <hostname> <binary> - -Enables 'manila-share' or 'manila-scheduler' services. - - Positional arguments - - <hostname> - - - Host name as 'foo_host@bar_backend'. - - - - - <binary> - - - Service binary, could be 'manila-share' or 'manila-scheduler'. - - - - -
-
- manila service-list - usage: manila service-list [--host <hostname>] [--binary <binary>] - [--status <status>] [--state <state>] - [--zone <zone>] - -List all services. - - Optional arguments - - --host <hostname> - - - Name of host. - - - - - --binary <binary> - - - Service binary. - - - - - --status <status> - - - Filter results by status. - - - - - --state <state> - - - Filter results by state. - - - - - --zone <zone> - - - Availability zone. - - - - -
-
- manila share-instance-force-delete - usage: manila share-instance-force-delete <instance> [<instance> ...] - -Attempt force-delete of share instance, regardless of state. - - Positional arguments - - <instance> - - - Name or ID of the instance(s) to force delete. - - - - -
-
- manila share-instance-list - usage: manila share-instance-list [--share-id <share_id>] - -List share instances. - - Optional arguments - - --share-id <share_id>, --share_id <share_id> - - - Filter results by share ID. - - - - -
-
- manila share-instance-reset-state - usage: manila share-instance-reset-state [--state <state>] <instance> - -Explicitly update the state of a share instance. - - Positional arguments - - <instance> - - - Name or ID of the share instance to modify. - - - - - - Optional arguments - - --state <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 - usage: manila share-instance-show <instance> - -Show details about a share instance. - - Positional arguments - - <instance> - - - Name or ID of the share instance. - - - - -
-
- manila share-network-create - usage: manila share-network-create [--nova-net-id <nova-net-id>] - [--neutron-net-id <neutron-net-id>] - [--neutron-subnet-id <neutron-subnet-id>] - [--name <name>] - [--description <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 <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_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 <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 <name> - - - Share network name. - - - - - --description <description> - - - Share network description. - - - - -
-
- manila share-network-delete - usage: manila share-network-delete <share-network> - -Delete share network. - - Positional arguments - - <share-network> - - - Name or ID of share network to be deleted. - - - - -
-
- manila share-network-list - usage: manila share-network-list [--all-tenants [<0|1>]] - [--project-id <project_id>] [--name <name>] - [--created-since <created_since>] - [--created-before <created_before>] - [--security-service <security_service>] - [--nova-net-id <nova_net_id>] - [--neutron-net-id <neutron_net_id>] - [--neutron-subnet-id <neutron_subnet_id>] - [--network-type <network_type>] - [--segmentation-id <segmentation_id>] - [--cidr <cidr>] [--ip-version <ip_version>] - [--offset <offset>] [--limit <limit>] - -Get a list of network info. - - Optional arguments - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin only). - - - - - --project-id <project_id>, --project_id <project_id> - - - Filter results by project ID. - - - - - --name <name> - - - Filter results by name. - - - - - --created-since <created_since>, --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>, --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>, --security_service <security_service> - - - Filter results by attached security service. - - - - - --nova-net-id <nova_net_id>, --nova_net_id <nova_net_id>, --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>, --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>, --neutron-subnet_id <neutron_subnet_id>, --neutron_subnet-id <neutron_subnet_id> - - - Filter results by neutron subnet ID. - - - - - --network-type <network_type>, --network_type <network_type> - - - Filter results by network type. - - - - - --segmentation-id <segmentation_id>, --segmentation_id <segmentation_id> - - - Filter results by segmentation ID. - - - - - --cidr <cidr> - - - Filter results by CIDR. - - - - - --ip-version <ip_version>, --ip_version <ip_version> - - - Filter results by IP version. - - - - - --offset <offset> - - - Start position of share networks listing. - - - - - --limit <limit> - - - Number of share networks to return per request. - - - - -
-
- manila share-network-security-service-add - usage: manila share-network-security-service-add <share-network> - <security-service> - -Associate security service with share network. - - Positional arguments - - <share-network> - - - Share network name or ID. - - - - - <security-service> - - - Security service name or ID to associate with. - - - - -
-
- manila share-network-security-service-list - usage: manila share-network-security-service-list <share-network> - -Get list of security services associated with a given share network. - - Positional arguments - - <share-network> - - - Share network name or ID. - - - - -
-
- manila share-network-security-service-remove - usage: manila share-network-security-service-remove <share-network> - <security-service> - -Dissociate security service from share network. - - Positional arguments - - <share-network> - - - Share network name or ID. - - - - - <security-service> - - - Security service name or ID to dissociate. - - - - -
-
- manila share-network-show - usage: manila share-network-show <share-network> - -Get a description for network used by the tenant. - - Positional arguments - - <share-network> - - - Name or ID of the share network to show. - - - - -
-
- manila share-network-update - usage: manila share-network-update [--nova-net-id <nova-net-id>] - [--neutron-net-id <neutron-net-id>] - [--neutron-subnet-id <neutron-subnet-id>] - [--name <name>] - [--description <description>] - <share-network> - -Update share network data. - - Positional arguments - - <share-network> - - - 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 <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_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 <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 <name> - - - Share network name. - - - - - --description <description> - - - Share network description. - - - - -
-
- manila share-server-delete - usage: manila share-server-delete <id> - -Delete share server. - - Positional arguments - - <id> - - - ID of share server. - - - - -
-
- manila share-server-details - usage: manila share-server-details <id> - -Show share server details. - - Positional arguments - - <id> - - - ID of share server. - - - - -
-
- manila share-server-list - usage: manila share-server-list [--host <hostname>] [--status <status>] - [--share-network <share_network>] - [--project-id <project_id>] - -List all share servers. - - Optional arguments - - --host <hostname> - - - Filter results by name of host. - - - - - --status <status> - - - Filter results by status. - - - - - --share-network <share_network> - - - Filter results by share network. - - - - - --project-id <project_id> - - - Filter results by project ID. - - - - -
-
- manila share-server-show - usage: manila share-server-show <id> - -Show share server info. - - Positional arguments - - <id> - - - ID of share server. - - - - -
-
- manila show - usage: manila show <share> - -Show details about a NAS share. - - Positional arguments - - <share> - - - Name or ID of the NAS share. - - - - -
-
- manila shrink - usage: manila shrink <share> <new_size> - -Decreases the size of an existing share. - - Positional arguments - - <share> - - - Name or ID of share to shrink. - - - - - <new_size> - - - New size of share, in GiBs. - - - - -
-
- manila snapshot-create - usage: manila snapshot-create [--force <True|False>] [--name <name>] - [--description <description>] - <share> - -Add a new snapshot. - - Positional arguments - - <share> - - - Name or ID of the share to snapshot. - - - - - - Optional arguments - - --force <True|False> - - - Optional flag to indicate whether to snapshot a share - even if it's busy. (Default=False) - - - - - --name <name> - - - Optional snapshot name. (Default=None) - - - - - --description <description> - - - Optional snapshot description. (Default=None) - - - - -
-
- manila snapshot-delete - usage: manila snapshot-delete <snapshot> - -Remove a snapshot. - - Positional arguments - - <snapshot> - - - Name or ID of the snapshot to delete. - - - - -
-
- manila snapshot-force-delete - usage: manila snapshot-force-delete <snapshot> - -Attempt force-delete of snapshot, regardless of state. - - Positional arguments - - <snapshot> - - - Name or ID of the snapshot to force delete. - - - - -
-
- manila snapshot-list - usage: manila snapshot-list [--all-tenants [<0|1>]] [--name <name>] - [--status <status>] [--share-id <share_id>] - [--usage [any|used|unused]] [--limit <limit>] - [--offset <offset>] [--sort-key <sort_key>] - [--sort-dir <sort_dir>] - -List all the snapshots. - - Optional arguments - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin only). - - - - - --name <name> - - - Filter results by name. - - - - - --status <status> - - - Filter results by status. - - - - - --share-id <share_id>, --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 <limit> - - - Maximum number of share snapshots to return. OPTIONAL: - Default=None. - - - - - --offset <offset> - - - Set offset to define start point of share snapshots - listing. OPTIONAL: Default=None. - - - - - --sort-key <sort_key>, --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_dir <sort_dir> - - - Sort direction, available values are ('asc', 'desc'). - OPTIONAL: Default=None. - - - - -
-
- manila snapshot-rename - usage: manila snapshot-rename [--description <description>] - <snapshot> [<name>] - -Rename a snapshot. - - Positional arguments - - <snapshot> - - - Name or ID of the snapshot to rename. - - - - - <name> - - - New name for the snapshot. - - - - - - Optional arguments - - --description <description> - - - Optional snapshot description. (Default=None) - - - - -
-
- manila snapshot-reset-state - usage: manila snapshot-reset-state [--state <state>] <snapshot> - -Explicitly update the state of a snapshot. - - Positional arguments - - <snapshot> - - - Name or ID of the snapshot to modify. - - - - - - Optional arguments - - --state <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 - usage: manila snapshot-show <snapshot> - -Show details about a snapshot. - - Positional arguments - - <snapshot> - - - Name or ID of the snapshot. - - - - -
-
- manila type-access-add - usage: manila type-access-add <share_type> <project_id> - -Adds share type access for the given project. - - Positional arguments - - <share_type> - - - Share type name or ID to add access for the given project. - - - - - <project_id> - - - Project ID to add share type access for. - - - - -
-
- manila type-access-list - usage: manila type-access-list <share_type> - -Print access information about the given share type. - - Positional arguments - - <share_type> - - - Filter results by share type name or ID. - - - - -
-
- manila type-access-remove - usage: manila type-access-remove <share_type> <project_id> - -Removes share type access for the given project. - - Positional arguments - - <share_type> - - - Share type name or ID to remove access for the given project. - - - - - <project_id> - - - Project ID to remove share type access for. - - - - -
-
- manila type-create - usage: manila type-create [--snapshot_support <snapshot_support>] - [--is_public <is_public>] - <name> <spec_driver_handles_share_servers> - -Create a new share type. - - Positional arguments - - <name> - - - Name of the new share type. - - - - - <spec_driver_handles_share_servers> - - - Required extra specification. Valid values are - 'true'/'1' and 'false'/'0' - - - - - - Optional arguments - - --snapshot_support <snapshot_support>, --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>, --is-public <is_public> - - - Make type accessible to the public (default true). - - - - -
-
- manila type-delete - usage: manila type-delete <id> - -Delete a specific share type. - - Positional arguments - - <id> - - - Name or ID of the share type to delete. - - - - -
-
- manila type-key - usage: manila type-key <stype> <action> [<key=value> [<key=value> ...]] - -Set or unset extra_spec for a share type. - - Positional arguments - - <stype> - - - Name or ID of the share type. - - - - - <action> - - - Actions: 'set' or 'unset'. - - - - - <key=value> - - - Extra_specs to set or unset (key is only necessary on unset). - - - - -
-
- manila type-list - usage: manila type-list [--all] - -Print a list of available 'share types'. - - Optional arguments - - --all - - - Display all share types (Admin only). - - - - -
-
- manila unmanage - usage: manila unmanage <share> - -Unmanage share. - - Positional arguments - - <share> - - - Name or ID of the share(s). - - - - -
-
- manila update - usage: manila update [--name <name>] [--description <description>] - [--is-public <is_public>] - <share> - -Rename a share. - - Positional arguments - - <share> - - - Name or ID of the share to rename. - - - - - - Optional arguments - - --name <name> - - - New name for the share. - - - - - --description <description> - - - Optional share description. (Default=None) - - - - - --is-public <is_public>, --is_public <is_public> - - - Public share is visible for all tenants. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_mistral_commands.xml b/doc/cli-reference/generated/ch_cli_mistral_commands.xml deleted file mode 100644 index 8bf6af21e1..0000000000 --- a/doc/cli-reference/generated/ch_cli_mistral_commands.xml +++ /dev/null @@ -1,1808 +0,0 @@ - - - - - - - - Workflow service command-line client - - The mistral client is the command-line - interface (CLI) for the Workflow service API and its extensions. - - This chapter documents mistral version - 1.2.0. - - - For help on a specific mistral - command, enter: - - $ mistral COMMAND - -
- mistral usage - usage: mistral [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] - [--os-mistral-url MISTRAL_URL] - [--os-mistral-version MISTRAL_VERSION] - [--os-mistral-service-type SERVICE_TYPE] - [--os-mistral-endpoint-type ENDPOINT_TYPE] - [--os-username USERNAME] [--os-password PASSWORD] - [--os-tenant-id TENANT_ID] [--os-tenant-name TENANT_NAME] - [--os-auth-token TOKEN] [--os-auth-url AUTH_URL] - [--os-cacert CACERT] [--insecure] -
-
- mistral 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-mistral-url MISTRAL_URL - - - Mistral API host (Env: OS_MISTRAL_URL) - - - - - --os-mistral-version MISTRAL_VERSION - - - Mistral API version (default = v2) (Env: - OS_MISTRAL_VERSION) - - - - - --os-mistral-service-type SERVICE_TYPE - - - Mistral service-type (should be the same name - as in keystone-endpoint) (default = - workflowv2) (Env: OS_MISTRAL_SERVICE_TYPE) - - - - - --os-mistral-endpoint-type ENDPOINT_TYPE - - - Mistral endpoint-type (should be the same name - as in keystone-endpoint) (default = publicURL) - (Env: OS_MISTRAL_ENDPOINT_TYPE) - - - - - --os-username USERNAME - - - Authentication username (Env: OS_USERNAME) - - - - - --os-password PASSWORD - - - Authentication password (Env: OS_PASSWORD) - - - - - --os-tenant-id TENANT_ID - - - Authentication tenant identifier (Env: - OS_TENANT_ID) - - - - - --os-tenant-name TENANT_NAME - - - Authentication tenant name (Env: - OS_TENANT_NAME) - - - - - --os-auth-token TOKEN - - - Authentication token (Env: OS_AUTH_TOKEN) - - - - - --os-auth-url AUTH_URL - - - Authentication URL (Env: OS_AUTH_URL) - - - - - --os-cacert CACERT - - - Authentication CA Certificate (Env: OS_CACERT) - - - - - --insecure - - - Disables SSL/TLS certificate verification - (Env: MISTRALCLIENT_INSECURE) - - - - -
-
- mistral action-create - usage: mistral action-create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--public] - definition - -Create new action. - - Positional arguments - - definition - - - Action definition file - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --public - - - With this flag action will be marked as "public". - - - - -
-
- mistral action-delete - usage: mistral action-delete [-h] name [name ...] - -Delete action. - - Positional arguments - - name - - - Name of action(s). - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-execution-delete - usage: mistral action-execution-delete [-h] id [id ...] - -Delete action execution. - - Positional arguments - - id - - - Id of action execution identifier(s). - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-execution-get - usage: mistral action-execution-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - id - -Show specific Action execution. - - Positional arguments - - id - - - Action execution ID. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-execution-get-input - usage: mistral action-execution-get-input [-h] id - -Show Action execution input data. - - Positional arguments - - id - - - Action execution ID. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-execution-get-output - usage: mistral action-execution-get-output [-h] id - -Show Action execution output data. - - Positional arguments - - id - - - Action execution ID. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-execution-list - usage: mistral action-execution-list [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [task_execution_id] - -List all Action executions. - - Positional arguments - - task_execution_id - - - Task execution ID. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-execution-update - usage: mistral action-execution-update [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--state {IDLE,RUNNING,SUCCESS,ERROR}] - [--output OUTPUT] - id - -Update specific Action execution. - - Positional arguments - - id - - - Action execution ID. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --state {IDLE,RUNNING,SUCCESS,ERROR} - - - Action execution state - - - - - --output OUTPUT - - - Action execution output - - - - -
-
- mistral action-get - usage: mistral action-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--prefix PREFIX] - name - -Show specific action. - - Positional arguments - - name - - - Action name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-get-definition - usage: mistral action-get-definition [-h] name - -Show action definition. - - Positional arguments - - name - - - Action name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-list - usage: mistral action-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List all actions. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral action-update - usage: mistral action-update [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--public] - definition - -Update action. - - Positional arguments - - definition - - - Action definition file - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --public - - - With this flag action will be marked as "public". - - - - -
-
- mistral cron-trigger-create - usage: mistral cron-trigger-create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--params PARAMS] [--pattern <* * * * *>] - [--first-time <YYYY-MM-DD HH:MM>] - [--count <integer>] - name workflow_name [workflow_input] - -Create new trigger. - - Positional arguments - - name - - - Cron trigger name - - - - - workflow_name - - - Workflow name - - - - - workflow_input - - - Workflow input - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --params PARAMS - - - Workflow params - - - - - --pattern <* * * * *> - - - Cron trigger pattern - - - - - --first-time <YYYY-MM-DD HH:MM> - - - Date and time of the first execution - - - - - --count <integer> - - - Number of wanted executions - - - - -
-
- mistral cron-trigger-delete - usage: mistral cron-trigger-delete [-h] name [name ...] - -Delete trigger. - - Positional arguments - - name - - - Name of cron trigger(s). - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral cron-trigger-get - usage: mistral cron-trigger-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - name - -Show specific cron trigger. - - Positional arguments - - name - - - Cron trigger name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral cron-trigger-list - usage: mistral cron-trigger-list [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List all cron triggers. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral environment-create - usage: mistral environment-create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - file - -Create new environment. - - Positional arguments - - file - - - Environment configuration file in JSON or YAML - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral environment-delete - usage: mistral environment-delete [-h] name [name ...] - -Delete environment. - - Positional arguments - - name - - - Name of environment(s). - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral environment-get - usage: mistral environment-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - name - -Show specific environment. - - Positional arguments - - name - - - Environment name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral environment-list - usage: mistral environment-list [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List all environments. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral environment-update - usage: mistral environment-update [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - file - -Update environment. - - Positional arguments - - file - - - Environment configuration file in JSON or YAML - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral execution-create - usage: mistral execution-create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [-d DESCRIPTION] - workflow_name [workflow_input] [params] - -Create new execution. - - Positional arguments - - workflow_name - - - Workflow name - - - - - workflow_input - - - Workflow input - - - - - params - - - Workflow additional parameters - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -d DESCRIPTION, --description DESCRIPTION - - - Execution description - - - - -
-
- mistral execution-delete - usage: mistral execution-delete [-h] id [id ...] - -Delete execution. - - Positional arguments - - id - - - Id of execution identifier(s). - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral execution-get - usage: mistral execution-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - id - -Show specific execution. - - Positional arguments - - id - - - Execution identifier - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral execution-get-input - usage: mistral execution-get-input [-h] id - -Show execution input data. - - Positional arguments - - id - - - Execution ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral execution-get-output - usage: mistral execution-get-output [-h] id - -Show execution output data. - - Positional arguments - - id - - - Execution ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral execution-list - usage: mistral execution-list [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--marker [MARKER]] [--limit [LIMIT]] - [--sort_keys [SORT_KEYS]] - [--sort_dirs [SORT_DIRS]] - -List all executions. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --marker [MARKER] - - - The last execution uuid of the previous page, displays - list of executions after "marker". - - - - - --limit [LIMIT] - - - Maximum number of executions to return in a single - result. - - - - - --sort_keys [SORT_KEYS] - - - Comma-separated list of sort keys to sort results by. - Default: created_at. Example: mistral execution-list - --sort_keys=id,description - - - - - --sort_dirs [SORT_DIRS] - - - Comma-separated list of sort directions. Default: asc. - Example: mistral execution-list - --sort_keys=id,description --sort_dirs=asc,desc - - - - -
-
- mistral execution-update - usage: mistral execution-update [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - (-s {RUNNING,PAUSED,SUCCESS,ERROR} | -d DESCRIPTION) - id - -Update execution. - - Positional arguments - - id - - - Execution identifier - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -s {RUNNING,PAUSED,SUCCESS,ERROR}, --state {RUNNING,PAUSED,SUCCESS,ERROR} - - - Execution state - - - - - -d DESCRIPTION, --description DESCRIPTION - - - Execution description - - - - -
-
- mistral run-action - usage: mistral run-action [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--prefix PREFIX] [-s] [-t TARGET] - name [input] - -Create new Action execution or just run specific action. - - Positional arguments - - name - - - Action name to execute. - - - - - input - - - Action input. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -s, --save-result - - - Save the result into DB. - - - - - -t TARGET, --target TARGET - - - Action will be executed on <target> executor. - - - - -
-
- mistral service-list - usage: mistral service-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List all services. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral task-get - usage: mistral task-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] [--prefix PREFIX] - id - -Show specific task. - - Positional arguments - - id - - - Task identifier - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral task-get-published - usage: mistral task-get-published [-h] id - -Show task published variables. - - Positional arguments - - id - - - Task ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral task-get-result - usage: mistral task-get-result [-h] id - -Show task output data. - - Positional arguments - - id - - - Task ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral task-list - usage: mistral task-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [workflow_execution] - -List all tasks. - - Positional arguments - - workflow_execution - - - Workflow execution ID associated with list of Tasks. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral task-rerun - usage: mistral task-rerun [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--resume] - id - -Rerun an existing task. - - Positional arguments - - id - - - Task identifier - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --resume - - - rerun only failed or unstarted action executions for - with-items task - - - - -
-
- mistral workbook-create - usage: mistral workbook-create [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - definition - -Create new workbook. - - Positional arguments - - definition - - - Workbook definition file - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workbook-delete - usage: mistral workbook-delete [-h] name [name ...] - -Delete workbook. - - Positional arguments - - name - - - Name of workbook(s). - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workbook-get - usage: mistral workbook-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - name - -Show specific workbook. - - Positional arguments - - name - - - Workbook name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workbook-get-definition - usage: mistral workbook-get-definition [-h] name - -Show workbook definition. - - Positional arguments - - name - - - Workbook name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workbook-list - usage: mistral workbook-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List all workbooks. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workbook-update - usage: mistral workbook-update [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - definition - -Update workbook. - - Positional arguments - - definition - - - Workbook definition file - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workbook-validate - usage: mistral workbook-validate [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - definition - -Validate workbook. - - Positional arguments - - definition - - - Workbook definition file - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workflow-create - usage: mistral workflow-create [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--public] - definition - -Create new workflow. - - Positional arguments - - definition - - - Workflow definition file - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --public - - - With this flag workflow will be marked as "public". - - - - -
-
- mistral workflow-delete - usage: mistral workflow-delete [-h] name [name ...] - -Delete workflow. - - Positional arguments - - name - - - Name of workflow(s). - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workflow-get - usage: mistral workflow-get [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - name - -Show specific workflow. - - Positional arguments - - name - - - Workflow name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workflow-get-definition - usage: mistral workflow-get-definition [-h] name - -Show workflow definition. - - Positional arguments - - name - - - Workflow name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workflow-list - usage: mistral workflow-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] - [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List all workflows. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- mistral workflow-update - usage: mistral workflow-update [-h] [-f {csv,json,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--public] - definition - -Update workflow. - - Positional arguments - - definition - - - Workflow definition - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --public - - - With this flag workflow will be marked as "public". - - - - -
-
- mistral workflow-validate - usage: mistral workflow-validate [-h] [-f {json,shell,table,value,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - definition - -Validate workflow. - - Positional arguments - - definition - - - Workflow definition file - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_monasca_commands.xml b/doc/cli-reference/generated/ch_cli_monasca_commands.xml deleted file mode 100644 index eedfefe4b7..0000000000 --- a/doc/cli-reference/generated/ch_cli_monasca_commands.xml +++ /dev/null @@ -1,1443 +0,0 @@ - - - - - - - - Monitoring command-line client - - The monasca client is the command-line - interface (CLI) for the Monitoring API and its extensions. - - This chapter documents monasca version - 1.0.24. - - - For help on a specific monasca - command, enter: - - $ monasca COMMAND - -
- monasca usage - 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] - <subcommand> ... - <subcommand> - 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 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 - usage: monasca alarm-definition-create [--description <DESCRIPTION>] - [--severity <SEVERITY>] - [--match-by <DIMENSION_KEY1,DIMENSION_KEY2,...>] - [--alarm-actions <NOTIFICATION-ID>] - [--ok-actions <NOTIFICATION-ID>] - [--undetermined-actions <NOTIFICATION-ID>] - <ALARM_DEFINITION_NAME> <EXPRESSION> - -Create an alarm definition. - - Positional arguments - - <ALARM_DEFINITION_NAME> - - - Name of the alarm definition to create. - - - - - <EXPRESSION> - - - The alarm expression to evaluate. Quoted. - - - - - - Optional arguments - - --description <DESCRIPTION> - - - Description of the alarm. - - - - - --severity <SEVERITY> - - - Severity is one of [LOW, MEDIUM, HIGH, CRITICAL]. - - - - - --match-by <DIMENSION_KEY1,DIMENSION_KEY2,...> - - - 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 <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - ALARM. This param may be specified multiple times. - - - - - --ok-actions <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - OK. This param may be specified multiple times. - - - - - --undetermined-actions <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - UNDETERMINED. This param may be specified multiple - times. - - - - -
-
- monasca alarm-definition-delete - usage: monasca alarm-definition-delete <ALARM_DEFINITION_ID> - -Delete the alarm definition. - - Positional arguments - - <ALARM_DEFINITION_ID> - - - The ID of the alarm definition. - - - - -
-
- monasca alarm-definition-list - usage: monasca alarm-definition-list [--name <ALARM_DEFINITION_NAME>] - [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] - [--offset <OFFSET LOCATION>] - [--limit <RETURN LIMIT>] - -List alarm definitions for this tenant. - - Optional arguments - - --name <ALARM_DEFINITION_NAME> - - - Name of the alarm definition. - - - - - --dimensions <KEY1=VALUE1,KEY2=VALUE2...> - - - 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 <OFFSET LOCATION> - - - The offset used to paginate the return data. - - - - - --limit <RETURN LIMIT> - - - The amount of data to be returned up to the API - maximum limit. - - - - -
-
- monasca alarm-definition-patch - usage: monasca alarm-definition-patch [--name <ALARM_DEFINITION_NAME>] - [--description <DESCRIPTION>] - [--expression <EXPRESSION>] - [--alarm-actions <NOTIFICATION-ID>] - [--ok-actions <NOTIFICATION-ID>] - [--undetermined-actions <NOTIFICATION-ID>] - [--actions-enabled <ACTIONS-ENABLED>] - [--severity <SEVERITY>] - <ALARM_DEFINITION_ID> - -Patch the alarm definition. - - Positional arguments - - <ALARM_DEFINITION_ID> - - - The ID of the alarm definition. - - - - - - Optional arguments - - --name <ALARM_DEFINITION_NAME> - - - Name of the alarm definition. - - - - - --description <DESCRIPTION> - - - Description of the alarm. - - - - - --expression <EXPRESSION> - - - The alarm expression to evaluate. Quoted. - - - - - --alarm-actions <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - ALARM. This param may be specified multiple times. - - - - - --ok-actions <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - OK. This param may be specified multiple times. - - - - - --undetermined-actions <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - UNDETERMINED. This param may be specified multiple - times. - - - - - --actions-enabled <ACTIONS-ENABLED> - - - The actions-enabled boolean is one of [true,false] - - - - - --severity <SEVERITY> - - - Severity is one of [LOW, MEDIUM, HIGH, CRITICAL]. - - - - -
-
- monasca alarm-definition-show - usage: monasca alarm-definition-show <ALARM_DEFINITION_ID> - -Describe the alarm definition. - - Positional arguments - - <ALARM_DEFINITION_ID> - - - The ID of the alarm definition. - - - - -
-
- monasca alarm-definition-update - usage: monasca alarm-definition-update [--description <DESCRIPTION>] - [--alarm-actions <NOTIFICATION-ID>] - [--ok-actions <NOTIFICATION-ID>] - [--undetermined-actions <NOTIFICATION-ID>] - [--match-by <DIMENSION_KEY1,DIMENSION_KEY2,...>] - [--severity <SEVERITY>] - <ALARM_DEFINITION_ID> - <ALARM_DEFINITION_NAME> <EXPRESSION> - <ACTIONS-ENABLED> - -Update the alarm definition. - - Positional arguments - - <ALARM_DEFINITION_ID> - - - The ID of the alarm definition. - - - - - <ALARM_DEFINITION_NAME> - - - Name of the alarm definition. - - - - - <EXPRESSION> - - - The alarm expression to evaluate. Quoted. - - - - - <ACTIONS-ENABLED> - - - The actions-enabled boolean is one of [true,false] - - - - - - Optional arguments - - --description <DESCRIPTION> - - - Description of the alarm. - - - - - --alarm-actions <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - ALARM. This param may be specified multiple times. - - - - - --ok-actions <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - OK. This param may be specified multiple times. - - - - - --undetermined-actions <NOTIFICATION-ID> - - - The notification method to use when an alarm state is - UNDETERMINED. This param may be specified multiple - times. - - - - - --match-by <DIMENSION_KEY1,DIMENSION_KEY2,...> - - - 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> - - - Severity is one of [LOW, MEDIUM, HIGH, CRITICAL]. - - - - -
-
- monasca alarm-delete - usage: monasca alarm-delete <ALARM_ID> - -Delete the alarm. - - Positional arguments - - <ALARM_ID> - - - The ID of the alarm. - - - - -
-
- monasca alarm-history - usage: monasca alarm-history [--offset <OFFSET LOCATION>] - [--limit <RETURN LIMIT>] - <ALARM_ID> - -Alarm state transition history. - - Positional arguments - - <ALARM_ID> - - - The ID of the alarm. - - - - - - Optional arguments - - --offset <OFFSET LOCATION> - - - The offset used to paginate the return data. - - - - - --limit <RETURN LIMIT> - - - The amount of data to be returned up to the API - maximum limit. - - - - -
-
- monasca alarm-history-list - usage: monasca alarm-history-list [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] - [--starttime <UTC_START_TIME>] - [--endtime <UTC_END_TIME>] - [--offset <OFFSET LOCATION>] - [--limit <RETURN LIMIT>] - -List alarms state history. - - Optional arguments - - --dimensions <KEY1=VALUE1,KEY2=VALUE2...> - - - 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 <UTC_START_TIME> - - - measurements >= UTC time. format: - 2014-01-01T00:00:00Z. OR format: -120 (for previous 2 - hours) - - - - - --endtime <UTC_END_TIME> - - - measurements <= UTC time. format: - 2014-01-01T00:00:00Z. - - - - - --offset <OFFSET LOCATION> - - - The offset used to paginate the return data. - - - - - --limit <RETURN LIMIT> - - - The amount of data to be returned up to the API - maximum limit. - - - - -
-
- monasca alarm-list - usage: monasca alarm-list [--alarm-definition-id <ALARM_DEFINITION_ID>] - [--metric-name <METRIC_NAME>] - [--metric-dimensions <KEY1=VALUE1,KEY2=VALUE2...>] - [--state <ALARM_STATE>] - [--state-updated-start-time <UTC_STATE_UPDATED_START>] - [--lifecycle-state <LIFECYCLE_STATE>] - [--link <LINK>] [--offset <OFFSET LOCATION>] - [--limit <RETURN LIMIT>] - -List alarms for this tenant. - - Optional arguments - - --alarm-definition-id <ALARM_DEFINITION_ID> - - - The ID of the alarm definition. - - - - - --metric-name <METRIC_NAME> - - - Name of the metric. - - - - - --metric-dimensions <KEY1=VALUE1,KEY2=VALUE2...> - - - 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> - - - ALARM_STATE is one of [UNDETERMINED, OK, ALARM]. - - - - - --state-updated-start-time <UTC_STATE_UPDATED_START> - - - Return all alarms whose state was updated on or after - the time specified - - - - - --lifecycle-state <LIFECYCLE_STATE> - - - The lifecycle state of the alarm - - - - - --link <LINK> - - - The link to external data associated with the alarm - - - - - --offset <OFFSET LOCATION> - - - The offset used to paginate the return data. - - - - - --limit <RETURN LIMIT> - - - The amount of data to be returned up to the API - maximum limit. - - - - -
-
- monasca alarm-patch - usage: monasca alarm-patch [--state <ALARM_STATE>] - [--lifecycle-state <LIFECYCLE_STATE>] - [--link <LINK>] - <ALARM_ID> - -Patch the alarm state. - - Positional arguments - - <ALARM_ID> - - - The ID of the alarm. - - - - - - Optional arguments - - --state <ALARM_STATE> - - - ALARM_STATE is one of [UNDETERMINED, OK, ALARM]. - - - - - --lifecycle-state <LIFECYCLE_STATE> - - - The lifecycle state of the alarm - - - - - --link <LINK> - - - A link to an external resource with information about - the alarm - - - - -
-
- monasca alarm-show - usage: monasca alarm-show <ALARM_ID> - -Describe the alarm. - - Positional arguments - - <ALARM_ID> - - - The ID of the alarm. - - - - -
-
- monasca alarm-update - usage: monasca alarm-update <ALARM_ID> <ALARM_STATE> <LIFECYCLE_STATE> <LINK> - -Update the alarm state. - - Positional arguments - - <ALARM_ID> - - - The ID of the alarm. - - - - - <ALARM_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 measurement-list - usage: monasca measurement-list [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] - [--endtime <UTC_END_TIME>] - [--offset <OFFSET LOCATION>] - [--limit <RETURN LIMIT>] [--merge_metrics] - <METRIC_NAME> <UTC_START_TIME> - -List measurements for the specified metric. - - Positional arguments - - <METRIC_NAME> - - - Name of the metric to list measurements. - - - - - <UTC_START_TIME> - - - measurements >= UTC time. format: - 2014-01-01T00:00:00Z. OR Format: -120 (previous 120 - minutes - - - - - - Optional arguments - - --dimensions <KEY1=VALUE1,KEY2=VALUE2...> - - - 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 <UTC_END_TIME> - - - measurements <= UTC time. format: - 2014-01-01T00:00:00Z. - - - - - --offset <OFFSET LOCATION> - - - The offset used to paginate the return data. - - - - - --limit <RETURN 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 - usage: monasca metric-create [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] - [--value-meta <KEY1=VALUE1,KEY2=VALUE2...>] - [--time <UNIX_TIMESTAMP>] - [--project-id <CROSS_PROJECT_ID>] - <METRIC_NAME> <METRIC_VALUE> - -Create metric. - - Positional arguments - - <METRIC_NAME> - - - Name of the metric to create. - - - - - <METRIC_VALUE> - - - Metric value. - - - - - - Optional arguments - - --dimensions <KEY1=VALUE1,KEY2=VALUE2...> - - - 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 <KEY1=VALUE1,KEY2=VALUE2...> - - - 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 <UNIX_TIMESTAMP> - - - Metric timestamp in milliseconds. Default: current - timestamp. - - - - - --project-id <CROSS_PROJECT_ID> - - - The Project ID to create metric on behalf of. Requires - monitoring-delegate role in keystone. - - - - -
-
- monasca metric-create-raw - usage: monasca metric-create-raw <JSON_BODY> - -Create metric from raw json body. - - Positional arguments - - <JSON_BODY> - - - The raw JSON body in single quotes. See api doc. - - - - -
-
- monasca metric-list - usage: monasca metric-list [--name <METRIC_NAME>] - [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] - [--offset <OFFSET LOCATION>] - [--limit <RETURN LIMIT>] - -List metrics for this tenant. - - Optional arguments - - --name <METRIC_NAME> - - - Name of the metric to list. - - - - - --dimensions <KEY1=VALUE1,KEY2=VALUE2...> - - - 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 <OFFSET LOCATION> - - - The offset used to paginate the return data. - - - - - --limit <RETURN LIMIT> - - - The amount of data to be returned up to the API - maximum limit. - - - - -
-
- monasca metric-statistics - usage: monasca metric-statistics [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] - [--endtime <UTC_END_TIME>] - [--period <PERIOD>] - [--offset <OFFSET LOCATION>] - [--limit <RETURN LIMIT>] [--merge_metrics] - <METRIC_NAME> <STATISTICS> <UTC_START_TIME> - -List measurement statistics for the specified metric. - - Positional arguments - - <METRIC_NAME> - - - Name of the metric to report measurement statistics. - - - - - <STATISTICS> - - - Statistics is one or more (separated by commas) of - [AVG, MIN, MAX, COUNT, SUM]. - - - - - <UTC_START_TIME> - - - measurements >= UTC time. format: - 2014-01-01T00:00:00Z. OR Format: -120 (previous 120 - minutes - - - - - - Optional arguments - - --dimensions <KEY1=VALUE1,KEY2=VALUE2...> - - - 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 <UTC_END_TIME> - - - measurements <= UTC time. format: - 2014-01-01T00:00:00Z. - - - - - --period <PERIOD> - - - number of seconds per interval (default is 300) - - - - - --offset <OFFSET LOCATION> - - - The offset used to paginate the return data. - - - - - --limit <RETURN 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 - usage: monasca notification-create <NOTIFICATION_NAME> <TYPE> <ADDRESS> - -Create notification. - - Positional arguments - - <NOTIFICATION_NAME> - - - Name of the notification to create. - - - - - <TYPE> - - - The notification type. Type must be EMAIL, WEBHOOK, or - PAGERDUTY. - - - - - <ADDRESS> - - - A valid EMAIL Address, URL, or SERVICE KEY - - - - -
-
- monasca notification-delete - usage: monasca notification-delete <NOTIFICATION_ID> - -Delete notification. - - Positional arguments - - <NOTIFICATION_ID> - - - The ID of the notification. - - - - -
-
- monasca notification-list - usage: monasca notification-list [--offset <OFFSET LOCATION>] - [--limit <RETURN LIMIT>] - -List notifications for this tenant. - - Optional arguments - - --offset <OFFSET LOCATION> - - - The offset used to paginate the return data. - - - - - --limit <RETURN LIMIT> - - - The amount of data to be returned up to the API - maximum limit. - - - - -
-
- monasca notification-show - usage: monasca notification-show <NOTIFICATION_ID> - -Describe the notification. - - Positional arguments - - <NOTIFICATION_ID> - - - The ID of the notification. If not specified returns all. - - - - -
-
- monasca notification-update - usage: monasca notification-update <NOTIFICATION_ID> <NOTIFICATION_NAME> - <TYPE> <ADDRESS> - -Update notification. - - Positional arguments - - <NOTIFICATION_ID> - - - The ID of the notification. - - - - - <NOTIFICATION_NAME> - - - Name of the notification. - - - - - <TYPE> - - - The notification type. Type must be either EMAIL, - WEBHOOK, or PAGERDUTY. - - - - - <ADDRESS> - - - A valid EMAIL Address, URL, or SERVICE KEY - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_murano_commands.xml b/doc/cli-reference/generated/ch_cli_murano_commands.xml deleted file mode 100644 index f66ef2ca7b..0000000000 --- a/doc/cli-reference/generated/ch_cli_murano_commands.xml +++ /dev/null @@ -1,1663 +0,0 @@ - - - - - - - - Application Catalog service command-line client - - The murano client is the command-line - interface (CLI) for the Application Catalog service API and its extensions. - - This chapter documents murano version - 0.8.0. - - - For help on a specific murano - command, enter: - - $ murano COMMAND - -
- murano usage - usage: murano [--version] [-d] [-v] [--cert-file OS_CERT] [--key-file OS_KEY] - [--ca-file OS_CACERT] [--api-timeout API_TIMEOUT] - [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] - [--os-region-name OS_REGION_NAME] - [--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth] - [--murano-url MURANO_URL] [--glance-url GLANCE_URL] - [--murano-api-version MURANO_API_VERSION] - [--os-service-type OS_SERVICE_TYPE] - [--os-endpoint-type OS_ENDPOINT_TYPE] [--include-password] - [--murano-repo-url MURANO_REPO_URL] [--insecure] - [--os-cacert <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] - [--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] - <subcommand> ... - - Subcommands - - app-show - - - List applications, added to specified environment. - - - - - bundle-import - - - Import a bundle. - - - - - bundle-save - - - Save a bundle. - - - - - category-create - - - Create a category. - - - - - category-delete - - - Delete a category. - - - - - category-list - - - List all available categories. - - - - - category-show - - - Display category details. - - - - - deployment-list - - - List deployments for an environment. - - - - - env-template-add-app - - - Add application to the environment template. - - - - - env-template-create - - - Create an environment template. - - - - - env-template-create-env - - - Create a new environment from template. - - - - - env-template-del-app - - - Delete application from the environment template. - - - - - env-template-delete - - - Delete an environment template. - - - - - env-template-list - - - List the environments templates. - - - - - env-template-show - - - Display environment template details. - - - - - env-template-update - - - Update an environment template. - - - - - environment-action-call - - - Call action `ACTION` in environment `ID`. - - - - - environment-action-get-result - - - Get result of `TASK` in environment `ID`. - - - - - environment-apps-edit - - - Edit environment's object model. - - - - - environment-create - - - Create an environment. - - - - - environment-delete - - - Delete an environment. - - - - - environment-deploy - - - Start deployment of a murano environment session. - - - - - environment-list - - - List the environments. - - - - - environment-rename - - - Rename an environment. - - - - - environment-session-create - - - Creates a new configuration session for environment - ID. - - - - - environment-show - - - Display environment details. - - - - - package-create - - - Create an application package. - - - - - package-delete - - - Delete a package. - - - - - package-download - - - Download a package to a filename or stdout. - - - - - package-import - - - Import a package. - - - - - package-list - - - List available packages. - - - - - package-save - - - Save a package. - - - - - package-show - - - Display details for a package. - - - - - package-update - - - Edit the package in question - - - - - bash-completion - - - Prints all of the commands and options to stdout. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - -
-
- murano optional arguments - - - --version - - - Show program's version number and exit. - - - - - -d, --debug - - - Defaults to env[MURANOCLIENT_DEBUG]. - - - - - -v, --verbose - - - Print more verbose output. - - - - - --cert-file OS_CERT - - - DEPRECATED! Use --os-cert. - - - - - --key-file OS_KEY - - - DEPRECATED! Use --os-key. - - - - - --ca-file OS_CACERT - - - DEPRECATED! Use --os-cacert. - - - - - --api-timeout API_TIMEOUT - - - Number of seconds to wait for an API response, - defaults to system socket timeout. - - - - - --os-tenant-id OS_TENANT_ID - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-tenant-name OS_TENANT_NAME - - - Defaults to env[OS_TENANT_NAME]. - - - - - --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]. - - - - - --murano-url MURANO_URL - - - Defaults to env[MURANO_URL]. - - - - - --glance-url GLANCE_URL - - - Defaults to env[GLANCE_URL]. - - - - - --murano-api-version MURANO_API_VERSION - - - Defaults to env[MURANO_API_VERSION] or 1. - - - - - --os-service-type OS_SERVICE_TYPE - - - Defaults to env[OS_SERVICE_TYPE]. - - - - - --os-endpoint-type OS_ENDPOINT_TYPE - - - Defaults to env[OS_ENDPOINT_TYPE]. - - - - - --include-password - - - Send os-username and os-password to murano. - - - - - --murano-repo-url MURANO_REPO_URL - - - Defaults to env[MURANO_REPO_URL] or - http://apps.openstack.org/api/v1/murano_repo/liberty/ - - - - - --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 <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - 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 - - - - -
-
- murano app-show - usage: murano app-show [-p <PATH>] <ID> - -List applications, added to specified environment. - - Positional arguments - - <ID> - - - Environment ID to show applications from. - - - - - - Optional arguments - - -p <PATH>, --path <PATH> - - - Level of detalization to show. Leave empty to browse - all applications in the environment. - - - - -
-
- murano bundle-import - usage: murano bundle-import [--is-public] [--exists-action {a,s,u}] - <FILE> [<FILE> ...] - -Import a bundle. `FILE` can be either a path to a zip file, URL, or name from -repo. If `FILE` is a local file, treat names of packages in a bundle as file -names, relative to location of the bundle file. Requirements are first -searched in the same directory. - - Positional arguments - - <FILE> - - - Bundle URL, bundle name, or path to the bundle file. - - - - - - Optional arguments - - --is-public - - - Make packages available to users from other tenants. - - - - - --exists-action {a,s,u} - - - Default action when a package already exists. - - - - -
-
- murano bundle-save - usage: murano bundle-save [-p <PATH>] [--no-images] <BUNDLE> - -Save a bundle. This will download a bundle of packages with all dependencies -to specified path. If path doesn't exist it will be created. - - Positional arguments - - <BUNDLE> - - - Bundle URL, bundle name, or path to the bundle file. - - - - - - Optional arguments - - -p <PATH>, --path <PATH> - - - Path to the directory to store packages. If not set - will use current directory. - - - - - --no-images - - - If set will skip images downloading. - - - - -
-
- murano category-create - usage: murano category-create <CATEGORY_NAME> - -Create a category. - - Positional arguments - - <CATEGORY_NAME> - - - Category name. - - - - -
-
- murano category-delete - usage: murano category-delete <ID> [<ID> ...] - -Delete a category. - - Positional arguments - - <ID> - - - ID of a category(ies) to delete. - - - - -
-
- murano category-list - usage: murano category-list - -List all available categories. - -
-
- murano category-show - usage: murano category-show <ID> - -Display category details. - - Positional arguments - - <ID> - - - ID of a category(s) to show. - - - - -
-
- murano deployment-list - usage: murano deployment-list <ID> - -List deployments for an environment. - - Positional arguments - - <ID> - - - Environment ID for which to list deployments. - - - - -
-
- murano env-template-add-app - usage: murano env-template-add-app <ENV_TEMPLATE_NAME> <FILE> - -Add application to the environment template. - - Positional arguments - - <ENV_TEMPLATE_NAME> - - - Environment template name. - - - - - <FILE> - - - Path to the template. - - - - -
-
- murano env-template-create - usage: murano env-template-create <ENV_TEMPLATE_NAME> - -Create an environment template. - - Positional arguments - - <ENV_TEMPLATE_NAME> - - - Environment template name. - - - - -
-
- murano env-template-create-env - usage: murano env-template-create-env <ID> <ENV_TEMPLATE_NAME> - -Create a new environment from template. - - Positional arguments - - <ID> - - - Environment template ID. - - - - - <ENV_TEMPLATE_NAME> - - - New environment name. - - - - -
-
- murano env-template-del-app - usage: murano env-template-del-app <ENV_TEMPLATE_ID> <ENV_TEMPLATE_APP_ID> - -Delete application from the environment template. - - Positional arguments - - <ENV_TEMPLATE_ID> - - - Environment template ID. - - - - - <ENV_TEMPLATE_APP_ID> - - - Application ID. - - - - -
-
- murano env-template-delete - usage: murano env-template-delete <ID> [<ID> ...] - -Delete an environment template. - - Positional arguments - - <ID> - - - ID of environment(s) template to delete. - - - - -
-
- murano env-template-list - usage: murano env-template-list - -List the environments templates. - -
-
- murano env-template-show - usage: murano env-template-show <ID> - -Display environment template details. - - Positional arguments - - <ID> - - - Environment template ID. - - - - -
-
- murano env-template-update - usage: murano env-template-update <ID> <ENV_TEMPLATE_NAME> - -Update an environment template. - - Positional arguments - - <ID> - - - Environment template ID. - - - - - <ENV_TEMPLATE_NAME> - - - Environment template name. - - - - -
-
- murano environment-action-call - usage: murano environment-action-call --action-id <ACTION> - [--arguments [<KEY=VALUE> [<KEY=VALUE> ...]]] - id - -Call action `ACTION` in environment `ID`. Returns id of an asynchronous task, -that executes the action. Actions can only be called on a `deployed` -environment. To view actions available in a given environment use -`environment-show` command. - - Positional arguments - - id - - - ID of Environment to call action against. - - - - - - Optional arguments - - --action-id <ACTION> - - - ID of action to run. - - - - - --arguments [<KEY=VALUE> [<KEY=VALUE> ...]] - - - Action arguments. - - - - -
-
- murano environment-action-get-result - usage: murano environment-action-get-result --task-id <TASK> <ID> - -Get result of `TASK` in environment `ID`. - - Positional arguments - - <ID> - - - ID of Environment where task is being executed. - - - - - - Optional arguments - - --task-id <TASK> - - - ID of action to run. - - - - -
-
- murano environment-apps-edit - usage: murano environment-apps-edit --session-id <SESSION_ID> <ID> [FILE] - -Edit environment's object model. `FILE` is path to a file, that contains -jsonpatch, that describes changes to be made to environment's object-model. [ -{ "op": "add", "path": "/-", "value": { ... your-app object model here ... } -}, { "op": "replace", "path": "/0/?/name", "value": "new_name" }, ] NOTE: -Values '===id1===', '===id2===', etc. in the resulting object-model will be -substituted with uuids. For more info on jsonpatch see RFC 6902 - - Positional arguments - - <ID> - - - ID of Environment to edit. - - - - - FILE - - - File to read jsonpatch from (defaults to stdin). - - - - - - Optional arguments - - --session-id <SESSION_ID> - - - Id of a config session. - - - - -
-
- murano environment-create - usage: murano environment-create [--join-net-id <NET_ID>] - [--join-subnet-id <SUBNET_ID>] - <ENVIRONMENT_NAME> - -Create an environment. - - Positional arguments - - <ENVIRONMENT_NAME> - - - Environment name. - - - - - - Optional arguments - - --join-net-id <NET_ID> - - - Network id to join. - - - - - --join-subnet-id <SUBNET_ID> - - - Subnetwork id to join. - - - - -
-
- murano environment-delete - usage: murano environment-delete [--abandon] <NAME or ID> [<NAME or ID> ...] - -Delete an environment. - - Positional arguments - - <NAME or ID> - - - Id or name of environment(s) to delete. - - - - - - Optional arguments - - --abandon - - - If set will abandon environment without deleting any of its - resources. - - - - -
-
- murano environment-deploy - usage: murano environment-deploy --session-id <SESSION> <ID> - -Start deployment of a murano environment session. - - Positional arguments - - <ID> - - - ID of Environment to deploy. - - - - - - Optional arguments - - --session-id <SESSION> - - - ID of configuration session to deploy. - - - - -
-
- murano environment-list - usage: murano environment-list [--all-tenants] - -List the environments. - - Optional arguments - - --all-tenants - - - Allows to list environments from all tenants (admin only). - - - - -
-
- murano environment-rename - usage: murano environment-rename <NAME or ID> <ENVIRONMENT_NAME> - -Rename an environment. - - Positional arguments - - <NAME or ID> - - - Environment ID or name. - - - - - <ENVIRONMENT_NAME> - - - A name to which the environment will be renamed. - - - - -
-
- murano environment-session-create - usage: murano environment-session-create <ID> - -Creates a new configuration session for environment ID. - - Positional arguments - - <ID> - - - ID of Environment to add session to. - - - - -
-
- murano environment-show - usage: murano environment-show [--session-id <SESSION_ID>] [--only-apps] - <NAME or ID> - -Display environment details. - - Positional arguments - - <NAME or ID> - - - Environment ID or name. - - - - - - Optional arguments - - --session-id <SESSION_ID> - - - Id of a config session. - - - - - --only-apps - - - Only print apps of the environment (useful for - automation). - - - - -
-
- murano package-create - usage: murano package-create [-t <HEAT_TEMPLATE>] [-c <CLASSES_DIRECTORY>] - [-r <RESOURCES_DIRECTORY>] [-n <DISPLAY_NAME>] - [-f <full-name>] [-a <AUTHOR>] - [--tags [<TAG1 TAG2> [<TAG1 TAG2> ...]]] - [-d <DESCRIPTION>] [-o <PACKAGE_NAME>] - [-u <UI_DEFINITION>] [--type TYPE] [-l <LOGO>] - -Create an application package. - - Optional arguments - - -t <HEAT_TEMPLATE>, --template <HEAT_TEMPLATE> - - - Path to the Heat template to import as an Application - Definition. - - - - - -c <CLASSES_DIRECTORY>, --classes-dir <CLASSES_DIRECTORY> - - - Path to the directory containing application classes. - - - - - -r <RESOURCES_DIRECTORY>, --resources-dir <RESOURCES_DIRECTORY> - - - Path to the directory containing application - resources. - - - - - -n <DISPLAY_NAME>, --name <DISPLAY_NAME> - - - Display name of the Application in Catalog. - - - - - -f <full-name>, --full-name <full-name> - - - Fully-qualified name of the Application in Catalog. - - - - - -a <AUTHOR>, --author <AUTHOR> - - - Name of the publisher. - - - - - --tags [<TAG1 TAG2> [<TAG1 TAG2> ...]] - - - A list of keywords connected to the application. - - - - - -d <DESCRIPTION>, --description <DESCRIPTION> - - - Detailed description for the Application in Catalog. - - - - - -o <PACKAGE_NAME>, --output <PACKAGE_NAME> - - - The name of the output file archive to save locally. - - - - - -u <UI_DEFINITION>, --ui <UI_DEFINITION> - - - Dynamic UI form definition. - - - - - --type TYPE - - - Package type. Possible values: Application or Library. - - - - - -l <LOGO>, --logo <LOGO> - - - Path to the package logo. - - - - -
-
- murano package-delete - usage: murano package-delete <ID> [<ID> ...] - -Delete a package. - - Positional arguments - - <ID> - - - Package ID to delete. - - - - -
-
- murano package-download - usage: murano package-download <ID> [file] - -Download a package to a filename or stdout. - - Positional arguments - - <ID> - - - Package ID to download. - - - - - file - - - Filename to save package to. If it is not specified and there is no - stdout redirection the package won't be saved. - - - - -
-
- murano package-import - usage: murano package-import [-c [<CATEGORY> [<CATEGORY> ...]]] [--is-public] - [--version VERSION] [--exists-action {a,s,u}] - <FILE> [<FILE> ...] - -Import a package. `FILE` can be either a path to a zip file, url or a FQPN. -You can use `--` to separate `FILE`s from other arguments. Categories have to -be separated with a space and have to be already present in murano. - - Positional arguments - - <FILE> - - - URL of the murano zip package, FQPN, or path to zip - package. - - - - - - Optional arguments - - -c [<CATEGORY> [<CATEGORY> ...]], --categories [<CATEGORY> [<CATEGORY> ...]] - - - Category list to attach. - - - - - --is-public - - - Make the package available for users from other - tenants. - - - - - --version VERSION - - - Version of the package to use from repository (ignored - when importing with multiple packages). - - - - - --exists-action {a,s,u} - - - Default action when a package already exists. - - - - -
-
- murano package-list - usage: murano package-list [--limit LIMIT] [--include-disabled] - -List available packages. - - Optional arguments - - --limit LIMIT - - - - - - - --include-disabled - - - - - - -
-
- murano package-save - usage: murano package-save [-p <PATH>] [--version VERSION] [--no-images] - <PACKAGE> [<PACKAGE> ...] - -Save a package. This will download package(s) with all dependencies to -specified path. If path doesn't exist it will be created. - - Positional arguments - - <PACKAGE> - - - Package URL or name. - - - - - - Optional arguments - - -p <PATH>, --path <PATH> - - - Path to the directory to store package. If not set - will use current directory. - - - - - --version VERSION - - - Version of the package to use from repository (ignored - when saving with multiple packages). - - - - - --no-images - - - If set will skip images downloading. - - - - -
-
- murano package-show - usage: murano package-show <ID> - -Display details for a package. - - Positional arguments - - <ID> - - - Package ID to show. - - - - -
-
- murano package-update - usage: murano package-update [--is-public {true|false}] - [--enabled {true|false}] [--name NAME] - [--description DESCRIPTION] - [--tags [<TAG> [<TAG> ...]]] - <ID> - -Edit the package in question - - Positional arguments - - <ID> - - - Package ID to update. - - - - - - Optional arguments - - --is-public {true|false} - - - Make package available to users from other tenants. - - - - - --enabled {true|false} - - - Make package active and available for deployments. - - - - - --name NAME - - - New name for the package. - - - - - --description DESCRIPTION - - - New package description. - - - - - --tags [<TAG> [<TAG> ...]] - - - A list of keywords connected to the application. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_neutron_commands.xml b/doc/cli-reference/generated/ch_cli_neutron_commands.xml deleted file mode 100644 index 2258817bba..0000000000 --- a/doc/cli-reference/generated/ch_cli_neutron_commands.xml +++ /dev/null @@ -1,11921 +0,0 @@ - - - - - - - - Networking service command-line client - - The neutron client is the command-line - interface (CLI) for the Networking service API and its extensions. - - This chapter documents neutron version - 4.0.0. - - - For help on a specific neutron - command, enter: - - $ neutron COMMAND - -
- neutron usage - usage: neutron [--version] [-v] [-q] [-h] [-r NUM] - [--os-service-type <os-service-type>] - [--os-endpoint-type <os-endpoint-type>] - [--service-type <service-type>] - [--endpoint-type <endpoint-type>] - [--os-auth-strategy <auth-strategy>] [--os-cloud <cloud>] - [--os-auth-url <auth-url>] - [--os-tenant-name <auth-tenant-name> | --os-project-name <auth-project-name>] - [--os-tenant-id <auth-tenant-id> | --os-project-id <auth-project-id>] - [--os-username <auth-username>] [--os-user-id <auth-user-id>] - [--os-user-domain-id <auth-user-domain-id>] - [--os-user-domain-name <auth-user-domain-name>] - [--os-project-domain-id <auth-project-domain-id>] - [--os-project-domain-name <auth-project-domain-name>] - [--os-cert <certificate>] [--os-cacert <ca-certificate>] - [--os-key <key>] [--os-password <auth-password>] - [--os-region-name <auth-region-name>] [--os-token <token>] - [--http-timeout <seconds>] [--os-url <url>] [--insecure] -
-
- neutron optional arguments - - - --version - - - show program's version number and exit - - - - - -v, --verbose, --debug - - - Increase verbosity of output and show tracebacks on - errors. You can repeat this option. - - - - - -q, --quiet - - - Suppress output except warnings and errors. - - - - - -h, --help - - - Show this help message and exit. - - - - - -r NUM, --retries NUM - - - How many times the request to the Neutron server - should be retried if it fails. - - - - - --os-service-type <os-service-type> - - - Defaults to env[OS_NETWORK_SERVICE_TYPE] or network. - - - - - --os-endpoint-type <os-endpoint-type> - - - Defaults to env[OS_ENDPOINT_TYPE] or public. - - - - - --service-type <service-type> - - - DEPRECATED! Use --os-service-type. - - - - - --endpoint-type <endpoint-type> - - - DEPRECATED! Use --os-endpoint-type. - - - - - --os-auth-strategy <auth-strategy> - - - DEPRECATED! Only keystone is supported. - - - - - --os-cloud <cloud> - - - Defaults to env[OS_CLOUD]. - - - - - --os-auth-url <auth-url> - - - Authentication URL, defaults to env[OS_AUTH_URL]. - - - - - --os-tenant-name <auth-tenant-name> - - - Authentication tenant name, defaults to - env[OS_TENANT_NAME]. - - - - - --os-project-name <auth-project-name> - - - Another way to specify tenant name. This option is - mutually exclusive with --os-tenant-name. Defaults to - env[OS_PROJECT_NAME]. - - - - - --os-tenant-id <auth-tenant-id> - - - Authentication tenant ID, defaults to - env[OS_TENANT_ID]. - - - - - --os-project-id <auth-project-id> - - - Another way to specify tenant ID. This option is - mutually exclusive with --os-tenant-id. Defaults to - env[OS_PROJECT_ID]. - - - - - --os-username <auth-username> - - - Authentication username, defaults to env[OS_USERNAME]. - - - - - --os-user-id <auth-user-id> - - - Authentication user ID (Env: OS_USER_ID) - - - - - --os-user-domain-id <auth-user-domain-id> - - - OpenStack user domain ID. Defaults to - env[OS_USER_DOMAIN_ID]. - - - - - --os-user-domain-name <auth-user-domain-name> - - - OpenStack user domain name. Defaults to - env[OS_USER_DOMAIN_NAME]. - - - - - --os-project-domain-id <auth-project-domain-id> - - - Defaults to env[OS_PROJECT_DOMAIN_ID]. - - - - - --os-project-domain-name <auth-project-domain-name> - - - Defaults to env[OS_PROJECT_DOMAIN_NAME]. - - - - - --os-cert <certificate> - - - Path of certificate file to use in SSL connection. - This file can optionally be prepended with the private - key. Defaults to env[OS_CERT]. - - - - - --os-cacert <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-key <key> - - - Path of client key to use in SSL connection. This - option is not necessary if your key is prepended to - your certificate file. Defaults to env[OS_KEY]. - - - - - --os-password <auth-password> - - - Authentication password, defaults to env[OS_PASSWORD]. - - - - - --os-region-name <auth-region-name> - - - Authentication region name, defaults to - env[OS_REGION_NAME]. - - - - - --os-token <token> - - - Authentication token, defaults to env[OS_TOKEN]. - - - - - --http-timeout <seconds> - - - Timeout in seconds to wait for an HTTP response. - Defaults to env[OS_NETWORK_TIMEOUT] or None if not - specified. - - - - - --os-url <url> - - - Defaults to env[OS_URL]. - - - - - --insecure - - - Explicitly allow neutronclient 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. - - - - -
-
- neutron API v2.0 commands - - - address-scope-create - - - Create an address scope for a given tenant. - - - - - address-scope-delete - - - Delete an address scope. - - - - - address-scope-list - - - List address scopes that belong to a given tenant. - - - - - address-scope-show - - - Show information about an address scope. - - - - - address-scope-update - - - Update an address scope. - - - - - agent-delete - - - Delete a given agent. - - - - - agent-list - - - List agents. - - - - - agent-show - - - Show information of a given agent. - - - - - agent-update - - - Updates the admin status and description for a specified agent. - - - - - availability-zone-list - - - List availability zones. - - - - - bash-completion - - - Prints all of the commands and options for bash-completion. - - - - - dhcp-agent-list-hosting-net - - - List DHCP agents hosting a network. - - - - - dhcp-agent-network-add - - - Add a network to a DHCP agent. - - - - - dhcp-agent-network-remove - - - Remove a network from a DHCP agent. - - - - - ext-list - - - List all extensions. - - - - - ext-show - - - Show information of a given resource. - - - - - firewall-create - - - Create a firewall. - - - - - firewall-delete - - - Delete a given firewall. - - - - - firewall-list - - - List firewalls that belong to a given tenant. - - - - - firewall-policy-create - - - Create a firewall policy. - - - - - firewall-policy-delete - - - Delete a given firewall policy. - - - - - firewall-policy-insert-rule - - - Insert a rule into a given firewall policy. - - - - - firewall-policy-list - - - List firewall policies that belong to a given tenant. - - - - - firewall-policy-remove-rule - - - Remove a rule from a given firewall policy. - - - - - firewall-policy-show - - - Show information of a given firewall policy. - - - - - firewall-policy-update - - - Update a given firewall policy. - - - - - firewall-rule-create - - - Create a firewall rule. - - - - - firewall-rule-delete - - - Delete a given firewall rule. - - - - - firewall-rule-list - - - List firewall rules that belong to a given tenant. - - - - - firewall-rule-show - - - Show information of a given firewall rule. - - - - - firewall-rule-update - - - Update a given firewall rule. - - - - - firewall-show - - - Show information of a given firewall. - - - - - firewall-update - - - Update a given firewall. - - - - - flavor-associate - - - Associate a Neutron service flavor with a flavor profile. - - - - - flavor-create - - - Create a Neutron service flavor. - - - - - flavor-delete - - - Delete a given Neutron service flavor. - - - - - flavor-disassociate - - - Disassociate a Neutron service flavor from a flavor profile. - - - - - flavor-list - - - List Neutron service flavors. - - - - - flavor-profile-create - - - Create a Neutron service flavor profile. - - - - - flavor-profile-delete - - - Delete a given Neutron service flavor profile. - - - - - flavor-profile-list - - - List Neutron service flavor profiles. - - - - - flavor-profile-show - - - Show information about a given Neutron service flavor profile. - - - - - flavor-profile-update - - - Update a given Neutron service flavor profile. - - - - - flavor-show - - - Show information about a given Neutron service flavor. - - - - - flavor-update - - - Update a Neutron service flavor. - - - - - floatingip-associate - - - Create a mapping between a floating IP and a fixed IP. - - - - - floatingip-create - - - Create a floating IP for a given tenant. - - - - - floatingip-delete - - - Delete a given floating IP. - - - - - floatingip-disassociate - - - Remove a mapping from a floating IP to a fixed IP. - - - - - floatingip-list - - - List floating IPs that belong to a given tenant. - - - - - floatingip-show - - - Show information of a given floating IP. - - - - - gateway-device-create - - - Create a network gateway device. - - - - - gateway-device-delete - - - Delete a given network gateway device. - - - - - gateway-device-list - - - List network gateway devices for a given tenant. - - - - - gateway-device-show - - - Show information for a given network gateway device. - - - - - gateway-device-update - - - Update a network gateway device. - - - - - help - - - print detailed help for another command - - - - - ipsec-site-connection-create - - - Create an IPsec site connection. - - - - - ipsec-site-connection-delete - - - Delete a given IPsec site connection. - - - - - ipsec-site-connection-list - - - List IPsec site connections that belong to a given tenant. - - - - - ipsec-site-connection-show - - - Show information of a given IPsec site connection. - - - - - ipsec-site-connection-update - - - Update a given IPsec site connection. - - - - - l3-agent-list-hosting-router - - - List L3 agents hosting a router. - - - - - l3-agent-router-add - - - Add a router to a L3 agent. - - - - - l3-agent-router-remove - - - Remove a router from a L3 agent. - - - - - lb-agent-hosting-pool - - - Get loadbalancer agent hosting a pool. - - - - - lb-healthmonitor-associate - - - Create a mapping between a health monitor and a pool. - - - - - lb-healthmonitor-create - - - Create a health monitor. - - - - - lb-healthmonitor-delete - - - Delete a given health monitor. - - - - - lb-healthmonitor-disassociate - - - Remove a mapping from a health monitor to a pool. - - - - - lb-healthmonitor-list - - - List health monitors that belong to a given tenant. - - - - - lb-healthmonitor-show - - - Show information of a given health monitor. - - - - - lb-healthmonitor-update - - - Update a given health monitor. - - - - - lb-member-create - - - Create a member. - - - - - lb-member-delete - - - Delete a given member. - - - - - lb-member-list - - - List members that belong to a given tenant. - - - - - lb-member-show - - - Show information of a given member. - - - - - lb-member-update - - - Update a given member. - - - - - lb-pool-create - - - Create a pool. - - - - - lb-pool-delete - - - Delete a given pool. - - - - - lb-pool-list - - - List pools that belong to a given tenant. - - - - - lb-pool-list-on-agent - - - List the pools on a loadbalancer agent. - - - - - lb-pool-show - - - Show information of a given pool. - - - - - lb-pool-stats - - - Retrieve stats for a given pool. - - - - - lb-pool-update - - - Update a given pool. - - - - - lb-vip-create - - - Create a vip. - - - - - lb-vip-delete - - - Delete a given vip. - - - - - lb-vip-list - - - List vips that belong to a given tenant. - - - - - lb-vip-show - - - Show information of a given vip. - - - - - lb-vip-update - - - Update a given vip. - - - - - lbaas-agent-hosting-loadbalancer - - - Get lbaas v2 agent hosting a loadbalancer. - - - - - lbaas-healthmonitor-create - - - LBaaS v2 Create a healthmonitor. - - - - - lbaas-healthmonitor-delete - - - LBaaS v2 Delete a given healthmonitor. - - - - - lbaas-healthmonitor-list - - - LBaaS v2 List healthmonitors that belong to a given tenant. - - - - - lbaas-healthmonitor-show - - - LBaaS v2 Show information of a given healthmonitor. - - - - - lbaas-healthmonitor-update - - - LBaaS v2 Update a given healthmonitor. - - - - - lbaas-listener-create - - - LBaaS v2 Create a listener. - - - - - lbaas-listener-delete - - - LBaaS v2 Delete a given listener. - - - - - lbaas-listener-list - - - LBaaS v2 List listeners that belong to a given tenant. - - - - - lbaas-listener-show - - - LBaaS v2 Show information of a given listener. - - - - - lbaas-listener-update - - - LBaaS v2 Update a given listener. - - - - - lbaas-loadbalancer-create - - - LBaaS v2 Create a loadbalancer. - - - - - lbaas-loadbalancer-delete - - - LBaaS v2 Delete a given loadbalancer. - - - - - lbaas-loadbalancer-list - - - LBaaS v2 List loadbalancers that belong to a given tenant. - - - - - lbaas-loadbalancer-list-on-agent - - - List the loadbalancers on a loadbalancer v2 agent. - - - - - lbaas-loadbalancer-show - - - LBaaS v2 Show information of a given loadbalancer. - - - - - lbaas-loadbalancer-stats - - - Retrieve stats for a given loadbalancer. - - - - - lbaas-loadbalancer-update - - - LBaaS v2 Update a given loadbalancer. - - - - - lbaas-member-create - - - LBaaS v2 Create a member. - - - - - lbaas-member-delete - - - LBaaS v2 Delete a given member. - - - - - lbaas-member-list - - - LBaaS v2 List members that belong to a given pool. - - - - - lbaas-member-show - - - LBaaS v2 Show information of a given member. - - - - - lbaas-member-update - - - LBaaS v2 Update a given member. - - - - - lbaas-pool-create - - - LBaaS v2 Create a pool. - - - - - lbaas-pool-delete - - - LBaaS v2 Delete a given pool. - - - - - lbaas-pool-list - - - LBaaS v2 List pools that belong to a given tenant. - - - - - lbaas-pool-show - - - LBaaS v2 Show information of a given pool. - - - - - lbaas-pool-update - - - LBaaS v2 Update a given pool. - - - - - meter-label-create - - - Create a metering label for a given tenant. - - - - - meter-label-delete - - - Delete a given metering label. - - - - - meter-label-list - - - List metering labels that belong to a given tenant. - - - - - meter-label-rule-create - - - Create a metering label rule for a given label. - - - - - meter-label-rule-delete - - - Delete a given metering label. - - - - - meter-label-rule-list - - - List metering labels that belong to a given label. - - - - - meter-label-rule-show - - - Show information of a given metering label rule. - - - - - meter-label-show - - - Show information of a given metering label. - - - - - net-create - - - Create a network for a given tenant. - - - - - net-delete - - - Delete a given network. - - - - - net-external-list - - - List external networks that belong to a given tenant. - - - - - net-gateway-connect - - - Add an internal network interface to a router. - - - - - net-gateway-create - - - Create a network gateway. - - - - - net-gateway-delete - - - Delete a given network gateway. - - - - - net-gateway-disconnect - - - Remove a network from a network gateway. - - - - - net-gateway-list - - - List network gateways for a given tenant. - - - - - net-gateway-show - - - Show information of a given network gateway. - - - - - net-gateway-update - - - Update the name for a network gateway. - - - - - net-list - - - List networks that belong to a given tenant. - - - - - net-list-on-dhcp-agent - - - List the networks on a DHCP agent. - - - - - net-show - - - Show information of a given network. - - - - - net-update - - - Update network's information. - - - - - port-create - - - Create a port for a given tenant. - - - - - port-delete - - - Delete a given port. - - - - - port-list - - - List ports that belong to a given tenant. - - - - - port-show - - - Show information of a given port. - - - - - port-update - - - Update port's information. - - - - - qos-available-rule-types - - - List available qos rule types. - - - - - qos-bandwidth-limit-rule-create - - - Create a qos bandwidth limit rule. - - - - - qos-bandwidth-limit-rule-delete - - - Delete a given qos bandwidth limit rule. - - - - - qos-bandwidth-limit-rule-list - - - List all qos bandwidth limit rules belonging to the specified policy. - - - - - qos-bandwidth-limit-rule-show - - - Show information about the given qos bandwidth limit rule. - - - - - qos-bandwidth-limit-rule-update - - - Update the given qos bandwidth limit rule. - - - - - qos-policy-create - - - Create a qos policy. - - - - - qos-policy-delete - - - Delete a given qos policy. - - - - - qos-policy-list - - - List QoS policies that belong to a given tenant connection. - - - - - qos-policy-show - - - Show information of a given qos policy. - - - - - qos-policy-update - - - Update a given qos policy. - - - - - queue-create - - - Create a queue. - - - - - queue-delete - - - Delete a given queue. - - - - - queue-list - - - List queues that belong to a given tenant. - - - - - queue-show - - - Show information of a given queue. - - - - - quota-delete - - - Delete defined quotas of a given tenant. - - - - - quota-list - - - List quotas of all tenants who have non-default quota values. - - - - - quota-show - - - Show quotas of a given tenant. - - - - - quota-update - - - Define tenant's quotas not to use defaults. - - - - - rbac-create - - - Create a RBAC policy for a given tenant. - - - - - rbac-delete - - - Delete a RBAC policy. - - - - - rbac-list - - - List RBAC policies that belong to a given tenant. - - - - - rbac-show - - - Show information of a given RBAC policy. - - - - - rbac-update - - - Update RBAC policy for given tenant. - - - - - router-create - - - Create a router for a given tenant. - - - - - router-delete - - - Delete a given router. - - - - - router-gateway-clear - - - Remove an external network gateway from a router. - - - - - router-gateway-set - - - Set the external network gateway for a router. - - - - - router-interface-add - - - Add an internal network interface to a router. - - - - - router-interface-delete - - - Remove an internal network interface from a router. - - - - - router-list - - - List routers that belong to a given tenant. - - - - - router-list-on-l3-agent - - - List the routers on a L3 agent. - - - - - router-port-list - - - List ports that belong to a given tenant, with specified router. - - - - - router-show - - - Show information of a given router. - - - - - router-update - - - Update router's information. - - - - - security-group-create - - - Create a security group. - - - - - security-group-delete - - - Delete a given security group. - - - - - security-group-list - - - List security groups that belong to a given tenant. - - - - - security-group-rule-create - - - Create a security group rule. - - - - - security-group-rule-delete - - - Delete a given security group rule. - - - - - security-group-rule-list - - - List security group rules that belong to a given tenant. - - - - - security-group-rule-show - - - Show information of a given security group rule. - - - - - security-group-show - - - Show information of a given security group. - - - - - security-group-update - - - Update a given security group. - - - - - service-provider-list - - - List service providers. - - - - - subnet-create - - - Create a subnet for a given tenant. - - - - - subnet-delete - - - Delete a given subnet. - - - - - subnet-list - - - List subnets that belong to a given tenant. - - - - - subnet-show - - - Show information of a given subnet. - - - - - subnet-update - - - Update subnet's information. - - - - - subnetpool-create - - - Create a subnetpool for a given tenant. - - - - - subnetpool-delete - - - Delete a given subnetpool. - - - - - subnetpool-list - - - List subnetpools that belong to a given tenant. - - - - - subnetpool-show - - - Show information of a given subnetpool. - - - - - subnetpool-update - - - Update subnetpool's information. - - - - - vpn-endpoint-group-create - - - Create a VPN endpoint group. - - - - - vpn-endpoint-group-delete - - - Delete a given VPN endpoint group. - - - - - vpn-endpoint-group-list - - - List VPN endpoint groups that belong to a given tenant. - - - - - vpn-endpoint-group-show - - - Show a specific VPN endpoint group. - - - - - vpn-endpoint-group-update - - - Update a given VPN endpoint group. - - - - - vpn-ikepolicy-create - - - Create an IKE policy. - - - - - vpn-ikepolicy-delete - - - Delete a given IKE policy. - - - - - vpn-ikepolicy-list - - - List IKE policies that belong to a tenant. - - - - - vpn-ikepolicy-show - - - Show information of a given IKE policy. - - - - - vpn-ikepolicy-update - - - Update a given IKE policy. - - - - - vpn-ipsecpolicy-create - - - Create an IPsec policy. - - - - - vpn-ipsecpolicy-delete - - - Delete a given IPsec policy. - - - - - vpn-ipsecpolicy-list - - - List IPsec policies that belong to a given tenant connection. - - - - - vpn-ipsecpolicy-show - - - Show information of a given IPsec policy. - - - - - vpn-ipsecpolicy-update - - - Update a given IPsec policy. - - - - - vpn-service-create - - - Create a VPN service. - - - - - vpn-service-delete - - - Delete a given VPN service. - - - - - vpn-service-list - - - List VPN service configurations that belong to a given tenant. - - - - - vpn-service-show - - - Show information of a given VPN service. - - - - - vpn-service-update - - - Update a given VPN service. - - - - -
-
- neutron address-scope-create - usage: neutron address-scope-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] [--shared] - name - -Create an address scope for a given tenant. - - Positional arguments - - name - - - Specify the name of the address scope. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --shared - - - Set the address scope as shared. - - - - -
-
- neutron address-scope-delete - usage: neutron address-scope-delete [-h] [--request-format {json}] - ADDRESS_SCOPE - -Delete an address scope. - - Positional arguments - - ADDRESS_SCOPE - - - ID or name of address_scope to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron address-scope-show - usage: neutron address-scope-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - ADDRESS_SCOPE - -Show information about an address scope. - - Positional arguments - - ADDRESS_SCOPE - - - ID or name of address_scope to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron address-scope-update - usage: neutron address-scope-update [-h] [--request-format {json}] - [--name NAME] - ADDRESS_SCOPE - -Update an address scope. - - Positional arguments - - ADDRESS_SCOPE - - - ID or name of address_scope to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Name of the address scope to update. - - - - -
-
- neutron agent-delete - usage: neutron agent-delete [-h] [--request-format {json}] AGENT - -Delete a given agent. - - Positional arguments - - AGENT - - - ID of agent to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron agent-show - usage: neutron agent-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - AGENT - -Show information of a given agent. - - Positional arguments - - AGENT - - - ID of agent to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron agent-update - usage: neutron agent-update [-h] [--request-format {json}] - [--admin-state-down] [--description DESCRIPTION] - AGENT - -Updates the admin status and description for a specified agent. - - Positional arguments - - AGENT - - - ID of agent to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --admin-state-down - - - Set admin state up of the agent to false. - - - - - --description DESCRIPTION - - - Description for the agent. - - - - -
-
- neutron dhcp-agent-list-hosting-net - usage: neutron dhcp-agent-list-hosting-net [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] - [-F FIELD] - network - -List DHCP agents hosting a network. - - Positional arguments - - network - - - Network to query. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron dhcp-agent-network-add - usage: neutron dhcp-agent-network-add [-h] [--request-format {json}] - dhcp_agent network - -Add a network to a DHCP agent. - - Positional arguments - - dhcp_agent - - - ID of the DHCP agent. - - - - - network - - - Network to add. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron dhcp-agent-network-remove - usage: neutron dhcp-agent-network-remove [-h] [--request-format {json}] - dhcp_agent network - -Remove a network from a DHCP agent. - - Positional arguments - - dhcp_agent - - - ID of the DHCP agent. - - - - - network - - - Network to remove. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron ext-show - usage: neutron ext-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - EXTENSION - -Show information of a given resource. - - Positional arguments - - EXTENSION - - - ID of extension to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron firewall-create - usage: neutron firewall-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] [--name NAME] - [--description DESCRIPTION] - [--admin-state-down] [--router ROUTER] - POLICY - -Create a firewall. - - Positional arguments - - POLICY - - - Firewall policy name or ID. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --name NAME - - - Name for the firewall. - - - - - --description DESCRIPTION - - - Description for the firewall rule. - - - - - --admin-state-down - - - Set admin state up to false. - - - - - --router ROUTER - - - Firewall associated router names or IDs (requires - FWaaS router insertion extension, this option can be - repeated) - - - - -
-
- neutron firewall-delete - usage: neutron firewall-delete [-h] [--request-format {json}] FIREWALL - -Delete a given firewall. - - Positional arguments - - FIREWALL - - - ID or name of firewall to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron firewall-policy-create - usage: neutron firewall-policy-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--description DESCRIPTION] [--shared] - [--firewall-rules FIREWALL_RULES] - [--audited] - NAME - -Create a firewall policy. - - Positional arguments - - NAME - - - Name for the firewall policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --description DESCRIPTION - - - Description for the firewall policy. - - - - - --shared - - - Create a shared policy. - - - - - --firewall-rules FIREWALL_RULES - - - Ordered list of whitespace-delimited firewall rule - names or IDs; e.g., --firewall-rules "rule1 rule2" - - - - - --audited - - - Sets audited to True. - - - - -
-
- neutron firewall-policy-delete - usage: neutron firewall-policy-delete [-h] [--request-format {json}] - FIREWALL_POLICY - -Delete a given firewall policy. - - Positional arguments - - FIREWALL_POLICY - - - ID or name of firewall_policy to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron firewall-policy-insert-rule - usage: neutron firewall-policy-insert-rule [-h] [--request-format {json}] - [--insert-before FIREWALL_RULE] - [--insert-after FIREWALL_RULE] - FIREWALL_POLICY FIREWALL_RULE - -Insert a rule into a given firewall policy. - - Positional arguments - - FIREWALL_POLICY - - - ID or name of firewall_policy to update. - - - - - FIREWALL_RULE - - - New rule to insert. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --insert-before FIREWALL_RULE - - - Insert before this rule. - - - - - --insert-after FIREWALL_RULE - - - Insert after this rule. - - - - -
-
- neutron firewall-policy-remove-rule - usage: neutron firewall-policy-remove-rule [-h] [--request-format {json}] - FIREWALL_POLICY FIREWALL_RULE - -Remove a rule from a given firewall policy. - - Positional arguments - - FIREWALL_POLICY - - - ID or name of firewall_policy to update. - - - - - FIREWALL_RULE - - - Firewall rule to remove from policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron firewall-policy-show - usage: neutron firewall-policy-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - FIREWALL_POLICY - -Show information of a given firewall policy. - - Positional arguments - - FIREWALL_POLICY - - - ID or name of firewall_policy to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron firewall-policy-update - usage: neutron firewall-policy-update [-h] [--request-format {json}] - [--firewall-rules FIREWALL_RULES] - FIREWALL_POLICY - -Update a given firewall policy. - - Positional arguments - - FIREWALL_POLICY - - - ID or name of firewall_policy to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --firewall-rules FIREWALL_RULES - - - Ordered list of whitespace-delimited firewall rule - names or IDs; e.g., --firewall-rules "rule1 rule2" - - - - -
-
- neutron firewall-rule-delete - usage: neutron firewall-rule-delete [-h] [--request-format {json}] - FIREWALL_RULE - -Delete a given firewall rule. - - Positional arguments - - FIREWALL_RULE - - - ID or name of firewall_rule to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron firewall-rule-show - usage: neutron firewall-rule-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - FIREWALL_RULE - -Show information of a given firewall rule. - - Positional arguments - - FIREWALL_RULE - - - ID or name of firewall_rule to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron firewall-rule-update - usage: neutron firewall-rule-update [-h] [--request-format {json}] - [--protocol {tcp,udp,icmp,any}] - FIREWALL_RULE - -Update a given firewall rule. - - Positional arguments - - FIREWALL_RULE - - - ID or name of firewall_rule to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --protocol {tcp,udp,icmp,any} - - - Protocol for the firewall rule. - - - - -
-
- neutron firewall-show - usage: neutron firewall-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - FIREWALL - -Show information of a given firewall. - - Positional arguments - - FIREWALL - - - ID or name of firewall to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron firewall-update - usage: neutron firewall-update [-h] [--request-format {json}] - [--policy POLICY] - [--router ROUTER | --no-routers] - FIREWALL - -Update a given firewall. - - Positional arguments - - FIREWALL - - - ID or name of firewall to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --policy POLICY - - - Firewall policy name or ID. - - - - - --router ROUTER - - - Firewall associated router names or IDs (requires - FWaaS router insertion extension, this option can be - repeated) - - - - - --no-routers - - - Associate no routers with the firewall (requires FWaaS - router insertion extension) - - - - -
-
- neutron flavor-associate - usage: neutron flavor-associate [-h] [--request-format {json}] - FLAVOR FLAVOR_PROFILE - -Associate a Neutron service flavor with a flavor profile. - - Positional arguments - - FLAVOR - - - Name or ID of the flavor to associate. - - - - - FLAVOR_PROFILE - - - ID of the flavor profile to be associated with the - flavor. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron flavor-create - usage: neutron flavor-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] - [--tenant-id TENANT_ID] - [--description DESCRIPTION] - [--enabled {True,False}] - NAME SERVICE_TYPE - -Create a Neutron service flavor. - - Positional arguments - - NAME - - - Name for the flavor. - - - - - SERVICE_TYPE - - - Service type to which the flavor applies to: e.g. VPN. - (See service-provider-list for loaded examples.) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --description DESCRIPTION - - - Description for the flavor. - - - - - --enabled {True,False} - - - Sets enabled flag. - - - - -
-
- neutron flavor-delete - usage: neutron flavor-delete [-h] [--request-format {json}] FLAVOR - -Delete a given Neutron service flavor. - - Positional arguments - - FLAVOR - - - ID or name of flavor to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron flavor-disassociate - usage: neutron flavor-disassociate [-h] [--request-format {json}] - FLAVOR FLAVOR_PROFILE - -Disassociate a Neutron service flavor from a flavor profile. - - Positional arguments - - FLAVOR - - - Name or ID of the flavor. - - - - - FLAVOR_PROFILE - - - ID of the flavor profile to be disassociated from the - flavor. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron flavor-profile-delete - usage: neutron flavor-profile-delete [-h] [--request-format {json}] - SERVICE_PROFILE - -Delete a given Neutron service flavor profile. - - Positional arguments - - SERVICE_PROFILE - - - ID or name of service_profile to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron flavor-profile-show - usage: neutron flavor-profile-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - SERVICE_PROFILE - -Show information about a given Neutron service flavor profile. - - Positional arguments - - SERVICE_PROFILE - - - ID or name of service_profile to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron flavor-profile-update - usage: neutron flavor-profile-update [-h] [--request-format {json}] - [--description DESCRIPTION] - [--driver DRIVER] [--metainfo METAINFO] - [--enabled {True,False}] - SERVICE_PROFILE - -Update a given Neutron service flavor profile. - - Positional arguments - - SERVICE_PROFILE - - - ID or name of service_profile to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --description DESCRIPTION - - - Description for the flavor profile. - - - - - --driver DRIVER - - - Python module path to driver. - - - - - --metainfo METAINFO - - - Metainfo for the flavor profile. - - - - - --enabled {True,False} - - - Sets enabled flag. - - - - -
-
- neutron flavor-show - usage: neutron flavor-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - FLAVOR - -Show information about a given Neutron service flavor. - - Positional arguments - - FLAVOR - - - ID or name of flavor to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron flavor-update - usage: neutron flavor-update [-h] [--request-format {json}] [--name NAME] - [--description DESCRIPTION] - [--enabled {True,False}] - FLAVOR - -Update a Neutron service flavor. - - Positional arguments - - FLAVOR - - - ID or name of flavor to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Name for the flavor. - - - - - --description DESCRIPTION - - - Description for the flavor. - - - - - --enabled {True,False} - - - Sets enabled flag. - - - - -
-
- neutron floatingip-associate - usage: neutron floatingip-associate [-h] [--request-format {json}] - [--fixed-ip-address FIXED_IP_ADDRESS] - FLOATINGIP_ID PORT - -Create a mapping between a floating IP and a fixed IP. - - Positional arguments - - FLOATINGIP_ID - - - ID of the floating IP to associate. - - - - - PORT - - - ID or name of the port to be associated with the - floating IP. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --fixed-ip-address FIXED_IP_ADDRESS - - - IP address on the port (only required if port has - multiple IPs). - - - - -
-
- neutron floatingip-create - usage: neutron floatingip-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] [--port-id PORT_ID] - [--fixed-ip-address FIXED_IP_ADDRESS] - [--floating-ip-address FLOATING_IP_ADDRESS] - [--subnet SUBNET_ID] - FLOATING_NETWORK - -Create a floating IP for a given tenant. - - Positional arguments - - FLOATING_NETWORK - - - Network name or ID to allocate floating IP from. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --port-id PORT_ID - - - ID of the port to be associated with the floating IP. - - - - - --fixed-ip-address FIXED_IP_ADDRESS - - - IP address on the port (only required if port has - multiple IPs). - - - - - --floating-ip-address FLOATING_IP_ADDRESS - - - IP address of the floating IP - - - - - --subnet SUBNET_ID - - - Subnet ID on which you want to create the floating IP. - - - - -
-
- neutron floatingip-delete - usage: neutron floatingip-delete [-h] [--request-format {json}] FLOATINGIP - -Delete a given floating IP. - - Positional arguments - - FLOATINGIP - - - ID of floatingip to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron floatingip-disassociate - usage: neutron floatingip-disassociate [-h] [--request-format {json}] - FLOATINGIP_ID - -Remove a mapping from a floating IP to a fixed IP. - - Positional arguments - - FLOATINGIP_ID - - - ID of the floating IP to disassociate. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron floatingip-show - usage: neutron floatingip-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - FLOATINGIP - -Show information of a given floating IP. - - Positional arguments - - FLOATINGIP - - - ID of floatingip to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron gateway-device-create - usage: neutron gateway-device-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}] - --connector-ip CONNECTOR_IP - (--client-certificate CERT_DATA | --client-certificate-file CERT_FILE) - NAME - -Create a network gateway device. - - Positional arguments - - NAME - - - Name of network gateway device to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt} - - - Type of the transport zone connector to use for this - device. Valid values are gre, stt, ipsec_gre, - ipsec_stt, and bridge. Defaults to stt. ipsecgre and - ipsecstt are also accepted as alternative names - - - - - --connector-ip CONNECTOR_IP - - - IP address for this device's transport connector. It - must correspond to the IP address of the interface - used for tenant traffic on the NSX gateway node. - - - - - --client-certificate CERT_DATA - - - PEM certificate used by the NSX gateway transport node - to authenticate with the NSX controller. - - - - - --client-certificate-file CERT_FILE - - - File containing the PEM certificate used by the NSX - gateway transport node to authenticate with the NSX - controller. - - - - -
-
- neutron gateway-device-delete - usage: neutron gateway-device-delete [-h] [--request-format {json}] - GATEWAY_DEVICE - -Delete a given network gateway device. - - Positional arguments - - GATEWAY_DEVICE - - - ID or name of gateway_device to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron gateway-device-show - usage: neutron gateway-device-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - GATEWAY_DEVICE - -Show information for a given network gateway device. - - Positional arguments - - GATEWAY_DEVICE - - - ID or name of gateway_device to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron gateway-device-update - usage: neutron gateway-device-update [-h] [--request-format {json}] - [--name NAME] - [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}] - [--connector-ip CONNECTOR_IP] - [--client-certificate CERT_DATA | --client-certificate-file CERT_FILE] - GATEWAY_DEVICE - -Update a network gateway device. - - Positional arguments - - GATEWAY_DEVICE - - - ID or name of gateway_device to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - New name for network gateway device. - - - - - --connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt} - - - Type of the transport zone connector to use for this - device. Valid values are gre, stt, ipsec_gre, - ipsec_stt, and bridge. Defaults to stt. ipsecgre and - ipsecstt are also accepted as alternative names - - - - - --connector-ip CONNECTOR_IP - - - IP address for this device's transport connector. It - must correspond to the IP address of the interface - used for tenant traffic on the NSX gateway node. - - - - - --client-certificate CERT_DATA - - - PEM certificate used by the NSX gateway transport node - to authenticate with the NSX controller. - - - - - --client-certificate-file CERT_FILE - - - File containing the PEM certificate used by the NSX - gateway transport node to authenticate with the NSX - controller. - - - - -
-
- neutron ipsec-site-connection-delete - usage: neutron ipsec-site-connection-delete [-h] [--request-format {json}] - IPSEC_SITE_CONNECTION - -Delete a given IPsec site connection. - - Positional arguments - - IPSEC_SITE_CONNECTION - - - ID or name of ipsec_site_connection to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron ipsec-site-connection-show - usage: neutron ipsec-site-connection-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] - [-F FIELD] - IPSEC_SITE_CONNECTION - -Show information of a given IPsec site connection. - - Positional arguments - - IPSEC_SITE_CONNECTION - - - ID or name of ipsec_site_connection to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron ipsec-site-connection-update - usage: neutron ipsec-site-connection-update [-h] [--request-format {json}] - [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT] - [--local-ep-group LOCAL_EP_GROUP] - [--peer-ep-group PEER_EP_GROUP] - IPSEC_SITE_CONNECTION - -Update a given IPsec site connection. - - Positional arguments - - IPSEC_SITE_CONNECTION - - - ID or name of ipsec_site_connection to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --dpd - - - action=ACTION,interval=INTERVAL,timeout=TIMEOUT - Ipsec connection. Dead Peer Detection attributes. - 'action'-hold,clear,disabled,restart,restart-by-peer. - 'interval' and 'timeout' are non negative integers. - 'interval' should be less than 'timeout' value. - 'action', default:hold 'interval', default:30, - 'timeout', default:120. - - - - - --local-ep-group LOCAL_EP_GROUP - - - Local endpoint group ID/name with subnet(s) for IPSec - connection. - - - - - --peer-ep-group PEER_EP_GROUP - - - Peer endpoint group ID/name with CIDR(s) for IPsec - connection. - - - - -
-
- neutron l3-agent-list-hosting-router - usage: neutron l3-agent-list-hosting-router [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] - [-F FIELD] - router - -List L3 agents hosting a router. - - Positional arguments - - router - - - Router to query. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron l3-agent-router-add - usage: neutron l3-agent-router-add [-h] [--request-format {json}] - l3_agent router - -Add a router to a L3 agent. - - Positional arguments - - l3_agent - - - ID of the L3 agent. - - - - - router - - - Router to add. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron l3-agent-router-remove - usage: neutron l3-agent-router-remove [-h] [--request-format {json}] - l3_agent router - -Remove a router from a L3 agent. - - Positional arguments - - l3_agent - - - ID of the L3 agent. - - - - - router - - - Router to remove. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-agent-hosting-pool - usage: neutron lb-agent-hosting-pool [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] [-F FIELD] - pool - -Get loadbalancer agent hosting a pool. Deriving from ListCommand though server -will return only one agent to keep common output format for all agent -schedulers - - Positional arguments - - pool - - - Pool to query. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lb-healthmonitor-associate - usage: neutron lb-healthmonitor-associate [-h] [--request-format {json}] - HEALTH_MONITOR_ID POOL - -Create a mapping between a health monitor and a pool. - - Positional arguments - - HEALTH_MONITOR_ID - - - Health monitor to associate. - - - - - POOL - - - ID of the pool to be associated with the health - monitor. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-healthmonitor-delete - usage: neutron lb-healthmonitor-delete [-h] [--request-format {json}] - HEALTH_MONITOR - -Delete a given health monitor. - - Positional arguments - - HEALTH_MONITOR - - - ID of health_monitor to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-healthmonitor-disassociate - usage: neutron lb-healthmonitor-disassociate [-h] [--request-format {json}] - HEALTH_MONITOR_ID POOL - -Remove a mapping from a health monitor to a pool. - - Positional arguments - - HEALTH_MONITOR_ID - - - Health monitor to associate. - - - - - POOL - - - ID of the pool to be associated with the health - monitor. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-healthmonitor-show - usage: neutron lb-healthmonitor-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - HEALTH_MONITOR - -Show information of a given health monitor. - - Positional arguments - - HEALTH_MONITOR - - - ID of health_monitor to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lb-healthmonitor-update - usage: neutron lb-healthmonitor-update [-h] [--request-format {json}] - HEALTH_MONITOR - -Update a given health monitor. - - Positional arguments - - HEALTH_MONITOR - - - ID of health_monitor to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-member-create - usage: neutron lb-member-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] [--admin-state-down] - [--weight WEIGHT] --address ADDRESS - --protocol-port PROTOCOL_PORT - POOL - -Create a member. - - Positional arguments - - POOL - - - Pool ID or name this vip belongs to. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --admin-state-down - - - Set admin state up to false. - - - - - --weight WEIGHT - - - Weight of pool member in the pool (default:1, - [0..256]). - - - - - --address ADDRESS - - - IP address of the pool member on the pool network. - - - - - --protocol-port PROTOCOL_PORT - - - Port on which the pool member listens for requests or - connections. - - - - -
-
- neutron lb-member-delete - usage: neutron lb-member-delete [-h] [--request-format {json}] MEMBER - -Delete a given member. - - Positional arguments - - MEMBER - - - ID or name of member to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-member-show - usage: neutron lb-member-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - MEMBER - -Show information of a given member. - - Positional arguments - - MEMBER - - - ID of member to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lb-member-update - usage: neutron lb-member-update [-h] [--request-format {json}] MEMBER - -Update a given member. - - Positional arguments - - MEMBER - - - ID or name of member to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-pool-delete - usage: neutron lb-pool-delete [-h] [--request-format {json}] POOL - -Delete a given pool. - - Positional arguments - - POOL - - - ID or name of pool to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-pool-list-on-agent - usage: neutron lb-pool-list-on-agent [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] [-F FIELD] - lbaas_agent - -List the pools on a loadbalancer agent. - - Positional arguments - - lbaas_agent - - - ID of the loadbalancer agent to query. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lb-pool-show - usage: neutron lb-pool-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - POOL - -Show information of a given pool. - - Positional arguments - - POOL - - - ID or name of pool to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lb-pool-stats - usage: neutron lb-pool-stats [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - POOL - -Retrieve stats for a given pool. - - Positional arguments - - POOL - - - ID or name of pool to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lb-pool-update - usage: neutron lb-pool-update [-h] [--request-format {json}] POOL - -Update a given pool. - - Positional arguments - - POOL - - - ID or name of pool to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-vip-create - usage: neutron lb-vip-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] - [--tenant-id TENANT_ID] [--address ADDRESS] - [--admin-state-down] - [--connection-limit CONNECTION_LIMIT] - [--description DESCRIPTION] --name NAME - --protocol-port PROTOCOL_PORT --protocol - {TCP,HTTP,HTTPS} --subnet-id SUBNET - POOL - -Create a vip. - - Positional arguments - - POOL - - - Pool ID or name this vip belongs to. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --address ADDRESS - - - IP address of the vip. - - - - - --admin-state-down - - - Set admin state up to false. - - - - - --connection-limit CONNECTION_LIMIT - - - The maximum number of connections per second allowed - for the vip. Positive integer or -1 for unlimited - (default). - - - - - --description DESCRIPTION - - - Description of the vip. - - - - - --name NAME - - - Name of the vip. - - - - - --protocol-port PROTOCOL_PORT - - - TCP port on which to listen for client traffic that is - associated with the vip address. - - - - - --protocol {TCP,HTTP,HTTPS} - - - Protocol for balancing. - - - - - --subnet-id SUBNET - - - The subnet on which to allocate the vip address. - - - - -
-
- neutron lb-vip-delete - usage: neutron lb-vip-delete [-h] [--request-format {json}] VIP - -Delete a given vip. - - Positional arguments - - VIP - - - ID or name of vip to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lb-vip-show - usage: neutron lb-vip-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - VIP - -Show information of a given vip. - - Positional arguments - - VIP - - - ID or name of vip to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lb-vip-update - usage: neutron lb-vip-update [-h] [--request-format {json}] VIP - -Update a given vip. - - Positional arguments - - VIP - - - ID or name of vip to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lbaas-agent-hosting-loadbalancer - usage: neutron lbaas-agent-hosting-loadbalancer [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] - [-F FIELD] - loadbalancer - -Get lbaas v2 agent hosting a loadbalancer. Deriving from ListCommand though -server will return only one agent to keep common output format for all agent -schedulers - - Positional arguments - - loadbalancer - - - LoadBalancer to query. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lbaas-healthmonitor-delete - usage: neutron lbaas-healthmonitor-delete [-h] [--request-format {json}] - HEALTHMONITOR - -LBaaS v2 Delete a given healthmonitor. - - Positional arguments - - HEALTHMONITOR - - - ID or name of healthmonitor to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lbaas-healthmonitor-show - usage: neutron lbaas-healthmonitor-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] - [-F FIELD] - HEALTHMONITOR - -LBaaS v2 Show information of a given healthmonitor. - - Positional arguments - - HEALTHMONITOR - - - ID or name of healthmonitor to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lbaas-healthmonitor-update - usage: neutron lbaas-healthmonitor-update [-h] [--request-format {json}] - [--name NAME] - HEALTHMONITOR - -LBaaS v2 Update a given healthmonitor. - - Positional arguments - - HEALTHMONITOR - - - ID or name of healthmonitor to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Updated name of the health monitor. - - - - -
-
- neutron lbaas-listener-delete - usage: neutron lbaas-listener-delete [-h] [--request-format {json}] LISTENER - -LBaaS v2 Delete a given listener. - - Positional arguments - - LISTENER - - - ID or name of listener to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lbaas-listener-show - usage: neutron lbaas-listener-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - LISTENER - -LBaaS v2 Show information of a given listener. - - Positional arguments - - LISTENER - - - ID or name of listener to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lbaas-listener-update - usage: neutron lbaas-listener-update [-h] [--request-format {json}] LISTENER - -LBaaS v2 Update a given listener. - - Positional arguments - - LISTENER - - - ID of listener to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lbaas-loadbalancer-create - usage: neutron lbaas-loadbalancer-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--description DESCRIPTION] - [--admin-state-down] [--name NAME] - [--provider PROVIDER] - [--flavor FLAVOR] - [--vip-address VIP_ADDRESS] - VIP_SUBNET - -LBaaS v2 Create a loadbalancer. - - Positional arguments - - VIP_SUBNET - - - Load balancer VIP subnet. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --description DESCRIPTION - - - Description of the load balancer. - - - - - --admin-state-down - - - Set admin state up to false. - - - - - --name NAME - - - Name of the load balancer. - - - - - --provider PROVIDER - - - Provider name of load balancer service. - - - - - --flavor FLAVOR - - - ID or name of flavor. - - - - - --vip-address VIP_ADDRESS - - - VIP address for the load balancer. - - - - -
-
- neutron lbaas-loadbalancer-delete - usage: neutron lbaas-loadbalancer-delete [-h] [--request-format {json}] - LOADBALANCER - -LBaaS v2 Delete a given loadbalancer. - - Positional arguments - - LOADBALANCER - - - ID or name of loadbalancer to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lbaas-loadbalancer-list-on-agent - usage: neutron lbaas-loadbalancer-list-on-agent [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] - [-F FIELD] - lbaas_agent - -List the loadbalancers on a loadbalancer v2 agent. - - Positional arguments - - lbaas_agent - - - ID of the loadbalancer agent to query. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lbaas-loadbalancer-show - usage: neutron lbaas-loadbalancer-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] - [-F FIELD] - LOADBALANCER - -LBaaS v2 Show information of a given loadbalancer. - - Positional arguments - - LOADBALANCER - - - ID or name of loadbalancer to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lbaas-loadbalancer-stats - usage: neutron lbaas-loadbalancer-stats [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] - [-F FIELD] - LOADBALANCER - -Retrieve stats for a given loadbalancer. - - Positional arguments - - LOADBALANCER - - - ID or name of loadbalancer to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lbaas-loadbalancer-update - usage: neutron lbaas-loadbalancer-update [-h] [--request-format {json}] - LOADBALANCER - -LBaaS v2 Update a given loadbalancer. - - Positional arguments - - LOADBALANCER - - - ID or name of loadbalancer to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lbaas-member-create - usage: neutron lbaas-member-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--admin-state-down] [--weight WEIGHT] - [--name NAME] --subnet SUBNET --address - ADDRESS --protocol-port PROTOCOL_PORT - POOL - -LBaaS v2 Create a member. - - Positional arguments - - POOL - - - ID or name of the pool that this member belongs to. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --admin-state-down - - - Set admin state up to false - - - - - --weight WEIGHT - - - Weight of member in the pool (default:1, [0..256]). - - - - - --name NAME - - - Name of the member to be created. - - - - - --subnet SUBNET - - - Subnet ID or name for the member. - - - - - --address ADDRESS - - - IP address of the pool member in the pool. - - - - - --protocol-port PROTOCOL_PORT - - - Port on which the pool member listens for requests or - connections. - - - - -
-
- neutron lbaas-member-delete - usage: neutron lbaas-member-delete [-h] [--request-format {json}] MEMBER POOL - -LBaaS v2 Delete a given member. - - Positional arguments - - MEMBER - - - ID or name of member to delete. - - - - - POOL - - - ID or name of the pool that this member belongs to. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lbaas-member-list - usage: neutron lbaas-member-list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] [-F FIELD] - [-P SIZE] [--sort-key FIELD] - [--sort-dir {asc,desc}] - POOL - -LBaaS v2 List members that belong to a given pool. - - Positional arguments - - POOL - - - ID or name of the pool that this member belongs to. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - - -P SIZE, --page-size SIZE - - - Specify retrieve unit of each request, then split one - request to several requests. - - - - - --sort-key FIELD - - - Sorts the list by the specified fields in the - specified directions. You can repeat this option, but - you must specify an equal number of sort_dir and - sort_key values. Extra sort_dir options are ignored. - Missing sort_dir options use the default asc value. - - - - - --sort-dir {asc,desc} - - - Sorts the list in the specified direction. You can - repeat this option. - - - - -
-
- neutron lbaas-member-show - usage: neutron lbaas-member-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - MEMBER POOL - -LBaaS v2 Show information of a given member. - - Positional arguments - - MEMBER - - - ID or name of member to look up. - - - - - POOL - - - ID or name of the pool that this member belongs to. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lbaas-member-update - usage: neutron lbaas-member-update [-h] [--request-format {json}] - [--admin-state-down] [--weight WEIGHT] - [--name NAME] - MEMBER POOL - -LBaaS v2 Update a given member. - - Positional arguments - - MEMBER - - - ID or name of member to update. - - - - - POOL - - - ID or name of the pool that this member belongs to - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --admin-state-down - - - Set admin state up to false - - - - - --weight WEIGHT - - - Weight of member in the pool (default:1, [0..256]) - - - - - --name NAME - - - Updated name of the member. - - - - -
-
- neutron lbaas-pool-delete - usage: neutron lbaas-pool-delete [-h] [--request-format {json}] POOL - -LBaaS v2 Delete a given pool. - - Positional arguments - - POOL - - - ID or name of pool to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron lbaas-pool-show - usage: neutron lbaas-pool-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - POOL - -LBaaS v2 Show information of a given pool. - - Positional arguments - - POOL - - - ID or name of pool to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron lbaas-pool-update - usage: neutron lbaas-pool-update [-h] [--request-format {json}] POOL - -LBaaS v2 Update a given pool. - - Positional arguments - - POOL - - - ID or name of pool to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron meter-label-create - usage: neutron meter-label-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--description DESCRIPTION] [--shared] - NAME - -Create a metering label for a given tenant. - - Positional arguments - - NAME - - - Name of metering label to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --description DESCRIPTION - - - Description of metering label to create. - - - - - --shared - - - Set the label as shared. - - - - -
-
- neutron meter-label-delete - usage: neutron meter-label-delete [-h] [--request-format {json}] - METERING_LABEL - -Delete a given metering label. - - Positional arguments - - METERING_LABEL - - - ID or name of metering_label to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron meter-label-rule-create - usage: neutron meter-label-rule-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--direction {ingress,egress}] - [--excluded] - LABEL REMOTE_IP_PREFIX - -Create a metering label rule for a given label. - - Positional arguments - - LABEL - - - Id or Name of the label. - - - - - REMOTE_IP_PREFIX - - - CIDR to match on. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --direction {ingress,egress} - - - Direction of traffic, default: ingress. - - - - - --excluded - - - Exclude this CIDR from the label, default: not - excluded. - - - - -
-
- neutron meter-label-rule-delete - usage: neutron meter-label-rule-delete [-h] [--request-format {json}] - METERING_LABEL_RULE - -Delete a given metering label. - - Positional arguments - - METERING_LABEL_RULE - - - ID or name of metering_label_rule to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron meter-label-rule-show - usage: neutron meter-label-rule-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - METERING_LABEL_RULE - -Show information of a given metering label rule. - - Positional arguments - - METERING_LABEL_RULE - - - ID or name of metering_label_rule to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron meter-label-show - usage: neutron meter-label-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - METERING_LABEL - -Show information of a given metering label. - - Positional arguments - - METERING_LABEL - - - ID or name of metering_label to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron net-create - usage: neutron net-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] - [--tenant-id TENANT_ID] [--admin-state-down] - [--shared] [--provider:network_type <network_type>] - [--provider:physical_network <physical_network_name>] - [--provider:segmentation_id <segmentation_id>] - [--vlan-transparent {True,False}] - [--qos-policy QOS_POLICY] - [--availability-zone-hint AVAILABILITY_ZONE] - NAME - -Create a network for a given tenant. - - Positional arguments - - NAME - - - Name of network to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --admin-state-down - - - Set admin state up to false. - - - - - --shared - - - Set the network as shared. - - - - - --provider:network_type <network_type> - - - The physical mechanism by which the virtual network is - implemented. - - - - - --provider:physical_network <physical_network_name> - - - Name of the physical network over which the virtual - network is implemented. - - - - - --provider:segmentation_id <segmentation_id> - - - VLAN ID for VLAN networks or tunnel-id for GRE/VXLAN - networks. - - - - - --vlan-transparent {True,False} - - - Create a vlan transparent network. - - - - - --qos-policy QOS_POLICY - - - Attach QoS policy ID or name to the resource. - - - - - --availability-zone-hint AVAILABILITY_ZONE - - - Availability Zone for the network (requires - availability zone extension, this option can be - repeated). - - - - -
-
- neutron net-delete - usage: neutron net-delete [-h] [--request-format {json}] NETWORK - -Delete a given network. - - Positional arguments - - NETWORK - - - ID or name of network to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron net-gateway-connect - usage: neutron net-gateway-connect [-h] [--request-format {json}] - [--segmentation-type SEGMENTATION_TYPE] - [--segmentation-id SEGMENTATION_ID] - NET-GATEWAY-ID NETWORK-ID - -Add an internal network interface to a router. - - Positional arguments - - NET-GATEWAY-ID - - - ID of the network gateway. - - - - - NETWORK-ID - - - ID of the internal network to connect on the gateway. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --segmentation-type SEGMENTATION_TYPE - - - L2 segmentation strategy on the external side of the - gateway (e.g.: VLAN, FLAT). - - - - - --segmentation-id SEGMENTATION_ID - - - Identifier for the L2 segment on the external side of - the gateway. - - - - -
-
- neutron net-gateway-create - usage: neutron net-gateway-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--device id=ID,interface_name=NAME_OR_ID] - NAME - -Create a network gateway. - - Positional arguments - - NAME - - - Name of network gateway to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --device - - - id=ID,interface_name=NAME_OR_ID - Device info for this gateway. You can repeat this - option for multiple devices for HA gateways. - - - - -
-
- neutron net-gateway-delete - usage: neutron net-gateway-delete [-h] [--request-format {json}] - NETWORK_GATEWAY - -Delete a given network gateway. - - Positional arguments - - NETWORK_GATEWAY - - - ID or name of network_gateway to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron net-gateway-disconnect - usage: neutron net-gateway-disconnect [-h] [--request-format {json}] - [--segmentation-type SEGMENTATION_TYPE] - [--segmentation-id SEGMENTATION_ID] - NET-GATEWAY-ID NETWORK-ID - -Remove a network from a network gateway. - - Positional arguments - - NET-GATEWAY-ID - - - ID of the network gateway. - - - - - NETWORK-ID - - - ID of the internal network to connect on the gateway. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --segmentation-type SEGMENTATION_TYPE - - - L2 segmentation strategy on the external side of the - gateway (e.g.: VLAN, FLAT). - - - - - --segmentation-id SEGMENTATION_ID - - - Identifier for the L2 segment on the external side of - the gateway. - - - - -
-
- neutron net-gateway-show - usage: neutron net-gateway-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - NETWORK_GATEWAY - -Show information of a given network gateway. - - Positional arguments - - NETWORK_GATEWAY - - - ID or name of network_gateway to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron net-gateway-update - usage: neutron net-gateway-update [-h] [--request-format {json}] - NETWORK_GATEWAY - -Update the name for a network gateway. - - Positional arguments - - NETWORK_GATEWAY - - - ID or name of network_gateway to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron net-list-on-dhcp-agent - usage: neutron net-list-on-dhcp-agent [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] - [-F FIELD] [-P SIZE] [--sort-key FIELD] - [--sort-dir {asc,desc}] - dhcp_agent - -List the networks on a DHCP agent. - - Positional arguments - - dhcp_agent - - - ID of the DHCP agent. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - - -P SIZE, --page-size SIZE - - - Specify retrieve unit of each request, then split one - request to several requests. - - - - - --sort-key FIELD - - - Sorts the list by the specified fields in the - specified directions. You can repeat this option, but - you must specify an equal number of sort_dir and - sort_key values. Extra sort_dir options are ignored. - Missing sort_dir options use the default asc value. - - - - - --sort-dir {asc,desc} - - - Sorts the list in the specified direction. You can - repeat this option. - - - - -
-
- neutron net-show - usage: neutron net-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - NETWORK - -Show information of a given network. - - Positional arguments - - NETWORK - - - ID or name of network to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron net-update - usage: neutron net-update [-h] [--request-format {json}] - [--qos-policy QOS_POLICY | --no-qos-policy] - NETWORK - -Update network's information. - - Positional arguments - - NETWORK - - - ID or name of network to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --qos-policy QOS_POLICY - - - Attach QoS policy ID or name to the resource. - - - - - --no-qos-policy - - - Detach QoS policy from the resource. - - - - -
-
- neutron port-create - usage: neutron port-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] - [--tenant-id TENANT_ID] [--name NAME] - [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] - [--device-id DEVICE_ID] - [--device-owner DEVICE_OWNER] [--admin-state-down] - [--mac-address MAC_ADDRESS] - [--vnic-type <direct | direct-physical | macvtap | normal | baremetal>] - [--binding-profile BINDING_PROFILE] - [--security-group SECURITY_GROUP | --no-security-groups] - [--extra-dhcp-opt EXTRA_DHCP_OPTS] - [--qos-policy QOS_POLICY] - [--allowed-address-pair ip_address=IP_ADDR[,mac_address=MAC_ADDR] - | --no-allowed-address-pairs] - NETWORK - -Create a port for a given tenant. - - Positional arguments - - NETWORK - - - Network ID or name this port belongs to. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --name NAME - - - Name of this port. - - - - - --fixed-ip - - - subnet_id=SUBNET,ip_address=IP_ADDR - Desired IP and/or subnet for this port: - subnet_id=<name_or_id>,ip_address=<ip>. You can repeat - this option. - - - - - --device-id DEVICE_ID - - - Device ID of this port. - - - - - --device-owner DEVICE_OWNER - - - Device owner of this port. - - - - - --admin-state-down - - - Set admin state up to false. - - - - - --mac-address MAC_ADDRESS - - - MAC address of this port. - - - - - --vnic-type <direct | direct-physical | macvtap | normal | baremetal> - - - VNIC type for this port. - - - - - --binding-profile BINDING_PROFILE - - - Custom data to be passed as binding:profile. - - - - - --security-group SECURITY_GROUP - - - Security group associated with the port. You can - repeat this option. - - - - - --no-security-groups - - - Associate no security groups with the port. - - - - - --extra-dhcp-opt EXTRA_DHCP_OPTS - - - Extra dhcp options to be assigned to this port: opt_na - me=<dhcp_option_name>,opt_value=<value>,ip_version={4, - 6}. You can repeat this option. - - - - - --qos-policy QOS_POLICY - - - Attach QoS policy ID or name to the resource. - - - - - --allowed-address-pair - - - ip_address=IP_ADDR[,mac_address=MAC_ADDR] - Allowed address pair associated with the port.You can - repeat this option. - - - - - --no-allowed-address-pairs - - - Associate no allowed address pairs with the port. - - - - -
-
- neutron port-delete - usage: neutron port-delete [-h] [--request-format {json}] PORT - -Delete a given port. - - Positional arguments - - PORT - - - ID or name of port to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron port-show - usage: neutron port-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - PORT - -Show information of a given port. - - Positional arguments - - PORT - - - ID or name of port to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron port-update - usage: neutron port-update [-h] [--request-format {json}] [--name NAME] - [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] - [--device-id DEVICE_ID] - [--device-owner DEVICE_OWNER] - [--admin-state-up {True,False}] - [--security-group SECURITY_GROUP | --no-security-groups] - [--extra-dhcp-opt EXTRA_DHCP_OPTS] - [--qos-policy QOS_POLICY | --no-qos-policy] - [--allowed-address-pair ip_address=IP_ADDR[,mac_address=MAC_ADDR] - | --no-allowed-address-pairs] - PORT - -Update port's information. - - Positional arguments - - PORT - - - ID or name of port to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Name of this port. - - - - - --fixed-ip - - - subnet_id=SUBNET,ip_address=IP_ADDR - Desired IP and/or subnet for this port: - subnet_id=<name_or_id>,ip_address=<ip>. You can repeat - this option. - - - - - --device-id DEVICE_ID - - - Device ID of this port. - - - - - --device-owner DEVICE_OWNER - - - Device owner of this port. - - - - - --admin-state-up {True,False} - - - Set admin state up for the port. - - - - - --security-group SECURITY_GROUP - - - Security group associated with the port. You can - repeat this option. - - - - - --no-security-groups - - - Associate no security groups with the port. - - - - - --extra-dhcp-opt EXTRA_DHCP_OPTS - - - Extra dhcp options to be assigned to this port: opt_na - me=<dhcp_option_name>,opt_value=<value>,ip_version={4, - 6}. You can repeat this option. - - - - - --qos-policy QOS_POLICY - - - Attach QoS policy ID or name to the resource. - - - - - --no-qos-policy - - - Detach QoS policy from the resource. - - - - - --allowed-address-pair - - - ip_address=IP_ADDR[,mac_address=MAC_ADDR] - Allowed address pair associated with the port.You can - repeat this option. - - - - - --no-allowed-address-pairs - - - Associate no allowed address pairs with the port. - - - - -
-
- neutron qos-bandwidth-limit-rule-create - usage: neutron qos-bandwidth-limit-rule-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--max-kbps MAX_KBPS] - [--max-burst-kbps MAX_BURST_KBPS] - QOS_POLICY - -Create a qos bandwidth limit rule. - - Positional arguments - - QOS_POLICY - - - ID or name of the QoS policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --max-kbps MAX_KBPS - - - max bandwidth in kbps. - - - - - --max-burst-kbps MAX_BURST_KBPS - - - max burst bandwidth in kbps. - - - - -
-
- neutron qos-bandwidth-limit-rule-delete - usage: neutron qos-bandwidth-limit-rule-delete [-h] [--request-format {json}] - BANDWIDTH_LIMIT_RULE QOS_POLICY - -Delete a given qos bandwidth limit rule. - - Positional arguments - - BANDWIDTH_LIMIT_RULE - - - ID of bandwidth_limit_rule to delete. - - - - - QOS_POLICY - - - ID or name of the QoS policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron qos-bandwidth-limit-rule-list - usage: neutron qos-bandwidth-limit-rule-list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] - [-F FIELD] [-P SIZE] - [--sort-key FIELD] - [--sort-dir {asc,desc}] - QOS_POLICY - -List all qos bandwidth limit rules belonging to the specified policy. - - Positional arguments - - QOS_POLICY - - - ID or name of the QoS policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - - -P SIZE, --page-size SIZE - - - Specify retrieve unit of each request, then split one - request to several requests. - - - - - --sort-key FIELD - - - Sorts the list by the specified fields in the - specified directions. You can repeat this option, but - you must specify an equal number of sort_dir and - sort_key values. Extra sort_dir options are ignored. - Missing sort_dir options use the default asc value. - - - - - --sort-dir {asc,desc} - - - Sorts the list in the specified direction. You can - repeat this option. - - - - -
-
- neutron qos-bandwidth-limit-rule-show - usage: neutron qos-bandwidth-limit-rule-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] - [-F FIELD] - BANDWIDTH_LIMIT_RULE QOS_POLICY - -Show information about the given qos bandwidth limit rule. - - Positional arguments - - BANDWIDTH_LIMIT_RULE - - - ID of bandwidth_limit_rule to look up. - - - - - QOS_POLICY - - - ID or name of the QoS policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron qos-bandwidth-limit-rule-update - usage: neutron qos-bandwidth-limit-rule-update [-h] [--request-format {json}] - [--max-kbps MAX_KBPS] - [--max-burst-kbps MAX_BURST_KBPS] - BANDWIDTH_LIMIT_RULE QOS_POLICY - -Update the given qos bandwidth limit rule. - - Positional arguments - - BANDWIDTH_LIMIT_RULE - - - ID of bandwidth_limit_rule to update. - - - - - QOS_POLICY - - - ID or name of the QoS policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --max-kbps MAX_KBPS - - - max bandwidth in kbps. - - - - - --max-burst-kbps MAX_BURST_KBPS - - - max burst bandwidth in kbps. - - - - -
-
- neutron qos-policy-create - usage: neutron qos-policy-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--description DESCRIPTION] [--shared] - NAME - -Create a qos policy. - - Positional arguments - - NAME - - - Name of QoS policy to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --description DESCRIPTION - - - Description of the QoS policy. - - - - - --shared - - - Accessible by other tenants. Set shared to True - (default is False). - - - - -
-
- neutron qos-policy-delete - usage: neutron qos-policy-delete [-h] [--request-format {json}] POLICY - -Delete a given qos policy. - - Positional arguments - - POLICY - - - ID or name of policy to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron qos-policy-show - usage: neutron qos-policy-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - POLICY - -Show information of a given qos policy. - - Positional arguments - - POLICY - - - ID or name of policy to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron qos-policy-update - usage: neutron qos-policy-update [-h] [--request-format {json}] [--name NAME] - [--description DESCRIPTION] [--shared] - POLICY - -Update a given qos policy. - - Positional arguments - - POLICY - - - ID or name of policy to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Name of QoS policy. - - - - - --description DESCRIPTION - - - Description of the QoS policy. - - - - - --shared - - - Accessible by other tenants. Set shared to True - (default is False). - - - - -
-
- neutron queue-create - usage: neutron queue-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] - [--tenant-id TENANT_ID] [--min MIN] [--max MAX] - [--qos-marking QOS_MARKING] [--default DEFAULT] - [--dscp DSCP] - NAME - -Create a queue. - - Positional arguments - - NAME - - - Name of queue. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --min MIN - - - Minimum rate. - - - - - --max MAX - - - Maximum rate. - - - - - --qos-marking QOS_MARKING - - - QOS marking as untrusted or trusted. - - - - - --default DEFAULT - - - If true all created ports will be the size of this - queue, if queue is not specified - - - - - --dscp DSCP - - - Differentiated Services Code Point. - - - - -
-
- neutron queue-delete - usage: neutron queue-delete [-h] [--request-format {json}] QOS_QUEUE - -Delete a given queue. - - Positional arguments - - QOS_QUEUE - - - ID or name of qos_queue to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron queue-show - usage: neutron queue-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - QOS_QUEUE - -Show information of a given queue. - - Positional arguments - - QOS_QUEUE - - - ID or name of qos_queue to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron rbac-create - usage: neutron rbac-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] - [--tenant-id TENANT_ID] --type {network} - [--target-tenant TARGET_TENANT] --action - {access_as_external,access_as_shared} - RBAC_OBJECT - -Create a RBAC policy for a given tenant. - - Positional arguments - - RBAC_OBJECT - - - ID or name of the RBAC object. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --type {network} - - - Type of the object that RBAC policy affects. - - - - - --target-tenant TARGET_TENANT - - - ID of the tenant to which the RBAC policy will be - enforced. - - - - - --action {access_as_external,access_as_shared} - - - Action for the RBAC policy. - - - - -
-
- neutron rbac-delete - usage: neutron rbac-delete [-h] [--request-format {json}] RBAC_POLICY - -Delete a RBAC policy. - - Positional arguments - - RBAC_POLICY - - - ID of rbac_policy to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron rbac-show - usage: neutron rbac-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - RBAC_POLICY - -Show information of a given RBAC policy. - - Positional arguments - - RBAC_POLICY - - - ID of rbac_policy to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron rbac-update - usage: neutron rbac-update [-h] [--request-format {json}] - [--target-tenant TARGET_TENANT] - RBAC_POLICY - -Update RBAC policy for given tenant. - - Positional arguments - - RBAC_POLICY - - - ID of rbac_policy to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --target-tenant TARGET_TENANT - - - ID of the tenant to which the RBAC policy will be - enforced. - - - - -
-
- neutron router-create - usage: neutron router-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] - [--tenant-id TENANT_ID] [--admin-state-down] - [--distributed {True,False}] [--ha {True,False}] - [--availability-zone-hint AVAILABILITY_ZONE] - NAME - -Create a router for a given tenant. - - Positional arguments - - NAME - - - Name of router to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --admin-state-down - - - Set admin state up to false. - - - - - --distributed {True,False} - - - Create a distributed router. - - - - - --ha {True,False} - - - Create a highly available router. - - - - - --availability-zone-hint AVAILABILITY_ZONE - - - Availability Zone for the router (requires - availability zone extension, this option can be - repeated). - - - - -
-
- neutron router-delete - usage: neutron router-delete [-h] [--request-format {json}] ROUTER - -Delete a given router. - - Positional arguments - - ROUTER - - - ID or name of router to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron router-gateway-clear - usage: neutron router-gateway-clear [-h] [--request-format {json}] ROUTER - -Remove an external network gateway from a router. - - Positional arguments - - ROUTER - - - ID or name of the router. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron router-gateway-set - usage: neutron router-gateway-set [-h] [--request-format {json}] - [--disable-snat] [--fixed-ip FIXED_IP] - ROUTER EXTERNAL-NETWORK - -Set the external network gateway for a router. - - Positional arguments - - ROUTER - - - ID or name of the router. - - - - - EXTERNAL-NETWORK - - - ID or name of the external network for the gateway. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --disable-snat - - - Disable source NAT on the router gateway. - - - - - --fixed-ip FIXED_IP - - - Desired IP and/or subnet on external network: - subnet_id=<name_or_id>,ip_address=<ip>. You can repeat - this option. - - - - -
-
- neutron router-interface-add - usage: neutron router-interface-add [-h] [--request-format {json}] - ROUTER INTERFACE - -Add an internal network interface to a router. - - Positional arguments - - ROUTER - - - ID or name of the router. - - - - - INTERFACE - - - The format is "SUBNET|subnet=SUBNET|port=PORT". Either - a subnet or port must be specified. Both ID and name - are accepted as SUBNET or PORT. Note that "subnet=" - can be omitted when specifying a subnet. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron router-interface-delete - usage: neutron router-interface-delete [-h] [--request-format {json}] - ROUTER INTERFACE - -Remove an internal network interface from a router. - - Positional arguments - - ROUTER - - - ID or name of the router. - - - - - INTERFACE - - - The format is "SUBNET|subnet=SUBNET|port=PORT". Either - a subnet or port must be specified. Both ID and name - are accepted as SUBNET or PORT. Note that "subnet=" - can be omitted when specifying a subnet. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron router-list-on-l3-agent - usage: neutron router-list-on-l3-agent [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] - [-F FIELD] - l3_agent - -List the routers on a L3 agent. - - Positional arguments - - l3_agent - - - ID of the L3 agent to query. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron router-port-list - usage: neutron router-port-list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--request-format {json}] [-D] [-F FIELD] - [-P SIZE] [--sort-key FIELD] - [--sort-dir {asc,desc}] - router - -List ports that belong to a given tenant, with specified router. - - Positional arguments - - router - - - ID or name of router to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - - -P SIZE, --page-size SIZE - - - Specify retrieve unit of each request, then split one - request to several requests. - - - - - --sort-key FIELD - - - Sorts the list by the specified fields in the - specified directions. You can repeat this option, but - you must specify an equal number of sort_dir and - sort_key values. Extra sort_dir options are ignored. - Missing sort_dir options use the default asc value. - - - - - --sort-dir {asc,desc} - - - Sorts the list in the specified direction. You can - repeat this option. - - - - -
-
- neutron router-show - usage: neutron router-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - ROUTER - -Show information of a given router. - - Positional arguments - - ROUTER - - - ID or name of router to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron router-update - usage: neutron router-update [-h] [--request-format {json}] [--name NAME] - [--admin-state-up {True,False}] - [--distributed {True,False}] - [--route destination=CIDR,nexthop=IP_ADDR | --no-routes] - ROUTER - -Update router's information. - - Positional arguments - - ROUTER - - - ID or name of router to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Name of this router. - - - - - --admin-state-up {True,False} - - - Specify the administrative state of the router (True - meaning "Up") - - - - - --distributed {True,False} - - - True means this router should operate in distributed - mode. - - - - - --route - - - destination=CIDR,nexthop=IP_ADDR - Route to associate with the router. You can repeat - this option. - - - - - --no-routes - - - Remove routes associated with the router. - - - - -
-
- neutron security-group-create - usage: neutron security-group-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--description DESCRIPTION] - NAME - -Create a security group. - - Positional arguments - - NAME - - - Name of security group. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --description DESCRIPTION - - - Description of security group. - - - - -
-
- neutron security-group-delete - usage: neutron security-group-delete [-h] [--request-format {json}] - SECURITY_GROUP - -Delete a given security group. - - Positional arguments - - SECURITY_GROUP - - - ID or name of security_group to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron security-group-rule-create - usage: neutron security-group-rule-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--direction {ingress,egress}] - [--ethertype ETHERTYPE] - [--protocol PROTOCOL] - [--port-range-min PORT_RANGE_MIN] - [--port-range-max PORT_RANGE_MAX] - [--remote-ip-prefix REMOTE_IP_PREFIX] - [--remote-group-id REMOTE_GROUP] - SECURITY_GROUP - -Create a security group rule. - - Positional arguments - - SECURITY_GROUP - - - Security group name or ID to add rule. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --direction {ingress,egress} - - - Direction of traffic: ingress/egress. - - - - - --ethertype ETHERTYPE - - - IPv4/IPv6 - - - - - --protocol PROTOCOL - - - Protocol of packet. Allowed values are [icmp, icmpv6, - tcp, udp] and integer representations [0-255] - - - - - --port-range-min PORT_RANGE_MIN - - - Starting port range. For ICMP it is type. - - - - - --port-range-max PORT_RANGE_MAX - - - Ending port range. For ICMP it is code. - - - - - --remote-ip-prefix REMOTE_IP_PREFIX - - - CIDR to match on. - - - - - --remote-group-id REMOTE_GROUP - - - Remote security group name or ID to apply rule. - - - - -
-
- neutron security-group-rule-delete - usage: neutron security-group-rule-delete [-h] [--request-format {json}] - SECURITY_GROUP_RULE - -Delete a given security group rule. - - Positional arguments - - SECURITY_GROUP_RULE - - - ID of security_group_rule to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron security-group-rule-show - usage: neutron security-group-rule-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] - [-F FIELD] - SECURITY_GROUP_RULE - -Show information of a given security group rule. - - Positional arguments - - SECURITY_GROUP_RULE - - - ID of security_group_rule to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron security-group-show - usage: neutron security-group-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - SECURITY_GROUP - -Show information of a given security group. - - Positional arguments - - SECURITY_GROUP - - - ID or name of security_group to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron security-group-update - usage: neutron security-group-update [-h] [--request-format {json}] - [--name NAME] [--description DESCRIPTION] - SECURITY_GROUP - -Update a given security group. - - Positional arguments - - SECURITY_GROUP - - - ID or name of security_group to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Name of security group. - - - - - --description DESCRIPTION - - - Description of security group. - - - - -
-
- neutron subnet-create - usage: neutron subnet-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] - [--tenant-id TENANT_ID] [--name NAME] - [--gateway GATEWAY_IP | --no-gateway] - [--allocation-pool start=IP_ADDR,end=IP_ADDR] - [--host-route destination=CIDR,nexthop=IP_ADDR] - [--dns-nameserver DNS_NAMESERVER] - [--disable-dhcp] [--enable-dhcp] - [--ip-version {4,6}] - [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] - [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] - [--subnetpool SUBNETPOOL] - [--prefixlen PREFIX_LENGTH] - NETWORK [CIDR] - -Create a subnet for a given tenant. - - Positional arguments - - NETWORK - - - Network ID or name this subnet belongs to. - - - - - CIDR - - - CIDR of subnet to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --name NAME - - - Name of this subnet. - - - - - --gateway GATEWAY_IP - - - Gateway IP of this subnet. - - - - - --no-gateway - - - No distribution of gateway. - - - - - --allocation-pool - - - start=IP_ADDR,end=IP_ADDR - Allocation pool IP addresses for this subnet (This - option can be repeated). - - - - - --host-route - - - destination=CIDR,nexthop=IP_ADDR - Additional route (This option can be repeated). - - - - - --dns-nameserver DNS_NAMESERVER - - - DNS name server for this subnet (This option can be - repeated). - - - - - --disable-dhcp - - - Disable DHCP for this subnet. - - - - - --enable-dhcp - - - Enable DHCP for this subnet. - - - - - --ip-version {4,6} IP - - - version to use, default is 4. Note that when - subnetpool is specified, IP version is determined from - the subnetpool and this option is ignored. - - - - - --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} - - - IPv6 RA (Router Advertisement) mode. - - - - - --ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} - - - IPv6 address mode. - - - - - --subnetpool SUBNETPOOL - - - ID or name of subnetpool from which this subnet will - obtain a CIDR. - - - - - --prefixlen PREFIX_LENGTH - - - Prefix length for subnet allocation from subnetpool. - - - - -
-
- neutron subnet-delete - usage: neutron subnet-delete [-h] [--request-format {json}] SUBNET - -Delete a given subnet. - - Positional arguments - - SUBNET - - - ID or name of subnet to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron subnet-show - usage: neutron subnet-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--request-format {json}] [-D] - [-F FIELD] - SUBNET - -Show information of a given subnet. - - Positional arguments - - SUBNET - - - ID or name of subnet to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron subnet-update - usage: neutron subnet-update [-h] [--request-format {json}] [--name NAME] - [--gateway GATEWAY_IP | --no-gateway] - [--allocation-pool start=IP_ADDR,end=IP_ADDR] - [--host-route destination=CIDR,nexthop=IP_ADDR] - [--dns-nameserver DNS_NAMESERVER] - [--disable-dhcp] [--enable-dhcp] - SUBNET - -Update subnet's information. - - Positional arguments - - SUBNET - - - ID or name of subnet to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Name of this subnet. - - - - - --gateway GATEWAY_IP - - - Gateway IP of this subnet. - - - - - --no-gateway - - - No distribution of gateway. - - - - - --allocation-pool - - - start=IP_ADDR,end=IP_ADDR - Allocation pool IP addresses for this subnet (This - option can be repeated). - - - - - --host-route - - - destination=CIDR,nexthop=IP_ADDR - Additional route (This option can be repeated). - - - - - --dns-nameserver DNS_NAMESERVER - - - DNS name server for this subnet (This option can be - repeated). - - - - - --disable-dhcp - - - Disable DHCP for this subnet. - - - - - --enable-dhcp - - - Enable DHCP for this subnet. - - - - -
-
- neutron subnetpool-create - usage: neutron subnetpool-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--min-prefixlen MIN_PREFIXLEN] - [--max-prefixlen MAX_PREFIXLEN] - [--default-prefixlen DEFAULT_PREFIXLEN] - [--pool-prefix PREFIXES] [--shared] - [--address-scope ADDRSCOPE] - name - -Create a subnetpool for a given tenant. - - Positional arguments - - name - - - Name of subnetpool to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --min-prefixlen MIN_PREFIXLEN - - - Subnetpool minimum prefix length. - - - - - --max-prefixlen MAX_PREFIXLEN - - - Subnetpool maximum prefix length. - - - - - --default-prefixlen DEFAULT_PREFIXLEN - - - Subnetpool default prefix length. - - - - - --pool-prefix PREFIXES - - - Subnetpool prefixes (This option can be repeated). - - - - - --shared - - - Set the subnetpool as shared. - - - - - --address-scope ADDRSCOPE - - - ID or name of the address scope with which the - subnetpool is associated. Prefixes must be unique - across address scopes - - - - -
-
- neutron subnetpool-delete - usage: neutron subnetpool-delete [-h] [--request-format {json}] SUBNETPOOL - -Delete a given subnetpool. - - Positional arguments - - SUBNETPOOL - - - ID or name of subnetpool to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron subnetpool-show - usage: neutron subnetpool-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - SUBNETPOOL - -Show information of a given subnetpool. - - Positional arguments - - SUBNETPOOL - - - ID or name of subnetpool to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron subnetpool-update - usage: neutron subnetpool-update [-h] [--request-format {json}] - [--min-prefixlen MIN_PREFIXLEN] - [--max-prefixlen MAX_PREFIXLEN] - [--default-prefixlen DEFAULT_PREFIXLEN] - [--pool-prefix PREFIXES] [--name NAME] - [--address-scope ADDRSCOPE | --no-address-scope] - SUBNETPOOL - -Update subnetpool's information. - - Positional arguments - - SUBNETPOOL - - - ID or name of subnetpool to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --min-prefixlen MIN_PREFIXLEN - - - Subnetpool minimum prefix length. - - - - - --max-prefixlen MAX_PREFIXLEN - - - Subnetpool maximum prefix length. - - - - - --default-prefixlen DEFAULT_PREFIXLEN - - - Subnetpool default prefix length. - - - - - --pool-prefix PREFIXES - - - Subnetpool prefixes (This option can be repeated). - - - - - --name NAME - - - Name of subnetpool to update. - - - - - --address-scope ADDRSCOPE - - - ID or name of the address scope with which the - subnetpool is associated. Prefixes must be unique - across address scopes - - - - - --no-address-scope - - - Detach subnetpool from the address scope - - - - -
-
- neutron vpn-endpoint-group-delete - usage: neutron vpn-endpoint-group-delete [-h] [--request-format {json}] - ENDPOINT_GROUP - -Delete a given VPN endpoint group. - - Positional arguments - - ENDPOINT_GROUP - - - ID or name of endpoint_group to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron vpn-endpoint-group-show - usage: neutron vpn-endpoint-group-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] - [-F FIELD] - ENDPOINT_GROUP - -Show a specific VPN endpoint group. - - Positional arguments - - ENDPOINT_GROUP - - - ID or name of endpoint_group to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron vpn-endpoint-group-update - usage: neutron vpn-endpoint-group-update [-h] [--request-format {json}] - [--name NAME] - [--description DESCRIPTION] - ENDPOINT_GROUP - -Update a given VPN endpoint group. - - Positional arguments - - ENDPOINT_GROUP - - - ID or name of endpoint_group to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --name NAME - - - Set a name for the endpoint group. - - - - - --description DESCRIPTION - - - Set a description for the endpoint group. - - - - -
-
- neutron vpn-ikepolicy-create - usage: neutron vpn-ikepolicy-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--description DESCRIPTION] - [--auth-algorithm {sha1}] - [--encryption-algorithm ENCRYPTION_ALGORITHM] - [--phase1-negotiation-mode {main}] - [--ike-version {v1,v2}] - [--pfs {group2,group5,group14}] - [--lifetime units=UNITS,value=VALUE] - NAME - -Create an IKE policy. - - Positional arguments - - NAME - - - Name of the IKE policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --description DESCRIPTION - - - Description of the IKE policy - - - - - --auth-algorithm {sha1} - - - Authentication algorithm in lowercase. Default:sha1 - - - - - --encryption-algorithm ENCRYPTION_ALGORITHM - - - Encryption algorithm in lowercase, default:aes-128 - - - - - --phase1-negotiation-mode {main} - - - IKE Phase1 negotiation mode in lowercase, default:main - - - - - --ike-version {v1,v2} - - - IKE version in lowercase, default:v1 - - - - - --pfs {group2,group5,group14} - - - Perfect Forward Secrecy in lowercase, default:group5 - - - - - --lifetime - - - units=UNITS,value=VALUE - IKE lifetime attributes. 'units'-seconds, - default:seconds. 'value'-non negative integer, - default:3600. - - - - -
-
- neutron vpn-ikepolicy-delete - usage: neutron vpn-ikepolicy-delete [-h] [--request-format {json}] IKEPOLICY - -Delete a given IKE policy. - - Positional arguments - - IKEPOLICY - - - ID or name of ikepolicy to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron vpn-ikepolicy-show - usage: neutron vpn-ikepolicy-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - IKEPOLICY - -Show information of a given IKE policy. - - Positional arguments - - IKEPOLICY - - - ID or name of ikepolicy to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron vpn-ikepolicy-update - usage: neutron vpn-ikepolicy-update [-h] [--request-format {json}] - [--lifetime units=UNITS,value=VALUE] - IKEPOLICY - -Update a given IKE policy. - - Positional arguments - - IKEPOLICY - - - ID or name of ikepolicy to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --lifetime - - - units=UNITS,value=VALUE - IKE lifetime attributes. 'units'-seconds, - default:seconds. 'value'-non negative integer, - default:3600. - - - - -
-
- neutron vpn-ipsecpolicy-create - usage: neutron vpn-ipsecpolicy-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] - [--description DESCRIPTION] - [--transform-protocol {esp,ah,ah-esp}] - [--auth-algorithm {sha1}] - [--encryption-algorithm ENCRYPTION_ALGORITHM] - [--encapsulation-mode {tunnel,transport}] - [--pfs {group2,group5,group14}] - [--lifetime units=UNITS,value=VALUE] - NAME - -Create an IPsec policy. - - Positional arguments - - NAME - - - Name of the IPsec policy. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --description DESCRIPTION - - - Description of the IPsec policy. - - - - - --transform-protocol {esp,ah,ah-esp} - - - Transform protocol in lowercase, default:esp - - - - - --auth-algorithm {sha1} - - - Authentication algorithm in lowercase, default:sha1 - - - - - --encryption-algorithm ENCRYPTION_ALGORITHM - - - Encryption algorithm in lowercase, default:aes-128 - - - - - --encapsulation-mode {tunnel,transport} - - - Encapsulation mode in lowercase, default:tunnel - - - - - --pfs {group2,group5,group14} - - - Perfect Forward Secrecy in lowercase, default:group5 - - - - - --lifetime - - - units=UNITS,value=VALUE - IPsec lifetime attributes. 'units'-seconds, - default:seconds. 'value'-non negative integer, - default:3600. - - - - -
-
- neutron vpn-ipsecpolicy-delete - usage: neutron vpn-ipsecpolicy-delete [-h] [--request-format {json}] - IPSECPOLICY - -Delete a given IPsec policy. - - Positional arguments - - IPSECPOLICY - - - ID or name of ipsecpolicy to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron vpn-ipsecpolicy-show - usage: neutron vpn-ipsecpolicy-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - IPSECPOLICY - -Show information of a given IPsec policy. - - Positional arguments - - IPSECPOLICY - - - ID or name of ipsecpolicy to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron vpn-ipsecpolicy-update - usage: neutron vpn-ipsecpolicy-update [-h] [--request-format {json}] - [--lifetime units=UNITS,value=VALUE] - IPSECPOLICY - -Update a given IPsec policy. - - Positional arguments - - IPSECPOLICY - - - ID or name of ipsecpolicy to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --lifetime - - - units=UNITS,value=VALUE - IPsec lifetime attributes. 'units'-seconds, - default:seconds. 'value'-non negative integer, - default:3600. - - - - -
-
- neutron vpn-service-create - usage: neutron vpn-service-create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] - [--tenant-id TENANT_ID] [--admin-state-down] - [--name NAME] [--description DESCRIPTION] - ROUTER [SUBNET] - -Create a VPN service. - - Positional arguments - - ROUTER - - - Router unique identifier for the VPN service. - - - - - SUBNET - - - [DEPRECATED in Mitaka] Unique identifier for the local - private subnet. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - --tenant-id TENANT_ID - - - The owner tenant ID. - - - - - --admin-state-down - - - Set admin state up to false. - - - - - --name NAME - - - Set a name for the VPN service. - - - - - --description DESCRIPTION - - - Set a description for the VPN service. - - - - -
-
- neutron vpn-service-delete - usage: neutron vpn-service-delete [-h] [--request-format {json}] VPNSERVICE - -Delete a given VPN service. - - Positional arguments - - VPNSERVICE - - - ID or name of vpnservice to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
-
- neutron vpn-service-show - usage: neutron vpn-service-show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--request-format {json}] [-D] [-F FIELD] - VPNSERVICE - -Show information of a given VPN service. - - Positional arguments - - VPNSERVICE - - - ID or name of vpnservice to look up. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - - -D, --show-details - - - Show detailed information. - - - - - -F FIELD, --field FIELD - - - Specify the field(s) to be returned by server. You can - repeat this option. - - - - -
-
- neutron vpn-service-update - usage: neutron vpn-service-update [-h] [--request-format {json}] VPNSERVICE - -Update a given VPN service. - - Positional arguments - - VPNSERVICE - - - ID or name of vpnservice to update. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-format {json} - - - DEPRECATED! Only JSON request format is supported. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_nova_commands.xml b/doc/cli-reference/generated/ch_cli_nova_commands.xml deleted file mode 100644 index f77d5c6c3d..0000000000 --- a/doc/cli-reference/generated/ch_cli_nova_commands.xml +++ /dev/null @@ -1,7415 +0,0 @@ - - - - - - - - Compute command-line client - - The nova client is the command-line - interface (CLI) for the OpenStack Compute API and its extensions. - - This chapter documents nova version - 3.2.0. - - - For help on a specific nova - command, enter: - - $ nova COMMAND - -
- nova usage - usage: nova [--version] [--debug] [--os-cache] [--timings] - [--os-region-name <region-name>] [--service-type <service-type>] - [--service-name <service-name>] - [--volume-service-name <volume-service-name>] - [--os-endpoint-type <endpoint-type>] - [--os-compute-api-version <compute-api-ver>] - [--bypass-url <bypass-url>] [--insecure] - [--os-cacert <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>] - [--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-default-domain-id OS_DEFAULT_DOMAIN_ID] - [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME] - [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] - [--os-user-domain-id OS_USER_DOMAIN_ID] - [--os-user-domain-name OS_USER_DOMAIN_NAME] - [--os-password OS_PASSWORD] - <subcommand> ... - - Subcommands - - absolute-limits - - - DEPRECATED, use limits instead. - - - - - add-fixed-ip - - - Add new IP address on a network to server. - - - - - add-floating-ip - - - DEPRECATED, use floating-ip-associate instead. - - - - - add-secgroup - - - Add a Security Group to a server. - - - - - agent-create - - - Create new agent build. - - - - - agent-delete - - - Delete existing agent build. - - - - - agent-list - - - List all builds. - - - - - agent-modify - - - Modify existing agent build. - - - - - aggregate-add-host - - - Add the host to the specified aggregate. - - - - - aggregate-create - - - Create a new aggregate with the specified - details. - - - - - aggregate-delete - - - Delete the aggregate. - - - - - aggregate-details - - - Show details of the specified aggregate. - - - - - aggregate-list - - - Print a list of all aggregates. - - - - - aggregate-remove-host - - - Remove the specified host from the specified - aggregate. - - - - - aggregate-set-metadata - - - Update the metadata associated with the - aggregate. - - - - - aggregate-update - - - Update the aggregate's name and optionally - availability zone. - - - - - availability-zone-list - - - List all the availability zones. - - - - - backup - - - Backup a server by creating a 'backup' type - snapshot. - - - - - boot - - - Boot a new server. - - - - - clear-password - - - Clear the admin password for a server. - - - - - cloudpipe-configure - - - Update the VPN IP/port of a cloudpipe - instance. - - - - - cloudpipe-create - - - Create a cloudpipe instance for the given - project. - - - - - cloudpipe-list - - - Print a list of all cloudpipe instances. - - - - - console-log - - - Get console log output of a server. - - - - - credentials - - - Show user credentials returned from auth. - - - - - delete - - - Immediately shut down and delete specified - server(s). - - - - - diagnostics - - - Retrieve server diagnostics. - - - - - dns-create - - - Create a DNS entry for domain, name, and IP. - - - - - dns-create-private-domain - - - Create the specified DNS domain. - - - - - dns-create-public-domain - - - Create the specified DNS domain. - - - - - dns-delete - - - Delete the specified DNS entry. - - - - - dns-delete-domain - - - Delete the specified DNS domain. - - - - - dns-domains - - - Print a list of available dns domains. - - - - - dns-list - - - List current DNS entries for domain and IP or - domain and name. - - - - - endpoints - - - Discover endpoints that get returned from the - authenticate services. - - - - - evacuate - - - Evacuate server from failed host. - - - - - fixed-ip-get - - - Retrieve info on a fixed IP. - - - - - fixed-ip-reserve - - - Reserve a fixed IP. - - - - - fixed-ip-unreserve - - - Unreserve a fixed IP. - - - - - flavor-access-add - - - Add flavor access for the given tenant. - - - - - flavor-access-list - - - Print access information about the given - flavor. - - - - - flavor-access-remove - - - Remove flavor access for the given tenant. - - - - - flavor-create - - - Create a new flavor. - - - - - flavor-delete - - - Delete a specific flavor - - - - - flavor-key - - - Set or unset extra_spec for a flavor. - - - - - flavor-list - - - Print a list of available 'flavors' (sizes of - servers). - - - - - flavor-show - - - Show details about the given flavor. - - - - - floating-ip-associate - - - Associate a floating IP address to a server. - - - - - floating-ip-bulk-create - - - Bulk create floating IPs by range (nova- - network only). - - - - - floating-ip-bulk-delete - - - Bulk delete floating IPs by range (nova- - network only). - - - - - floating-ip-bulk-list - - - List all floating IPs (nova-network only). - - - - - floating-ip-create - - - Allocate a floating IP for the current tenant. - - - - - floating-ip-delete - - - De-allocate a floating IP. - - - - - floating-ip-disassociate - - - Disassociate a floating IP address from a - server. - - - - - floating-ip-list - - - List floating IPs. - - - - - floating-ip-pool-list - - - List all floating IP pools. - - - - - get-mks-console - - - Get a serial console to a server. (Supported - by API versions '2.8' - '2.latest') [hint: use - '--os-compute-api-version' flag to show help - message for proper version] - - - - - get-password - - - Get the admin password for a server. - - - - - get-rdp-console - - - Get a rdp console to a server. - - - - - get-serial-console - - - Get a serial console to a server. - - - - - get-spice-console - - - Get a spice console to a server. - - - - - get-vnc-console - - - Get a vnc console to a server. - - - - - host-action - - - Perform a power action on a host. - - - - - host-describe - - - Describe a specific host. - - - - - host-list - - - List all hosts by service. - - - - - host-update - - - Update host settings. - - - - - hypervisor-list - - - List hypervisors. - - - - - hypervisor-servers - - - List servers belonging to specific - hypervisors. - - - - - hypervisor-show - - - Display the details of the specified - hypervisor. - - - - - hypervisor-stats - - - Get hypervisor statistics over all compute - nodes. - - - - - hypervisor-uptime - - - Display the uptime of the specified - hypervisor. - - - - - image-create - - - Create a new image by taking a snapshot of a - running server. - - - - - image-delete - - - Delete specified image(s). - - - - - image-list - - - Print a list of available images to boot from. - - - - - image-meta - - - Set or delete metadata on an image. - - - - - image-show - - - Show details about the given image. - - - - - interface-attach - - - Attach a network interface to a server. - - - - - interface-detach - - - Detach a network interface from a server. - - - - - interface-list - - - List interfaces attached to a server. - - - - - keypair-add - - - Create a new key pair for use with servers. - - - - - keypair-delete - - - Delete keypair given by its name. (Supported - by API versions '2.0' - '2.latest') [hint: use - '--os-compute-api-version' flag to show help - message for proper version] - - - - - keypair-list - - - Print a list of keypairs for a user (Supported - by API versions '2.0' - '2.latest') [hint: use - '--os-compute-api-version' flag to show help - message for proper version] - - - - - keypair-show - - - Show details about the given keypair. - (Supported by API versions '2.0' - '2.latest') - [hint: use '--os-compute-api-version' flag to - show help message for proper version] - - - - - limits - - - Print rate and absolute limits. - - - - - list - - - List active servers. - - - - - list-secgroup - - - List Security Group(s) of a server. - - - - - live-migration - - - Migrate running server to a new machine. - - - - - lock - - - Lock a server. A normal (non-admin) user will - not be able to execute actions on a locked - server. - - - - - meta - - - Set or delete metadata on a server. - - - - - migrate - - - Migrate a server. The new host will be - selected by the scheduler. - - - - - network-associate-host - - - Associate host with network. - - - - - network-associate-project - - - Associate project with network. - - - - - network-create - - - Create a network. - - - - - network-delete - - - Delete network by label or id. - - - - - network-disassociate - - - Disassociate host and/or project from the - given network. - - - - - network-list - - - Print a list of available networks. - - - - - network-show - - - Show details about the given network. - - - - - pause - - - Pause a server. - - - - - 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 so their 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 - - - DEPRECATED, use limits instead. - - - - - reboot - - - Reboot a server. - - - - - rebuild - - - Shutdown, re-image, and re-boot a server. - - - - - refresh-network - - - Refresh server network information. - - - - - remove-fixed-ip - - - Remove an IP address from a server. - - - - - remove-floating-ip - - - DEPRECATED, use floating-ip-disassociate - instead. - - - - - remove-secgroup - - - Remove a Security Group from a server. - - - - - rename - - - Rename a server. - - - - - rescue - - - Reboots a server into rescue mode, which - starts the machine from either the initial - image or a specified image, attaching the - current boot disk as secondary. - - - - - reset-network - - - Reset network of a server. - - - - - reset-state - - - Reset the state of a server. - - - - - resize - - - Resize a server. - - - - - resize-confirm - - - Confirm a previous resize. - - - - - resize-revert - - - Revert a previous resize (and return to the - previous VM). - - - - - resume - - - Resume a server. - - - - - root-password - - - DEPRECATED, use set-password instead. - - - - - scrub - - - Delete networks and security groups associated - with a project. - - - - - secgroup-add-default-rule - - - Add a rule to the set of rules that will be - added to the 'default' security group for new - tenants (nova-network only). - - - - - secgroup-add-group-rule - - - Add a source group rule to a security group. - - - - - secgroup-add-rule - - - Add a rule to a security group. - - - - - secgroup-create - - - Create a security group. - - - - - secgroup-delete - - - Delete a security group. - - - - - secgroup-delete-default-rule - - - Delete a rule from the set of rules that will - be added to the 'default' security group for - new tenants (nova-network only). - - - - - secgroup-delete-group-rule - - - Delete a source group rule from a security - group. - - - - - secgroup-delete-rule - - - Delete a rule from a security group. - - - - - secgroup-list - - - List security groups for the current tenant. - - - - - secgroup-list-default-rules - - - List rules that will be added to the 'default' - security group for new tenants. - - - - - secgroup-list-rules - - - List rules for a security group. - - - - - secgroup-update - - - Update a security group. - - - - - server-group-create - - - Create a new server group with the specified - details. - - - - - server-group-delete - - - Delete specific server group(s). - - - - - server-group-get - - - Get a specific server group. - - - - - server-group-list - - - Print a list of all server groups. - - - - - service-delete - - - Delete the service. - - - - - service-disable - - - Disable the service. - - - - - service-enable - - - Enable the service. - - - - - service-force-down - - - Force service to down. (Supported by API - versions '2.11' - '2.latest') [hint: use - '--os-compute-api-version' flag to show help - message for proper version] - - - - - service-list - - - Show a list of all running services. Filter by - host & binary. - - - - - set-password - - - Change the admin password for a server. - - - - - shelve - - - Shelve a server. - - - - - shelve-offload - - - Remove a shelved server from the compute node. - - - - - show - - - Show details about the given server. - - - - - ssh - - - SSH into a server. - - - - - start - - - Start the server(s). - - - - - stop - - - Stop the server(s). - - - - - suspend - - - Suspend a server. - - - - - unlock - - - Unlock a server. - - - - - unpause - - - Unpause a server. - - - - - unrescue - - - Restart the server from normal boot disk - again. - - - - - unshelve - - - Unshelve a server. - - - - - usage - - - Show usage data for a single tenant. - - - - - usage-list - - - List usage data for all tenants. - - - - - version-list - - - List all API versions. - - - - - virtual-interface-list - - - Show virtual interface info about the given - server. - - - - - volume-attach - - - Attach a volume to a server. - - - - - volume-attachments - - - List all the volumes attached to a server. - - - - - volume-create - - - DEPRECATED: Add a new volume. - - - - - volume-delete - - - DEPRECATED: Remove volume(s). - - - - - volume-detach - - - Detach a volume from a server. - - - - - volume-list - - - DEPRECATED: List all the volumes. - - - - - volume-show - - - DEPRECATED: Show details about a volume. - - - - - volume-snapshot-create - - - DEPRECATED: Add a new snapshot. - - - - - volume-snapshot-delete - - - DEPRECATED: Remove a snapshot. - - - - - volume-snapshot-list - - - DEPRECATED: List all the snapshots. - - - - - volume-snapshot-show - - - DEPRECATED: Show details about a snapshot. - - - - - volume-type-create - - - DEPRECATED: Create a new volume type. - - - - - volume-type-delete - - - DEPRECATED: Delete a specific volume type. - - - - - volume-type-list - - - DEPRECATED: Print a list of available 'volume - types'. - - - - - volume-update - - - Update volume attachment. - - - - - x509-create-cert - - - Create x509 cert for a user in tenant. - - - - - x509-get-root-cert - - - Fetch the x509 root cert. - - - - - bash-completion - - - Prints all of the commands and options to - stdout so that the nova.bash_completion script - doesn't have to hard code them. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - - host-evacuate-live - - - Live migrate all instances of the specified - host to other available hosts. - - - - - cell-capacities - - - Get cell capacities for all cells or a given - cell. - - - - - cell-show - - - Show details of a given cell. - - - - - migration-list - - - Print a list of migrations. - - - - - instance-action - - - Show an action. - - - - - instance-action-list - - - List actions on a server. - - - - - net - - - DEPRECATED, use tenant-network-show instead. - - - - - net-create - - - DEPRECATED, use tenant-network-create instead. - - - - - net-delete - - - DEPRECATED, use tenant-network-delete instead. - - - - - net-list - - - DEPRECATED, use tenant-network-list instead. - - - - - tenant-network-create - - - Create a tenant network. - - - - - tenant-network-delete - - - Delete a tenant network. - - - - - tenant-network-list - - - List tenant networks. - - - - - tenant-network-show - - - Show a tenant network. - - - - - host-servers-migrate - - - Migrate all instances of the specified host to - other available hosts. - - - - - host-evacuate - - - Evacuate all instances from failed host. - - - - - host-meta - - - Set or Delete metadata on all instances of a - host. - - - - - list-extensions - - - List all the os-api extensions that are - available. - - - - - force-delete - - - Force delete a server. - - - - - restore - - - Restore a soft-deleted server. - - - - - baremetal-interface-add - - - Add a network interface to a baremetal node. - - - - - baremetal-interface-list - - - List network interfaces associated with a - baremetal node. - - - - - baremetal-interface-remove - - - Remove a network interface from a baremetal - node. - - - - - baremetal-node-create - - - Create a baremetal node. - - - - - baremetal-node-delete - - - Remove a baremetal node and any associated - interfaces. - - - - - baremetal-node-list - - - Print list of available baremetal nodes. - - - - - baremetal-node-show - - - Show information about a baremetal node. - - - - -
-
- nova 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. - - - - - --timings - - - Print call timing info. - - - - - --os-region-name <region-name> - - - Defaults to env[OS_REGION_NAME]. - - - - - --service-type <service-type> - - - Defaults to compute for most actions. - - - - - --service-name <service-name> - - - Defaults to env[NOVA_SERVICE_NAME]. - - - - - --volume-service-name <volume-service-name> - - - Defaults to env[NOVA_VOLUME_SERVICE_NAME]. - - - - - --os-endpoint-type <endpoint-type> - - - Defaults to env[NOVA_ENDPOINT_TYPE], - env[OS_ENDPOINT_TYPE] or publicURL. - - - - - --os-compute-api-version <compute-api-ver> - - - Accepts X, X.Y (where X is major and Y is - minor part) or "X.latest", defaults to - env[OS_COMPUTE_API_VERSION]. - - - - - --bypass-url <bypass-url> - - - Use this API endpoint instead of the Service - Catalog. Defaults to - env[NOVACLIENT_BYPASS_URL]. - - - - - --os-auth-type <name>, --os-auth-plugin <name> - - - Authentication type to use - - - - -
-
- nova add-fixed-ip - usage: nova add-fixed-ip <server> <network-id> - -Add new IP address on a network to server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <network-id> - - - Network ID. - - - - -
-
- nova add-secgroup - usage: nova add-secgroup <server> <secgroup> - -Add a Security Group to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <secgroup> - - - Name of Security Group. - - - - -
-
- nova agent-create - usage: nova agent-create <os> <architecture> <version> <url> <md5hash> - <hypervisor> - -Create new agent build. - - Positional arguments - - <os> - - - Type of OS. - - - - - <architecture> - - - Type of architecture. - - - - - <version> - - - Version. - - - - - <url> - - - URL. - - - - - <md5hash> - - - MD5 hash. - - - - - <hypervisor> - - - Type of hypervisor. - - - - -
-
- nova agent-delete - usage: nova agent-delete <id> - -Delete existing agent build. - - Positional arguments - - <id> - - - ID of the agent-build. - - - - -
-
- nova agent-list - usage: nova agent-list [--hypervisor <hypervisor>] - -List all builds. - - Optional arguments - - --hypervisor <hypervisor> - - - Type of hypervisor. - - - - -
-
- nova agent-modify - usage: nova agent-modify <id> <version> <url> <md5hash> - -Modify existing agent build. - - Positional arguments - - <id> - - - ID of the agent-build. - - - - - <version> - - - Version. - - - - - <url> - - - URL - - - - - <md5hash> - - - MD5 hash. - - - - -
-
- nova aggregate-add-host - usage: nova aggregate-add-host <aggregate> <host> - -Add the host to the specified aggregate. - - Positional arguments - - <aggregate> - - - Name or ID of aggregate. - - - - - <host> - - - The host to add to the aggregate. - - - - -
-
- nova aggregate-create - usage: nova aggregate-create <name> [<availability-zone>] - -Create a new aggregate with the specified details. - - Positional arguments - - <name> - - - Name of aggregate. - - - - - <availability-zone> - - - The availability zone of the aggregate (optional). - - - - -
-
- nova aggregate-delete - usage: nova aggregate-delete <aggregate> - -Delete the aggregate. - - Positional arguments - - <aggregate> - - - Name or ID of aggregate to delete. - - - - -
-
- nova aggregate-details - usage: nova aggregate-details <aggregate> - -Show details of the specified aggregate. - - Positional arguments - - <aggregate> - - - Name or ID of aggregate. - - - - -
-
- nova aggregate-list - usage: nova aggregate-list - -Print a list of all aggregates. - -
-
- nova aggregate-remove-host - usage: nova aggregate-remove-host <aggregate> <host> - -Remove the specified host from the specified aggregate. - - Positional arguments - - <aggregate> - - - Name or ID of aggregate. - - - - - <host> - - - The host to remove from the aggregate. - - - - -
-
- nova aggregate-set-metadata - usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...] - -Update the metadata associated with the aggregate. - - Positional arguments - - <aggregate> - - - Name or ID of aggregate to update. - - - - - <key=value> - - - Metadata to add/update to aggregate. Specify only the key to - delete a metadata item. - - - - -
-
- nova aggregate-update - usage: nova aggregate-update <aggregate> <name> [<availability-zone>] - -Update the aggregate's name and optionally availability zone. - - Positional arguments - - <aggregate> - - - Name or ID of aggregate to update. - - - - - <name> - - - Name of aggregate. - - - - - <availability-zone> - - - The availability zone of the aggregate. - - - - -
-
- nova availability-zone-list - usage: nova availability-zone-list - -List all the availability zones. - -
-
- nova backup - usage: nova backup <server> <name> <backup-type> <rotation> - -Backup a server by creating a 'backup' type snapshot. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <name> - - - Name of the backup image. - - - - - <backup-type> - - - The backup type, like "daily" or "weekly". - - - - - <rotation> - - - Int parameter representing how many backups to keep around. - - - - -
-
- nova baremetal-interface-add - usage: nova baremetal-interface-add [--datapath_id <datapath_id>] - [--port_no <port_no>] - <node> <address> - -Add a network interface to a baremetal node. - - Positional arguments - - <node> - - - ID of node - - - - - <address> - - - MAC address of interface - - - - - - Optional arguments - - --datapath_id <datapath_id> - - - OpenFlow Datapath ID of interface - - - - - --port_no <port_no> - - - OpenFlow port number of interface - - - - -
-
- nova baremetal-interface-list - usage: nova baremetal-interface-list <node> - -List network interfaces associated with a baremetal node. - - Positional arguments - - <node> - - - ID of node - - - - -
-
- nova baremetal-interface-remove - usage: nova baremetal-interface-remove <node> <address> - -Remove a network interface from a baremetal node. - - Positional arguments - - <node> - - - ID of node - - - - - <address> - - - MAC address of interface - - - - -
-
- nova baremetal-node-create - usage: nova baremetal-node-create [--pm_address <pm_address>] - [--pm_user <pm_user>] - [--pm_password <pm_password>] - [--terminal_port <terminal_port>] - <service_host> <cpus> <memory_mb> <local_gb> - <prov_mac_address> - -Create a baremetal node. - - Positional arguments - - <service_host> - - - Name of nova compute host which will control - this baremetal node - - - - - <cpus> - - - Number of CPUs in the node - - - - - <memory_mb> - - - Megabytes of RAM in the node - - - - - <local_gb> - - - Gigabytes of local storage in the node - - - - - <prov_mac_address> - - - MAC address to provision the node - - - - - - Optional arguments - - --pm_address <pm_address> - - - Power management IP for the node - - - - - --pm_user <pm_user> - - - Username for the node's power management - - - - - --pm_password <pm_password> - - - Password for the node's power management - - - - - --terminal_port <terminal_port> - - - ShellInABox port? - - - - -
-
- nova baremetal-node-delete - usage: nova baremetal-node-delete <node> - -Remove a baremetal node and any associated interfaces. - - Positional arguments - - <node> - - - ID of the node to delete. - - - - -
-
- nova baremetal-node-list - usage: nova baremetal-node-list - -Print list of available baremetal nodes. - -
-
- nova baremetal-node-show - usage: nova baremetal-node-show <node> - -Show information about a baremetal node. - - Positional arguments - - <node> - - - ID of node - - - - -
-
- nova boot - usage: nova boot [--flavor <flavor>] [--image <image>] - [--image-with <key=value>] [--boot-volume <volume_id>] - [--snapshot <snapshot_id>] [--min-count <number>] - [--max-count <number>] [--meta <key=value>] - [--file <dst-path=src-path>] [--key-name <key-name>] - [--user-data <user-data>] - [--availability-zone <availability-zone>] - [--security-groups <security-groups>] - [--block-device-mapping <dev-name=mapping>] - [--block-device key1=value1[,key2=value2...]] - [--swap <swap_size>] - [--ephemeral size=<size>[,format=<format>]] - [--hint <key=value>] - [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] - [--config-drive <value>] [--poll] [--admin-pass <value>] - [--access-ip-v4 <value>] [--access-ip-v6 <value>] - <name> - -Boot a new server. - - Positional arguments - - <name> - - - Name for the new server. - - - - - - Optional arguments - - --flavor <flavor> - - - Name or ID of flavor (see 'nova flavor-list'). - - - - - --image <image> - - - Name or ID of image (see 'nova image-list'). - - - - - --image-with <key=value> - - - Image metadata property (see 'nova image- - show'). - - - - - --boot-volume <volume_id> - - - Volume ID to boot from. - - - - - --snapshot <snapshot_id> - - - Snapshot ID to boot from (will create a - volume). - - - - - --min-count <number> - - - Boot at least <number> servers (limited by - quota). - - - - - --max-count <number> - - - Boot up to <number> servers (limited by - quota). - - - - - --meta <key=value> - - - Record arbitrary key/value metadata to - /meta_data.json on the metadata server. Can be - specified multiple times. - - - - - --file <dst-path=src-path> - - - Store arbitrary files from <src-path> locally - to <dst-path> on the new server. Limited by - the injected_files quota value. - - - - - --key-name <key-name> - - - Key name of keypair that should be created - earlier with the command keypair-add. - - - - - --user-data <user-data> - - - user data file to pass to be exposed by the - metadata server. - - - - - --availability-zone <availability-zone> - - - The availability zone for server placement. - - - - - --security-groups <security-groups> - - - Comma separated list of security group names. - - - - - --block-device-mapping <dev-name=mapping> - - - Block device mapping in the format <dev- - name>=<id>:<type>:<size(GB)>:<delete-on- - terminate>. - - - - - --block-device - - - key1=value1[,key2=value2...] - Block device mapping with the keys: id=UUID - (image_id, snapshot_id or volume_id only if - using source image, snapshot or volume) - source=source type (image, snapshot, volume or - blank), dest=destination type of the block - device (volume or local), bus=device's bus - (e.g. uml, lxc, virtio, ...; if omitted, - hypervisor driver chooses a suitable default, - honoured only if device type is supplied) - type=device type (e.g. disk, cdrom, ...; - defaults to 'disk') device=name of the device - (e.g. vda, xda, ...; if omitted, hypervisor - driver chooses suitable device depending on - selected bus; note the libvirt driver always - uses default device names), size=size of the - block device in MB(for swap) and in GB(for - other formats) (if omitted, hypervisor driver - calculates size), format=device will be - formatted (e.g. swap, ntfs, ...; optional), - bootindex=integer used for ordering the boot - disks (for image backed instances it is equal - to 0, for others need to be specified) and - shutdown=shutdown behaviour (either preserve - or remove, for local destination set to - remove). - - - - - --swap <swap_size> - - - Create and attach a local swap block device of - <swap_size> MB. - - - - - --ephemeral - - - size=<size>[,format=<format>] - Create and attach a local ephemeral block - device of <size> GB and format it to <format>. - - - - - --hint <key=value> - - - Send arbitrary key/value pairs to the - scheduler for custom use. - - - - - --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid> - - - Create a NIC on the server. Specify option - multiple times to create multiple NICs. net- - id: attach NIC to network with this UUID - (either port-id or net-id must be provided), - v4-fixed-ip: IPv4 fixed address for NIC - (optional), v6-fixed-ip: IPv6 fixed address - for NIC (optional), port-id: attach NIC to - port with this UUID (either port-id or net-id - must be provided). - - - - - --config-drive <value> - - - Enable config drive. - - - - - --poll - - - Report the new server boot progress until it - completes. - - - - - --admin-pass <value> - - - Admin password for the instance. - - - - - --access-ip-v4 <value> - - - Alternative access IPv4 of the instance. - - - - - --access-ip-v6 <value> - - - Alternative access IPv6 of the instance. - - - - -
-
- nova cell-capacities - usage: nova cell-capacities [--cell <cell-name>] - -Get cell capacities for all cells or a given cell. - - Optional arguments - - --cell <cell-name> - - - Name of the cell to get the capacities. - - - - -
-
- nova cell-show - usage: nova cell-show <cell-name> - -Show details of a given cell. - - Positional arguments - - <cell-name> - - - Name of the cell. - - - - -
-
- nova clear-password - usage: nova clear-password <server> - -Clear the admin password for a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova cloudpipe-configure - usage: nova cloudpipe-configure <ip address> <port> - -Update the VPN IP/port of a cloudpipe instance. - - Positional arguments - - <ip address> - - - New IP Address. - - - - - <port> - - - New Port. - - - - -
-
- nova cloudpipe-create - usage: nova cloudpipe-create <project_id> - -Create a cloudpipe instance for the given project. - - Positional arguments - - <project_id> - - - UUID of the project to create the cloudpipe for. - - - - -
-
- nova cloudpipe-list - usage: nova cloudpipe-list - -Print a list of all cloudpipe instances. - -
-
- nova console-log - usage: nova console-log [--length <length>] <server> - -Get console log output of a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - - Optional arguments - - --length <length> - - - Length in lines to tail. - - - - -
-
- nova credentials - usage: nova credentials [--wrap <integer>] - -Show user credentials returned from auth. - - Optional arguments - - --wrap <integer> - - - Wrap PKI tokens to a specified length, or 0 to disable. - - - - -
-
- nova delete - usage: nova delete [--all-tenants] <server> [<server> ...] - -Immediately shut down and delete specified server(s). - - Positional arguments - - <server> - - - Name or ID of server(s). - - - - - - Optional arguments - - --all-tenants - - - Delete server(s) in another tenant by name (Admin only). - - - - -
-
- nova diagnostics - usage: nova diagnostics <server> - -Retrieve server diagnostics. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova dns-create - usage: nova dns-create [--type <type>] <ip> <name> <domain> - -Create a DNS entry for domain, name, and IP. - - Positional arguments - - <ip> - - - IP address. - - - - - <name> - - - DNS name. - - - - - <domain> - - - DNS domain. - - - - - - Optional arguments - - --type <type> - - - DNS type (e.g. "A") - - - - -
-
- nova dns-create-private-domain - usage: nova dns-create-private-domain - [--availability-zone <availability-zone>] - <domain> - -Create the specified DNS domain. - - Positional arguments - - <domain> - - - DNS domain. - - - - - - Optional arguments - - --availability-zone <availability-zone> - - - Limit access to this domain to servers in the - specified availability zone. - - - - -
-
- nova dns-create-public-domain - usage: nova dns-create-public-domain [--project <project>] <domain> - -Create the specified DNS domain. - - Positional arguments - - <domain> - - - DNS domain. - - - - - - Optional arguments - - --project <project> - - - Limit access to this domain to users of the specified - project. - - - - -
-
- nova dns-delete - usage: nova dns-delete <domain> <name> - -Delete the specified DNS entry. - - Positional arguments - - <domain> - - - DNS domain. - - - - - <name> - - - DNS name. - - - - -
-
- nova dns-delete-domain - usage: nova dns-delete-domain <domain> - -Delete the specified DNS domain. - - Positional arguments - - <domain> - - - DNS domain. - - - - -
-
- nova dns-domains - usage: nova dns-domains - -Print a list of available dns domains. - -
-
- nova dns-list - usage: nova dns-list [--ip <ip>] [--name <name>] <domain> - -List current DNS entries for domain and IP or domain and name. - - Positional arguments - - <domain> - - - DNS domain. - - - - - - Optional arguments - - --ip <ip> - - - IP address. - - - - - --name <name> - - - DNS name. - - - - -
-
- nova endpoints - usage: nova endpoints - -Discover endpoints that get returned from the authenticate services. - -
-
- nova evacuate - usage: nova evacuate [--password <password>] [--on-shared-storage] - <server> [<host>] - -Evacuate server from failed host. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <host> - - - Name or ID of the target host. If no host is - specified, the scheduler will choose one. - - - - - - Optional arguments - - --password <password> - - - Set the provided admin password on the evacuated - server. Not applicable with on-shared-storage flag. - - - - - --on-shared-storage - - - Specifies whether server files are located on shared - storage. - - - - -
-
- nova fixed-ip-get - usage: nova fixed-ip-get <fixed_ip> - -Retrieve info on a fixed IP. - - Positional arguments - - <fixed_ip> - - - Fixed IP Address. - - - - -
-
- nova fixed-ip-reserve - usage: nova fixed-ip-reserve <fixed_ip> - -Reserve a fixed IP. - - Positional arguments - - <fixed_ip> - - - Fixed IP Address. - - - - -
-
- nova fixed-ip-unreserve - usage: nova fixed-ip-unreserve <fixed_ip> - -Unreserve a fixed IP. - - Positional arguments - - <fixed_ip> - - - Fixed IP Address. - - - - -
-
- nova flavor-access-add - usage: nova flavor-access-add <flavor> <tenant_id> - -Add flavor access for the given tenant. - - Positional arguments - - <flavor> - - - Flavor name or ID to add access for the given tenant. - - - - - <tenant_id> - - - Tenant ID to add flavor access for. - - - - -
-
- nova flavor-access-list - usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>] - -Print access information about the given flavor. - - Optional arguments - - --flavor <flavor> - - - Filter results by flavor name or ID. - - - - - --tenant <tenant_id> - - - Filter results by tenant ID. - - - - -
-
- nova flavor-access-remove - usage: nova flavor-access-remove <flavor> <tenant_id> - -Remove flavor access for the given tenant. - - Positional arguments - - <flavor> - - - Flavor name or ID to remove access for the given tenant. - - - - - <tenant_id> - - - Tenant ID to remove flavor access for. - - - - -
-
- nova flavor-create - usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>] - [--rxtx-factor <factor>] [--is-public <is-public>] - <name> <id> <ram> <disk> <vcpus> - -Create a new flavor. - - Positional arguments - - <name> - - - Unique name of the new flavor. - - - - - <id> - - - Unique ID of the new flavor. Specifying 'auto' will - generated a UUID for the ID. - - - - - <ram> - - - Memory size in MB. - - - - - <disk> - - - Disk size in GB. - - - - - <vcpus> - - - Number of vcpus - - - - - - Optional arguments - - --ephemeral <ephemeral> - - - Ephemeral space size in GB (default 0). - - - - - --swap <swap> - - - Swap space size in MB (default 0). - - - - - --rxtx-factor <factor> - - - RX/TX factor (default 1). - - - - - --is-public <is-public> - - - Make flavor accessible to the public (default - true). - - - - -
-
- nova flavor-delete - usage: nova flavor-delete <flavor> - -Delete a specific flavor - - Positional arguments - - <flavor> - - - Name or ID of the flavor to delete. - - - - -
-
- nova flavor-key - usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...] - -Set or unset extra_spec for a flavor. - - Positional arguments - - <flavor> - - - Name or ID of flavor. - - - - - <action> - - - Actions: 'set' or 'unset'. - - - - - <key=value> - - - Extra_specs to set/unset (only key is necessary on unset). - - - - -
-
- nova flavor-list - usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>] - [--limit <limit>] - -Print a list of available 'flavors' (sizes of servers). - - Optional arguments - - --extra-specs - - - Get extra-specs of each flavor. - - - - - --all - - - Display all flavors (Admin only). - - - - - --marker <marker> - - - The last flavor ID of the previous page; displays list of - flavors after "marker". - - - - - --limit <limit> - - - Maximum number of flavors to display. If limit == -1, all - flavors will be displayed. If limit is bigger than - 'osapi_max_limit' option of Nova API, limit - 'osapi_max_limit' will be used instead. - - - - -
-
- nova flavor-show - usage: nova flavor-show <flavor> - -Show details about the given flavor. - - Positional arguments - - <flavor> - - - Name or ID of flavor. - - - - -
-
- nova floating-ip-associate - usage: nova floating-ip-associate [--fixed-address <fixed_address>] - <server> <address> - -Associate a floating IP address to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <address> - - - IP Address. - - - - - - Optional arguments - - --fixed-address <fixed_address> - - - Fixed IP Address to associate with. - - - - -
-
- nova floating-ip-bulk-create - usage: nova floating-ip-bulk-create [--pool <pool>] [--interface <interface>] - <range> - -Bulk create floating IPs by range (nova-network only). - - Positional arguments - - <range> - - - Address range to create. - - - - - - Optional arguments - - --pool <pool> - - - Pool for new Floating IPs. - - - - - --interface <interface> - - - Interface for new Floating IPs. - - - - -
-
- nova floating-ip-bulk-delete - usage: nova floating-ip-bulk-delete <range> - -Bulk delete floating IPs by range (nova-network only). - - Positional arguments - - <range> - - - Address range to delete. - - - - -
-
- nova floating-ip-bulk-list - usage: nova floating-ip-bulk-list [--host <host>] - -List all floating IPs (nova-network only). - - Optional arguments - - --host <host> - - - Filter by host. - - - - -
-
- nova floating-ip-create - usage: nova floating-ip-create [<floating-ip-pool>] - -Allocate a floating IP for the current tenant. - - Positional arguments - - <floating-ip-pool> - - - Name of Floating IP Pool. (Optional) - - - - -
-
- nova floating-ip-delete - usage: nova floating-ip-delete <address> - -De-allocate a floating IP. - - Positional arguments - - <address> - - - IP of Floating IP. - - - - -
-
- nova floating-ip-disassociate - usage: nova floating-ip-disassociate <server> <address> - -Disassociate a floating IP address from a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <address> - - - IP Address. - - - - -
-
- nova floating-ip-list - usage: nova floating-ip-list - -List floating IPs. - -
-
- nova floating-ip-pool-list - usage: nova floating-ip-pool-list - -List all floating IP pools. - -
-
- nova force-delete - usage: nova force-delete <server> - -Force delete a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova get-mks-console - usage: nova get-mks-console <server> - -Get a serial console to a server. (Supported by API versions '2.8' - -'2.latest') [hint: use '--os-compute-api-version' flag to show help message -for proper version] - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova get-password - usage: nova get-password <server> [<private-key>] - -Get the admin password for a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <private-key> - - - Private key (used locally to decrypt password) (Optional). - When specified, the command displays the clear (decrypted) VM - password. When not specified, the ciphered VM password is - displayed. - - - - -
-
- nova get-rdp-console - usage: nova get-rdp-console <server> <console-type> - -Get a rdp console to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <console-type> - - - Type of rdp console ("rdp-html5"). - - - - -
-
- nova get-serial-console - usage: nova get-serial-console [--console_type CONSOLE_TYPE] <server> - -Get a serial console to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - - Optional arguments - - --console_type CONSOLE_TYPE - - - Type of serial console, default="serial". - - - - -
-
- nova get-spice-console - usage: nova get-spice-console <server> <console-type> - -Get a spice console to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <console-type> - - - Type of spice console ("spice-html5"). - - - - -
-
- nova get-vnc-console - usage: nova get-vnc-console <server> <console-type> - -Get a vnc console to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <console-type> - - - Type of vnc console ("novnc" or "xvpvnc"). - - - - -
-
- nova host-action - usage: nova host-action [--action <action>] <hostname> - -Perform a power action on a host. - - Positional arguments - - <hostname> - - - Name of host. - - - - - - Optional arguments - - --action <action> - - - A power action: startup, reboot, or shutdown. - - - - -
-
- nova host-describe - usage: nova host-describe <hostname> - -Describe a specific host. - - Positional arguments - - <hostname> - - - Name of host. - - - - -
-
- nova host-evacuate - usage: nova host-evacuate [--target_host <target_host>] [--on-shared-storage] - <host> - -Evacuate all instances from failed host. - - Positional arguments - - <host> - - - Name of host. - - - - - - Optional arguments - - --target_host <target_host> - - - Name of target host. If no host is specified - the scheduler will select a target. - - - - - --on-shared-storage - - - Specifies whether all instances files are on - shared storage - - - - -
-
- nova host-evacuate-live - usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate] - [--disk-over-commit] - [--max-servers <max_servers>] - <host> - -Live migrate all instances of the specified host to other available hosts. - - Positional arguments - - <host> - - - Name of host. - - - - - - Optional arguments - - --target-host <target_host> - - - Name of target host. - - - - - --block-migrate - - - Enable block migration. - - - - - --disk-over-commit - - - Enable disk overcommit. - - - - - --max-servers <max_servers> - - - Maximum number of servers to live migrate - simultaneously - - - - -
-
- nova host-list - usage: nova host-list [--zone <zone>] - -List all hosts by service. - - Optional arguments - - --zone <zone> - - - Filters the list, returning only those hosts in the - availability zone <zone>. - - - - -
-
- nova host-meta - usage: nova host-meta <host> <action> <key=value> [<key=value> ...] - -Set or Delete metadata on all instances of a host. - - Positional arguments - - <host> - - - Name of host. - - - - - <action> - - - Actions: 'set' or 'delete' - - - - - <key=value> - - - Metadata to set or delete (only key is necessary on delete) - - - - -
-
- nova host-servers-migrate - usage: nova host-servers-migrate <host> - -Migrate all instances of the specified host to other available hosts. - - Positional arguments - - <host> - - - Name of host. - - - - -
-
- nova host-update - usage: nova host-update [--status <enable|disable>] - [--maintenance <enable|disable>] - <hostname> - -Update host settings. - - Positional arguments - - <hostname> - - - Name of host. - - - - - - Optional arguments - - --status <enable|disable> - - - Either enable or disable a host. - - - - - --maintenance <enable|disable> - - - Either put or resume host to/from maintenance. - - - - -
-
- nova hypervisor-list - usage: nova hypervisor-list [--matching <hostname>] - -List hypervisors. - - Optional arguments - - --matching <hostname> - - - List hypervisors matching the given <hostname>. - - - - -
-
- nova hypervisor-servers - usage: nova hypervisor-servers <hostname> - -List servers belonging to specific hypervisors. - - Positional arguments - - <hostname> - - - The hypervisor hostname (or pattern) to search for. - - - - -
-
- nova hypervisor-show - usage: nova hypervisor-show [--wrap <integer>] <hypervisor> - -Display the details of the specified hypervisor. - - Positional arguments - - <hypervisor> - - - Name or ID of the hypervisor to show the details of. - - - - - - Optional arguments - - --wrap <integer> - - - Wrap the output to a specified length. Default is 40 or 0 - to disable - - - - -
-
- nova hypervisor-stats - usage: nova hypervisor-stats - -Get hypervisor statistics over all compute nodes. - -
-
- nova hypervisor-uptime - usage: nova hypervisor-uptime <hypervisor> - -Display the uptime of the specified hypervisor. - - Positional arguments - - <hypervisor> - - - Name or ID of the hypervisor to show the uptime of. - - - - -
-
- nova image-create - usage: nova image-create [--metadata <key=value>] [--show] [--poll] - <server> <name> - -Create a new image by taking a snapshot of a running server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <name> - - - Name of snapshot. - - - - - - Optional arguments - - --metadata <key=value> - - - Record arbitrary key/value metadata to - /meta_data.json on the metadata server. Can be - specified multiple times. - - - - - --show - - - Print image info. - - - - - --poll - - - Report the snapshot progress and poll until image - creation is complete. - - - - -
-
- nova image-delete - usage: nova image-delete <image> [<image> ...] - -Delete specified image(s). - - Positional arguments - - <image> - - - Name or ID of image(s). - - - - -
-
- nova image-list - usage: nova image-list [--limit <limit>] - -Print a list of available images to boot from. - - Optional arguments - - --limit <limit> - - - Number of images to return per request. - - - - -
-
- nova image-meta - usage: nova image-meta <image> <action> <key=value> [<key=value> ...] - -Set or delete metadata on an image. - - Positional arguments - - <image> - - - Name or ID of image. - - - - - <action> - - - Actions: 'set' or 'delete'. - - - - - <key=value> - - - Metadata to add/update or delete (only key is necessary on - delete). - - - - -
-
- nova image-show - usage: nova image-show <image> - -Show details about the given image. - - Positional arguments - - <image> - - - Name or ID of image. - - - - -
-
- nova instance-action - usage: nova instance-action <server> <request_id> - -Show an action. - - Positional arguments - - <server> - - - Name or UUID of the server to show an action for. - - - - - <request_id> - - - Request ID of the action to get. - - - - -
-
- nova instance-action-list - usage: nova instance-action-list <server> - -List actions on a server. - - Positional arguments - - <server> - - - Name or UUID of the server to list actions for. - - - - -
-
- nova interface-attach - usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>] - [--fixed-ip <fixed_ip>] - <server> - -Attach a network interface to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - - Optional arguments - - --port-id <port_id> - - - Port ID. - - - - - --net-id <net_id> - - - Network ID - - - - - --fixed-ip <fixed_ip> - - - Requested fixed IP. - - - - -
-
- nova interface-detach - usage: nova interface-detach <server> <port_id> - -Detach a network interface from a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <port_id> - - - Port ID. - - - - -
-
- nova interface-list - usage: nova interface-list <server> - -List interfaces attached to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova keypair-add - usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>] - [--user <user-id>] - <name> - -Create a new key pair for use with servers. - - Positional arguments - - <name> - - - Name of key. - - - - - - Optional arguments - - --pub-key <pub-key> - - - Path to a public ssh key. - - - - - --key-type <key-type> - - - Keypair type. Can be ssh or x509. (Supported by API - versions '2.2' - '2.latest') - - - - - --user <user-id> - - - ID of user to whom to add key-pair (Admin only). - (Supported by API versions '2.10' - '2.latest') - - - - -
-
- nova keypair-delete - usage: nova keypair-delete [--user <user-id>] <name> - -Delete keypair given by its name. (Supported by API versions '2.0' - -'2.latest') [hint: use '--os-compute-api-version' flag to show help message -for proper version] - - Positional arguments - - <name> - - - Keypair name to delete. - - - - - - Optional arguments - - --user <user-id> - - - ID of key-pair owner (Admin only). - - - - -
-
- nova keypair-list - usage: nova keypair-list [--user <user-id>] - -Print a list of keypairs for a user (Supported by API versions '2.0' - -'2.latest') [hint: use '--os-compute-api-version' flag to show help message -for proper version] - - Optional arguments - - --user <user-id> - - - List key-pairs of specified user ID (Admin only). - - - - -
-
- nova keypair-show - usage: nova keypair-show [--user <user-id>] <keypair> - -Show details about the given keypair. (Supported by API versions '2.0' - -'2.latest') [hint: use '--os-compute-api-version' flag to show help message -for proper version] - - Positional arguments - - <keypair> - - - Name of keypair. - - - - - - Optional arguments - - --user <user-id> - - - ID of key-pair owner (Admin only). - - - - -
-
- nova limits - usage: nova limits [--tenant [<tenant>]] [--reserved] - -Print rate and absolute limits. - - Optional arguments - - --tenant [<tenant>] - - - Display information from single tenant (Admin only). - - - - - --reserved - - - Include reservations count. - - - - -
-
- nova list - usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>] - [--ip6 <ip6-regexp>] [--name <name-regexp>] - [--instance-name <name-regexp>] [--status <status>] - [--flavor <flavor>] [--image <image>] [--host <hostname>] - [--all-tenants [<0|1>]] [--tenant [<tenant>]] - [--user [<user>]] [--deleted] [--fields <fields>] [--minimal] - [--sort <key>[:<direction>]] [--marker <marker>] - [--limit <limit>] - -List active servers. - - Optional arguments - - --reservation-id <reservation-id> - - - Only return servers that match reservation-id. - - - - - --ip <ip-regexp> - - - Search with regular expression match by IP - address. - - - - - --ip6 <ip6-regexp> - - - Search with regular expression match by IPv6 - address. - - - - - --name <name-regexp> - - - Search with regular expression match by name. - - - - - --instance-name <name-regexp> - - - Search with regular expression match by server - name. - - - - - --status <status> - - - Search by server status. - - - - - --flavor <flavor> - - - Search by flavor name or ID. - - - - - --image <image> - - - Search by image name or ID. - - - - - --host <hostname> - - - Search servers by hostname to which they are - assigned (Admin only). - - - - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin - only). - - - - - --tenant [<tenant>] - - - Display information from single tenant (Admin - only). - - - - - --user [<user>] - - - Display information from single user (Admin - only). - - - - - --deleted - - - Only display deleted servers (Admin only). - - - - - --fields <fields> - - - Comma-separated list of fields to display. Use - the show command to see which fields are - available. - - - - - --minimal - - - Get only UUID and name. - - - - - --sort <key>[:<direction>] - - - Comma-separated list of sort keys and - directions in the form of <key>[:<asc|desc>]. - The direction defaults to descending if not - specified. - - - - - --marker <marker> - - - The last server UUID of the previous page; - displays list of servers after "marker". - - - - - --limit <limit> - - - Maximum number of servers to display. If limit - == -1, all servers will be displayed. If limit - is bigger than 'osapi_max_limit' option of - Nova API, limit 'osapi_max_limit' will be used - instead. - - - - -
-
- nova list-extensions - usage: nova list-extensions - -List all the os-api extensions that are available. - -
-
- nova list-secgroup - usage: nova list-secgroup <server> - -List Security Group(s) of a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova live-migration - usage: nova live-migration [--block-migrate] [--disk-over-commit] - <server> [<host>] - -Migrate running server to a new machine. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <host> - - - Destination host name. - - - - - - Optional arguments - - --block-migrate - - - True in case of block_migration. - (Default=False:live_migration) - - - - - --disk-over-commit - - - Allow overcommit. (Default=False) - - - - -
-
- nova lock - usage: nova lock <server> - -Lock a server. A normal (non-admin) user will not be able to execute actions -on a locked server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova meta - usage: nova meta <server> <action> <key=value> [<key=value> ...] - -Set or delete metadata on a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <action> - - - Actions: 'set' or 'delete'. - - - - - <key=value> - - - Metadata to set or delete (only key is necessary on delete). - - - - -
-
- nova migrate - usage: nova migrate [--poll] <server> - -Migrate a server. The new host will be selected by the scheduler. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - - Optional arguments - - --poll - - - Report the server migration progress until it completes. - - - - -
-
- nova migration-list - usage: nova migration-list [--host <host>] [--status <status>] - [--cell_name <cell_name>] - -Print a list of migrations. - - Optional arguments - - --host <host> - - - Fetch migrations for the given host. - - - - - --status <status> - - - Fetch migrations for the given status. - - - - - --cell_name <cell_name> - - - Fetch migrations for the given cell_name. - - - - -
-
- nova network-associate-host - usage: nova network-associate-host <network> <host> - -Associate host with network. - - Positional arguments - - <network> - - - UUID of network. - - - - - <host> - - - Name of host - - - - -
-
- nova network-associate-project - usage: nova network-associate-project <network> - -Associate project with network. - - Positional arguments - - <network> - - - UUID of network. - - - - -
-
- nova network-create - usage: nova network-create [--fixed-range-v4 <x.x.x.x/yy>] - [--fixed-range-v6 CIDR_V6] [--vlan <vlan id>] - [--vlan-start <vlan start>] [--vpn <vpn start>] - [--gateway GATEWAY] [--gateway-v6 GATEWAY_V6] - [--bridge <bridge>] - [--bridge-interface <bridge interface>] - [--multi-host <'T'|'F'>] [--dns1 <DNS Address>] - [--dns2 <DNS Address>] [--uuid <network uuid>] - [--fixed-cidr <x.x.x.x/yy>] - [--project-id <project id>] [--priority <number>] - [--mtu MTU] [--enable-dhcp <'T'|'F'>] - [--dhcp-server DHCP_SERVER] - [--share-address <'T'|'F'>] - [--allowed-start ALLOWED_START] - [--allowed-end ALLOWED_END] - <network_label> - -Create a network. - - Positional arguments - - <network_label> - - - Label for network - - - - - - Optional arguments - - --fixed-range-v4 <x.x.x.x/yy> - - - IPv4 subnet (ex: 10.0.0.0/8) - - - - - --fixed-range-v6 - - - CIDR_V6 IPv6 subnet (ex: fe80::/64 - - - - - --vlan <vlan id> - - - The vlan ID to be assigned to the project. - - - - - --vlan-start <vlan start> - - - First vlan ID to be assigned to the project. - Subsequent vlan IDs will be assigned - incrementally. - - - - - --vpn <vpn start> - - - vpn start - - - - - --gateway GATEWAY - - - gateway - - - - - --gateway-v6 - - - GATEWAY_V6 IPv6 gateway - - - - - --bridge <bridge> - - - VIFs on this network are connected to this - bridge. - - - - - --bridge-interface <bridge interface> - - - The bridge is connected to this interface. - - - - - --multi-host <'T'|'F'> - - - Multi host - - - - - --dns1 <DNS Address> - - - First DNS. - - - - - --dns2 <DNS Address> - - - Second DNS. - - - - - --uuid <network uuid> - - - Network UUID. - - - - - --fixed-cidr <x.x.x.x/yy> - - - IPv4 subnet for fixed IPs (ex: 10.20.0.0/16). - - - - - --project-id <project id> - - - Project ID. - - - - - --priority <number> - - - Network interface priority. - - - - - --mtu MTU - - - MTU for network. - - - - - --enable-dhcp <'T'|'F'> - - - Enable DHCP. - - - - - --dhcp-server DHCP_SERVER - - - DHCP-server address (defaults to gateway - address) - - - - - --share-address <'T'|'F'> - - - Share address - - - - - --allowed-start ALLOWED_START - - - Start of allowed addresses for instances. - - - - - --allowed-end ALLOWED_END - - - End of allowed addresses for instances. - - - - -
-
- nova network-delete - usage: nova network-delete <network> - -Delete network by label or id. - - Positional arguments - - <network> - - - UUID or label of network. - - - - -
-
- nova network-disassociate - usage: nova network-disassociate [--host-only [<0|1>]] - [--project-only [<0|1>]] - <network> - -Disassociate host and/or project from the given network. - - Positional arguments - - <network> - - - UUID of network. - - - - - - Optional arguments - - --host-only [<0|1>] - - - - - - - --project-only [<0|1>] - - - - - - -
-
- nova network-list - usage: nova network-list [--fields <fields>] - -Print a list of available networks. - - Optional arguments - - --fields <fields> - - - Comma-separated list of fields to display. Use the show - command to see which fields are available. - - - - -
-
- nova network-show - usage: nova network-show <network> - -Show details about the given network. - - Positional arguments - - <network> - - - UUID or label of network. - - - - -
-
- nova pause - usage: nova pause <server> - -Pause a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova quota-class-show - usage: nova quota-class-show <class> - -List the quotas for a quota class. - - Positional arguments - - <class> - - - Name of quota class to list the quotas for. - - - - -
-
- nova quota-class-update - usage: nova quota-class-update [--instances <instances>] [--cores <cores>] - [--ram <ram>] [--floating-ips <floating-ips>] - [--fixed-ips <fixed-ips>] - [--metadata-items <metadata-items>] - [--injected-files <injected-files>] - [--injected-file-content-bytes <injected-file-content-bytes>] - [--injected-file-path-bytes <injected-file-path-bytes>] - [--key-pairs <key-pairs>] - [--security-groups <security-groups>] - [--security-group-rules <security-group-rules>] - [--server-groups <server-groups>] - [--server-group-members <server-group-members>] - <class> - -Update the quotas for a quota class. - - Positional arguments - - <class> - - - Name of quota class to set the quotas for. - - - - - - Optional arguments - - --instances <instances> - - - New value for the "instances" quota. - - - - - --cores <cores> - - - New value for the "cores" quota. - - - - - --ram <ram> - - - New value for the "ram" quota. - - - - - --floating-ips <floating-ips> - - - New value for the "floating-ips" quota. - - - - - --fixed-ips <fixed-ips> - - - New value for the "fixed-ips" quota. - - - - - --metadata-items <metadata-items> - - - New value for the "metadata-items" quota. - - - - - --injected-files <injected-files> - - - New value for the "injected-files" quota. - - - - - --injected-file-content-bytes <injected-file-content-bytes> - - - New value for the "injected-file-content- - bytes" quota. - - - - - --injected-file-path-bytes <injected-file-path-bytes> - - - New value for the "injected-file-path-bytes" - quota. - - - - - --key-pairs <key-pairs> - - - New value for the "key-pairs" quota. - - - - - --security-groups <security-groups> - - - New value for the "security-groups" quota. - - - - - --security-group-rules <security-group-rules> - - - New value for the "security-group-rules" - quota. - - - - - --server-groups <server-groups> - - - New value for the "server-groups" quota. - - - - - --server-group-members <server-group-members> - - - New value for the "server-group-members" - quota. - - - - -
-
- nova quota-defaults - usage: nova quota-defaults [--tenant <tenant-id>] - -List the default quotas for a tenant. - - Optional arguments - - --tenant <tenant-id> - - - ID of tenant to list the default quotas for. - - - - -
-
- nova quota-delete - usage: nova quota-delete --tenant <tenant-id> [--user <user-id>] - -Delete quota for a tenant/user so their quota will Revert back to default. - - Optional arguments - - --tenant <tenant-id> - - - ID of tenant to delete quota for. - - - - - --user <user-id> - - - ID of user to delete quota for. - - - - -
-
- nova quota-show - usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] - -List the quotas for a tenant/user. - - Optional arguments - - --tenant <tenant-id> - - - ID of tenant to list the quotas for. - - - - - --user <user-id> - - - ID of user to list the quotas for. - - - - -
-
- nova quota-update - usage: nova quota-update [--user <user-id>] [--instances <instances>] - [--cores <cores>] [--ram <ram>] - [--floating-ips <floating-ips>] - [--fixed-ips <fixed-ips>] - [--metadata-items <metadata-items>] - [--injected-files <injected-files>] - [--injected-file-content-bytes <injected-file-content-bytes>] - [--injected-file-path-bytes <injected-file-path-bytes>] - [--key-pairs <key-pairs>] - [--security-groups <security-groups>] - [--security-group-rules <security-group-rules>] - [--server-groups <server-groups>] - [--server-group-members <server-group-members>] - [--force] - <tenant-id> - -Update the quotas for a tenant/user. - - Positional arguments - - <tenant-id> - - - ID of tenant to set the quotas for. - - - - - - Optional arguments - - --user <user-id> - - - ID of user to set the quotas for. - - - - - --instances <instances> - - - New value for the "instances" quota. - - - - - --cores <cores> - - - New value for the "cores" quota. - - - - - --ram <ram> - - - New value for the "ram" quota. - - - - - --floating-ips <floating-ips> - - - New value for the "floating-ips" quota. - - - - - --fixed-ips <fixed-ips> - - - New value for the "fixed-ips" quota. - - - - - --metadata-items <metadata-items> - - - New value for the "metadata-items" quota. - - - - - --injected-files <injected-files> - - - New value for the "injected-files" quota. - - - - - --injected-file-content-bytes <injected-file-content-bytes> - - - New value for the "injected-file-content- - bytes" quota. - - - - - --injected-file-path-bytes <injected-file-path-bytes> - - - New value for the "injected-file-path-bytes" - quota. - - - - - --key-pairs <key-pairs> - - - New value for the "key-pairs" quota. - - - - - --security-groups <security-groups> - - - New value for the "security-groups" quota. - - - - - --security-group-rules <security-group-rules> - - - New value for the "security-group-rules" - quota. - - - - - --server-groups <server-groups> - - - New value for the "server-groups" quota. - - - - - --server-group-members <server-group-members> - - - New value for the "server-group-members" - quota. - - - - - --force - - - Whether force update the quota even if the - already used and reserved exceeds the new - quota. - - - - -
-
- nova reboot - usage: nova reboot [--hard] [--poll] <server> [<server> ...] - -Reboot a server. - - Positional arguments - - <server> - - - Name or ID of server(s). - - - - - - Optional arguments - - --hard - - - Perform a hard reboot (instead of a soft one). - - - - - --poll - - - Poll until reboot is complete. - - - - -
-
- nova rebuild - usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll] - [--minimal] [--preserve-ephemeral] [--name <name>] - [--meta <key=value>] [--file <dst-path=src-path>] - <server> <image> - -Shutdown, re-image, and re-boot a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <image> - - - Name or ID of new image. - - - - - - Optional arguments - - --rebuild-password <rebuild-password> - - - Set the provided admin password on the rebuilt - server. - - - - - --poll - - - Report the server rebuild progress until it - completes. - - - - - --minimal - - - Skips flavor/image lookups when showing - servers. - - - - - --preserve-ephemeral - - - Preserve the default ephemeral storage - partition on rebuild. - - - - - --name <name> - - - Name for the new server. - - - - - --meta <key=value> - - - Record arbitrary key/value metadata to - /meta_data.json on the metadata server. Can be - specified multiple times. - - - - - --file <dst-path=src-path> - - - Store arbitrary files from <src-path> locally - to <dst-path> on the new server. You may store - up to 5 files. - - - - -
-
- nova refresh-network - usage: nova refresh-network <server> - -Refresh server network information. - - Positional arguments - - <server> - - - Name or ID of a server for which the network cache should be - refreshed from neutron (Admin only). - - - - -
-
- nova remove-fixed-ip - usage: nova remove-fixed-ip <server> <address> - -Remove an IP address from a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <address> - - - IP Address. - - - - -
-
- nova remove-secgroup - usage: nova remove-secgroup <server> <secgroup> - -Remove a Security Group from a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <secgroup> - - - Name of Security Group. - - - - -
-
- nova rename - usage: nova rename <server> <name> - -Rename a server. - - Positional arguments - - <server> - - - Name (old name) or ID of server. - - - - - <name> - - - New name for the server. - - - - -
-
- nova rescue - usage: nova rescue [--password <password>] [--image <image>] <server> - -Reboots a server into rescue mode, which starts the machine from either the -initial image or a specified image, attaching the current boot disk as -secondary. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - - Optional arguments - - --password <password> - - - The admin password to be set in the rescue - environment. - - - - - --image <image> - - - The image to rescue with. - - - - -
-
- nova reset-network - usage: nova reset-network <server> - -Reset network of a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova reset-state - usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...] - -Reset the state of a server. - - Positional arguments - - <server> - - - Name or ID of server(s). - - - - - - Optional arguments - - --all-tenants - - - Reset state server(s) in another tenant by name (Admin only). - - - - - --active - - - Request the server be reset to "active" state instead of - "error" state (the default). - - - - -
-
- nova resize - usage: nova resize [--poll] <server> <flavor> - -Resize a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <flavor> - - - Name or ID of new flavor. - - - - - - Optional arguments - - --poll - - - Report the server resize progress until it completes. - - - - -
-
- nova resize-confirm - usage: nova resize-confirm <server> - -Confirm a previous resize. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova resize-revert - usage: nova resize-revert <server> - -Revert a previous resize (and return to the previous VM). - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova restore - usage: nova restore <server> - -Restore a soft-deleted server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova resume - usage: nova resume <server> - -Resume a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova scrub - usage: nova scrub <project_id> - -Delete networks and security groups associated with a project. - - Positional arguments - - <project_id> - - - The ID of the project. - - - - -
-
- nova secgroup-add-default-rule - usage: nova secgroup-add-default-rule <ip-proto> <from-port> <to-port> <cidr> - -Add a rule to the set of rules that will be added to the 'default' security -group for new tenants (nova-network only). - - Positional arguments - - <ip-proto> - - - IP protocol (icmp, tcp, udp). - - - - - <from-port> - - - Port at start of range. - - - - - <to-port> - - - Port at end of range. - - - - - <cidr> - - - CIDR for address range. - - - - -
-
- nova secgroup-add-group-rule - usage: nova secgroup-add-group-rule <secgroup> <source-group> <ip-proto> - <from-port> <to-port> - -Add a source group rule to a security group. - - Positional arguments - - <secgroup> - - - ID or name of security group. - - - - - <source-group> - - - ID or name of source group. - - - - - <ip-proto> - - - IP protocol (icmp, tcp, udp). - - - - - <from-port> - - - Port at start of range. - - - - - <to-port> - - - Port at end of range. - - - - -
-
- nova secgroup-add-rule - usage: nova secgroup-add-rule <secgroup> <ip-proto> <from-port> <to-port> - <cidr> - -Add a rule to a security group. - - Positional arguments - - <secgroup> - - - ID or name of security group. - - - - - <ip-proto> - - - IP protocol (icmp, tcp, udp). - - - - - <from-port> - - - Port at start of range. - - - - - <to-port> - - - Port at end of range. - - - - - <cidr> - - - CIDR for address range. - - - - -
-
- nova secgroup-create - usage: nova secgroup-create <name> <description> - -Create a security group. - - Positional arguments - - <name> - - - Name of security group. - - - - - <description> - - - Description of security group. - - - - -
-
- nova secgroup-delete - usage: nova secgroup-delete <secgroup> - -Delete a security group. - - Positional arguments - - <secgroup> - - - ID or name of security group. - - - - -
-
- nova secgroup-delete-default-rule - usage: nova secgroup-delete-default-rule <ip-proto> <from-port> <to-port> - <cidr> - -Delete a rule from the set of rules that will be added to the 'default' -security group for new tenants (nova-network only). - - Positional arguments - - <ip-proto> - - - IP protocol (icmp, tcp, udp). - - - - - <from-port> - - - Port at start of range. - - - - - <to-port> - - - Port at end of range. - - - - - <cidr> - - - CIDR for address range. - - - - -
-
- nova secgroup-delete-group-rule - usage: nova secgroup-delete-group-rule <secgroup> <source-group> <ip-proto> - <from-port> <to-port> - -Delete a source group rule from a security group. - - Positional arguments - - <secgroup> - - - ID or name of security group. - - - - - <source-group> - - - ID or name of source group. - - - - - <ip-proto> - - - IP protocol (icmp, tcp, udp). - - - - - <from-port> - - - Port at start of range. - - - - - <to-port> - - - Port at end of range. - - - - -
-
- nova secgroup-delete-rule - usage: nova secgroup-delete-rule <secgroup> <ip-proto> <from-port> <to-port> - <cidr> - -Delete a rule from a security group. - - Positional arguments - - <secgroup> - - - ID or name of security group. - - - - - <ip-proto> - - - IP protocol (icmp, tcp, udp). - - - - - <from-port> - - - Port at start of range. - - - - - <to-port> - - - Port at end of range. - - - - - <cidr> - - - CIDR for address range. - - - - -
-
- nova secgroup-list - usage: nova secgroup-list [--all-tenants [<0|1>]] - -List security groups for the current tenant. - - Optional arguments - - --all-tenants [<0|1>] - - - Display information from all tenants (Admin only). - - - - -
-
- nova secgroup-list-default-rules - usage: nova secgroup-list-default-rules - -List rules that will be added to the 'default' security group for new tenants. - -
-
- nova secgroup-list-rules - usage: nova secgroup-list-rules <secgroup> - -List rules for a security group. - - Positional arguments - - <secgroup> - - - ID or name of security group. - - - - -
-
- nova secgroup-update - usage: nova secgroup-update <secgroup> <name> <description> - -Update a security group. - - Positional arguments - - <secgroup> - - - ID or name of security group. - - - - - <name> - - - Name of security group. - - - - - <description> - - - Description of security group. - - - - -
-
- nova server-group-create - usage: nova server-group-create <name> [<policy> [<policy> ...]] - -Create a new server group with the specified details. - - Positional arguments - - <name> - - - Server group name. - - - - - <policy> - - - Policies for the server groups. ("affinity" or "anti-affinity") - - - - -
-
- nova server-group-delete - usage: nova server-group-delete <id> [<id> ...] - -Delete specific server group(s). - - Positional arguments - - <id> - - - Unique ID(s) of the server group to delete. - - - - -
-
- nova server-group-get - usage: nova server-group-get <id> - -Get a specific server group. - - Positional arguments - - <id> - - - Unique ID of the server group to get. - - - - -
-
- nova server-group-list - usage: nova server-group-list [--all-projects] - -Print a list of all server groups. - - Optional arguments - - --all-projects - - - Display server groups from all projects (Admin only). - - - - -
-
- nova service-delete - usage: nova service-delete <id> - -Delete the service. - - Positional arguments - - <id> - - - ID of service. - - - - -
-
- nova service-disable - usage: nova service-disable [--reason <reason>] <hostname> <binary> - -Disable the service. - - Positional arguments - - <hostname> - - - Name of host. - - - - - <binary> - - - Service binary. - - - - - - Optional arguments - - --reason <reason> - - - Reason for disabling service. - - - - -
-
- nova service-enable - usage: nova service-enable <hostname> <binary> - -Enable the service. - - Positional arguments - - <hostname> - - - Name of host. - - - - - <binary> - - - Service binary. - - - - -
-
- nova service-force-down - usage: nova service-force-down [--unset] <hostname> <binary> - -Force service to down. (Supported by API versions '2.11' - '2.latest') [hint: -use '--os-compute-api-version' flag to show help message for proper version] - - Positional arguments - - <hostname> - - - Name of host. - - - - - <binary> - - - Service binary. - - - - - - Optional arguments - - --unset - - - Unset the force state down of service. - - - - -
-
- nova service-list - usage: nova service-list [--host <hostname>] [--binary <binary>] - -Show a list of all running services. Filter by host & binary. - - Optional arguments - - --host <hostname> - - - Name of host. - - - - - --binary <binary> - - - Service binary. - - - - -
-
- nova set-password - usage: nova set-password <server> - -Change the admin password for a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova shelve - usage: nova shelve <server> - -Shelve a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova shelve-offload - usage: nova shelve-offload <server> - -Remove a shelved server from the compute node. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova show - usage: nova show [--minimal] <server> - -Show details about the given server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - - Optional arguments - - --minimal - - - Skips flavor/image lookups when showing servers. - - - - -
-
- nova ssh - usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE] - [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY] - [--extra-opts EXTRA] - <server> - -SSH into a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - - Optional arguments - - --port PORT - - - Optional flag to indicate which port to use - for ssh. (Default=22) - - - - - --address-type ADDRESS_TYPE - - - Optional flag to indicate which IP type to - use. Possible values includes fixed and - floating (the Default). - - - - - --network <network> - - - Network to use for the ssh. - - - - - --ipv6 - - - Optional flag to indicate whether to use an - IPv6 address attached to a server. (Defaults - to IPv4 address) - - - - - --login <login> - - - Login to use. - - - - - -i IDENTITY, --identity IDENTITY - - - Private key file, same as the -i option to the - ssh command. - - - - - --extra-opts EXTRA - - - Extra options to pass to ssh. see: man ssh. - - - - -
-
- nova start - usage: nova start [--all-tenants] <server> [<server> ...] - -Start the server(s). - - Positional arguments - - <server> - - - Name or ID of server(s). - - - - - - Optional arguments - - --all-tenants - - - Start server(s) in another tenant by name (Admin only). - - - - -
-
- nova stop - usage: nova stop [--all-tenants] <server> [<server> ...] - -Stop the server(s). - - Positional arguments - - <server> - - - Name or ID of server(s). - - - - - - Optional arguments - - --all-tenants - - - Stop server(s) in another tenant by name (Admin only). - - - - -
-
- nova suspend - usage: nova suspend <server> - -Suspend a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova tenant-network-create - usage: nova tenant-network-create <network_label> <cidr> - -Create a tenant network. - - Positional arguments - - <network_label> - - - Network label (ex. my_new_network) - - - - - <cidr> - - - IP block to allocate from (ex. 172.16.0.0/24 or - 2001:DB8::/64) - - - - -
-
- nova tenant-network-delete - usage: nova tenant-network-delete <network_id> - -Delete a tenant network. - - Positional arguments - - <network_id> - - - ID of network - - - - -
-
- nova tenant-network-list - usage: nova tenant-network-list - -List tenant networks. - -
-
- nova tenant-network-show - usage: nova tenant-network-show <network_id> - -Show a tenant network. - - Positional arguments - - <network_id> - - - ID of network - - - - -
-
- nova unlock - usage: nova unlock <server> - -Unlock a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova unpause - usage: nova unpause <server> - -Unpause a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova unrescue - usage: nova unrescue <server> - -Restart the server from normal boot disk again. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova unshelve - usage: nova unshelve <server> - -Unshelve a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova usage - usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>] - -Show usage data for a single tenant. - - Optional arguments - - --start <start> - - - Usage range start date ex 2012-01-20. (default: 4 - weeks ago) - - - - - --end <end> - - - Usage range end date, ex 2012-01-20. (default: - tomorrow) - - - - - --tenant <tenant-id> - - - UUID of tenant to get usage for. - - - - -
-
- nova usage-list - usage: nova usage-list [--start <start>] [--end <end>] - -List usage data for all tenants. - - Optional arguments - - --start <start> - - - Usage range start date ex 2012-01-20. (default: 4 weeks - ago) - - - - - --end <end> - - - Usage range end date, ex 2012-01-20. (default: tomorrow) - - - - -
-
- nova version-list - usage: nova version-list - -List all API versions. - -
-
- nova virtual-interface-list - usage: nova virtual-interface-list <server> - -Show virtual interface info about the given server. - - Positional arguments - - <server> - - - ID of server. - - - - -
-
- nova volume-attach - usage: nova volume-attach <server> <volume> [<device>] - -Attach a volume to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <volume> - - - ID of the volume to attach. - - - - - <device> - - - Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if - supported). Libvirt driver will use default device name. - - - - -
-
- nova volume-attachments - usage: nova volume-attachments <server> - -List all the volumes attached to a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - -
-
- nova volume-detach - usage: nova volume-detach <server> <volume> - -Detach a volume from a server. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <volume> - - - ID of the volume to detach. - - - - -
-
- nova volume-update - usage: nova volume-update <server> <attachment> <volume> - -Update volume attachment. - - Positional arguments - - <server> - - - Name or ID of server. - - - - - <attachment> - - - Attachment ID of the volume. - - - - - <volume> - - - ID of the volume to attach. - - - - -
-
- nova x509-create-cert - usage: nova x509-create-cert [<private-key-filename>] [<x509-cert-filename>] - -Create x509 cert for a user in tenant. - - Positional arguments - - <private-key-filename> - - - Filename for the private key. [Default: pk.pem] - - - - - <x509-cert-filename> - - - Filename for the X.509 certificate. [Default: - cert.pem] - - - - -
-
- nova x509-get-root-cert - usage: nova x509-get-root-cert [<filename>] - -Fetch the x509 root cert. - - Positional arguments - - <filename> - - - Filename to write the x509 root cert. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_openstack_commands.xml b/doc/cli-reference/generated/ch_cli_openstack_commands.xml deleted file mode 100644 index c687664f61..0000000000 --- a/doc/cli-reference/generated/ch_cli_openstack_commands.xml +++ /dev/null @@ -1,15334 +0,0 @@ - - - - - - - - OpenStack command-line client - - The openstack client is a common - OpenStack command-line interface (CLI). - - This chapter documents openstack version - 2.0.0. - - - For help on a specific openstack - command, enter: - - $ openstack COMMAND - -
- openstack usage - usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] - [--os-cloud <cloud-config-name>] - [--os-region-name <auth-region-name>] - [--os-cacert <ca-bundle-file>] [--verify | --insecure] - [--os-default-domain <auth-domain>] - [--os-interface <interface>] [--timing] - [--os-compute-api-version <compute-api-version>] - [--os-network-api-version <network-api-version>] - [--os-image-api-version <image-api-version>] - [--os-volume-api-version <volume-api-version>] - [--os-identity-api-version <identity-api-version>] - [--os-auth-type <auth-type>] - [--os-project-domain-id <auth-project-domain-id>] - [--os-protocol <auth-protocol>] - [--os-project-name <auth-project-name>] - [--os-trust-id <auth-trust-id>] - [--os-service-provider-endpoint <auth-service-provider-endpoint>] - [--os-domain-name <auth-domain-name>] - [--os-user-domain-id <auth-user-domain-id>] - [--os-identity-provider-url <auth-identity-provider-url>] - [--os-access-token-endpoint <auth-access-token-endpoint>] - [--os-domain-id <auth-domain-id>] - [--os-user-domain-name <auth-user-domain-name>] - [--os-scope <auth-scope>] [--os-user-id <auth-user-id>] - [--os-identity-provider <auth-identity-provider>] - [--os-username <auth-username>] - [--os-auth-url <auth-auth-url>] - [--os-client-secret <auth-client-secret>] - [--os-client-id <auth-client-id>] - [--os-project-domain-name <auth-project-domain-name>] - [--os-password <auth-password>] - [--os-endpoint <auth-endpoint>] [--os-url <auth-url>] - [--os-token <auth-token>] [--os-project-id <auth-project-id>] - [--os-object-api-version <object-api-version>] - [--os-mb-api-version <mb-api-version>] - [--inspector-api-version INSPECTOR_API_VERSION] - [--inspector-url INSPECTOR_URL] - [--os-dns-api-version <dns-api-version>] - [--os-policy-api-version <policy-api-version>] - [--os-queues-api-version <queues-api-version>] - [--os-data-processing-api-version <data-processing-api-version>] - [--os-management-api-version <management-api-version>] - [--os-baremetal-api-version <baremetal-api-version>] -
-
- openstack 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 help message and exit. - - - - - --debug - - - Show tracebacks on errors. - - - - - --os-cloud <cloud-config-name> - - - Cloud name in clouds.yaml (Env: OS_CLOUD) - - - - - --os-region-name <auth-region-name> - - - Authentication region name (Env: OS_REGION_NAME) - - - - - --os-cacert <ca-bundle-file> - - - CA certificate bundle file (Env: OS_CACERT) - - - - - --verify - - - Verify server certificate (default) - - - - - --insecure - - - Disable server certificate verification - - - - - --os-default-domain <auth-domain> - - - Default domain ID, default=default (Env: - OS_DEFAULT_DOMAIN) - - - - - --os-interface <interface> - - - Select an interface type. Valid interface types: - [admin, public, internal]. (Env: OS_INTERFACE) - - - - - --timing - - - Print API call timing info - - - - - --os-compute-api-version <compute-api-version> - - - Compute API version, default=2 (Env: - OS_COMPUTE_API_VERSION) - - - - - --os-network-api-version <network-api-version> - - - Network API version, default=2.0 (Env: - OS_NETWORK_API_VERSION) - - - - - --os-image-api-version <image-api-version> - - - Image API version, default=1 (Env: - OS_IMAGE_API_VERSION) - - - - - --os-volume-api-version <volume-api-version> - - - Volume API version, default=2 (Env: - OS_VOLUME_API_VERSION) - - - - - --os-identity-api-version <identity-api-version> - - - Identity API version, default=3 (Env: - OS_IDENTITY_API_VERSION) - - - - - --os-auth-type <auth-type> - - - Select an authentication type. Available types: - v2token, admin_token, v2password, v3password, - v3scopedsaml, v3oidcpassword, v3unscopedadfs, token, - v3token, password, v3unscopedsaml, osc_password, - token_endpoint. Default: selected based on --os- - username/--os-token (Env: OS_AUTH_TYPE) - - - - - --os-project-domain-id <auth-project-domain-id> - - - With v3password: Domain ID containing project With - v3scopedsaml: Domain ID containing project With - v3oidcpassword: Domain ID containing project With - v3unscopedadfs: Domain ID containing project With - token: Domain ID containing project With v3token: - Domain ID containing project With password: Domain ID - containing project With v3unscopedsaml: Domain ID - containing project With osc_password: Domain ID - containing project (Env: OS_PROJECT_DOMAIN_ID) - - - - - --os-protocol <auth-protocol> - - - With v3oidcpassword: Name of the federated protocol - used for federated authentication. Must match its - counterpart name configured at the keystone service - provider. Typically values would be 'saml2' or 'oidc'. - (Env: OS_PROTOCOL) - - - - - --os-project-name <auth-project-name> - - - With v3password: Project name to scope to With - v3scopedsaml: Project name to scope to With - v3oidcpassword: Project name to scope to With - v3unscopedadfs: Project name to scope to With token: - Project name to scope to With v3token: Project name to - scope to With password: Project name to scope to With - v3unscopedsaml: Project name to scope to With - osc_password: Project name to scope to (Env: - OS_PROJECT_NAME) - - - - - --os-trust-id <auth-trust-id> - - - With v2token: Trust ID With v2password: Trust ID With - v3password: Trust ID With v3scopedsaml: Trust ID With - v3oidcpassword: Trust ID With v3unscopedadfs: Trust ID - With token: Trust ID With v3token: Trust ID With - password: Trust ID With v3unscopedsaml: Trust ID With - osc_password: Trust ID (Env: OS_TRUST_ID) - - - - - --os-service-provider-endpoint <auth-service-provider-endpoint> - - - With v3unscopedadfs: Service Provider's Endpoint (Env: - OS_SERVICE_PROVIDER_ENDPOINT) - - - - - --os-domain-name <auth-domain-name> - - - With v3password: Domain name to scope to With - v3scopedsaml: Domain name to scope to With - v3oidcpassword: Domain name to scope to With - v3unscopedadfs: Domain name to scope to With token: - Domain name to scope to With v3token: Domain name to - scope to With password: Domain name to scope to With - v3unscopedsaml: Domain name to scope to With - osc_password: Domain name to scope to (Env: - OS_DOMAIN_NAME) - - - - - --os-user-domain-id <auth-user-domain-id> - - - With v3password: User's domain id With password: - User's domain id With osc_password: User's domain id - (Env: OS_USER_DOMAIN_ID) - - - - - --os-identity-provider-url <auth-identity-provider-url> - - - With v3unscopedadfs: Identity Provider's URL With - v3unscopedsaml: Identity Provider's URL (Env: - OS_IDENTITY_PROVIDER_URL) - - - - - --os-access-token-endpoint <auth-access-token-endpoint> - - - With v3oidcpassword: OpenID Connect Provider Token - Endpoint (Env: OS_ACCESS_TOKEN_ENDPOINT) - - - - - --os-domain-id <auth-domain-id> - - - With v3password: Domain ID to scope to With - v3scopedsaml: Domain ID to scope to With - v3oidcpassword: Domain ID to scope to With - v3unscopedadfs: Domain ID to scope to With token: - Domain ID to scope to With v3token: Domain ID to scope - to With password: Domain ID to scope to With - v3unscopedsaml: Domain ID to scope to With - osc_password: Domain ID to scope to (Env: - OS_DOMAIN_ID) - - - - - --os-user-domain-name <auth-user-domain-name> - - - With v3password: User's domain name With password: - User's domain name With osc_password: User's domain - name (Env: OS_USER_DOMAIN_NAME) - - - - - --os-scope <auth-scope> - - - With v3oidcpassword: OpenID Connect scope that is - requested from OP (Env: OS_SCOPE) - - - - - --os-user-id <auth-user-id> - - - With v2password: User ID to login with With - v3password: User ID With password: User id With - osc_password: User id (Env: OS_USER_ID) - - - - - --os-identity-provider <auth-identity-provider> - - - With v3oidcpassword: Identity Provider's name With - v3unscopedadfs: Identity Provider's name With - v3unscopedsaml: Identity Provider's name (Env: - OS_IDENTITY_PROVIDER) - - - - - --os-username <auth-username> - - - With v2password: Username to login with With - v3password: Username With v3oidcpassword: Username - With v3unscopedadfs: Username With password: Username - With v3unscopedsaml: Username With osc_password: - Username (Env: OS_USERNAME) - - - - - --os-auth-url <auth-auth-url> - - - With v2token: Authentication URL With v2password: - Authentication URL With v3password: Authentication URL - With v3scopedsaml: Authentication URL With - v3oidcpassword: Authentication URL With - v3unscopedadfs: Authentication URL With token: - Authentication URL With v3token: Authentication URL - With password: Authentication URL With v3unscopedsaml: - Authentication URL With osc_password: Authentication - URL (Env: OS_AUTH_URL) - - - - - --os-client-secret <auth-client-secret> - - - With v3oidcpassword: OAuth 2.0 Client Secret (Env: - OS_CLIENT_SECRET) - - - - - --os-client-id <auth-client-id> - - - With v3oidcpassword: OAuth 2.0 Client ID (Env: - OS_CLIENT_ID) - - - - - --os-project-domain-name <auth-project-domain-name> - - - With v3password: Domain name containing project With - v3scopedsaml: Domain name containing project With - v3oidcpassword: Domain name containing project With - v3unscopedadfs: Domain name containing project With - token: Domain name containing project With v3token: - Domain name containing project With password: Domain - name containing project With v3unscopedsaml: Domain - name containing project With osc_password: Domain name - containing project (Env: OS_PROJECT_DOMAIN_NAME) - - - - - --os-password <auth-password> - - - With v2password: Password to use With v3password: - User's password With v3oidcpassword: Password With - v3unscopedadfs: Password With password: User's - password With v3unscopedsaml: Password With - osc_password: User's password (Env: OS_PASSWORD) - - - - - --os-endpoint <auth-endpoint> - - - With admin_token: The endpoint that will always be - used With token_endpoint: The endpoint that will - always be used (Env: OS_ENDPOINT) - - - - - --os-url <auth-url> - - - With token_endpoint: Specific service endpoint to use - (Env: OS_URL) - - - - - --os-token <auth-token> - - - With v2token: Token With admin_token: The token that - will always be used With v3scopedsaml: Token to - authenticate with With token: Token to authenticate - with With v3token: Token to authenticate with With - token_endpoint: The token that will always be used - With token_endpoint: Authentication token to use (Env: - OS_TOKEN) - - - - - --os-project-id <auth-project-id> - - - With v3password: Project ID to scope to With - v3scopedsaml: Project ID to scope to With - v3oidcpassword: Project ID to scope to With - v3unscopedadfs: Project ID to scope to With token: - Project ID to scope to With v3token: Project ID to - scope to With password: Project ID to scope to With - v3unscopedsaml: Project ID to scope to With - osc_password: Project ID to scope to (Env: - OS_PROJECT_ID) - - - - - --os-object-api-version <object-api-version> - - - Object API version, default=1 (Env: - OS_OBJECT_API_VERSION) - - - - - --os-mb-api-version <mb-api-version> - - - MB API version, default=1 (Env: OS_MB_API_VERSION) - - - - - --inspector-api-version INSPECTOR_API_VERSION - - - inspector API version, only 1 is supported now (env: - INSPECTOR_VERSION). - - - - - --inspector-url INSPECTOR_URL - - - inspector URL, defaults to localhost (env: - INSPECTOR_URL). - - - - - --os-dns-api-version <dns-api-version> - - - DNS API version, default=2 (Env: OS_DNS_API_VERSION) - - - - - --os-policy-api-version <policy-api-version> - - - Policy API version, default=1 (Env: - OS_POLICY_API_VERSION) - - - - - --os-queues-api-version <queues-api-version> - - - Queues API version, default=1.1 (Env: - OS_QUEUES_API_VERSION) - - - - - --os-data-processing-api-version <data-processing-api-version> - - - Data processing API version, default=1.1 (Env: - OS_DATA_PROCESSING_API_VERSION) - - - - - --os-management-api-version <management-api-version> - - - Management API version, default=2 (Env: - OS_MANAGEMENT_API_VERSION) - - - - - --os-baremetal-api-version <baremetal-api-version> - - - Baremetal API version, default=1.6 (Env: - OS_BAREMETAL_API_VERSION) - - - - -
- -
- OpenStack with Identity API v2 commands -
- openstack aggregate add host - usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate add host [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <aggregate> <host> - -Add host to aggregate - - Positional arguments - - <aggregate> - - - Aggregate (name or ID) - - - - - <host> - - - Host to add to <aggregate> - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack aggregate create - usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--zone <availability-zone>] - [--property <key=value>] - <name> - -Create a new aggregate - - Positional arguments - - <name> - - - New aggregate name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --zone <availability-zone> - - - Availability zone name - - - - - --property <key=value> - - - Property to add to this aggregate (repeat option to - set multiple properties) - - - - -
-
- openstack aggregate delete - usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate delete [-h] <aggregate> - -Delete an existing aggregate - - Positional arguments - - <aggregate> - - - Aggregate to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack aggregate list - usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - -List all aggregates - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack aggregate remove host - usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate remove host [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <aggregate> <host> - -Remove host from aggregate - - Positional arguments - - <aggregate> - - - Aggregate (name or ID) - - - - - <host> - - - Host to remove from <aggregate> - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack aggregate set - usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] [--name <name>] - [--zone <availability-zone>] - [--property <key=value>] - <aggregate> - -Set aggregate properties - - Positional arguments - - <aggregate> - - - Aggregate to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - Set aggregate name - - - - - --zone <availability-zone> - - - Set availability zone name - - - - - --property <key=value> - - - Property to set on <aggregate> (repeat option to set - multiple properties) - - - - -
-
- openstack aggregate show - usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <aggregate> - -Display aggregate details - - Positional arguments - - <aggregate> - - - Aggregate to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack availability zone list - usage: openstack --os-auth-type token --os-identity-api-version 2 availability zone list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - -List availability zones and their status - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack backup create - usage: openstack --os-auth-type token --os-identity-api-version 2 backup create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--container <container>] [--name <name>] - [--description <description>] - <volume> - -Create new backup - - Positional arguments - - <volume> - - - Volume to backup (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --container <container> - - - Optional backup container name - - - - - --name <name> - - - Name of the backup - - - - - --description <description> - - - Description of the backup - - - - -
-
- openstack backup delete - usage: openstack --os-auth-type token --os-identity-api-version 2 backup delete [-h] <backup> [<backup> ...] - -Delete backup(s) - - Positional arguments - - <backup> - - - Backup(s) to delete (ID only) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack backup list - usage: openstack --os-auth-type token --os-identity-api-version 2 backup list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] [--long] - -List backups - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack backup restore - usage: openstack --os-auth-type token --os-identity-api-version 2 backup restore [-h] <backup> <volume> - -Restore backup - - Positional arguments - - <backup> - - - Backup to restore (ID only) - - - - - <volume> - - - Volume to restore to (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack backup show - usage: openstack --os-auth-type token --os-identity-api-version 2 backup show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <backup> - -Display backup details - - Positional arguments - - <backup> - - - Backup to display (ID only) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack baremetal create - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--chassis-uuid <chassis>] --driver <driver> - [--driver-info <key=value>] - [--property <key=value>] - [--extra <key=value>] [--uuid <uuid>] - [--name <name>] - -Register a new node with the baremetal service - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --chassis-uuid <chassis> - - - UUID of the chassis that this node belongs to. - - - - - --driver <driver> - - - Driver used to control the node [REQUIRED]. - - - - - --driver-info <key=value> - - - Key/value pair used by the driver, such as out-of-band - management credentials. Can be specified multiple - times. - - - - - --property <key=value> - - - Key/value pair describing the physical characteristics - of the node. This is exported to Nova and used by the - scheduler. Can be specified multiple times. - - - - - --extra <key=value> - - - Record arbitrary key/value metadata. Can be specified - multiple times. - - - - - --uuid <uuid> - - - Unique UUID for the node. - - - - - --name <name> - - - Unique name for the node. - - - - -
-
- openstack baremetal delete - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal delete [-h] <node> - -Unregister a baremetal node - - Positional arguments - - <node> - - - Node to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack baremetal introspection rule delete - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule delete [-h] uuid - -Delete an introspection rule. - - Positional arguments - - uuid - - - rule UUID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack baremetal introspection rule import - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule import [-h] file - -Import one or several introspection rules from a json file. - - Positional arguments - - file - - - JSON file to import, may contain one or several rules - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack baremetal introspection rule list - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List all introspection rules. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack baremetal introspection rule purge - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule purge [-h] - -Drop all introspection rules. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack baremetal introspection rule show - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--prefix PREFIX] - uuid - -Show an introspection rule. - - Positional arguments - - uuid - - - rule UUID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack baremetal introspection start - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection start [-h] - [--new-ipmi-username NEW_IPMI_USERNAME] - [--new-ipmi-password NEW_IPMI_PASSWORD] - uuid [uuid ...] - -Start the introspection. - - Positional arguments - - uuid - - - baremetal node UUID(s) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --new-ipmi-username NEW_IPMI_USERNAME - - - if set, *Ironic Inspector* will update IPMI user name - to this value - - - - - --new-ipmi-password NEW_IPMI_PASSWORD - - - if set, *Ironic Inspector* will update IPMI password - to this value - - - - -
-
- openstack baremetal introspection status - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection status [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - uuid - -Get introspection status. - - Positional arguments - - uuid - - - baremetal node UUID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack baremetal list - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--limit <limit>] [--marker <node>] - [--sort <key>[:<direction>]] [--maintenance] - [--associated] [--long] - -List baremetal nodes - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --limit <limit> - - - Maximum number of nodes to return per request, 0 for - no limit. Default is the maximum number used by the - Baremetal API Service. - - - - - --marker <node> - - - Node UUID (for example, of the last node in the list - from a previous request). Returns the list of nodes - after this UUID. - - - - - --sort <key>[:<direction>] - - - Sort output by selected keys and directions(asc or - desc) (default: asc), multiple keys and directions can - be specified separated by comma - - - - - --maintenance - - - List nodes in maintenance mode. - - - - - --associated - - - List only nodes associated with an instance. - - - - - --long - - - Show detailed information about the nodes. - - - - -
-
- openstack baremetal set - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal set [-h] [--property <path=value>] <node> - -Set baremetal properties - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <path=value> - - - Property to add to this baremetal host (repeat option - to set multiple properties) - - - - -
-
- openstack baremetal show - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] [--instance] - [--long] - <node> - -Show baremetal node details - - Positional arguments - - <node> - - - Name or UUID of the node (or instance UUID if - --instance is specified) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --instance <node> - - - is an instance UUID. - - - - - --long - - - - - - -
-
- openstack baremetal unset - usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal unset [-h] [--property <path>] <node> - -Unset baremetal properties - - Positional arguments - - <node> - - - Name or UUID of the node. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <path> - - - Property to unset on this baremetal host (repeat option - to unset multiple properties) - - - - -
-
- openstack catalog list - usage: openstack --os-auth-type token --os-identity-api-version 2 catalog list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List services in the service catalog - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack catalog show - usage: openstack --os-auth-type token --os-identity-api-version 2 catalog show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <service> - -Display service catalog details - - Positional arguments - - <service> - - - Service to display (type or name) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack command list - usage: openstack --os-auth-type token --os-identity-api-version 2 command list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List recognized commands by group - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack compute agent create - usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <os> <architecture> <version> <url> - <md5hash> <hypervisor> - -Create compute agent command - - Positional arguments - - <os> - - - Type of OS - - - - - <architecture> - - - Type of architecture - - - - - <version> - - - Version - - - - - <url> - - - URL - - - - - <md5hash> - - - MD5 hash - - - - - <hypervisor> - - - Type of hypervisor - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack compute agent delete - usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent delete [-h] <id> - -Delete compute agent command - - Positional arguments - - <id> - - - ID of agent to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack compute agent list - usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--hypervisor <hypervisor>] - -List compute agent command - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --hypervisor <hypervisor> - - - Type of hypervisor - - - - -
-
- openstack compute agent set - usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <id> <version> <url> <md5hash> - -Set compute agent command - - Positional arguments - - <id> - - - ID of the agent - - - - - <version> - - - Version of the agent - - - - - <url> - - - URL - - - - - <md5hash> - - - MD5 hash - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack compute service delete - usage: openstack --os-auth-type token --os-identity-api-version 2 compute service delete [-h] <service> - -Delete service command - - Positional arguments - - <service> - - - Compute service to delete (ID only) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack compute service list - usage: openstack --os-auth-type token --os-identity-api-version 2 compute service list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--host <host>] [--service <service>] - -List service command - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --host <host> - - - Name of host - - - - - --service <service> - - - Name of service - - - - -
-
- openstack compute service set - usage: openstack --os-auth-type token --os-identity-api-version 2 compute service set [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--enable | --disable] - <host> <service> - -Set service command - - Positional arguments - - <host> - - - Name of host - - - - - <service> - - - Name of service - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --enable - - - Enable a service - - - - - --disable - - - Disable a service - - - - -
-
- openstack configuration show - usage: openstack --os-auth-type token --os-identity-api-version 2 configuration show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--mask | --unmask] - -Display configuration details - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --mask - - - Attempt to mask passwords (default) - - - - - --unmask - - - Show password in clear text - - - - -
-
- openstack congress datasource create - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--description <datasource-description>] - [--config <key=value>] - <datasource-driver> - <datasource-name> - -Create a datasource. - - Positional arguments - - <datasource-driver> - - - Selected datasource driver - - - - - <datasource-name> - - - Name you want to call the datasource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description <datasource-description> - - - Description of the datasource - - - - - --config <key=value> - - - config dictionary to pass in - - - - -
-
- openstack congress datasource delete - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource delete [-h] <datasource-name> - -Delete a datasource. - - Positional arguments - - <datasource-name> - - - Name of the datasource to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress datasource list - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List Datasources. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress datasource row list - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource row list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <datasource-name> <table> - -List datasource rows. - - Positional arguments - - <datasource-name> - - - Name of the datasource to show - - - - - <table> - - - Table to get the datasource rows from - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress datasource schema show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource schema show [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <datasource-name> - -Show schema for datasource. - - Positional arguments - - <datasource-name> - - - Name of the datasource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress datasource status show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource status show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--prefix PREFIX] - <datasource-name> - -List status for datasource. - - Positional arguments - - <datasource-name> - - - Name of the datasource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress datasource table list - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <datasource-name> - -List datasource tables. - - Positional arguments - - <datasource-name> - - - Name of the datasource - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress datasource table schema show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table schema show [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <datasource-name> - <table-name> - -Show schema for datasource table. - - Positional arguments - - <datasource-name> - - - Name of the datasource - - - - - <table-name> - - - Name of the table - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress datasource table show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <datasource-name> <table-id> - -Show Datasource Table properties. - - Positional arguments - - <datasource-name> - - - Name of datasource - - - - - <table-id> - - - Table id - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress driver config show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver config show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <datasource-driver> - -List driver tables. - - Positional arguments - - <datasource-driver> - - - Name of the datasource driver - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress driver list - usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List drivers. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress driver schema show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver schema show [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <datasource-driver> - -List datasource tables. - - Positional arguments - - <datasource-driver> - - - Name of the datasource driver - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress policy create - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--description <description>] - [--abbreviation <abbreviation>] - [--kind <kind>] - <policy_name> - -Create a policy. - - Positional arguments - - <policy_name> - - - Name of the policy - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description <description> - - - Policy description - - - - - --abbreviation <abbreviation> - - - Policy abbreviation (used in traces) - - - - - --kind <kind> - - - Kind of policy: {nonrecursive, database, action, - materialized} - - - - -
-
- openstack congress policy delete - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy delete [-h] <policy> - -Delete a policy. - - Positional arguments - - <policy> - - - ID or name of the policy to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress policy list - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List Policy. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress policy row list - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy row list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--trace] - <policy-name> <table> - -List policy rows. - - Positional arguments - - <policy-name> - - - Name of the policy to show - - - - - <table> - - - Table to get the policy rows from - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --trace - - - Display explanation of result - - - - -
-
- openstack congress policy rule create - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--name RULE_NAME] - [--comment COMMENT] - <policy-name> <rule> - -Create a policy rule. - - Positional arguments - - <policy-name> - - - Name or identifier of the policy - - - - - <rule> - - - Policy rule - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name RULE_NAME - - - Name of the policy rule - - - - - --comment COMMENT - - - Comment about policy rule - - - - -
-
- openstack congress policy rule delete - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule delete [-h] - <policy-name> <rule-id/rule-name> - -Delete a policy rule. - - Positional arguments - - <policy-name> - - - Name of the policy to delete - - - - - <rule-id/rule-name> - - - ID/Name of the policy rule to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress policy rule list - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule list [-h] <policy-name> - -List policy rules. - - Positional arguments - - <policy-name> - - - Name of the policy - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress policy rule show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <policy-name> <rule-id/rule-name> - -Show a policy rule. - - Positional arguments - - <policy-name> - - - Name or identifier of the policy - - - - - <rule-id/rule-name> - - - Policy rule id or rule name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress policy show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <policy-name> - -Show policy properties. - - Positional arguments - - <policy-name> - - - Name of policy - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress policy simulate - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy simulate [-h] [--delta] [--trace] - <policy> <query> <sequence> - <action_policy> - -Show the result of simulation. - - Positional arguments - - <policy> - - - Name of the policy - - - - - <query> - - - String representing query (policy rule or literal) - - - - - <sequence> - - - String representing sequence of updates/actions - - - - - <action_policy> - - - Name of the policy with actions - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --delta - - - Return difference in query caused by update sequence - - - - - --trace - - - Include trace describing computation - - - - -
-
- openstack congress policy table list - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy table list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <policy-name> - -List policy tables. - - Positional arguments - - <policy-name> - - - Name of the policy - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack congress policy table show - usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy table show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <policy-name> <table-id> - -Show policy table properties. - - Positional arguments - - <policy-name> - - - Name of policy - - - - - <table-id> - - - Table id - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack console log show - usage: openstack --os-auth-type token --os-identity-api-version 2 console log show [-h] [--lines <num-lines>] <server> - -Show server's console output - - Positional arguments - - <server> - - - Server to show console log (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --lines <num-lines> - - - Number of lines to display from the end of the log - (default=all) - - - - -
-
- openstack console url show - usage: openstack --os-auth-type token --os-identity-api-version 2 console url show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--novnc | --xvpvnc | --spice] - <server> - -Show server's remote console URL - - Positional arguments - - <server> - - - Server to show URL (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --novnc - - - Show noVNC console URL (default) - - - - - --xvpvnc - - - Show xpvnc console URL - - - - - --spice - - - Show SPICE console URL - - - - -
-
- openstack container create - usage: openstack --os-auth-type token --os-identity-api-version 2 container create [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <container-name> [<container-name> ...] - -Create new container - - Positional arguments - - <container-name> - - - New container name(s) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack container delete - usage: openstack --os-auth-type token --os-identity-api-version 2 container delete [-h] <container> [<container> ...] - -Delete container - - Positional arguments - - <container> - - - Container(s) to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack container list - usage: openstack --os-auth-type token --os-identity-api-version 2 container list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--prefix <prefix>] [--marker <marker>] - [--end-marker <end-marker>] [--limit <limit>] - [--long] [--all] - -List containers - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --prefix <prefix> - - - Filter list using <prefix> - - - - - --marker <marker> - - - Anchor for paging - - - - - --end-marker <end-marker> - - - End anchor for paging - - - - - --limit <limit> - - - Limit the number of containers returned - - - - - --long - - - List additional fields in output - - - - - --all - - - List all containers (default is 10000) - - - - -
-
- openstack container save - usage: openstack --os-auth-type token --os-identity-api-version 2 container save [-h] <container> - -Save container contents locally - - Positional arguments - - <container> - - - Container to save - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack container set - usage: openstack --os-auth-type token --os-identity-api-version 2 container set [-h] --property <key=value> <container> - -Set container properties - - Positional arguments - - <container> - - - Container to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key=value> - - - Set a property on this container (repeat option to set - multiple properties) - - - - -
-
- openstack container show - usage: openstack --os-auth-type token --os-identity-api-version 2 container show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <container> - -Display container details - - Positional arguments - - <container> - - - Container to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack container unset - usage: openstack --os-auth-type token --os-identity-api-version 2 container unset [-h] --property <key> <container> - -Unset container properties - - Positional arguments - - <container> - - - Container to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property to remove from container (repeat option to remove - multiple properties) - - - - -
-
- openstack dataprocessing data source create - usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--prefix PREFIX] --type - <type> --url <url> - [--username <username>] - [--password <password>] - [--description <description>] - <name> - -Creates data source - - Positional arguments - - <name> - - - Name of the data source - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type <type> - - - Type of the data source (swift, hdfs or maprfs) - [REQUIRED] - - - - - --url <url> - - - Url for the data source [REQUIRED] - - - - - --username <username> - - - Username for accessing the data source url - - - - - --password <password> - - - Password for accessing the data source url - - - - - --description <description> - - - Description of the data source - - - - -
-
- openstack dataprocessing data source delete - usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source delete [-h] <data-source> - -Delete data source - - Positional arguments - - <data-source> - - - Name or id of the data source to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack dataprocessing data source list - usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] [--type <type>] - -Lists data sources - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - - --type <type> - - - List data sources of specific type (swift, hdfs or - maprfs) - - - - -
-
- openstack dataprocessing data source show - usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--prefix PREFIX] - <data-source> - -Display data source details - - Positional arguments - - <data-source> - - - Name or id of the data source to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack dataprocessing plugin configs get - usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing plugin configs get [-h] [--file <file>] - <plugin> <version> - -Get plugin configs - - Positional arguments - - <plugin> - - - Name of the plugin to provide config information about - - - - - <version> - - - Version of the plugin to provide config information about - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --file <file> - - - Destination file (defaults to plugin name) - - - - -
-
- openstack dataprocessing plugin list - usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing plugin list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - -Lists plugins - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack dataprocessing plugin show - usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing plugin show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <plugin> - -Display plugin details - - Positional arguments - - <plugin> - - - Name of the plugin to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ec2 credentials create - usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--project <project>] [--user <user>] - -Create EC2 credentials - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Create credentials in project (name or ID; default: - current authenticated project) - - - - - --user <user> - - - Create credentials for user (name or ID; default: - current authenticated user) - - - - -
-
- openstack ec2 credentials delete - usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials delete [-h] [--user <user>] <access-key> - -Delete EC2 credentials - - Positional arguments - - <access-key> - - - Credentials access key - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --user <user> - - - Delete credentials for user (name or ID) - - - - -
-
- openstack ec2 credentials list - usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--user <user>] - -List EC2 credentials - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --user <user> - - - Filter list by user (name or ID) - - - - -
-
- openstack ec2 credentials show - usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--user <user>] - <access-key> - -Display EC2 credentials details - - Positional arguments - - <access-key> - - - Credentials access key - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --user <user> - - - Show credentials for user (name or ID) - - - - -
-
- openstack endpoint create - usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] --publicurl - <url> [--adminurl <url>] - [--internalurl <url>] [--region <region-id>] - <service> - -Create new endpoint - - Positional arguments - - <service> - - - New endpoint service (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --publicurl <url> - - - New endpoint public URL (required) - - - - - --adminurl <url> - - - New endpoint admin URL - - - - - --internalurl <url> - - - New endpoint internal URL - - - - - --region <region-id> - - - New endpoint region ID - - - - -
-
- openstack endpoint delete - usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint delete [-h] <endpoint-id> - -Delete endpoint - - Positional arguments - - <endpoint-id> - - - Endpoint ID to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack endpoint list - usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - -List endpoints - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack endpoint show - usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <endpoint-id> - -Display endpoint details - - Positional arguments - - <endpoint-id> - - - Endpoint ID to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack extension list - usage: openstack --os-auth-type token --os-identity-api-version 2 extension list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--compute] [--identity] [--network] - [--volume] [--long] - -List API extensions - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --compute - - - List extensions for the Compute API - - - - - --identity - - - List extensions for the Identity API - - - - - --network - - - List extensions for the Network API - - - - - --volume - - - List extensions for the Volume API - - - - - --long - - - List additional fields in output - - - - -
-
- openstack flavor create - usage: openstack --os-auth-type token --os-identity-api-version 2 flavor create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] [--id <id>] - [--ram <size-mb>] [--disk <size-gb>] - [--ephemeral <size-gb>] [--swap <size-gb>] - [--vcpus <vcpus>] [--rxtx-factor <factor>] - [--public | --private] - <flavor-name> - -Create new flavor - - Positional arguments - - <flavor-name> - - - New flavor name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --id <id> - - - Unique flavor ID; 'auto' creates a UUID (default: - auto) - - - - - --ram <size-mb> - - - Memory size in MB (default 256M) - - - - - --disk <size-gb> - - - Disk size in GB (default 0G) - - - - - --ephemeral <size-gb> - - - Ephemeral disk size in GB (default 0G) - - - - - --swap <size-gb> - - - Swap space size in GB (default 0G) - - - - - --vcpus <vcpus> - - - Number of vcpus (default 1) - - - - - --rxtx-factor <factor> - - - RX/TX factor (default 1) - - - - - --public - - - Flavor is available to other projects (default) - - - - - --private - - - Flavor is not available to other projects - - - - -
-
- openstack flavor delete - usage: openstack --os-auth-type token --os-identity-api-version 2 flavor delete [-h] <flavor> - -Delete flavor - - Positional arguments - - <flavor> - - - Flavor to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack flavor list - usage: openstack --os-auth-type token --os-identity-api-version 2 flavor list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--public | --private | --all] [--long] - [--marker <marker>] [--limit <limit>] - -List flavors - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --public - - - List only public flavors (default) - - - - - --private - - - List only private flavors - - - - - --all - - - List all flavors, whether public or private - - - - - --long - - - List additional fields in output - - - - - --marker <marker> - - - The last flavor ID of the previous page - - - - - --limit <limit> - - - Maximum number of flavors to display - - - - -
-
- openstack flavor set - usage: openstack --os-auth-type token --os-identity-api-version 2 flavor set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--property <key=value>] - <flavor> - -Set flavor properties - - Positional arguments - - <flavor> - - - Flavor to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key=value> - - - Property to add or modify for this flavor (repeat - option to set multiple properties) - - - - -
-
- openstack flavor show - usage: openstack --os-auth-type token --os-identity-api-version 2 flavor show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <flavor> - -Display flavor details - - Positional arguments - - <flavor> - - - Flavor to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack flavor unset - usage: openstack --os-auth-type token --os-identity-api-version 2 flavor unset [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] --property <key> - <flavor> - -Unset flavor properties - - Positional arguments - - <flavor> - - - Flavor to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property to remove from flavor (repeat option to unset - multiple properties) - - - - -
-
- openstack host list - usage: openstack --os-auth-type token --os-identity-api-version 2 host list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--zone <zone>] - -List host command - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --zone <zone> - - - Only return hosts in the availability zone. - - - - -
-
- openstack host show - usage: openstack --os-auth-type token --os-identity-api-version 2 host show [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <host> - -Show host command - - Positional arguments - - <host> - - - Name of host - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack hypervisor list - usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--matching <hostname>] - -List hypervisors - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --matching <hostname> - - - Filter hypervisors using <hostname> substring - - - - -
-
- openstack hypervisor show - usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <hypervisor> - -Display hypervisor details - - Positional arguments - - <hypervisor> - - - Hypervisor to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack hypervisor stats show - usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor stats show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -Display hypervisor stats details - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack image add project - usage: openstack --os-auth-type token --os-identity-api-version 2 image add project [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--project-domain <project-domain>] - <image> <project> - -Associate project with image - - Positional arguments - - <image> - - - Image to share (name or ID) - - - - - <project> - - - Project to associate with image (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project-domain <project-domain> - - - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - - - - -
-
- openstack image create - usage: openstack --os-auth-type token --os-identity-api-version 2 image create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--id <id>] - [--container-format <container-format>] - [--disk-format <disk-format>] [--owner <owner>] - [--min-disk <disk-gb>] [--min-ram <ram-mb>] - [--file <file>] [--protected | --unprotected] - [--public | --private] [--property <key=value>] - [--tag <tag>] - <image-name> - -Create/upload an image - - Positional arguments - - <image-name> - - - New image name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --id <id> - - - Image ID to reserve - - - - - --container-format <container-format> - - - Image container format (default: bare) - - - - - --disk-format <disk-format> - - - Image disk format (default: raw) - - - - - --owner <owner> - - - Image owner project name or ID - - - - - --min-disk <disk-gb> - - - Minimum disk size needed to boot image, in gigabytes - - - - - --min-ram <ram-mb> - - - Minimum RAM size needed to boot image, in megabytes - - - - - --file <file> - - - Upload image from local file - - - - - --protected - - - Prevent image from being deleted - - - - - --unprotected - - - Allow image to be deleted (default) - - - - - --public - - - Image is accessible to the public - - - - - --private - - - Image is inaccessible to the public (default) - - - - - --property <key=value> - - - Set a property on this image (repeat option to set - multiple properties) - - - - - --tag <tag> - - - Set a tag on this image (repeat option to set multiple - tags) - - - - -
-
- openstack image delete - usage: openstack --os-auth-type token --os-identity-api-version 2 image delete [-h] <image> [<image> ...] - -Delete image(s) - - Positional arguments - - <image> - - - Image(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack image list - usage: openstack --os-auth-type token --os-identity-api-version 2 image list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--public | --private | --shared] - [--property <key=value>] [--long] - [--sort <key>[:<direction>]] - -List available images - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --public - - - List only public images - - - - - --private - - - List only private images - - - - - --shared - - - List only shared images - - - - - --property <key=value> - - - Filter output based on property - - - - - --long - - - List additional fields in output - - - - - --sort <key>[:<direction>] - - - Sort output by selected keys and directions(asc or - desc) (default: asc), multiple keys and directions can - be specified separated by comma - - - - -
-
- openstack image remove project - usage: openstack --os-auth-type token --os-identity-api-version 2 image remove project [-h] [--project-domain <project-domain>] - <image> <project> - -Disassociate project with image - - Positional arguments - - <image> - - - Image to unshare (name or ID) - - - - - <project> - - - Project to disassociate with image (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project-domain <project-domain> - - - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - - - - -
-
- openstack image save - usage: openstack --os-auth-type token --os-identity-api-version 2 image save [-h] [--file <filename>] <image> - -Save an image locally - - Positional arguments - - <image> - - - Image to save (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --file <filename> - - - Downloaded image save filename (default: stdout) - - - - -
-
- openstack image set - usage: openstack --os-auth-type token --os-identity-api-version 2 image set [-h] [--name <name>] [--owner <project>] - [--min-disk <disk-gb>] [--min-ram <ram-mb>] - [--container-format <container-format>] - [--disk-format <disk-format>] - [--protected | --unprotected] - [--public | --private] [--property <key=value>] - [--tag <tag>] [--architecture <architecture>] - [--instance-id <instance-id>] - [--kernel-id <kernel-id>] [--os-distro <os-distro>] - [--os-version <os-version>] - [--ramdisk-id <ramdisk-id>] - <image> - -Set image properties - - Positional arguments - - <image> - - - Image to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - New image name - - - - - --owner <project> - - - New image owner project (name or ID) - - - - - --min-disk <disk-gb> - - - Minimum disk size needed to boot image, in gigabytes - - - - - --min-ram <ram-mb> - - - Minimum RAM size needed to boot image, in megabytes - - - - - --container-format <container-format> - - - Image container format (default: bare) - - - - - --disk-format <disk-format> - - - Image disk format (default: raw) - - - - - --protected - - - Prevent image from being deleted - - - - - --unprotected - - - Allow image to be deleted (default) - - - - - --public - - - Image is accessible to the public - - - - - --private - - - Image is inaccessible to the public (default) - - - - - --property <key=value> - - - Set a property on this image (repeat option to set - multiple properties) - - - - - --tag <tag> - - - Set a tag on this image (repeat option to set multiple - tags) - - - - - --architecture <architecture> - - - Operating system architecture - - - - - --instance-id <instance-id> - - - ID of server instance used to create this image - - - - - --kernel-id <kernel-id> - - - ID of kernel image used to boot this disk image - - - - - --os-distro <os-distro> - - - Operating system distribution name - - - - - --os-version <os-version> - - - Operating system distribution version - - - - - --ramdisk-id <ramdisk-id> - - - ID of ramdisk image used to boot this disk image - - - - -
-
- openstack image show - usage: openstack --os-auth-type token --os-identity-api-version 2 image show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <image> - -Display image details - - Positional arguments - - <image> - - - Image to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ip fixed add - usage: openstack --os-auth-type token --os-identity-api-version 2 ip fixed add [-h] <network> <server> - -Add fixed IP address to server - - Positional arguments - - <network> - - - Network to fetch an IP address from (name or ID) - - - - - <server> - - - Server to receive the IP address (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ip fixed remove - usage: openstack --os-auth-type token --os-identity-api-version 2 ip fixed remove [-h] <ip-address> <server> - -Remove fixed IP address from server - - Positional arguments - - <ip-address> - - - IP address to remove from server (name only) - - - - - <server> - - - Server to remove the IP address from (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ip floating add - usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating add [-h] <ip-address> <server> - -Add floating IP address to server - - Positional arguments - - <ip-address> - - - IP address to add to server (name only) - - - - - <server> - - - Server to receive the IP address (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ip floating create - usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <pool> - -Create new floating IP address - - Positional arguments - - <pool> - - - Pool to fetch IP address from (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ip floating delete - usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating delete [-h] <ip-address> - -Delete a floating IP address - - Positional arguments - - <ip-address> - - - IP address to delete (ID only) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ip floating list - usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List floating IP addresses - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ip floating pool list - usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating pool list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List pools of floating IP addresses - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ip floating remove - usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating remove [-h] <ip-address> <server> - -Remove floating IP address from server - - Positional arguments - - <ip-address> - - - IP address to remove from server (name only) - - - - - <server> - - - Server to remove the IP address from (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack keypair create - usage: openstack --os-auth-type token --os-identity-api-version 2 keypair create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--public-key <file>] - <name> - -Create new public key - - Positional arguments - - <name> - - - New public key name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --public-key <file> - - - Filename for public key to add - - - - -
-
- openstack keypair delete - usage: openstack --os-auth-type token --os-identity-api-version 2 keypair delete [-h] <key> - -Delete public key - - Positional arguments - - <key> - - - Public key to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack keypair list - usage: openstack --os-auth-type token --os-identity-api-version 2 keypair list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List public key fingerprints - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack keypair show - usage: openstack --os-auth-type token --os-identity-api-version 2 keypair show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--public-key] - <key> - -Display public key details - - Positional arguments - - <key> - - - Public key to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --public-key - - - Show only bare public key - - - - -
-
- openstack limits show - usage: openstack --os-auth-type token --os-identity-api-version 2 limits show [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - (--absolute | --rate) [--reserved] - [--project <project>] [--domain <domain>] - -Show compute and volume limits - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --absolute - - - Show absolute limits - - - - - --rate - - - Show rate limits - - - - - --reserved - - - Include reservations count [only valid with - --absolute] - - - - - --project <project> - - - Show limits for a specific project (name or ID) [only - valid with --absolute] - - - - - --domain <domain> - - - Domain that owns --project (name or ID) [only valid - with --absolute] - - - - -
-
- openstack management plan add role - usage: openstack --os-auth-type token --os-identity-api-version 2 management plan add role [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -Add a Role to a Management Plan. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack management plan create - usage: openstack --os-auth-type token --os-identity-api-version 2 management plan create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [-d DESCRIPTION] - name - -Create a Management Plan. - - Positional arguments - - name - - - Name of the plan being created. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -d DESCRIPTION, --description DESCRIPTION - - - A textual description of the plan. - - - - -
-
- openstack management plan delete - usage: openstack --os-auth-type token --os-identity-api-version 2 management plan delete [-h] plan_uuid - -Delete a Management Plan. - - Positional arguments - - plan_uuid - - - The UUID of the plan being deleted. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack management plan download - usage: openstack --os-auth-type token --os-identity-api-version 2 management plan download [-h] - -Download the a Management Plan. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack management plan list - usage: openstack --os-auth-type token --os-identity-api-version 2 management plan list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List the Management Plans. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack management plan remove role - usage: openstack --os-auth-type token --os-identity-api-version 2 management plan remove role [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -Remove a Role from a Management Plan. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack management plan set - usage: openstack --os-auth-type token --os-identity-api-version 2 management plan set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [-P <KEY1=VALUE1>] [-F <ROLE=FLAVOR>] - [-S <ROLE=SCALE-COUNT>] - plan_uuid - -Update a Management Plans properties. - - Positional arguments - - plan_uuid - - - The UUID of the plan being updated. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -P <KEY1=VALUE1>, --parameter <KEY1=VALUE1> - - - Set a parameter in the Plan. This can be specified - multiple times. - - - - - -F <ROLE=FLAVOR>, --flavor <ROLE=FLAVOR> - - - Set the flavor for a role in the Plan. This can be - specified multiple times. - - - - - -S <ROLE=SCALE-COUNT>, --scale <ROLE=SCALE-COUNT> - - - Set the Scale count for a role in the Plan. This can - be specified multiple times. - - - - -
-
- openstack management plan show - usage: openstack --os-auth-type token --os-identity-api-version 2 management plan show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -Show a Management Plan. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack management role list - usage: openstack --os-auth-type token --os-identity-api-version 2 management role list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List Roles. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack message-broker - Command "message-broker" matches: - message-broker cluster create - message-broker cluster delete - message-broker cluster list - message-broker cluster set - message-broker cluster show - - -
-
- openstack message-broker cluster - Command "message-broker cluster" matches: - message-broker cluster create - message-broker cluster delete - message-broker cluster list - message-broker cluster set - message-broker cluster show - - -
-
- openstack message-broker cluster create - usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --name NAME --nic NIC --flavor - FLAVOR --size SIZE - [--volume_size VOLUME_SIZE] - [--auth <type=type,user=user,pass=pass>] - -Create Cluster - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME - - - Cluster Name - - - - - --nic NIC - - - Network to place nodes on - - - - - --flavor FLAVOR - - - Flavor to use. - - - - - --size SIZE - - - Number of nodes - - - - - --volume_size VOLUME_SIZE - - - Volume size - - - - - --auth <type=type,user=user,pass=pass> - - - broker authentication,type=type,user=user,pass=pass - - - - -
-
- openstack message-broker cluster delete - usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster delete [-h] id - -Delete Cluster - - Positional arguments - - id - - - Cluster ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack message-broker cluster list - usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List Clusters - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack message-broker cluster set - usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster set [-h] [--name NAME] [--email EMAIL] - [--ttl TTL] - [--description DESCRIPTION | --no-description] - [--masters MASTERS [MASTERS ...]] - id - -Set Cluster - - Positional arguments - - id - - - Cluster ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME - - - Cluster Name - - - - - --email EMAIL - - - Cluster Email - - - - - --ttl TTL - - - Time To Live (Seconds) - - - - - --description DESCRIPTION - - - Description - - - - - --no-description - - - - - - - --masters MASTERS [MASTERS ...] - - - Cluster Masters - - - - -
-
- openstack message-broker cluster show - usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - id - -Show Cluster - - Positional arguments - - id - - - Cluster ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack messaging flavor delete - usage: openstack --os-auth-type token --os-identity-api-version 2 messaging flavor delete [-h] <flavor_name> - -Delete a flavor. - - Positional arguments - - <flavor_name> - - - Name of the flavor - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack module list - usage: openstack --os-auth-type token --os-identity-api-version 2 module list [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--all] - -List module versions - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --all - - - Show all modules that have version information - - - - -
-
- openstack network create - usage: openstack --os-auth-type token --os-identity-api-version 2 network create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--enable | --disable] [--share | --no-share] - [--project <project>] - [--project-domain <project-domain>] - <name> - -Create new network - - Positional arguments - - <name> - - - New network name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --enable - - - Enable network (default) - - - - - --disable - - - Disable network - - - - - --share - - - Share the network between projects - - - - - --no-share - - - Do not share the network between projects - - - - - --project <project> - - - Owner's project (name or ID) - - - - - --project-domain <project-domain> - - - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - - - - -
-
- openstack network delete - usage: openstack --os-auth-type token --os-identity-api-version 2 network delete [-h] <network> [<network> ...] - -Delete network(s) - - Positional arguments - - <network> - - - Network to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack network list - usage: openstack --os-auth-type token --os-identity-api-version 2 network list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--external] [--long] - -List networks - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --external - - - List external networks - - - - - --long - - - List additional fields in output - - - - -
-
- openstack network set - usage: openstack --os-auth-type token --os-identity-api-version 2 network set [-h] [--name <name>] [--enable | --disable] - [--share | --no-share] - <network> - -Set network properties - - Positional arguments - - <network> - - - Network to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - Set network name - - - - - --enable - - - Enable network - - - - - --disable - - - Disable network - - - - - --share - - - Share the network between projects - - - - - --no-share - - - Do not share the network between projects - - - - -
-
- openstack network show - usage: openstack --os-auth-type token --os-identity-api-version 2 network show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <network> - -Show network details - - Positional arguments - - <network> - - - Network to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack object create - usage: openstack --os-auth-type token --os-identity-api-version 2 object create [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <container> <filename> [<filename> ...] - -Upload object to container - - Positional arguments - - <container> - - - Container for new object - - - - - <filename> - - - Local filename(s) to upload - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack object delete - usage: openstack --os-auth-type token --os-identity-api-version 2 object delete [-h] <container> <object> [<object> ...] - -Delete object from container - - Positional arguments - - <container> - - - Delete object(s) from <container> - - - - - <object> - - - Object(s) to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack object list - usage: openstack --os-auth-type token --os-identity-api-version 2 object list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--prefix <prefix>] [--delimiter <delimiter>] - [--marker <marker>] [--end-marker <end-marker>] - [--limit <limit>] [--long] [--all] - <container> - -List objects - - Positional arguments - - <container> - - - Container to list - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --prefix <prefix> - - - Filter list using <prefix> - - - - - --delimiter <delimiter> - - - Roll up items with <delimiter> - - - - - --marker <marker> - - - Anchor for paging - - - - - --end-marker <end-marker> - - - End anchor for paging - - - - - --limit <limit> - - - Limit the number of objects returned - - - - - --long - - - List additional fields in output - - - - - --all - - - List all objects in container (default is 10000) - - - - -
-
- openstack object save - usage: openstack --os-auth-type token --os-identity-api-version 2 object save [-h] [--file <filename>] <container> <object> - -Save object locally - - Positional arguments - - <container> - - - Download <object> from <container> - - - - - <object> - - - Object to save - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --file <filename> - - - Destination filename (defaults to object name) - - - - -
-
- openstack object set - usage: openstack --os-auth-type token --os-identity-api-version 2 object set [-h] --property <key=value> <container> <object> - -Set object properties - - Positional arguments - - <container> - - - Modify <object> from <container> - - - - - <object> - - - Object to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key=value> - - - Set a property on this object (repeat option to set - multiple properties) - - - - -
-
- openstack object show - usage: openstack --os-auth-type token --os-identity-api-version 2 object show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <container> <object> - -Display object details - - Positional arguments - - <container> - - - Display <object> from <container> - - - - - <object> - - - Object to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack object store account set - usage: openstack --os-auth-type token --os-identity-api-version 2 object store account set [-h] --property <key=value> - -Set account properties - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key=value> - - - Set a property on this account (repeat option to set - multiple properties) - - - - -
-
- openstack object store account show - usage: openstack --os-auth-type token --os-identity-api-version 2 object store account show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - -Display account details - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack object store account unset - usage: openstack --os-auth-type token --os-identity-api-version 2 object store account unset [-h] --property <key> - -Unset account properties - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property to remove from account (repeat option to remove - multiple properties) - - - - -
-
- openstack object unset - usage: openstack --os-auth-type token --os-identity-api-version 2 object unset [-h] --property <key> <container> <object> - -Unset object properties - - Positional arguments - - <container> - - - Modify <object> from <container> - - - - - <object> - - - Object to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property to remove from object (repeat option to remove - multiple properties) - - - - -
-
- openstack pool create - usage: openstack --os-auth-type token --os-identity-api-version 2 pool create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <pool_name> <pool_uri> <pool_weight> <pool_group> - -Create a pool. - - Positional arguments - - <pool_name> - - - Name of the pool - - - - - <pool_uri> - - - Storage engine URI - - - - - <pool_weight> - - - weight of the pool - - - - - <pool_group> - - - Group of the pool - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack project create - usage: openstack --os-auth-type token --os-identity-api-version 2 project create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--description <description>] - [--enable | --disable] - [--property <key=value>] [--or-show] - <project-name> - -Create new project - - Positional arguments - - <project-name> - - - New project name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description <description> - - - Project description - - - - - --enable - - - Enable project (default) - - - - - --disable - - - Disable project - - - - - --property <key=value> - - - Add a property to <name> (repeat option to set - multiple properties) - - - - - --or-show - - - Return existing project - - - - -
-
- openstack project delete - usage: openstack --os-auth-type token --os-identity-api-version 2 project delete [-h] <project> [<project> ...] - -Delete project(s) - - Positional arguments - - <project> - - - Project(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack project list - usage: openstack --os-auth-type token --os-identity-api-version 2 project list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] [--long] - -List projects - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack project set - usage: openstack --os-auth-type token --os-identity-api-version 2 project set [-h] [--name <name>] - [--description <description>] - [--enable | --disable] [--property <key=value>] - <project> - -Set project properties - - Positional arguments - - <project> - - - Project to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - Set project name - - - - - --description <description> - - - Set project description - - - - - --enable - - - Enable project - - - - - --disable - - - Disable project - - - - - --property <key=value> - - - Set a project property (repeat option to set multiple - properties) - - - - -
-
- openstack project show - usage: openstack --os-auth-type token --os-identity-api-version 2 project show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <project> - -Display project details - - Positional arguments - - <project> - - - Project to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ptr record list - usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List floatingip ptr records - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ptr record set - usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--description DESCRIPTION | --no-description] - [--ttl TTL | --no-ttl] - floatingip_id ptrdname - -Set floatingip ptr record - - Positional arguments - - floatingip_id - - - Floating IP ID - - - - - ptrdname - - - PTRD Name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description DESCRIPTION - - - Description - - - - - --no-description - - - - - - - --ttl TTL - - - TTL - - - - - --no-ttl - - - - - - -
-
- openstack ptr record show - usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - floatingip_id - -Show floatingip ptr record details - - Positional arguments - - floatingip_id - - - Floating IP ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack ptr record unset - usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record unset [-h] floatingip_id - -Unset floatingip ptr record - - Positional arguments - - floatingip_id - - - Floating IP ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack queue create - usage: openstack --os-auth-type token --os-identity-api-version 2 queue create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <queue_name> - -Create a queue. - - Positional arguments - - <queue_name> - - - Name of the queue - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack queue delete - usage: openstack --os-auth-type token --os-identity-api-version 2 queue delete [-h] <queue_name> - -Delete a queue. - - Positional arguments - - <queue_name> - - - Name of the queue - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack queue exists - usage: openstack --os-auth-type token --os-identity-api-version 2 queue exists [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <queue_name> - -Check queue existence. - - Positional arguments - - <queue_name> - - - Name of the queue - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack queue get metadata - usage: openstack --os-auth-type token --os-identity-api-version 2 queue get metadata [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <queue_name> - -Get queue metadata. - - Positional arguments - - <queue_name> - - - Name of the queue - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack queue list - usage: openstack --os-auth-type token --os-identity-api-version 2 queue list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--marker <queue_id>] [--limit <limit>] - -List available queues. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --marker <queue_id> - - - Queue's paging marker - - - - - --limit <limit> - - - Page size limit - - - - -
-
- openstack queue set metadata - usage: openstack --os-auth-type token --os-identity-api-version 2 queue set metadata [-h] <queue_name> <queue_metadata> - -Set queue metadata. - - Positional arguments - - <queue_name> - - - Name of the queue - - - - - <queue_metadata> - - - Queue metadata - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack queue stats - usage: openstack --os-auth-type token --os-identity-api-version 2 queue stats [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <queue_name> - -Get queue stats. - - Positional arguments - - <queue_name> - - - Name of the queue - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack quota set - usage: openstack --os-auth-type token --os-identity-api-version 2 quota set [-h] [--class] [--properties <properties>] - [--ram <ram>] [--secgroup-rules <secgroup-rules>] - [--instances <instances>] [--key-pairs <key-pairs>] - [--fixed-ips <fixed-ips>] [--secgroups <secgroups>] - [--injected-file-size <injected-file-size>] - [--floating-ips <floating-ips>] - [--injected-files <injected-files>] - [--cores <cores>] - [--injected-path-size <injected-path-size>] - [--gigabytes <gigabytes>] [--volumes <volumes>] - [--snapshots <snapshots>] - [--volume-type <volume-type>] - <project/class> - -Set quotas for project or class - - Positional arguments - - <project/class> - - - Set quotas for this project or class (name/ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --class - - - Set quotas for <class> - - - - - --properties <properties> - - - New value for the properties quota - - - - - --ram <ram> - - - New value for the ram quota - - - - - --secgroup-rules <secgroup-rules> - - - New value for the secgroup-rules quota - - - - - --instances <instances> - - - New value for the instances quota - - - - - --key-pairs <key-pairs> - - - New value for the key-pairs quota - - - - - --fixed-ips <fixed-ips> - - - New value for the fixed-ips quota - - - - - --secgroups <secgroups> - - - New value for the secgroups quota - - - - - --injected-file-size <injected-file-size> - - - New value for the injected-file-size quota - - - - - --floating-ips <floating-ips> - - - New value for the floating-ips quota - - - - - --injected-files <injected-files> - - - New value for the injected-files quota - - - - - --cores <cores> - - - New value for the cores quota - - - - - --injected-path-size <injected-path-size> - - - New value for the injected-path-size quota - - - - - --gigabytes <gigabytes> - - - New value for the gigabytes quota - - - - - --volumes <volumes> - - - New value for the volumes quota - - - - - --snapshots <snapshots> - - - New value for the snapshots quota - - - - - --volume-type <volume-type> - - - Set quotas for a specific <volume-type> - - - - -
-
- openstack quota show - usage: openstack --os-auth-type token --os-identity-api-version 2 quota show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--class | --default] - <project/class> - -Show quotas for project or class - - Positional arguments - - <project/class> - - - Show this project or class (name/ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --class - - - Show quotas for <class> - - - - - --default - - - Show default quotas for <project> - - - - -
-
- openstack recordset create - usage: openstack --os-auth-type token --os-identity-api-version 2 recordset create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] --records - RECORDS [RECORDS ...] --type TYPE - [--ttl TTL] [--description DESCRIPTION] - zone_id name - -Create new recordset - - Positional arguments - - zone_id - - - Zone ID - - - - - name - - - RecordSet Name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --records RECORDS [RECORDS ...] - - - RecordSet Records - - - - - --type TYPE - - - RecordSet Type - - - - - --ttl TTL - - - Time To Live (Seconds) - - - - - --description DESCRIPTION - - - Description - - - - -
-
- openstack recordset delete - usage: openstack --os-auth-type token --os-identity-api-version 2 recordset delete [-h] zone_id id - -Delete recordset - - Positional arguments - - zone_id - - - Zone ID - - - - - id - - - RecordSet ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack recordset list - usage: openstack --os-auth-type token --os-identity-api-version 2 recordset list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - zone_id - -List recordsets - - Positional arguments - - zone_id - - - Zone ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack recordset set - usage: openstack --os-auth-type token --os-identity-api-version 2 recordset set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] [--name NAME] - [--records RECORDS [RECORDS ...]] - [--description DESCRIPTION | --no-description] - [--ttl TTL | --no-ttl] - zone_id id - -Set recordset properties - - Positional arguments - - zone_id - - - Zone ID - - - - - id - - - RecordSet ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME - - - RecordSet Name - - - - - --records RECORDS [RECORDS ...] - - - Records - - - - - --description DESCRIPTION - - - Description - - - - - --no-description - - - - - - - --ttl TTL - - - TTL - - - - - --no-ttl - - - - - - -
-
- openstack recordset show - usage: openstack --os-auth-type token --os-identity-api-version 2 recordset show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - zone_id id - -Show recordset details - - Positional arguments - - zone_id - - - Zone ID - - - - - id - - - RecordSet ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack role add - usage: openstack --os-auth-type token --os-identity-api-version 2 role add [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] --project <project> --user <user> - <role> - -Add role to project:user - - Positional arguments - - <role> - - - Role to add to <project>:<user> (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Include <project> (name or ID) - - - - - --user <user> - - - Include <user> (name or ID) - - - - -
-
- openstack role create - usage: openstack --os-auth-type token --os-identity-api-version 2 role create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--or-show] - <name> - -Create new role - - Positional arguments - - <name> - - - New role name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --or-show - - - Return existing role - - - - -
-
- openstack role delete - usage: openstack --os-auth-type token --os-identity-api-version 2 role delete [-h] <role> [<role> ...] - -Delete role(s) - - Positional arguments - - <role> - - - Role(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack role list - usage: openstack --os-auth-type token --os-identity-api-version 2 role list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--project <project>] [--user <user>] - -List roles - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Filter roles by <project> (name or ID) - - - - - --user <user> - - - Filter roles by <user> (name or ID) - - - - -
-
- openstack role remove - usage: openstack --os-auth-type token --os-identity-api-version 2 role remove [-h] --project <project> --user <user> <role> - -Remove role from project : user - - Positional arguments - - <role> - - - Role to remove (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Include <project> (name or ID) - - - - - --user <user> - - - Include <user> (name or ID) - - - - -
-
- openstack role show - usage: openstack --os-auth-type token --os-identity-api-version 2 role show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <role> - -Display role details - - Positional arguments - - <role> - - - Role to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack security group create - usage: openstack --os-auth-type token --os-identity-api-version 2 security group create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--description <description>] - <name> - -Create a new security group - - Positional arguments - - <name> - - - New security group name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description <description> - - - Security group description - - - - -
-
- openstack security group delete - usage: openstack --os-auth-type token --os-identity-api-version 2 security group delete [-h] <group> - -Delete a security group - - Positional arguments - - <group> - - - Security group to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack security group list - usage: openstack --os-auth-type token --os-identity-api-version 2 security group list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--all-projects] - -List security groups - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --all-projects - - - Display information from all projects (admin only) - - - - -
-
- openstack security group rule create - usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--proto <proto>] - [--src-ip <ip-address>] - [--dst-port <port-range>] - <group> - -Create a new security group rule - - Positional arguments - - <group> - - - Create rule in this security group (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --proto <proto> - - - IP protocol (icmp, tcp, udp; default: tcp) - - - - - --src-ip <ip-address> - - - Source IP (may use CIDR notation; default: 0.0.0.0/0) - - - - - --dst-port <port-range> - - - Destination port, may be a range: 137:139 (default: 0; - only required for proto tcp and udp) - - - - -
-
- openstack security group rule delete - usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule delete [-h] <rule> - -Delete a security group rule - - Positional arguments - - <rule> - - - Security group rule to delete (ID only) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack security group rule list - usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - <group> - -List security group rules - - Positional arguments - - <group> - - - List all rules in this security group (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack security group set - usage: openstack --os-auth-type token --os-identity-api-version 2 security group set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--name <new-name>] - [--description <description>] - <group> - -Set security group properties - - Positional arguments - - <group> - - - Security group to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <new-name> - - - New security group name - - - - - --description <description> - - - New security group description - - - - -
-
- openstack security group show - usage: openstack --os-auth-type token --os-identity-api-version 2 security group show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <group> - -Display security group details - - Positional arguments - - <group> - - - Security group to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server add security group - usage: openstack --os-auth-type token --os-identity-api-version 2 server add security group [-h] <server> <group> - -Add security group to server - - Positional arguments - - <server> - - - Server (name or ID) - - - - - <group> - - - Security group to add (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server add volume - usage: openstack --os-auth-type token --os-identity-api-version 2 server add volume [-h] [--device <device>] <server> <volume> - -Add volume to server - - Positional arguments - - <server> - - - Server (name or ID) - - - - - <volume> - - - Volume to add (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --device <device> - - - Server internal device name for volume - - - - -
-
- openstack server create - usage: openstack --os-auth-type token --os-identity-api-version 2 server create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - (--image <image> | --volume <volume>) --flavor - <flavor> - [--security-group <security-group-name>] - [--key-name <key-name>] - [--property <key=value>] - [--file <dest-filename=source-filename>] - [--user-data <user-data>] - [--availability-zone <zone-name>] - [--block-device-mapping <dev-name=mapping>] - [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] - [--hint <key=value>] - [--config-drive <config-drive-volume>|True] - [--min <count>] [--max <count>] [--wait] - <server-name> - -Create a new server - - Positional arguments - - <server-name> - - - New server name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --image <image> - - - Create server from this image - - - - - --volume <volume> - - - Create server from this volume - - - - - --flavor <flavor> - - - Create server with this flavor - - - - - --security-group <security-group-name> - - - Security group to assign to this server (repeat for - multiple groups) - - - - - --key-name <key-name> - - - Keypair to inject into this server (optional - extension) - - - - - --property <key=value> - - - Set a property on this server (repeat for multiple - values) - - - - - --file <dest-filename=source-filename> - - - File to inject into image before boot (repeat for - multiple files) - - - - - --user-data <user-data> - - - User data file to serve from the metadata server - - - - - --availability-zone <zone-name> - - - Select an availability zone for the server - - - - - --block-device-mapping <dev-name=mapping> - - - Map block devices; map is - <id>:<type>:<size(GB)>:<delete_on_terminate> (optional - extension) - - - - - --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid> - - - Create a NIC on the server. Specify option multiple - times to create multiple NICs. Either net-id or port- - id must be provided, but not both. net-id: attach NIC - to network with this UUID, port-id: attach NIC to port - with this UUID, v4-fixed-ip: IPv4 fixed address for - NIC (optional), v6-fixed-ip: IPv6 fixed address for - NIC (optional). - - - - - --hint <key=value> - - - Hints for the scheduler (optional extension) - - - - - --config-drive <config-drive-volume>|True - - - Use specified volume as the config drive, or 'True' to - use an ephemeral drive - - - - - --min <count> - - - Minimum number of servers to launch (default=1) - - - - - --max <count> - - - Maximum number of servers to launch (default=1) - - - - - --wait - - - Wait for build to complete - - - - -
-
- openstack server delete - usage: openstack --os-auth-type token --os-identity-api-version 2 server delete [-h] [--wait] <server> [<server> ...] - -Delete server(s) - - Positional arguments - - <server> - - - Server(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --wait - - - Wait for delete to complete - - - - -
-
- openstack server image create - usage: openstack --os-auth-type token --os-identity-api-version 2 server image create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--name <image-name>] [--wait] - <server> - -Create a new disk image from a running server - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <image-name> - - - Name of new image (default is server name) - - - - - --wait - - - Wait for image create to complete - - - - -
-
- openstack server list - usage: openstack --os-auth-type token --os-identity-api-version 2 server list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--reservation-id <reservation-id>] - [--ip <ip-address-regex>] - [--ip6 <ip-address-regex>] [--name <name-regex>] - [--instance-name <server-name>] - [--status <status>] [--flavor <flavor>] - [--image <image>] [--host <hostname>] - [--all-projects] [--project <project>] - [--project-domain <project-domain>] - [--user <user>] [--user-domain <user-domain>] - [--long] [--marker <marker>] [--limit <limit>] - -List servers - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --reservation-id <reservation-id> - - - Only return instances that match the reservation - - - - - --ip <ip-address-regex> - - - Regular expression to match IP addresses - - - - - --ip6 <ip-address-regex> - - - Regular expression to match IPv6 addresses - - - - - --name <name-regex> - - - Regular expression to match names - - - - - --instance-name <server-name> - - - Regular expression to match instance name (admin only) - - - - - --status <status> - - - Search by server status - - - - - --flavor <flavor> - - - Search by flavor - - - - - --image <image> - - - Search by image - - - - - --host <hostname> - - - Search by hostname - - - - - --all-projects - - - Include all projects (admin only) - - - - - --project <project> - - - Search by project (admin only) (name or ID) - - - - - --project-domain <project-domain> - - - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - - - - - --user <user> - - - Search by user (admin only) (name or ID) - - - - - --user-domain <user-domain> - - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - - - - --long - - - List additional fields in output - - - - - --marker <marker> - - - The last server (name or ID) of the previous page. - Display list of servers after marker. Display all - servers if not specified. - - - - - --limit <limit> - - - Maximum number of servers to display. If limit equals - -1, all servers will be displayed. If limit is greater - than 'osapi_max_limit' option of Nova API, - 'osapi_max_limit' will be used instead. - - - - -
-
- openstack server lock - usage: openstack --os-auth-type token --os-identity-api-version 2 server lock [-h] <server> [<server> ...] - -Lock server(s). A non-admin user will not be able to execute actions - - Positional arguments - - <server> - - - Server(s) to lock (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server migrate - usage: openstack --os-auth-type token --os-identity-api-version 2 server migrate [-h] [--live <hostname>] - [--shared-migration | --block-migration] - [--disk-overcommit | --no-disk-overcommit] - [--wait] - <server> - -Migrate server to different host - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --live <hostname> - - - Target hostname - - - - - --shared-migration - - - Perform a shared live migration (default) - - - - - --block-migration - - - Perform a block live migration - - - - - --disk-overcommit - - - Allow disk over-commit on the destination host - - - - - --no-disk-overcommit - - - Do not over-commit disk on the destination host - (default) - - - - - --wait - - - Wait for resize to complete - - - - -
-
- openstack server pause - usage: openstack --os-auth-type token --os-identity-api-version 2 server pause [-h] <server> [<server> ...] - -Pause server(s) - - Positional arguments - - <server> - - - Server(s) to pause (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server reboot - usage: openstack --os-auth-type token --os-identity-api-version 2 server reboot [-h] [--hard | --soft] [--wait] <server> - -Perform a hard or soft server reboot - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --hard - - - Perform a hard reboot - - - - - --soft - - - Perform a soft reboot - - - - - --wait - - - Wait for reboot to complete - - - - -
-
- openstack server rebuild - usage: openstack --os-auth-type token --os-identity-api-version 2 server rebuild [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] --image <image> - [--password <password>] [--wait] - <server> - -Rebuild server - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --image <image> - - - Recreate server from this image - - - - - --password <password> - - - Set the password on the rebuilt instance - - - - - --wait - - - Wait for rebuild to complete - - - - -
-
- openstack server remove security group - usage: openstack --os-auth-type token --os-identity-api-version 2 server remove security group [-h] <server> <group> - -Remove security group from server - - Positional arguments - - <server> - - - Name or ID of server to use - - - - - <group> - - - Name or ID of security group to remove from server - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server remove volume - usage: openstack --os-auth-type token --os-identity-api-version 2 server remove volume [-h] <server> <volume> - -Remove volume from server - - Positional arguments - - <server> - - - Server (name or ID) - - - - - <volume> - - - Volume to remove (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server rescue - usage: openstack --os-auth-type token --os-identity-api-version 2 server rescue [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <server> - -Put server in rescue mode - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server resize - usage: openstack --os-auth-type token --os-identity-api-version 2 server resize [-h] [--flavor <flavor> | --confirm | --revert] - [--wait] - <server> - -Scale server to a new flavor - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --flavor <flavor> - - - Resize server to specified flavor - - - - - --confirm - - - Confirm server resize is complete - - - - - --revert - - - Restore server state before resize - - - - - --wait - - - Wait for resize to complete - - - - -
-
- openstack server resume - usage: openstack --os-auth-type token --os-identity-api-version 2 server resume [-h] <server> [<server> ...] - -Resume server(s) - - Positional arguments - - <server> - - - Server(s) to resume (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server set - usage: openstack --os-auth-type token --os-identity-api-version 2 server set [-h] [--name <new-name>] [--root-password] - [--property <key=value>] - <server> - -Set server properties - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <new-name> - - - New server name - - - - - --root-password - - - Set new root password (interactive only) - - - - - --property <key=value> - - - Property to add/change for this server (repeat option - to set multiple properties) - - - - -
-
- openstack server shelve - usage: openstack --os-auth-type token --os-identity-api-version 2 server shelve [-h] <server> [<server> ...] - -Shelve server(s) - - Positional arguments - - <server> - - - Server(s) to shelve (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server show - usage: openstack --os-auth-type token --os-identity-api-version 2 server show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--diagnostics] - <server> - -Show server details - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --diagnostics - - - Display server diagnostics information - - - - -
-
- openstack server ssh - usage: openstack --os-auth-type token --os-identity-api-version 2 server ssh [-h] [--login <login-name>] [--port <port>] - [--identity <keyfile>] [--option <config-options>] - [-4 | -6] - [--public | --private | --address-type <address-type>] - <server> - -Ssh to server - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --login <login-name> - - - Login name (ssh -l option) - - - - - --port <port> - - - Destination port (ssh -p option) - - - - - --identity <keyfile> - - - Private key file (ssh -i option) - - - - - --option <config-options> - - - Options in ssh_config(5) format (ssh -o option) - - - - - -4 - - - Use only IPv4 addresses - - - - - -6 - - - Use only IPv6 addresses - - - - - --public - - - Use public IP address - - - - - --private - - - Use private IP address - - - - - --address-type <address-type> - - - Use other IP address (public, private, etc) - - - - -
-
- openstack server start - usage: openstack --os-auth-type token --os-identity-api-version 2 server start [-h] <server> [<server> ...] - -Start server(s). - - Positional arguments - - <server> - - - Server(s) to start (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server stop - usage: openstack --os-auth-type token --os-identity-api-version 2 server stop [-h] <server> [<server> ...] - -Stop server(s). - - Positional arguments - - <server> - - - Server(s) to stop (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server suspend - usage: openstack --os-auth-type token --os-identity-api-version 2 server suspend [-h] <server> [<server> ...] - -Suspend server(s) - - Positional arguments - - <server> - - - Server(s) to suspend (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server unlock - usage: openstack --os-auth-type token --os-identity-api-version 2 server unlock [-h] <server> [<server> ...] - -Unlock server(s) - - Positional arguments - - <server> - - - Server(s) to unlock (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server unpause - usage: openstack --os-auth-type token --os-identity-api-version 2 server unpause [-h] <server> [<server> ...] - -Unpause server(s) - - Positional arguments - - <server> - - - Server(s) to unpause (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server unrescue - usage: openstack --os-auth-type token --os-identity-api-version 2 server unrescue [-h] <server> - -Restore server from rescue mode - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack server unset - usage: openstack --os-auth-type token --os-identity-api-version 2 server unset [-h] [--property <key>] <server> - -Unset server properties - - Positional arguments - - <server> - - - Server (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property key to remove from server (repeat to unset - multiple values) - - - - -
-
- openstack server unshelve - usage: openstack --os-auth-type token --os-identity-api-version 2 server unshelve [-h] <server> [<server> ...] - -Unshelve server(s) - - Positional arguments - - <server> - - - Server(s) to unshelve (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack service create - usage: openstack --os-auth-type token --os-identity-api-version 2 service create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] [--name <name>] - [--description <description>] - <type> - -Create new service - - Positional arguments - - <type> - - - New service type (compute, image, identity, volume, - etc) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - New service name - - - - - --description <description> - - - New service description - - - - -
-
- openstack service delete - usage: openstack --os-auth-type token --os-identity-api-version 2 service delete [-h] <service> - -Delete service - - Positional arguments - - <service> - - - Service to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack service list - usage: openstack --os-auth-type token --os-identity-api-version 2 service list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] [--long] - -List services - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack service show - usage: openstack --os-auth-type token --os-identity-api-version 2 service show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--catalog] - <service> - -Display service details - - Positional arguments - - <service> - - - Service to display (type, name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --catalog - - - Show service catalog information - - - - -
-
- openstack snapshot create - usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] --name <name> - [--description <description>] [--force] - <volume> - -Create new snapshot - - Positional arguments - - <volume> - - - Volume to snapshot (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - Name of the snapshot - - - - - --description <description> - - - Description of the snapshot - - - - - --force - - - Create a snapshot attached to an instance. Default is - False - - - - -
-
- openstack snapshot delete - usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot delete [-h] <snapshot> [<snapshot> ...] - -Delete snapshot(s) - - Positional arguments - - <snapshot> - - - Snapshot(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack snapshot list - usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--all-projects] [--long] - -List snapshots - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --all-projects - - - Include all projects (admin only) - - - - - --long - - - List additional fields in output - - - - -
-
- openstack snapshot set - usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot set [-h] [--name <name>] - [--description <description>] - [--property <key=value>] - <snapshot> - -Set snapshot properties - - Positional arguments - - <snapshot> - - - Snapshot to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - New snapshot name - - - - - --description <description> - - - New snapshot description - - - - - --property <key=value> - - - Property to add/change for this snapshot (repeat - option to set multiple properties) - - - - -
-
- openstack snapshot show - usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <snapshot> - -Display snapshot details - - Positional arguments - - <snapshot> - - - Snapshot to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack snapshot unset - usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot unset [-h] --property <key> <snapshot> - -Unset snapshot properties - - Positional arguments - - <snapshot> - - - Snapshot to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property to remove from snapshot (repeat to remove - multiple values) - - - - -
-
- openstack tld create - usage: openstack --os-auth-type token --os-identity-api-version 2 tld create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] --name NAME - [--description DESCRIPTION] - -Create new tld - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME - - - TLD Name - - - - - --description DESCRIPTION - - - Description - - - - -
-
- openstack tld delete - usage: openstack --os-auth-type token --os-identity-api-version 2 tld delete [-h] id - -Delete tld - - Positional arguments - - id - - - TLD ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack tld list - usage: openstack --os-auth-type token --os-identity-api-version 2 tld list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List tlds - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack tld set - usage: openstack --os-auth-type token --os-identity-api-version 2 tld set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--name NAME] - [--description DESCRIPTION | --no-description] - id - -Set tld properties - - Positional arguments - - id - - - TLD ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME - - - TLD Name - - - - - --description DESCRIPTION - - - Description - - - - - --no-description - - - - - - -
-
- openstack tld show - usage: openstack --os-auth-type token --os-identity-api-version 2 tld show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - id - -Show tld details - - Positional arguments - - id - - - TLD ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack token issue - usage: openstack --os-auth-type token --os-identity-api-version 2 token issue [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - -Issue new token - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack token revoke - usage: openstack --os-auth-type token --os-identity-api-version 2 token revoke [-h] <token> - -Revoke existing token - - Positional arguments - - <token> - - - Token to be deleted - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack usage list - usage: openstack --os-auth-type token --os-identity-api-version 2 usage list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--start <start>] [--end <end>] - -List resource usage per project - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --start <start> - - - Usage range start date, ex 2012-01-20 (default: 4 - weeks ago) - - - - - --end <end> - - - Usage range end date, ex 2012-01-20 (default: - tomorrow) - - - - -
-
- openstack usage show - usage: openstack --os-auth-type token --os-identity-api-version 2 usage show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--project <project>] - [--start <start>] [--end <end>] - -Show resource usage for a single project - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Name or ID of project to show usage for - - - - - --start <start> - - - Usage range start date, ex 2012-01-20 (default: 4 - weeks ago) - - - - - --end <end> - - - Usage range end date, ex 2012-01-20 (default: - tomorrow) - - - - -
-
- openstack user create - usage: openstack --os-auth-type token --os-identity-api-version 2 user create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--project <project>] - [--password <password>] [--password-prompt] - [--email <email-address>] [--enable | --disable] - [--or-show] - <name> - -Create new user - - Positional arguments - - <name> - - - New user name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Default project (name or ID) - - - - - --password <password> - - - Set user password - - - - - --password-prompt - - - Prompt interactively for password - - - - - --email <email-address> - - - Set user email address - - - - - --enable - - - Enable user (default) - - - - - --disable - - - Disable user - - - - - --or-show - - - Return existing user - - - - -
-
- openstack user delete - usage: openstack --os-auth-type token --os-identity-api-version 2 user delete [-h] <user> [<user> ...] - -Delete user(s) - - Positional arguments - - <user> - - - User(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack user list - usage: openstack --os-auth-type token --os-identity-api-version 2 user list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--project <project>] [--long] - -List users - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Filter users by project (name or ID) - - - - - --long - - - List additional fields in output - - - - -
-
- openstack user role list - usage: openstack --os-auth-type token --os-identity-api-version 2 user role list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--project <project>] - [<user>] - -List user-role assignments - - Positional arguments - - <user> - - - User to list (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Filter users by <project> (name or ID) - - - - -
-
- openstack user set - usage: openstack --os-auth-type token --os-identity-api-version 2 user set [-h] [--name <name>] [--project <project>] - [--password <user-password>] [--password-prompt] - [--email <email-address>] [--enable | --disable] - <user> - -Set user properties - - Positional arguments - - <user> - - - User to change (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - Set user name - - - - - --project <project> - - - Set default project (name or ID) - - - - - --password <user-password> - - - Set user password - - - - - --password-prompt - - - Prompt interactively for password - - - - - --email <email-address> - - - Set user email address - - - - - --enable - - - Enable user (default) - - - - - --disable - - - Disable user - - - - -
-
- openstack user show - usage: openstack --os-auth-type token --os-identity-api-version 2 user show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <user> - -Display user details - - Positional arguments - - <user> - - - User to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack volume create - usage: openstack --os-auth-type token --os-identity-api-version 2 volume create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] --size <size> - [--snapshot <snapshot>] - [--description <description>] - [--type <volume-type>] [--user <user>] - [--project <project>] - [--availability-zone <availability-zone>] - [--image <image>] [--source <volume>] - [--property <key=value>] - <name> - -Create new volume - - Positional arguments - - <name> - - - New volume name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --size <size> - - - New volume size in GB - - - - - --snapshot <snapshot> - - - Use <snapshot> as source of new volume - - - - - --description <description> - - - New volume description - - - - - --type <volume-type> - - - Use <volume-type> as the new volume type - - - - - --user <user> - - - Specify an alternate user (name or ID) - - - - - --project <project> - - - Specify an alternate project (name or ID) - - - - - --availability-zone <availability-zone> - - - Create new volume in <availability-zone> - - - - - --image <image> - - - Use <image> as source of new volume (name or ID) - - - - - --source <volume> - - - Volume to clone (name or ID) - - - - - --property <key=value> - - - Set a property on this volume (repeat option to set - multiple properties) - - - - -
-
- openstack volume delete - usage: openstack --os-auth-type token --os-identity-api-version 2 volume delete [-h] [--force] <volume> [<volume> ...] - -Delete volume(s) - - Positional arguments - - <volume> - - - Volume(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --force - - - Attempt forced removal of volume(s), regardless of state - (defaults to False) - - - - -
-
- openstack volume list - usage: openstack --os-auth-type token --os-identity-api-version 2 volume list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--name <name>] [--status <status>] - [--all-projects] [--long] - -List volumes - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - Filter results by volume name - - - - - --status <status> - - - Filter results by status - - - - - --all-projects - - - Include all projects (admin only) - - - - - --long - - - List additional fields in output - - - - -
-
- openstack volume qos associate - usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos associate [-h] <qos-spec> <volume-type> - -Associate a QoS specification to a volume type - - Positional arguments - - <qos-spec> - - - QoS specification to modify (name or ID) - - - - - <volume-type> - - - Volume type to associate the QoS (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack volume qos create - usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--consumer <consumer>] - [--property <key=value>] - <name> - -Create new QoS specification - - Positional arguments - - <name> - - - New QoS specification name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --consumer <consumer> - - - Consumer of the QoS. Valid consumers: back-end, both, - front-end (defaults to 'both') - - - - - --property <key=value> - - - Set a QoS specification property (repeat option to set - multiple properties) - - - - -
-
- openstack volume qos delete - usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos delete [-h] <qos-spec> [<qos-spec> ...] - -Delete QoS specification - - Positional arguments - - <qos-spec> - - - QoS specification(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack volume qos disassociate - usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos disassociate [-h] - [--volume-type <volume-type> | --all] - <qos-spec> - -Disassociate a QoS specification from a volume type - - Positional arguments - - <qos-spec> - - - QoS specification to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --volume-type <volume-type> - - - Volume type to disassociate the QoS from (name or ID) - - - - - --all - - - Disassociate the QoS from every volume type - - - - -
-
- openstack volume qos list - usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List QoS specifications - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack volume qos set - usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos set [-h] [--property <key=value>] <qos-spec> - -Set QoS specification properties - - Positional arguments - - <qos-spec> - - - QoS specification to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key=value> - - - Property to add or modify for this QoS specification - (repeat option to set multiple properties) - - - - -
-
- openstack volume qos show - usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <qos-spec> - -Display QoS specification details - - Positional arguments - - <qos-spec> - - - QoS specification to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack volume qos unset - usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos unset [-h] [--property <key>] <qos-spec> - -Unset QoS specification properties - - Positional arguments - - <qos-spec> - - - QoS specification to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property to remove from the QoS specification. (repeat - option to unset multiple properties) - - - - -
-
- openstack volume set - usage: openstack --os-auth-type token --os-identity-api-version 2 volume set [-h] [--name <name>] [--description <description>] - [--size <size>] [--property <key=value>] - <volume> - -Set volume properties - - Positional arguments - - <volume> - - - Volume to change (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - New volume name - - - - - --description <description> - - - New volume description - - - - - --size <size> - - - Extend volume size in GB - - - - - --property <key=value> - - - Property to add or modify for this volume (repeat - option to set multiple properties) - - - - -
-
- openstack volume show - usage: openstack --os-auth-type token --os-identity-api-version 2 volume show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <volume> - -Show volume details - - Positional arguments - - <volume> - - - Volume to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack volume type create - usage: openstack --os-auth-type token --os-identity-api-version 2 volume type create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--property <key=value>] - <name> - -Create new volume type - - Positional arguments - - <name> - - - New volume type name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key=value> - - - Property to add for this volume type (repeat option to - set multiple properties) - - - - -
-
- openstack volume type delete - usage: openstack --os-auth-type token --os-identity-api-version 2 volume type delete [-h] <volume-type> - -Delete volume type - - Positional arguments - - <volume-type> - - - Volume type to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack volume type list - usage: openstack --os-auth-type token --os-identity-api-version 2 volume type list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - -List volume types - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack volume type set - usage: openstack --os-auth-type token --os-identity-api-version 2 volume type set [-h] [--property <key=value>] <volume-type> - -Set volume type properties - - Positional arguments - - <volume-type> - - - Volume type to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key=value> - - - Property to add or modify for this volume type (repeat - option to set multiple properties) - - - - -
-
- openstack volume type show - usage: openstack --os-auth-type token --os-identity-api-version 2 volume type show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <volume-type> - -Display volume type details - - Positional arguments - - <volume-type> - - - Volume type to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack volume type unset - usage: openstack --os-auth-type token --os-identity-api-version 2 volume type unset [-h] --property <key> <volume-type> - -Unset volume type properties - - Positional arguments - - <volume-type> - - - Volume type to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property to remove from volume type (repeat option to - remove multiple properties) - - - - -
-
- openstack volume unset - usage: openstack --os-auth-type token --os-identity-api-version 2 volume unset [-h] --property <key> <volume> - -Unset volume properties - - Positional arguments - - <volume> - - - Volume to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --property <key> - - - Property to remove from volume (repeat option to remove - multiple properties) - - - - -
-
- openstack zone abandon - usage: openstack --os-auth-type token --os-identity-api-version 2 zone abandon [-h] id - -Abandon a zone - - Positional arguments - - id - - - Zone ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone axfr - usage: openstack --os-auth-type token --os-identity-api-version 2 zone axfr [-h] id - -AXFR a zone - - Positional arguments - - id - - - Zone ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone blacklist create - usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --pattern PATTERN - [--description DESCRIPTION] - -Create new blacklist - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --pattern PATTERN - - - Blacklist pattern - - - - - --description DESCRIPTION - - - Description - - - - -
-
- openstack zone blacklist delete - usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist delete [-h] id - -Delete blacklist - - Positional arguments - - id - - - Blacklist ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone blacklist list - usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List blacklists - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone blacklist set - usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] --pattern - PATTERN - [--description DESCRIPTION | --no-description] - id - -Set blacklist properties - - Positional arguments - - id - - - Blacklist ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --pattern PATTERN - - - Blacklist pattern - - - - - --description DESCRIPTION - - - Description - - - - - --no-description - - - - - - -
-
- openstack zone blacklist show - usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - id - -Show blacklist details - - Positional arguments - - id - - - Blacklist ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone create - usage: openstack --os-auth-type token --os-identity-api-version 2 zone create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--email EMAIL] [--type TYPE] - [--ttl TTL] [--description DESCRIPTION] - [--masters MASTERS [MASTERS ...]] - name - -Create new zone - - Positional arguments - - name - - - Zone Name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --email EMAIL - - - Zone Email - - - - - --type TYPE - - - Zone Type - - - - - --ttl TTL - - - Time To Live (Seconds) - - - - - --description DESCRIPTION - - - Description - - - - - --masters MASTERS [MASTERS ...] - - - Zone Masters - - - - -
-
- openstack zone delete - usage: openstack --os-auth-type token --os-identity-api-version 2 zone delete [-h] id - -Delete zone - - Positional arguments - - id - - - Zone ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone list - usage: openstack --os-auth-type token --os-identity-api-version 2 zone list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--type TYPE] - -List zones - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type TYPE - - - Zone Type - - - - -
-
- openstack zone set - usage: openstack --os-auth-type token --os-identity-api-version 2 zone set [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--name NAME] [--email EMAIL] - [--ttl TTL] - [--description DESCRIPTION | --no-description] - [--masters MASTERS [MASTERS ...]] - id - -Set zone properties - - Positional arguments - - id - - - Zone ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name NAME - - - Zone Name - - - - - --email EMAIL - - - Zone Email - - - - - --ttl TTL - - - Time To Live (Seconds) - - - - - --description DESCRIPTION - - - Description - - - - - --no-description - - - - - - - --masters MASTERS [MASTERS ...] - - - Zone Masters - - - - -
-
- openstack zone show - usage: openstack --os-auth-type token --os-identity-api-version 2 zone show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - id - -Show zone details - - Positional arguments - - id - - - Zone ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone transfer accept request - usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer accept request [-h] --transfer-id TRANSFER_ID - --key KEY - -Accept a Zone Transfer Request - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --transfer-id TRANSFER_ID - - - Transfer ID - - - - - --key KEY - - - Transfer Key - - - - -
-
- openstack zone transfer accept show - usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer accept show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - id - -Show Zone Transfer Accept - - Positional arguments - - id - - - Zone Tranfer Accept ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone transfer request create - usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --target-project-id - TARGET_PROJECT_ID - [--description DESCRIPTION] - zone_id - -Create new zone transfer request - - Positional arguments - - zone_id - - - Zone ID to transfer. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --target-project-id TARGET_PROJECT_ID - - - Target Project ID to transfer to. - - - - - --description DESCRIPTION - - - Description - - - - -
-
- openstack zone transfer request delete - usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request delete [-h] id - - - Positional arguments - - id - - - Zone Transfer ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone transfer request list - usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List zone transfer requests - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack zone transfer request set - usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request set [-h] - [--description DESCRIPTION | --no-description] - id - -Set Transfer - - Positional arguments - - id - - - Zone Transfer ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description DESCRIPTION - - - Description - - - - - --no-description - - - - - - -
-
- openstack zone transfer request show - usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - id - -Show zonet transfer details - - Positional arguments - - id - - - Zone Tranfer ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
- -
- -
- OpenStack with Identity API v3 commands (diff) - - You can select the Identity API version to use by adding the - --os-identity-api-version parameter or by setting - the corresponding environment variable: -$ export OS_IDENTITY_API_VERSION=3 - - -This section documents only the difference in subcommands available for the openstack client when the identity API version is changed from v2 to v3. - -
- openstack access token create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 access token create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --consumer-key <consumer-key> - --consumer-secret <consumer-secret> - --request-key <request-key> - --request-secret <request-secret> - --verifier <verifier> - -Create an access token - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --consumer-key <consumer-key> - - - Consumer key (required) - - - - - --consumer-secret <consumer-secret> - - - Consumer secret (required) - - - - - --request-key <request-key> - - - Request token to exchange for access token (required) - - - - - --request-secret <request-secret> - - - Secret associated with <request-key> (required) - - - - - --verifier <verifier> - - - Verifier associated with <request-key> (required) - - - - -
-
- openstack consumer create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 consumer create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--description <description>] - -Create new consumer - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description <description> - - - New consumer description - - - - -
-
- openstack consumer delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 consumer delete [-h] <consumer> - -Delete consumer - - Positional arguments - - <consumer> - - - Consumer to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack consumer list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 consumer list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List consumers - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack consumer set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 consumer set [-h] [--description <description>] <consumer> - -Set consumer properties - - Positional arguments - - <consumer> - - - Consumer to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description <description> - - - New consumer description - - - - -
-
- openstack consumer show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 consumer show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <consumer> - -Display consumer details - - Positional arguments - - <consumer> - - - Consumer to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack credential create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 credential create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--type <type>] [--project <project>] - <user> <data> - -Create credential command - - Positional arguments - - <user> - - - Name or ID of user that owns the credential - - - - - <data> - - - New credential data - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type <type> - - - New credential type - - - - - --project <project> - - - Project name or ID which limits the scope of the - credential - - - - -
-
- openstack credential delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 credential delete [-h] <credential-id> - -Delete credential command - - Positional arguments - - <credential-id> - - - ID of credential to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack credential list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 credential list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List credential command - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack credential set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 credential set [-h] --user <user> --type <type> --data <data> - [--project <project>] - <credential-id> - -Set credential command - - Positional arguments - - <credential-id> - - - ID of credential to change - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --user <user> - - - Name or ID of user that owns the credential - - - - - --type <type> - - - New credential type - - - - - --data <data> - - - New credential data - - - - - --project <project> - - - Project name or ID which limits the scope of the - credential - - - - -
-
- openstack credential show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 credential show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <credential-id> - -Show credential command - - Positional arguments - - <credential-id> - - - ID of credential to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack domain create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 domain create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--description <description>] - [--enable | --disable] [--or-show] - <domain-name> - -Create new domain - - Positional arguments - - <domain-name> - - - New domain name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description <description> - - - New domain description - - - - - --enable - - - Enable domain (default) - - - - - --disable - - - Disable domain - - - - - --or-show - - - Return existing domain - - - - -
-
- openstack domain delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 domain delete [-h] <domain> - -Delete domain - - Positional arguments - - <domain> - - - Domain to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack domain list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 domain list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List domains - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack domain set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 domain set [-h] [--name <name>] [--description <description>] - [--enable | --disable] - <domain> - -Set domain properties - - Positional arguments - - <domain> - - - Domain to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - New domain name - - - - - --description <description> - - - New domain description - - - - - --enable - - - Enable domain - - - - - --disable - - - Disable domain - - - - -
-
- openstack domain show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 domain show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <domain> - -Display domain details - - Positional arguments - - <domain> - - - Domain to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack endpoint set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 endpoint set [-h] [--region <region-id>] - [--interface <interface>] [--url <url>] - [--service <service>] [--enable | --disable] - <endpoint-id> - -Set endpoint properties - - Positional arguments - - <endpoint-id> - - - Endpoint ID to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --region <region-id> - - - New endpoint region ID - - - - - --interface <interface> - - - New endpoint interface type (admin, public or - internal) - - - - - --url <url> - - - New endpoint URL - - - - - --service <service> - - - New endpoint service (name or ID) - - - - - --enable - - - Enable endpoint - - - - - --disable - - - Disable endpoint - - - - -
-
- openstack federation domain list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 federation domain list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List accessible domains - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack federation project list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 federation project list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List accessible projects - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack federation protocol create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] - [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --identity-provider - <identity-provider> --mapping - <mapping> - <name> - -Create new federation protocol - - Positional arguments - - <name> - - - New federation protocol name (must be unique per - identity provider) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --identity-provider <identity-provider> - - - Identity provider that will support the new federation - protocol (name or ID) (required) - - - - - --mapping <mapping> - - - Mapping that is to be used (name or ID) (required) - - - - -
-
- openstack federation protocol delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol delete [-h] --identity-provider - <identity-provider> - <federation-protocol> - -Delete federation protocol - - Positional arguments - - <federation-protocol> - - - Federation protocol to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --identity-provider <identity-provider> - - - Identity provider that supports <federation-protocol> - (name or ID) (required) - - - - -
-
- openstack federation protocol list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - --identity-provider - <identity-provider> - -List federation protocols - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --identity-provider <identity-provider> - - - Identity provider to list (name or ID) (required) - - - - -
-
- openstack federation protocol set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol set [-h] --identity-provider - <identity-provider> - [--mapping <mapping>] - <name> - -Set federation protocol properties - - Positional arguments - - <name> - - - Federation protocol to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --identity-provider <identity-provider> - - - Identity provider that supports <federation-protocol> - (name or ID) (required) - - - - - --mapping <mapping> - - - Mapping that is to be used (name or ID) - - - - -
-
- openstack federation protocol show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --identity-provider - <identity-provider> - <federation-protocol> - -Display federation protocol details - - Positional arguments - - <federation-protocol> - - - Federation protocol to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --identity-provider <identity-provider> - - - Identity provider that supports <federation-protocol> - (name or ID) (required) - - - - -
-
- openstack group add user (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 group add user [-h] [--group-domain <group-domain>] - [--user-domain <user-domain>] - <group> <user> - -Add user to group - - Positional arguments - - <group> - - - Group to contain <user> (name or ID) - - - - - <user> - - - User to add to <group> (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --group-domain <group-domain> - - - Domain the group belongs to (name or ID). This can be - used in case collisions between group names exist. - - - - - --user-domain <user-domain> - - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - - - -
-
- openstack group contains user (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 group contains user [-h] [--group-domain <group-domain>] - [--user-domain <user-domain>] - <group> <user> - -Check user membership in group - - Positional arguments - - <group> - - - Group to check (name or ID) - - - - - <user> - - - User to check (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --group-domain <group-domain> - - - Domain the group belongs to (name or ID). This can be - used in case collisions between group names exist. - - - - - --user-domain <user-domain> - - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - - - -
-
- openstack group create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 group create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--domain <domain>] - [--description <description>] [--or-show] - <group-name> - -Create new group - - Positional arguments - - <group-name> - - - New group name - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --domain <domain> - - - Domain to contain new group (name or ID) - - - - - --description <description> - - - New group description - - - - - --or-show - - - Return existing group - - - - -
-
- openstack group delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 group delete [-h] [--domain <domain>] <group> [<group> ...] - -Delete group(s) - - Positional arguments - - <group> - - - Group(s) to delete (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --domain <domain> - - - Domain containing group(s) (name or ID) - - - - -
-
- openstack group list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 group list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--domain <domain>] [--user <user>] - [--user-domain <user-domain>] [--long] - -List groups - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --domain <domain> - - - Filter group list by <domain> (name or ID) - - - - - --user <user> - - - Filter group list by <user> (name or ID) - - - - - --user-domain <user-domain> - - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - - - - --long - - - List additional fields in output - - - - -
-
- openstack group remove user (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 group remove user [-h] [--group-domain <group-domain>] - [--user-domain <user-domain>] - <group> <user> - -Remove user from group - - Positional arguments - - <group> - - - Group containing <user> (name or ID) - - - - - <user> - - - User to remove from <group> (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --group-domain <group-domain> - - - Domain the group belongs to (name or ID). This can be - used in case collisions between group names exist. - - - - - --user-domain <user-domain> - - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - - - -
-
- openstack group set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 group set [-h] [--domain <domain>] [--name <name>] - [--description <description>] - <group> - -Set group properties - - Positional arguments - - <group> - - - Group to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --domain <domain> - - - Domain containing <group> (name or ID) - - - - - --name <name> - - - New group name - - - - - --description <description> - - - New group description - - - - -
-
- openstack group show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 group show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] [--domain <domain>] - <group> - -Display group details - - Positional arguments - - <group> - - - Group to display (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --domain <domain> - - - Domain containing <group> (name or ID) - - - - -
-
- openstack identity provider create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--remote-id <remote-id> | --remote-id-file <file-name>] - [--description <description>] - [--enable | --disable] - <name> - -Create new identity provider - - Positional arguments - - <name> - - - New identity provider name (must be unique) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --remote-id <remote-id> - - - Remote IDs to associate with the Identity Provider - (repeat to provide multiple values) - - - - - --remote-id-file <file-name> - - - Name of a file that contains many remote IDs to - associate with the identity provider, one per line - - - - - --description <description> - - - New identity provider description - - - - - --enable - - - Enable identity provider (default) - - - - - --disable - - - Disable the identity provider - - - - -
-
- openstack identity provider delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider delete [-h] <identity-provider> - -Delete identity provider - - Positional arguments - - <identity-provider> - - - Identity provider to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack identity provider list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List identity providers - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack identity provider set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider set [-h] [--description <description>] - [--remote-id <remote-id> | --remote-id-file <file-name>] - [--enable | --disable] - <identity-provider> - -Set identity provider properties - - Positional arguments - - <identity-provider> - - - Identity provider to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --description <description> - - - Set identity provider description - - - - - --remote-id <remote-id> - - - Remote IDs to associate with the Identity Provider - (repeat to provide multiple values) - - - - - --remote-id-file <file-name> - - - Name of a file that contains many remote IDs to - associate with the identity provider, one per line - - - - - --enable - - - Enable the identity provider - - - - - --disable - - - Disable the identity provider - - - - -
-
- openstack identity provider show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <identity-provider> - -Display identity provider details - - Positional arguments - - <identity-provider> - - - Identity provider to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack mapping create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 mapping create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] --rules - <filename> - <name> - -Create new mapping - - Positional arguments - - <name> - - - New mapping name (must be unique) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --rules <filename> - - - Filename that contains a set of mapping rules - (required) - - - - -
-
- openstack mapping delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 mapping delete [-h] <mapping> - -Delete mapping - - Positional arguments - - <mapping> - - - Mapping to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack mapping list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 mapping list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List mappings - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack mapping set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 mapping set [-h] [--rules <filename>] <name> - -Set mapping properties - - Positional arguments - - <name> - - - Mapping to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --rules <filename> - - - Filename that contains a new set of mapping rules - - - - -
-
- openstack mapping show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 mapping show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <mapping> - -Display mapping details - - Positional arguments - - <mapping> - - - Mapping to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack policy create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 policy create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] [--type <type>] - <filename> - -Create new policy - - Positional arguments - - <filename> - - - New serialized policy rules file - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type <type> - - - New MIME type of the policy rules file (defaults to - application/json) - - - - -
-
- openstack policy delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 policy delete [-h] <policy> - -Delete policy - - Positional arguments - - <policy> - - - Policy to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack policy list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 policy list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] [--long] - -List policies - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --long - - - List additional fields in output - - - - -
-
- openstack policy set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 policy set [-h] [--type <type>] [--rules <filename>] <policy> - -Set policy properties - - Positional arguments - - <policy> - - - Policy to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type <type> - - - New MIME type of the policy rules file - - - - - --rules <filename> - - - New serialized policy rules file - - - - -
-
- openstack policy show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 policy show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <policy> - -Display policy details - - Positional arguments - - <policy> - - - Policy to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack region create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 region create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - [--parent-region <region-id>] - [--description <description>] - <region-id> - -Create new region - - Positional arguments - - <region-id> - - - New region ID - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --parent-region <region-id> - - - Parent region ID - - - - - --description <description> - - - New region description - - - - -
-
- openstack region delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 region delete [-h] <region-id> - -Delete region - - Positional arguments - - <region-id> - - - Region ID to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack region list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 region list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--parent-region <region-id>] - -List regions - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --parent-region <region-id> - - - Filter by parent region ID - - - - -
-
- openstack region set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 region set [-h] [--parent-region <region-id>] - [--description <description>] - <region-id> - -Set region properties - - Positional arguments - - <region-id> - - - Region to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --parent-region <region-id> - - - New parent region ID - - - - - --description <description> - - - New region description - - - - -
-
- openstack region show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 region show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <region-id> - -Display region details - - Positional arguments - - <region-id> - - - Region to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack request token authorize (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 request token authorize [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --request-key <request-key> --role - <role> - -Authorize a request token - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --request-key <request-key> - - - Request token to authorize (ID only) (required) - - - - - --role <role> - - - Roles to authorize (name or ID) (repeat to set - multiple values) (required) - - - - -
-
- openstack request token create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 request token create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --consumer-key <consumer-key> - --consumer-secret <consumer-secret> - --project <project> [--domain <domain>] - -Create a request token - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --consumer-key <consumer-key> - - - Consumer key (required) - - - - - --consumer-secret <consumer-secret> - - - Consumer secret (required) - - - - - --project <project> - - - Project that consumer wants to access (name or ID) - (required) - - - - - --domain <domain> - - - Domain owning <project> (name or ID) - - - - -
-
- openstack role assignment list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 role assignment list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--effective] [--role <role>] - [--user <user>] - [--user-domain <user-domain>] - [--group <group>] - [--group-domain <group-domain>] - [--domain <domain> | --project <project>] - [--project-domain <project-domain>] - [--inherited] - -List role assignments - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --effective - - - Returns only effective role assignments - - - - - --role <role> - - - Role to filter (name or ID) - - - - - --user <user> - - - User to filter (name or ID) - - - - - --user-domain <user-domain> - - - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - - - - - --group <group> - - - Group to filter (name or ID) - - - - - --group-domain <group-domain> - - - Domain the group belongs to (name or ID). This can be - used in case collisions between group names exist. - - - - - --domain <domain> - - - Domain to filter (name or ID) - - - - - --project <project> - - - Project to filter (name or ID) - - - - - --project-domain <project-domain> - - - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - - - - - --inherited - - - Specifies if the role grant is inheritable to the sub - projects - - - - -
-
- openstack role set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 role set [-h] [--name <name>] <role> - -Set role properties - - Positional arguments - - <role> - - - Role to modify (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --name <name> - - - Set role name - - - - -
-
- openstack service provider create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 service provider create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - --auth-url <auth-url> - [--description <description>] - --service-provider-url <sp-url> - [--enable | --disable] - <name> - -Create new service provider - - Positional arguments - - <name> - - - New service provider name (must be unique) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --auth-url <auth-url> - - - Authentication URL of remote federated service - provider (required) - - - - - --description <description> - - - New service provider description - - - - - --service-provider-url <sp-url> - - - A service URL where SAML assertions are being sent - (required) - - - - - --enable - - - Enable the service provider (default) - - - - - --disable - - - Disable the service provider - - - - -
-
- openstack service provider delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 service provider delete [-h] <service-provider> - -Delete service provider - - Positional arguments - - <service-provider> - - - Service provider to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack service provider list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 service provider list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List service providers - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack service provider set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 service provider set [-h] [--auth-url <auth-url>] - [--description <description>] - [--service-provider-url <sp-url>] - [--enable | --disable] - <service-provider> - -Set service provider properties - - Positional arguments - - <service-provider> - - - Service provider to modify - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --auth-url <auth-url> - - - New Authentication URL of remote federated service - provider - - - - - --description <description> - - - New service provider description - - - - - --service-provider-url <sp-url> - - - New service provider URL, where SAML assertions are - sent - - - - - --enable - - - Enable the service provider - - - - - --disable - - - Disable the service provider - - - - -
-
- openstack service provider show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 service provider show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] - [--noindent] [--prefix PREFIX] - <service-provider> - -Display service provider details - - Positional arguments - - <service-provider> - - - Service provider to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack service set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 service set [-h] [--type <type>] [--name <service-name>] - [--description <description>] - [--enable | --disable] - <service> - -Set service properties - - Positional arguments - - <service> - - - Service to update (type, name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --type <type> - - - New service type (compute, image, identity, volume, - etc) - - - - - --name <service-name> - - - New service name - - - - - --description <description> - - - New service description - - - - - --enable - - - Enable service - - - - - --disable - - - Disable service - - - - -
-
- openstack trust create (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 trust create [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] --project <project> --role - <role> [--impersonate] - [--expiration <expiration>] - [--project-domain <project-domain>] - [--trustor-domain <trustor-domain>] - [--trustee-domain <trustee-domain>] - <trustor-user> <trustee-user> - -Create new trust - - Positional arguments - - <trustor-user> - - - User that is delegating authorization (name or ID) - - - - - <trustee-user> - - - User that is assuming authorization (name or ID) - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --project <project> - - - Project being delegated (name or ID) (required) - - - - - --role <role> - - - Roles to authorize (name or ID) (repeat to set - multiple values) (required) - - - - - --impersonate - - - Tokens generated from the trust will represent - <trustor> (defaults to False) - - - - - --expiration <expiration> - - - Sets an expiration date for the trust (format of YYYY- - mm-ddTHH:MM:SS) - - - - - --project-domain <project-domain> - - - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - - - - - --trustor-domain <trustor-domain> - - - Domain that contains <trustor> (name or ID) - - - - - --trustee-domain <trustee-domain> - - - Domain that contains <trustee> (name or ID) - - - - -
-
- openstack trust delete (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 trust delete [-h] <trust> [<trust> ...] - -Delete trust(s) - - Positional arguments - - <trust> - - - Trust(s) to delete - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack trust list (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 trust list [-h] - [-f {csv,html,json,json,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List trusts - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack trust show (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 trust show [-h] - [-f {html,json,json,shell,table,value,yaml,yaml}] - [-c COLUMN] [--max-width <integer>] [--noindent] - [--prefix PREFIX] - <trust> - -Display trust details - - Positional arguments - - <trust> - - - Trust to display - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- openstack user password set (Identity API v3) - usage: openstack --os-auth-type token --os-identity-api-version 3 user password set [-h] [--password <new-password>] - -Change current user password - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --password <new-password> - - - New user password - - - - -
-
- diff --git a/doc/cli-reference/generated/ch_cli_sahara_commands.xml b/doc/cli-reference/generated/ch_cli_sahara_commands.xml deleted file mode 100644 index f29bdd0fd1..0000000000 --- a/doc/cli-reference/generated/ch_cli_sahara_commands.xml +++ /dev/null @@ -1,1844 +0,0 @@ - - - - - - - - Data processing command-line client - - The sahara client is the command-line - interface (CLI) for the Data processing API and its extensions. - - This chapter documents sahara version - 0.11.1. - - - For help on a specific sahara - command, enter: - - $ sahara COMMAND - -
- sahara usage - usage: sahara [--version] [--debug] [--os-cache] [--region-name <region-name>] - [--service-type <service-type>] - [--endpoint-type <endpoint-type>] - [--sahara-api-version <sahara-api-ver>] - [--bypass-url <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 <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] - [--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-user-name OS_USERNAME] - [--os-user-domain-id OS_USER_DOMAIN_ID] - [--os-user-domain-name OS_USER_DOMAIN_NAME] - [--os-password OS_PASSWORD] - <subcommand> ... - - 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 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 <region-name> - - - Defaults to env[OS_REGION_NAME]. - - - - - --service-type <service-type> - - - Defaults to data-processing for all actions. - - - - - --endpoint-type <endpoint-type> - - - Defaults to env[SAHARA_ENDPOINT_TYPE] or - env[OS_ENDPOINT_TYPE] or publicURL. - - - - - --sahara-api-version <sahara-api-ver> - - - Accepts "api", defaults to env[SAHARA_API_VERSION]. - - - - - --bypass-url <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 <ca-certificate> - - - Specify a CA bundle file to use in verifying a TLS - (https) server certificate. Defaults to - env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - 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-user-name OS_USERNAME, --os-username 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 - 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 - usage: sahara cluster-delete [--name NAME] [--id <cluster_id>] - -Delete a cluster. - - Optional arguments - - --name NAME - - - Name of the cluster. - - - - - --id <cluster_id> - - - ID of the cluster to delete. - - - - -
-
- sahara cluster-list - usage: sahara cluster-list - -Print a list of available clusters. - -
-
- sahara cluster-scale - usage: sahara cluster-scale [--name NAME] [--id <cluster_id>] [--json JSON] - -Scale a cluster. - - Optional arguments - - --name NAME - - - Name of the cluster. - - - - - --id <cluster_id> - - - ID of the cluster. - - - - - --json JSON - - - JSON representation of cluster scale. - - - - -
-
- sahara cluster-show - usage: sahara cluster-show [--name NAME] [--id <cluster_id>] - [--show-progress SHOW_PROGRESS] [--json] - -Show details of a cluster. - - Optional arguments - - --name NAME - - - Name of the cluster. - - - - - --id <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 - usage: sahara cluster-template-create [--json JSON] - -Create a cluster template. - - Optional arguments - - --json JSON - - - JSON representation of cluster template. - - - - -
-
- sahara cluster-template-delete - usage: sahara cluster-template-delete [--name NAME] [--id <template_id>] - -Delete a cluster template. - - Optional arguments - - --name NAME - - - Name of the cluster template. - - - - - --id <template_id> - - - ID of the cluster template to delete. - - - - -
-
- sahara cluster-template-list - usage: sahara cluster-template-list - -Print a list of available cluster templates. - -
-
- sahara cluster-template-show - usage: sahara cluster-template-show [--name NAME] [--id <template_id>] - [--json] - -Show details of a cluster template. - - Optional arguments - - --name NAME - - - Name of the cluster template. - - - - - --id <template_id> - - - ID of the cluster template to show. - - - - - --json - - - Print JSON representation of cluster template. - - - - -
-
- sahara cluster-template-update - usage: sahara cluster-template-update [--name NAME] [--id <template_id>] - [--json JSON] - -Update a cluster template. - - Optional arguments - - --name NAME - - - Name of the cluster template to update. - - - - - --id <template_id> - - - ID of the cluster template to update. - - - - - --json JSON - - - JSON representation of cluster template update. - - - - -
-
- sahara data-source-create - 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 - 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 - usage: sahara data-source-list - -Print a list of available data sources. - -
-
- sahara data-source-show - 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 - 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 - usage: sahara image-add-tag [--name NAME] [--id <image_id>] --tag <tag> - -Add a tag to an image. - - Optional arguments - - --name NAME - - - Name of the image. - - - - - --id <image_id> - - - ID of image to tag. - - - - - --tag <tag> - - - Tag to add. - - - - -
-
- sahara image-list - usage: sahara image-list - -Print a list of available images. - -
-
- sahara image-register - usage: sahara image-register --id <image_id> [--username <name>] - [--description <desc>] - -Register an image from the Image index. - - Optional arguments - - --id <image_id> - - - ID of image, run "glance image-list" to see all IDs. - - - - - --username <name> - - - Username of privileged user in the image. - - - - - --description <desc> - - - Description of the image. - - - - -
-
- sahara image-remove-tag - usage: sahara image-remove-tag [--name NAME] [--id <image_id>] --tag <tag> - -Remove a tag from an image. - - Optional arguments - - --name NAME - - - Name of the image. - - - - - --id <image_id> - - - Image to tag. - - - - - --tag <tag> - - - Tag to remove. - - - - -
-
- sahara image-show - usage: sahara image-show [--name NAME] [--id <image_id>] - -Show details of an image. - - Optional arguments - - --name NAME - - - Name of the image. - - - - - --id <image_id> - - - ID of the image. - - - - -
-
- sahara image-unregister - usage: sahara image-unregister [--name NAME] [--id <image_id>] - -Unregister an image. - - Optional arguments - - --name NAME - - - Name of the image. - - - - - --id <image_id> - - - ID of image to unregister. - - - - -
-
- sahara job-binary-create - 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 - 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 - 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 - usage: sahara job-binary-data-list - -Print a list of internally stored job binary data. - -
-
- sahara job-binary-delete - 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 - usage: sahara job-binary-list - -Print a list of job binaries. - -
-
- sahara job-binary-show - 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 - usage: sahara job-binary-update [--name NAME] [--id <job_binary_id>] - [--json JSON] - -Update a job binary. - - Optional arguments - - --name NAME - - - Name of the job binary to update. - - - - - --id <job_binary_id> - - - ID of the job binary to update. - - - - - --json JSON - - - JSON representation of job binary update. - - - - -
-
- sahara job-create - 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 - usage: sahara job-delete --id ID - -Delete a job. - - Optional arguments - - --id ID - - - ID of a job. - - - - -
-
- sahara job-list - usage: sahara job-list - -Print a list of jobs. - -
-
- sahara job-show - usage: sahara job-show --id ID - -Show details of a job. - - Optional arguments - - --id ID - - - ID of the job. - - - - -
-
- sahara job-template-create - 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 - 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 - usage: sahara job-template-list - -Print a list of job templates. - -
-
- sahara job-template-show - 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 - usage: sahara job-type-list [--type <job_type>] [--plugin <plugin>] - [--plugin-version <plugin_version>] - -Show supported job types. - - Optional arguments - - --type <job_type> - - - Report only on this job type. - - - - - --plugin <plugin> - - - Report only job types supported by this plugin. - - - - - --plugin-version <plugin_version> - - - Report only on job types supported by this version of - a specified plugin. Only valid with --plugin. - - - - -
-
- sahara node-group-template-create - 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 - usage: sahara node-group-template-delete [--name NAME] [--id <template_id>] - -Delete a node group template. - - Optional arguments - - --name NAME - - - Name of the node group template. - - - - - --id <template_id> - - - ID of the node group template to delete. - - - - -
-
- sahara node-group-template-list - usage: sahara node-group-template-list - -Print a list of available node group templates. - -
-
- sahara node-group-template-show - usage: sahara node-group-template-show [--name NAME] [--id <template_id>] - [--json] - -Show details of a node group template. - - Optional arguments - - --name NAME - - - Name of the node group template. - - - - - --id <template_id> - - - ID of the node group template to show. - - - - - --json - - - Print JSON representation of node group template. - - - - -
-
- sahara node-group-template-update - usage: sahara node-group-template-update [--name NAME] [--id <template_id>] - [--json JSON] - -Update a node group template. - - Optional arguments - - --name NAME - - - Name of the node group template to update. - - - - - --id <template_id> - - - ID of the node group template to update. - - - - - --json JSON - - - JSON representation of the node group template update. - - - - -
-
- sahara plugin-list - usage: sahara plugin-list - -Print a list of available plugins. - -
-
- sahara plugin-show - usage: sahara plugin-show --name <plugin> - -Show details of a plugin. - - Optional arguments - - --name <plugin> - - - Name of the plugin. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_senlin_commands.xml b/doc/cli-reference/generated/ch_cli_senlin_commands.xml deleted file mode 100644 index ed3d2aa9da..0000000000 --- a/doc/cli-reference/generated/ch_cli_senlin_commands.xml +++ /dev/null @@ -1,2802 +0,0 @@ - - - - - - - - Clustering service command-line client - - The senlin client is the command-line - interface (CLI) for the Clustering service API and its extensions. - - This chapter documents senlin version - 0.1.8. - - - For help on a specific senlin - command, enter: - - $ senlin COMMAND - -
- senlin usage - usage: senlin [--version] [-d] [-v] [--api-timeout API_TIMEOUT] - [--senlin-api-version SENLIN_API_VERSION] - [--os-auth-plugin AUTH_PLUGIN] [--os-auth-url AUTH_URL] - [--os-project-id PROJECT_ID] [--os-project-name PROJECT_NAME] - [--os-tenant-id TENANT_ID] [--os-tenant-name TENANT_NAME] - [--os-domain-id DOMAIN_ID] [--os-domain-name DOMAIN_NAME] - [--os-project-domain-id PROJECT_DOMAIN_ID] - [--os-project-domain-name PROJECT_DOMAIN_NAME] - [--os-user-domain-id USER_DOMAIN_ID] - [--os-user-domain-name USER_DOMAIN_NAME] - [--os-username USERNAME] [--os-user-id USER_ID] - [--os-password PASSWORD] [--os-trust-id TRUST_ID] - [--os-cacert CA_BUNDLE_FILE | --verify | --insecure] - [--os-token TOKEN] [--os-access-info ACCESS_INFO] - [--os-api-name <service>=<name>] - [--os-api-region <service>=<region>] - [--os-api-version <service>=<version>] - [--os-api-interface <service>=<interface>] - <subcommand> ... - - Subcommands - - action-list - - - List actions. - - - - - action-show - - - Show detailed info about the specified action. - - - - - build-info - - - Retrieve build information. - - - - - cluster-create - - - Create the cluster. - - - - - cluster-delete - - - Delete the cluster(s). - - - - - cluster-list - - - List the user's clusters. - - - - - cluster-node-add - - - Add specified nodes to cluster. - - - - - cluster-node-del - - - Delete specified nodes from cluster. - - - - - cluster-node-list - - - List nodes from cluster. - - - - - cluster-policy-attach - - - Attach policy to cluster. - - - - - cluster-policy-detach - - - Detach policy from cluster. - - - - - cluster-policy-disable - - - Disable a policy on a cluster. - - - - - cluster-policy-enable - - - Enable a policy on cluster. - - - - - cluster-policy-list - - - List policies from cluster. - - - - - cluster-policy-show - - - Show a specific policy that is bound to the specified - cluster. - - - - - cluster-policy-update - - - Update a policy on cluster. - - - - - cluster-resize - - - Resize a cluster. - - - - - cluster-scale-in - - - Scale in a cluster by the specified number of nodes. - - - - - cluster-scale-out - - - Scale out a cluster by the specified number of nodes. - - - - - cluster-show - - - Show details of the cluster. - - - - - cluster-update - - - Update the cluster. - - - - - event-list - - - List events. - - - - - event-show - - - Describe the event. - - - - - node-create - - - Create the node. - - - - - node-delete - - - Delete the node(s). - - - - - node-join - - - Make node join the specified cluster. - - - - - node-leave - - - Make node leave its current cluster. - - - - - node-list - - - Show list of nodes. - - - - - node-show - - - Show detailed info about the specified node. - - - - - node-update - - - Update the node. - - - - - policy-create - - - Create a policy. - - - - - policy-delete - - - Delete policy(s). - - - - - policy-list - - - List policies that meet the criteria. - - - - - policy-show - - - Show the policy details. - - - - - policy-type-list - - - List the available policy types. - - - - - policy-type-schema - - - Get the spec of a policy type. - - - - - policy-type-show - - - Show the policy type. - - - - - policy-update - - - Update a policy. - - - - - profile-create - - - Create a profile. - - - - - profile-delete - - - Delete profile(s). - - - - - profile-list - - - List profiles that meet the criteria. - - - - - profile-show - - - Show the profile details. - - - - - profile-type-list - - - List the available profile types. - - - - - profile-type-schema - - - Get the spec of a profile type. - - - - - profile-update - - - Update a profile. - - - - - trigger-create - - - Create a trigger. - - - - - trigger-delete - - - Delete trigger(s). - - - - - trigger-list - - - List triggers that meet the criteria. - - - - - trigger-show - - - Show the trigger details. - - - - - webhook-create - - - Create a webhook. - - - - - webhook-delete - - - Delete webhook(s). - - - - - webhook-list - - - List webhooks that meet the criteria. - - - - - webhook-show - - - Show the webhook details. - - - - - bash-completion - - - Prints all of the commands and options to stdout. - - - - - help - - - Display help about this program or one of its - subcommands. - - - - -
-
- senlin optional arguments - - - --version - - - Shows the client version and exits. - - - - - -d, --debug - - - Defaults to env[SENLINCLIENT_DEBUG]. - - - - - -v, --verbose - - - Print more verbose output. - - - - - --api-timeout API_TIMEOUT - - - Number of seconds to wait for an API response, - defaults to system socket timeout - - - - - --senlin-api-version SENLIN_API_VERSION - - - Version number for Senlin API to use, Default to "1". - - - - - --os-auth-plugin AUTH_PLUGIN - - - Authentication plugin, default to env[OS_AUTH_PLUGIN] - - - - - --os-auth-url AUTH_URL - - - Defaults to env[OS_AUTH_URL] - - - - - --os-project-id PROJECT_ID - - - Defaults to env[OS_PROJECT_ID]. - - - - - --os-project-name PROJECT_NAME - - - Defaults to env[OS_PROJECT_NAME]. - - - - - --os-tenant-id TENANT_ID - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-tenant-name TENANT_NAME - - - Defaults to env[OS_TENANT_NAME]. - - - - - --os-domain-id DOMAIN_ID - - - Domain ID for scope of authorization, defaults to - env[OS_DOMAIN_ID]. - - - - - --os-domain-name DOMAIN_NAME - - - Domain name for scope of authorization, defaults to - env[OS_DOMAIN_NAME]. - - - - - --os-project-domain-id PROJECT_DOMAIN_ID - - - Project domain ID for scope of authorization, defaults - to env[OS_PROJECT_DOMAIN_ID]. - - - - - --os-project-domain-name PROJECT_DOMAIN_NAME - - - Project domain name for scope of authorization, - defaults to env[OS_PROJECT_DOMAIN_NAME]. - - - - - --os-user-domain-id USER_DOMAIN_ID - - - User domain ID for scope of authorization, defaults to - env[OS_USER_DOMAIN_ID]. - - - - - --os-user-domain-name USER_DOMAIN_NAME - - - User domain name for scope of authorization, defaults - to env[OS_USER_DOMAIN_NAME]. - - - - - --os-username USERNAME - - - Defaults to env[OS_USERNAME]. - - - - - --os-user-id USER_ID - - - Defaults to env[OS_USER_ID]. - - - - - --os-password PASSWORD - - - Defaults to env[OS_PASSWORD] - - - - - --os-trust-id TRUST_ID - - - Defaults to env[OS_TRUST_ID] - - - - - --os-cacert CA_BUNDLE_FILE - - - Path of CA TLS certificate(s) used to verify the - remote server's certificate. Without this option - senlin looks for the default system CA certificates. - - - - - --verify - - - Verify server certificate (default) - - - - - --insecure - - - Explicitly allow senlinclient 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. - - - - - --os-token TOKEN - - - A string token to bootstrap the Keystone database, - defaults to env[OS_TOKEN] - - - - - --os-access-info ACCESS_INFO - - - Access info, defaults to env[OS_ACCESS_INFO] - - - - - --os-api-name <service>=<name> - - - Desired API names, defaults to env[OS_API_NAME] - - - - - --os-api-region <service>=<region> - - - Desired API region, defaults to env[OS_API_REGION] - - - - - --os-api-version <service>=<version> - - - Desired API versions, defaults to env[OS_API_VERSION] - - - - - --os-api-interface <service>=<interface> - - - Desired API interface, defaults to env[OS_INTERFACE] - - - - -
-
- senlin action-list - usage: senlin action-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-k <KEYS>] - [-s <DIR>] [-l <LIMIT>] [-m <ID>] [-D] [-F] - -List actions. - - Optional arguments - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned actions. This - can be specified multiple times, or once with - parameters separated by a semicolon. - - - - - -k <KEYS>, --sort-keys <KEYS> - - - Name of keys used for sorting the returned events. - - - - - -s <DIR>, --sort-dir <DIR> - - - Direction for sorting, where DIR can be "asc" or - "desc". - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of nodes returned. - - - - - -m <ID>, --marker <ID> - - - Only return nodes that appear after the given node ID. - - - - - -D, --show-deleted - - - Include soft-deleted nodes if any. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin action-show - usage: senlin action-show <ACTION> - -Show detailed info about the specified action. - - Positional arguments - - <ACTION> - - - Name or ID of the action to show the details for. - - - - -
-
- senlin build-info - usage: senlin build-info - -Retrieve build information. :param sc: Instance of senlinclient. :param args: -Additional command line arguments, if any. - -
-
- senlin cluster-create - usage: senlin cluster-create -p <PROFILE> [-n <MIN-SIZE>] [-m <MAX-SIZE>] - [-c <DESIRED-CAPACITY>] [-o <PARENT_ID>] - [-t <TIMEOUT>] [-M <KEY1=VALUE1;KEY2=VALUE2...>] - <CLUSTER_NAME> - -Create the cluster. - - Positional arguments - - <CLUSTER_NAME> - - - Name of the cluster to create. - - - - - - Optional arguments - - -p <PROFILE>, --profile <PROFILE> - - - Profile Id used for this cluster. - - - - - -n <MIN-SIZE>, --min-size <MIN-SIZE> - - - Min size of the cluster. Default to 0. - - - - - -m <MAX-SIZE>, --max-size <MAX-SIZE> - - - Max size of the cluster. Default to -1, means - unlimited. - - - - - -c <DESIRED-CAPACITY>, --desired-capacity <DESIRED-CAPACITY> - - - Desired capacity of the cluster. Default to 0. - - - - - -o <PARENT_ID>, --parent <PARENT_ID> - - - ID of the parent cluster, if exists. - - - - - -t <TIMEOUT>, --timeout <TIMEOUT> - - - Cluster creation timeout in minutes. - - - - - -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> - - - Metadata values to be attached to the cluster. This - can be specified multiple times, or once with key- - value pairs separated by a semicolon. - - - - -
-
- senlin cluster-delete - usage: senlin cluster-delete <CLUSTER> [<CLUSTER> ...] - -Delete the cluster(s). - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster(s) to delete. - - - - -
-
- senlin cluster-list - usage: senlin cluster-list [-D] [-n] [-f <KEY1=VALUE1;KEY2=VALUE2...>] - [-k <KEYS>] [-s <DIR>] [-l <LIMIT>] [-m <ID>] [-g] - [-F] - -List the user's clusters. - - Optional arguments - - -D, --show-deleted - - - Include soft-deleted clusters if any. - - - - - -n, --show-nested - - - Include nested clusters if any. - - - - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned triggers. This - can be specified multiple times, or once with - parameters separated by a semicolon. - - - - - -k <KEYS>, --sort-keys <KEYS> - - - Name of keys used for sorting the returned events. - - - - - -s <DIR>, --sort-dir <DIR> - - - Direction for sorting, where DIR can be "asc" or - "desc". - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of clusters returned. - - - - - -m <ID>, --marker <ID> - - - Only return clusters that appear after the given - cluster ID. - - - - - -g, --global-project - - - Indicate that the cluster list should include clusters - from all projects. This option is subject to access - policy checking. Default is False. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin cluster-node-add - usage: senlin cluster-node-add -n <NODES> <CLUSTER> - -Add specified nodes to cluster. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -n <NODES>, --nodes <NODES> - - - ID of nodes to be added; multiple nodes can be - separated with "," - - - - -
-
- senlin cluster-node-del - usage: senlin cluster-node-del -n <NODES> <CLUSTER> - -Delete specified nodes from cluster. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -n <NODES>, --nodes <NODES> - - - ID of nodes to be deleted; multiple nodes can be - separatedwith ",". - - - - -
-
- senlin cluster-node-list - usage: senlin cluster-node-list [-D] [-f <KEY1=VALUE1;KEY2=VALUE2...>] - [-l <LIMIT>] [-m <ID>] [-F] - <CLUSTER> - -List nodes from cluster. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to nodes from. - - - - - - Optional arguments - - -D, --show-deleted - - - Include soft-deleted nodes if any. - - - - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned nodes. This can - be specified multiple times, or once with parameters - separated by a semicolon. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of nodes returned. - - - - - -m <ID>, --marker <ID> - - - Only return nodes that appear after the given node ID. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin cluster-policy-attach - usage: senlin cluster-policy-attach -p <POLICY> [-r <PRIORITY>] [-l <LEVEL>] - [-c <SECONDS>] [-e] - <NAME or ID> - -Attach policy to cluster. - - Positional arguments - - <NAME or ID> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -p <POLICY>, --policy <POLICY> - - - ID or name of policy to be attached. - - - - - -r <PRIORITY>, --priority <PRIORITY> - - - An integer specifying the relative priority among all - policies attached to a cluster. The lower the value, - the higher the priority. Default is 50. - - - - - -l <LEVEL>, --enforcement-level <LEVEL> - - - An integer between 0 and 100 representing the - enforcement level. Default to enforcement level of - policy. - - - - - -c <SECONDS>, --cooldown <SECONDS> - - - An integer indicating the cooldown seconds once the - policy is effected. Default to cooldown of policy. - - - - - -e, --enabled - - - Whether the policy should be enabled once attached. - Default to enabled. - - - - -
-
- senlin cluster-policy-detach - usage: senlin cluster-policy-detach -p <POLICY> <NAME or ID> - -Detach policy from cluster. - - Positional arguments - - <NAME or ID> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -p <POLICY>, --policy <POLICY> - - - ID or name of policy to be detached. - - - - -
-
- senlin cluster-policy-disable - usage: senlin cluster-policy-disable -p <POLICY> <NAME or ID> - -Disable a policy on a cluster. - - Positional arguments - - <NAME or ID> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -p <POLICY>, --policy <POLICY> - - - ID or name of policy to be disabled. - - - - -
-
- senlin cluster-policy-enable - usage: senlin cluster-policy-enable -p <POLICY> <NAME or ID> - -Enable a policy on cluster. - - Positional arguments - - <NAME or ID> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -p <POLICY>, --policy <POLICY> - - - ID or name of policy to be enabled. - - - - -
-
- senlin cluster-policy-list - usage: senlin cluster-policy-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] - [-k <KEYS>] [-s <DIR>] - <CLUSTER> - -List policies from cluster. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to query on. - - - - - - Optional arguments - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned results. This - can be specified multiple times, or once with - parameters separated by a semicolon. - - - - - -k <KEYS>, --sort-keys <KEYS> - - - Name of keys used for sorting the returned events. - - - - - -s <DIR>, --sort-dir <DIR> - - - Direction for sorting, where DIR can be "asc" or - "desc". - - - - -
-
- senlin cluster-policy-show - usage: senlin cluster-policy-show -p <POLICY> <CLUSTER> - -Show a specific policy that is bound to the specified cluster. - - Positional arguments - - <CLUSTER> - - - ID or name of the cluster to query on. - - - - - - Optional arguments - - -p <POLICY>, --policy <POLICY> - - - ID or name of the policy to query on. - - - - -
-
- senlin cluster-policy-update - usage: senlin cluster-policy-update -p <POLICY> [-r <PRIORITY>] [-l <LEVEL>] - [-c <COOLDOWN>] [-e <BOOLEAN>] - <NAME or ID> - -Update a policy on cluster. - - Positional arguments - - <NAME or ID> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -p <POLICY>, --policy <POLICY> - - - ID or name of policy to be updated. - - - - - -r <PRIORITY>, --priority <PRIORITY> - - - An integer specifying the relative priority among all - policies attached to a cluster. The lower the value, - the higher the priority. Default is 50. - - - - - -l <LEVEL>, --enforcement-level <LEVEL> - - - New enforcement level. - - - - - -c <COOLDOWN>, --cooldown <COOLDOWN> - - - Cooldown interval in seconds. - - - - - -e <BOOLEAN>, --enabled <BOOLEAN> - - - Whether the policy should be enabled. - - - - -
-
- senlin cluster-resize - usage: senlin cluster-resize [-c <CAPACITY>] [-a <ADJUSTMENT>] - [-p <PERCENTAGE>] [-t <MIN_STEP>] [-s] [-n MIN] - [-m MAX] - <CLUSTER> - -Resize a cluster. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -c <CAPACITY>, --capacity <CAPACITY> - - - The desired number of nodes of the cluster. - - - - - -a <ADJUSTMENT>, --adjustment <ADJUSTMENT> - - - A positive integer meaning the number of nodes to add, - or a negative integer indicating the number of nodes - to remove. - - - - - -p <PERCENTAGE>, --percentage <PERCENTAGE> - - - A value that is interpreted as the percentage of size - adjustment. This value can be positive or negative. - - - - - -t <MIN_STEP>, --min-step <MIN_STEP> - - - An integer specifying the number of nodes for - adjustment when <PERCENTAGE> is specified. - - - - - -s, --strict A - - - boolean specifying whether the resize should be - performed on a best-effort basis when the new capacity - may go beyond size constraints. - - - - - -n MIN, --min-size MIN - - - New lower bound of cluster size. - - - - - -m MAX, --max-size MAX - - - New upper bound of cluster size. A value of -1 - indicates no upper limit on cluster size. - - - - -
-
- senlin cluster-scale-in - usage: senlin cluster-scale-in [-c <COUNT>] <CLUSTER> - -Scale in a cluster by the specified number of nodes. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -c <COUNT>, --count <COUNT> - - - Number of nodes to be deleted from the specified - cluster. - - - - -
-
- senlin cluster-scale-out - usage: senlin cluster-scale-out [-c <COUNT>] <CLUSTER> - -Scale out a cluster by the specified number of nodes. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to operate on. - - - - - - Optional arguments - - -c <COUNT>, --count <COUNT> - - - Number of nodes to be added to the specified cluster. - - - - -
-
- senlin cluster-show - usage: senlin cluster-show <CLUSTER> - -Show details of the cluster. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to show. - - - - -
-
- senlin cluster-update - usage: senlin cluster-update [-p <PROFILE>] [-t <TIMEOUT>] [-r <PARENT>] - [-M <KEY1=VALUE1;KEY2=VALUE2...>] [-n <NAME>] - <CLUSTER> - -Update the cluster. - - Positional arguments - - <CLUSTER> - - - Name or ID of cluster to be updated. - - - - - - Optional arguments - - -p <PROFILE>, --profile <PROFILE> - - - ID of new profile to use. - - - - - -t <TIMEOUT>, --timeout <TIMEOUT> - - - New timeout (in minutes) value for the cluster. - - - - - -r <PARENT>, --parent <PARENT> - - - ID of parent cluster for the cluster. - - - - - -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> - - - Metadata values to be attached to the cluster. This - can be specified multiple times, or once with key- - value pairs separated by a semicolon. - - - - - -n <NAME>, --name <NAME> - - - New name for the cluster to update. - - - - -
-
- senlin event-list - usage: senlin event-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>] - [-m <ID>] [-k <KEYS>] [-s <DIR>] [-g] [-D] [-F] - -List events. - - Optional arguments - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned events. This - can be specified multiple times, or once with - parameters separated by a semicolon. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of events returned. - - - - - -m <ID>, --marker <ID> - - - Only return events that appear after the given event - ID. - - - - - -k <KEYS>, --sort-keys <KEYS> - - - Name of keys used for sorting the returned events. - - - - - -s <DIR>, --sort-dir <DIR> - - - Direction for sorting, where DIR can be "asc" or - "desc". - - - - - -g, --global-project - - - Whether events from all projects should be listed. - Default to False. Setting this to True may demand for - an admin privilege. - - - - - -D, --show-deleted - - - Whether deleted events should be listed as well. - Default to False. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin event-show - usage: senlin event-show <EVENT> - -Describe the event. - - Positional arguments - - <EVENT> - - - ID of event to display details for. - - - - -
-
- senlin node-create - usage: senlin node-create -p <PROFILE> [-c <CLUSTER>] [-r <ROLE>] - [-M <KEY1=VALUE1;KEY2=VALUE2...>] - <NODE_NAME> - -Create the node. - - Positional arguments - - <NODE_NAME> - - - Name of the node to create. - - - - - - Optional arguments - - -p <PROFILE>, --profile <PROFILE> - - - Profile Id used for this node. - - - - - -c <CLUSTER>, --cluster <CLUSTER> - - - Cluster Id for this node. - - - - - -r <ROLE>, --role <ROLE> - - - Role for this node in the specific cluster. - - - - - -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> - - - Metadata values to be attached to the cluster. This - can be specified multiple times, or once with key- - value pairs separated by a semicolon. - - - - -
-
- senlin node-delete - usage: senlin node-delete <NODE> [<NODE> ...] - -Delete the node(s). - - Positional arguments - - <NODE> - - - Name or ID of node(s) to delete. - - - - -
-
- senlin node-join - usage: senlin node-join -c CLUSTER <NODE> - -Make node join the specified cluster. - - Positional arguments - - <NODE> - - - Name or ID of node to operate on. - - - - - - Optional arguments - - -c CLUSTER, --cluster CLUSTER - - - ID or name of cluster for node to join. - - - - -
-
- senlin node-leave - usage: senlin node-leave <NODE> - -Make node leave its current cluster. - - Positional arguments - - <NODE> - - - Name or ID of node to operate on. - - - - -
-
- senlin node-list - usage: senlin node-list [-c <CLUSTER>] [-D] [-f <KEY1=VALUE1;KEY2=VALUE2...>] - [-k <KEYS>] [-s <DIR>] [-l <LIMIT>] [-m <ID>] [-g] - [-F] - -Show list of nodes. - - Optional arguments - - -c <CLUSTER>, --cluster <CLUSTER> - - - ID or name of cluster from which nodes are to be - listed. - - - - - -D, --show-deleted - - - Include soft-deleted nodes if any. - - - - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned nodes. This can - be specified multiple times, or once with parameters - separated by a semicolon. - - - - - -k <KEYS>, --sort-keys <KEYS> - - - Name of keys used for sorting the returned nodes. - - - - - -s <DIR>, --sort-dir <DIR> - - - Direction for sorting, where DIR can be "asc" or - "desc". - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of nodes returned. - - - - - -m <ID>, --marker <ID> - - - Only return nodes that appear after the given node ID. - - - - - -g, --global-project - - - Indicate that this node list should include nodes from - all projects. This option is subject to access policy - checking. Default is False. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin node-show - usage: senlin node-show [-D] <NODE> - -Show detailed info about the specified node. - - Positional arguments - - <NODE> - - - Name or ID of the node to show the details for. - - - - - - Optional arguments - - -D, --details - - - Include physical object details. - - - - -
-
- senlin node-update - usage: senlin node-update [-n <NAME>] [-p <PROFILE ID>] [-r <ROLE>] - [-M <KEY1=VALUE1;KEY2=VALUE2...>] - <NODE> - -Update the node. - - Positional arguments - - <NODE> - - - Name or ID of node to update. - - - - - - Optional arguments - - -n <NAME>, --name <NAME> - - - New name for the node. - - - - - -p <PROFILE ID>, --profile <PROFILE ID> - - - ID of new profile to use. - - - - - -r <ROLE>, --role <ROLE> - - - Role for this node in the specific cluster. - - - - - -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> - - - Metadata values to be attached to the node. Metadata - can be specified multiple times, or once with key- - value pairs separated by a semicolon. - - - - -
-
- senlin policy-create - usage: senlin policy-create -s <SPEC_FILE> [-c <SECONDS>] [-l <LEVEL>] <NAME> - -Create a policy. - - Positional arguments - - <NAME> - - - Name of the policy to create. - - - - - - Optional arguments - - -s <SPEC_FILE>, --spec-file <SPEC_FILE> - - - The spec file used to create the policy. - - - - - -c <SECONDS>, --cooldown <SECONDS> - - - An integer indicating the cooldown seconds once the - policy is effected. Default to 0. - - - - - -l <LEVEL>, --enforcement-level <LEVEL> - - - An integer between 0 and 100 representing the - enforcement level. Default to 0. - - - - -
-
- senlin policy-delete - usage: senlin policy-delete <POLICY> [<POLICY> ...] - -Delete policy(s). - - Positional arguments - - <POLICY> - - - Name or ID of policy(s) to delete. - - - - -
-
- senlin policy-list - usage: senlin policy-list [-D] [-l <LIMIT>] [-m <ID>] [-F] - -List policies that meet the criteria. - - Optional arguments - - -D, --show-deleted - - - Include soft-deleted policies if any. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of policies returned. - - - - - -m <ID>, --marker <ID> - - - Only return policies that appear after the given ID. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin policy-show - usage: senlin policy-show <POLICY> - -Show the policy details. - - Positional arguments - - <POLICY> - - - Name of the policy to be updated. - - - - -
-
- senlin policy-type-list - usage: senlin policy-type-list - -List the available policy types. - -
-
- senlin policy-type-schema - usage: senlin policy-type-schema [-F <FORMAT>] <POLICY_TYPE> - -Get the spec of a policy type. - - Positional arguments - - <POLICY_TYPE> - - - Policy type to generate a template for. - - - - - - Optional arguments - - -F <FORMAT>, --format <FORMAT> - - - The template output format, one of: yaml, json. - - - - -
-
- senlin policy-type-show - usage: senlin policy-type-show <POLICY_TYPE> - -Show the policy type. - - Positional arguments - - <POLICY_TYPE> - - - Policy type to get the details for. - - - - -
-
- senlin policy-update - usage: senlin policy-update [-c <SECONDS>] [-l <LEVEL>] [-n <NAME>] <POLICY> - -Update a policy. - - Positional arguments - - <POLICY> - - - Name of the policy to be updated. - - - - - - Optional arguments - - -c <SECONDS>, --cooldown <SECONDS> - - - An integer indicating the cooldown seconds once the - policy is effected. Default to 0. - - - - - -l <LEVEL>, --enforcement-level <LEVEL> - - - An integer between 0 and 100 representing the - enforcement level. Default to 0. - - - - - -n <NAME>, --name <NAME> - - - New name of the policy to be updated. - - - - -
-
- senlin profile-create - usage: senlin profile-create -s <SPEC FILE> [-p <PERMISSION>] - [-M <KEY1=VALUE1;KEY2=VALUE2...>] - <PROFILE_NAME> - -Create a profile. - - Positional arguments - - <PROFILE_NAME> - - - Name of the profile to create. - - - - - - Optional arguments - - -s <SPEC FILE>, --spec-file <SPEC FILE> - - - The spec file used to create the profile. - - - - - -p <PERMISSION>, --permission <PERMISSION> - - - A string format permission for this profile. - - - - - -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> - - - Metadata values to be attached to the profile. This - can be specified multiple times, or once with key- - value pairs separated by a semicolon. - - - - -
-
- senlin profile-delete - usage: senlin profile-delete <PROFILE> [<PROFILE> ...] - -Delete profile(s). - - Positional arguments - - <PROFILE> - - - Name or ID of profile(s) to delete. - - - - -
-
- senlin profile-list - usage: senlin profile-list [-D] [-l <LIMIT>] [-m <ID>] [-F] - -List profiles that meet the criteria. - - Optional arguments - - -D, --show-deleted - - - Include soft-deleted profiles if any. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of profiles returned. - - - - - -m <ID>, --marker <ID> - - - Only return profiles that appear after the given ID. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin profile-show - usage: senlin profile-show <PROFILE> - -Show the profile details. - - Positional arguments - - <PROFILE> - - - Name or ID of profile to show. - - - - -
-
- senlin profile-type-list - usage: senlin profile-type-list - -List the available profile types. :param sc: Instance of senlinclient. :param -args: Additional command line arguments, if any. - -
-
- senlin profile-type-schema - usage: senlin profile-type-schema [-F <FORMAT>] <PROFILE_TYPE> - -Get the spec of a profile type. - - Positional arguments - - <PROFILE_TYPE> - - - Profile type to generate a template for. - - - - - - Optional arguments - - -F <FORMAT>, --format <FORMAT> - - - The template output format, one of: yaml, json. - - - - -
-
- senlin profile-update - usage: senlin profile-update [-n <NAME>] [-p <PERMISSION>] - [-M <KEY1=VALUE1;KEY2=VALUE2...>] - <PROFILE_ID> - -Update a profile. - - Positional arguments - - <PROFILE_ID> - - - Name or ID of the profile to update. - - - - - - Optional arguments - - -n <NAME>, --name <NAME> - - - The new name for the profile. - - - - - -p <PERMISSION>, --permission <PERMISSION> - - - A string format permission for this profile. - - - - - -M <KEY1=VALUE1;KEY2=VALUE2...>, --metadata <KEY1=VALUE1;KEY2=VALUE2...> - - - Metadata values to be attached to the profile. This - can be specified multiple times, or once with key- - value pairs separated by a semicolon. - - - - -
-
- senlin trigger-create - usage: senlin trigger-create -s <SPEC FILE> [--desc <DESCRIPTION>] [-e] - [-v SEVERITY] [--state STATE] - <TRIGGER_NAME> - -Create a trigger. - - Positional arguments - - <TRIGGER_NAME> - - - Name of the trigger to create. - - - - - - Optional arguments - - -s <SPEC FILE>, --spec-file <SPEC FILE> - - - The spec file used to create the trigger. - - - - - --desc <DESCRIPTION> - - - A string for describing of the trigger to be created. - - - - - -e, --enabled - - - Whether the trigger should be enabled when created. - - - - - -v SEVERITY, --severity SEVERITY - - - Severity level of the target trigger to be created. - - - - - --state STATE - - - Initial state of the target trigger. - - - - -
-
- senlin trigger-delete - usage: senlin trigger-delete <TRIGGER> [<TRIGGER> ...] - -Delete trigger(s). - - Positional arguments - - <TRIGGER> - - - Name or ID of trigger(s) to delete. - - - - -
-
- senlin trigger-list - usage: senlin trigger-list [-D] [-l <LIMIT>] [-m <ID>] [-k <KEYS>] [-s <DIR>] - [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-g] [-F] - -List triggers that meet the criteria. - - Optional arguments - - -D, --show-deleted - - - Include soft-deleted triggers if any. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of triggers returned. - - - - - -m <ID>, --marker <ID> - - - Only return triggers that appear after the given ID. - - - - - -k <KEYS>, --sort-keys <KEYS> - - - Name of keys used for sorting the returned triggers. - - - - - -s <DIR>, --sort-dir <DIR> - - - Direction for sorting, where DIR can be "asc" or - "desc". - - - - - -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> - - - Filter parameters to apply on returned clusters. This - can be specified multiple times, or once with - parameters separated by a semicolon. - - - - - -g, --global-project - - - Indicate that the list should include triggers from - all projects. This option is subject to access policy - checking. Default is False. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin trigger-show - usage: senlin trigger-show <TRIGGER> - -Show the trigger details. - - Positional arguments - - <TRIGGER> - - - Name or ID of trigger to show. - - - - -
-
- senlin webhook-create - usage: senlin webhook-create [-c <CLUSTER>] [-n <NODE>] -a <ACTION> - [-C <KEY1=VALUE1;KEY2=VALUE2...>] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] - <NAME> - -Create a webhook. - - Positional arguments - - <NAME> - - - Name of the webhook to create. - - - - - - Optional arguments - - -c <CLUSTER>, --cluster <CLUSTER> - - - Targeted cluster for this webhook. - - - - - -n <NODE>, --node <NODE> - - - Targeted node for this webhook. - - - - - -a <ACTION>, --action <ACTION> - - - Name of action to be triggered for this webhook. - - - - - -C <KEY1=VALUE1;KEY2=VALUE2...>, --credential <KEY1=VALUE1;KEY2=VALUE2...> - - - The credential to be used when the webhook is - triggered. - - - - - -P <KEY1=VALUE1;KEY2=VALUE2...>, --params <KEY1=VALUE1;KEY2=VALUE2...> - - - A dictionary of parameters that will be passed to - target action when the webhook is triggered. - - - - -
-
- senlin webhook-delete - usage: senlin webhook-delete <WEBHOOK> [<WEBHOOK> ...] - -Delete webhook(s). - - Positional arguments - - <WEBHOOK> - - - Name or ID of webhook(s) to delete. - - - - -
-
- senlin webhook-list - usage: senlin webhook-list [-D] [-l <LIMIT>] [-m <ID>] [-F] - -List webhooks that meet the criteria. - - Optional arguments - - -D, --show-deleted - - - Include deleted webhooks if any. - - - - - -l <LIMIT>, --limit <LIMIT> - - - Limit the number of webhooks returned. - - - - - -m <ID>, --marker <ID> - - - Only return webhooks that appear after the given ID. - - - - - -F, --full-id - - - Print full IDs in list. - - - - -
-
- senlin webhook-show - usage: senlin webhook-show <WEBHOOK> - -Show the webhook details. - - Positional arguments - - <WEBHOOK> - - - Name or ID of the webhook to show. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_swift_commands.xml b/doc/cli-reference/generated/ch_cli_swift_commands.xml deleted file mode 100644 index a779838c72..0000000000 --- a/doc/cli-reference/generated/ch_cli_swift_commands.xml +++ /dev/null @@ -1,880 +0,0 @@ - - - - - - - - Object Storage command-line client - - The swift client is the command-line - interface (CLI) for the OpenStack Object Storage API and its extensions. - - This chapter documents swift version - 2.6.0. - - - For help on a specific swift - command, enter: - - $ swift COMMAND - -
- swift usage - [--debug] [--info] [--quiet] [--auth <auth_url>] - [--auth-version <auth_version>] [--user <username>] - [--key <api_key>] [--retries <num_retries>] - [--os-username <auth-user-name>] [--os-password <auth-password>] - [--os-user-id <auth-user-id>] - [--os-user-domain-id <auth-user-domain-id>] - [--os-user-domain-name <auth-user-domain-name>] - [--os-tenant-id <auth-tenant-id>] - [--os-tenant-name <auth-tenant-name>] - [--os-project-id <auth-project-id>] - [--os-project-name <auth-project-name>] - [--os-project-domain-id <auth-project-domain-id>] - [--os-project-domain-name <auth-project-domain-name>] - [--os-auth-url <auth-url>] [--os-auth-token <auth-token>] - [--os-storage-url <storage-url>] [--os-region-name <region-name>] - [--os-service-type <service-type>] - [--os-endpoint-type <endpoint-type>] - [--os-cacert <ca-certificate>] [--insecure] - [--no-ssl-compression] - <subcommand> [--help] [<subcommand options>] - - Subcommands - - delete - - - Delete a container or objects within a container. - - - - - download - - - Download objects from containers. - - - - - list - - - Lists the containers for the account or the objects - for a container. - - - - - post - - - Updates meta information for the account, container, - or object; creates containers if not present. - - - - - stat - - - Displays information for the account, container, - or object. - - - - - upload - - - Uploads files or directories to the given container. - - - - - capabilities - - - List cluster capabilities. - - - - - tempurl - - - Create a temporary URL. - - - - - auth - - - Display auth related environment variables. - - - - -
-
- swift examples - swift download --help - swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K api_key stat -v - swift --os-auth-url https://api.example.com/v2.0 --os-tenant-name tenant \ - --os-username user --os-password password list - swift --os-auth-url https://api.example.com/v3 --auth-version 3\ - --os-project-name project1 --os-project-domain-name domain1 \ - --os-username user --os-user-domain-name domain1 \ - --os-password password list - swift --os-auth-url https://api.example.com/v3 --auth-version 3\ - --os-project-id 0123456789abcdef0123456789abcdef \ - --os-user-id abcdef0123456789abcdef0123456789 \ - --os-password password list - swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \ - --os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \ - list - swift list --lh -
-
- swift optional arguments - - - --version - - - show program's version number and exit - - - - - -h, --help - - - show this help message and exit - - - - - --os-help - - - Show OpenStack authentication options. - - - - - -s, --snet - - - Use SERVICENET internal network. - - - - - -v, --verbose - - - Print more info. - - - - - --debug - - - Show the curl commands and results of all http queries - regardless of result status. - - - - - --info - - - Show the curl commands and results of all http queries - which return an error. - - - - - -q, --quiet - - - Suppress status output. - - - - - -A AUTH, --auth=AUTH URL - - - for obtaining an auth token. - - - - - -V AUTH_VERSION, --auth-version=AUTH_VERSION - - - Specify a version for authentication. Defaults to 1.0. - - - - - -U USER, --user=USER - - - User name for obtaining an auth token. - - - - - -K KEY, --key=KEY - - - Key for obtaining an auth token. - - - - - -R RETRIES, --retries=RETRIES - - - The number of times to retry a failed connection. - - - - - --insecure - - - Allow swiftclient to access servers without having to - verify the SSL certificate. Defaults to - env[SWIFTCLIENT_INSECURE] (set to 'true' to enable). - - - - - --no-ssl-compression - - - This option is deprecated and not used anymore. SSL - compression should be disabled by default by the - system SSL library. - - - - -
-
- swift capabilities - - Usage: swift capabilities - -Retrieve capability of the proxy. -Optional positional arguments: - <proxy_url> Proxy URL of the cluster to retrieve capabilities. - -
-
- swift delete - - Usage: swift delete - -Delete a container or objects within a container. - - Positional arguments - - <container> - - - Name of container to delete from. - - - - - [object] - - - Name of object to delete. Specify multiple times - for multiple objects. - - - - - - Optional arguments - - -a, --all - - - Delete all containers and objects. - - - - - --leave-segments - - - Do not delete segments of manifest objects. - - - - - --object-threads <threads> - - - Number of threads to use for deleting objects. - Default is 10. - - - - - --container-threads <threads> - - - Number of threads to use for deleting containers. - Default is 10. - - - - -
-
- swift download - - Usage: swift download - -Download objects from containers. - - Positional arguments - - <container> - - - Name of container to download from. To download a - whole account, omit this and specify --all. - - - - - <object> - - - Name of object to download. Specify multiple times - for multiple objects. Omit this to download all - objects from the container. - - - - - - Optional arguments - - -a, --all - - - Indicates that you really want to download - everything in the account. - - - - - -m, --marker - - - Marker to use when starting a container or account - download. - - - - - -p, --prefix <prefix> - - - Only download items beginning with <prefix> - - - - - -r, --remove-prefix - - - An optional flag for --prefix <prefix>, use this - option to download items without <prefix> - - - - - -o, --output <out_file> - - - For a single file download, stream the output to - <out_file>. Specifying "-" as <out_file> will - redirect to stdout. - - - - - -D, --output-dir <out_directory> - - - An optional directory to which to store objects. - By default, all objects are recreated in the current - directory. - - - - - --object-threads <threads> - - - Number of threads to use for downloading objects. - Default is 10. - - - - - --container-threads <threads> - - - Number of threads to use for downloading containers. - Default is 10. - - - - - --no-download - - - Perform download(s), but don't actually write anything - to disk. - - - - - -H, --header <header:value> - - - Adds a customized request header to the query, like - "Range" or "If-Match". This option may be repeated. - Example --header "content-type:text/plain" - - - - - --skip-identical - - - Skip downloading files that are identical on both - sides. - - - - - --no-shuffle - - - By default, when downloading a complete account or - container, download order is randomised in order to - to reduce the load on individual drives when multiple - clients are executed simultaneously to download the - same set of objects (e.g. a nightly automated download - script to multiple servers). Enable this option to - submit download jobs to the thread pool in the order - they are listed in the object store. - - - - -
-
- swift list - - Usage: swift list - -Lists the containers for the account or the objects for a container. - - Positional arguments - - [container] - - - Name of container to list object in. - - - - - - Optional arguments - - -l, --long - - - Long listing format, similar to ls -l. - - - - - --lh - - - Report sizes in human readable format similar to - ls -lh. - - - - - -t, --totals - - - Used with -l or --lh, only report totals. - - - - - -p, --prefix - - - Only list items beginning with the prefix. - - - - - -d, --delimiter - - - Roll up items with the given delimiter. For containers - only. See OpenStack Swift API documentation for what - this means. - - - - -
-
- swift post - - Usage: swift post - -Updates meta information for the account, container, or object. -If the container is not found, it will be created automatically. - - Positional arguments - - [container] - - - Name of container to post to. - - - - - [object] - - - Name of object to post. - - - - - - Optional arguments - - -r, --read-acl <acl> - - - Read ACL for containers. Quick summary of ACL syntax: - .r:*, .r:-.example.com, .r:www.example.com, account1, - account2:user2 - - - - - -w, --write-acl <acl> - - - Write ACL for containers. Quick summary of ACL syntax: - account1 account2:user2 - - - - - -t, --sync-to <sync-to> - - - Sync To for containers, for multi-cluster replication. - - - - - -k, --sync-key <sync-key> - - - Sync Key for containers, for multi-cluster replication. - - - - - -m, --meta <name:value> - - - Sets a meta data item. This option may be repeated. - Example: -m Color:Blue -m Size:Large - - - - - -H, --header <header:value> - - - Adds a customized request header. - This option may be repeated. Example - -H "content-type:text/plain" -H "Content-Length: 4000" - - - - -
-
- swift stat - - Usage: swift stat - -Displays information for the account, container, or object. - - Positional arguments - - [container] - - - Name of container to stat from. - - - - - [object] - - - Name of object to stat. - - - - - - Optional arguments - - --lh - - - Report sizes in human readable format similar to - ls -lh. - - - - -
-
- swift tempurl - - Usage: swift tempurl - -Generates a temporary URL for a Swift object. - - Positional arguments - - <method> - - - An HTTP method to allow for this temporary URL. - Usually 'GET' or 'PUT'. - - - - - <seconds> - - - The amount of time in seconds the temporary URL will be - valid for; or, if --absolute is passed, the Unix - timestamp when the temporary URL will expire. - - - - - <path> - - - The full path to the Swift object. Example: - /v1/AUTH_account/c/o. - - - - - <key> - - - The secret temporary URL key set on the Swift cluster. - To set a key, run 'swift post -m - "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"' - - - - - - Optional arguments - - --absolute - - - Interpet the <seconds> positional argument as a Unix - timestamp rather than a number of seconds in the - future. - - - - -
-
- swift upload - - Usage: swift upload - - Uploads specified files and directories to the given container. - - Positional arguments - - <container> - - - Name of container to upload to. - - - - - <file_or_directory> - - - Name of file or directory to upload. Specify multiple - times for multiple uploads. - - - - - - Optional arguments - - -c, --changed - - - Only upload files that have changed since the last - upload. - - - - - --skip-identical - - - Skip uploading files that are identical on both sides. - - - - - -S, --segment-size <size> - - - Upload files in segments no larger than <size> (in - Bytes) and then create a "manifest" file that will - download all the segments as if it were the original - file. - - - - - --segment-container <container> - - - Upload the segments into the specified container. If - not specified, the segments will be uploaded to a - <container>_segments container to not pollute the - main <container> listings. - - - - - --leave-segments - - - Indicates that you want the older segments of manifest - objects left alone (in the case of overwrites). - - - - - --object-threads <threads> - - - Number of threads to use for uploading full objects. - Default is 10. - - - - - --segment-threads <threads> - - - Number of threads to use for uploading object segments. - Default is 10. - - - - - -H, --header <header:value> - - - Adds a customized request header. This option may be - repeated. Example -H "content-type:text/plain" - -H "Content-Length: 4000". - - - - - --use-slo - - - When used in conjunction with --segment-size it will - create a Static Large Object instead of the default - Dynamic Large Object. - - - - - --object-name <object-name> - - - Upload file and name object to <object-name> or upload - dir and use <object-name> as object prefix instead of - folder name. - - - - - --ignore-checksum - - - Turn off checksum validation for uploads. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_trove-manage_commands.xml b/doc/cli-reference/generated/ch_cli_trove-manage_commands.xml deleted file mode 100644 index a30012a4b9..0000000000 --- a/doc/cli-reference/generated/ch_cli_trove-manage_commands.xml +++ /dev/null @@ -1,586 +0,0 @@ - - - - - - - - Database service management command-line client - - The trove-manage client is the command-line - interface (CLI) for the Database Management Utility API and its extensions. - - This chapter documents trove-manage version - 4.0.0. - - - For help on a specific trove-manage - command, enter: - - $ trove-manage COMMAND - -
- trove-manage usage - usage: trove-manage [-h] [--config-dir DIR] [--config-file PATH] [--debug] - [--log-config-append PATH] [--log-date-format DATE_FORMAT] - [--log-dir LOG_DIR] [--log-file PATH] - [--log-format FORMAT] [--nodebug] [--nouse-syslog] - [--nouse-syslog-rfc-format] [--noverbose] - [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog] - [--use-syslog-rfc-format] [--verbose] [--version] - {db_sync,db_upgrade,db_downgrade,datastore_update,datastore_version_update,db_recreate,db_load_datastore_config_parameters,datastore_version_flavor_add,datastore_version_flavor_delete} - ... -
-
- trove-manage optional arguments - - - -h, --help - - - show this help message and exit - - - - - --config-dir DIR - - - Path to a config directory to pull *.conf files from. - This file set is sorted, so as to provide a - predictable parse order if individual options are - over-ridden. The set is parsed after the file(s) - specified via previous --config-file, arguments hence - over-ridden options in the directory take precedence. - - - - - --config-file PATH - - - Path to a config file to use. Multiple config files - can be specified, with values in later files taking - precedence. The default files used are: None. - - - - - --debug, -d - - - Print debugging output (set logging level to DEBUG - instead of default INFO level). - - - - - --log-config-append PATH, --log_config PATH - - - The name of a logging configuration file. This file is - appended to any existing logging configuration files. - For details about logging configuration files, see the - Python logging module documentation. - - - - - --log-date-format DATE_FORMAT - - - Format string for %(asctime)s in log records. Default: - None . - - - - - --log-dir LOG_DIR, --logdir LOG_DIR - - - (Optional) The base directory used for relative --log- - file paths. - - - - - --log-file PATH, --logfile PATH - - - (Optional) Name of log file to output to. If no - default is set, logging will go to stdout. - - - - - --log-format FORMAT - - - DEPRECATED. A logging.Formatter log message format - string which may use any of the available - logging.LogRecord attributes. This option is - deprecated. Please use logging_context_format_string - and logging_default_format_string instead. - - - - - --nodebug - - - The inverse of --debug - - - - - --nouse-syslog - - - The inverse of --use-syslog - - - - - --nouse-syslog-rfc-format - - - The inverse of --use-syslog-rfc-format - - - - - --noverbose - - - The inverse of --verbose - - - - - --syslog-log-facility SYSLOG_LOG_FACILITY - - - Syslog facility to receive log lines. - - - - - --use-syslog - - - Use syslog for logging. Existing syslog format is - DEPRECATED and will be changed later to honor RFC5424. - - - - - --use-syslog-rfc-format - - - (Optional) Enables or disables syslog rfc5424 format - for logging. If enabled, prefixes the MSG part of the - syslog message with APP-NAME (RFC5424). The format - without the APP-NAME is deprecated in Kilo, and will - be removed in Mitaka, along with this option. - - - - - --verbose, -v - - - If set to false, will disable INFO logging level, - making WARNING the default. - - - - - --version - - - show program's version number and exit - - - - -
-
- trove-manage datastore_update - usage: trove-manage datastore_update [-h] datastore_name default_version - -Add or update a datastore. If the datastore already exists, the default -version will be updated. - - Positional arguments - - datastore_name - - - Name of the datastore. - - - - - default_version - - - Name or ID of an existing datastore version to set as the - default. When adding a new datastore, use an empty string. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- trove-manage datastore_version_flavor_add - usage: trove-manage datastore_version_flavor_add [-h] - datastore_name - datastore_version_name - flavor_ids - - - Positional arguments - - datastore_name - - - Name of the datastore. - - - - - datastore_version_name - - - Name of the datastore version. - - - - - flavor_ids - - - Comma separated list of flavor ids. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- trove-manage datastore_version_flavor_delete - usage: trove-manage datastore_version_flavor_delete [-h] - datastore_name - datastore_version_name - flavor_id - - - Positional arguments - - datastore_name - - - Name of the datastore. - - - - - datastore_version_name - - - Name of the datastore version. - - - - - flavor_id - - - The flavor to be deleted for a given datastore and - datastore version. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- trove-manage datastore_version_update - usage: trove-manage datastore_version_update [-h] - datastore version_name manager - image_id packages active - -Add or update a datastore version. If the datastore version already exists, -all values except the datastore name and version will be updated. - - Positional arguments - - datastore - - - Name of the datastore. - - - - - version_name - - - Name of the datastore version. - - - - - manager - - - Name of the manager that will administer the datastore - version. - - - - - image_id - - - ID of the image used to create an instance of the datastore - version. - - - - - packages - - - Packages required by the datastore version that are installed - on the guest image. - - - - - active - - - Whether the datastore version is active or not. Accepted - values are 0 and 1. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- trove-manage db_downgrade - usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version - -Downgrade the database to the specified version. - - Positional arguments - - version - - - Target version. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --repo_path REPO_PATH - - - SQLAlchemy Migrate repository path. - - - - -
-
- trove-manage db_load_datastore_config_parameters - usage: trove-manage db_load_datastore_config_parameters [-h] - datastore - datastore_version - config_file_location - -Loads configuration group parameter validation rules for a datastore version -into the database. - - Positional arguments - - datastore - - - Name of the datastore. - - - - - datastore_version - - - Name of the datastore version. - - - - - config_file_location - - - Fully qualified file path to the configuration group - parameter validation rules. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- trove-manage db_recreate - usage: trove-manage db_recreate [-h] [--repo_path REPO_PATH] - -Drop the database and recreate it. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --repo_path REPO_PATH - - - SQLAlchemy Migrate repository path. - - - - -
-
- trove-manage db_sync - usage: trove-manage db_sync [-h] [--repo_path REPO_PATH] - -Populate the database structure - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --repo_path REPO_PATH - - - SQLAlchemy Migrate repository path. - - - - -
-
- trove-manage db_upgrade - usage: trove-manage db_upgrade [-h] [--version VERSION] - [--repo_path REPO_PATH] - -Upgrade the database to the specified version. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --version VERSION - - - Target version. Defaults to the latest version. - - - - - --repo_path REPO_PATH - - - SQLAlchemy Migrate repository path. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_trove_commands.xml b/doc/cli-reference/generated/ch_cli_trove_commands.xml deleted file mode 100644 index 40c493dccf..0000000000 --- a/doc/cli-reference/generated/ch_cli_trove_commands.xml +++ /dev/null @@ -1,2832 +0,0 @@ - - - - - - - - Database service command-line client - - The trove client is the command-line - interface (CLI) for the Database API and its extensions. - - This chapter documents trove version - 1.4.0. - - - For help on a specific trove - command, enter: - - $ trove COMMAND - -
- trove usage - usage: trove [--version] [--debug] [--os-auth-system <auth-system>] - [--service-type <service-type>] [--service-name <service-name>] - [--bypass-url <bypass-url>] - [--database-service-name <database-service-name>] - [--endpoint-type <endpoint-type>] - [--os-database-api-version <database-api-ver>] - [--retries <retries>] [--json] [--insecure] - [--os-cacert <ca-certificate>] [--os-cert <certificate>] - [--os-key <key>] [--timeout <seconds>] - [--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-user-name OS_USERNAME] - [--os-user-domain-id OS_USER_DOMAIN_ID] - [--os-user-domain-name OS_USER_DOMAIN_NAME] - [--os-password OS_PASSWORD] [--os-tenant-name <auth-tenant-name>] - [--os-tenant-id <tenant-id>] [--os-auth-token OS_AUTH_TOKEN] - [--os-region-name <region-name>] - <subcommand> ... - - Subcommands - - backup-copy - - - Creates a backup from another backup. - - - - - backup-create - - - Creates a backup of an instance. - - - - - backup-delete - - - Deletes a backup. - - - - - backup-list - - - Lists available backups. - - - - - backup-list-instance - - - Lists available backups for an instance. - - - - - backup-show - - - Shows details of a backup. - - - - - cluster-create - - - Creates a new cluster. - - - - - cluster-delete - - - Deletes a cluster. - - - - - cluster-grow - - - Adds more instances to a cluster. - - - - - cluster-instances - - - Lists all instances of a cluster. - - - - - cluster-list - - - Lists all the clusters. - - - - - cluster-show - - - Shows details of a cluster. - - - - - cluster-shrink - - - Drops instances from a cluster. - - - - - configuration-attach - - - Attaches a configuration group to an - instance. - - - - - configuration-create - - - Creates a configuration group. - - - - - configuration-default - - - Shows the default configuration of an - instance. - - - - - configuration-delete - - - Deletes a configuration group. - - - - - configuration-detach - - - Detaches a configuration group from an - instance. - - - - - configuration-instances - - - Lists all instances associated with a - configuration group. - - - - - configuration-list - - - Lists all configuration groups. - - - - - configuration-parameter-list - - - Lists available parameters for a - configuration group. - - - - - configuration-parameter-show - - - Shows details of a configuration parameter. - - - - - configuration-patch - - - Patches a configuration group. - - - - - configuration-show - - - Shows details of a configuration group. - - - - - configuration-update - - - Updates a configuration group. - - - - - create - - - Creates a new instance. - - - - - database-create - - - Creates a database on an instance. - - - - - database-delete - - - Deletes a database from an instance. - - - - - database-list - - - Lists available databases on an instance. - - - - - datastore-list - - - Lists available datastores. - - - - - datastore-show - - - Shows details of a datastore. - - - - - datastore-version-list - - - Lists available versions for a datastore. - - - - - datastore-version-show - - - Shows details of a datastore version. - - - - - delete - - - Deletes an instance. - - - - - detach-replica - - - Detaches a replica instance from its - replication source. - - - - - eject-replica-source - - - Ejects a replica source from its set. - - - - - flavor-list - - - Lists available flavors. - - - - - flavor-show - - - Shows details of a flavor. - - - - - limit-list - - - Lists the limits for a tenant. - - - - - list - - - Lists all the instances. - - - - - metadata-create - - - Creates metadata in the database for - instance <id>. - - - - - metadata-delete - - - Deletes metadata for instance <id>. - - - - - metadata-edit - - - Replaces metadata value with a new one, this - is non-destructive. - - - - - metadata-list - - - Shows all metadata for instance <id>. - - - - - metadata-show - - - Shows metadata entry for key <key> and - instance <id>. - - - - - metadata-update - - - Updates metadata, this is destructive. - - - - - promote-to-replica-source - - - Promotes a replica to be the new replica - source of its set. - - - - - resize-instance - - - Resizes an instance with a new flavor. - - - - - resize-volume - - - Resizes the volume size of an instance. - - - - - restart - - - Restarts an instance. - - - - - root-enable - - - Enables root for an instance and resets if - already exists. - - - - - root-show - - - Gets status if root was ever enabled for an - instance or cluster. - - - - - secgroup-add-rule - - - Creates a security group rule. - - - - - secgroup-delete-rule - - - Deletes a security group rule. - - - - - secgroup-list - - - Lists all security groups. - - - - - secgroup-list-rules - - - Lists all rules for a security group. - - - - - secgroup-show - - - Shows details of a security group. - - - - - show - - - Shows details of an instance. - - - - - update - - - Updates an instance: Edits name, - configuration, or replica source. - - - - - user-create - - - Creates a user on an instance. - - - - - user-delete - - - Deletes a user from an instance. - - - - - user-grant-access - - - Grants access to a database(s) for a user. - - - - - user-list - - - Lists the users for an instance. - - - - - user-revoke-access - - - Revokes access to a database for a user. - - - - - user-show - - - Shows details of a user of an instance. - - - - - user-show-access - - - Shows access details of a user of an - instance. - - - - - user-update-attributes - - - Updates a user's attributes on an instance. - - - - - bash-completion - - - Prints arguments for bash_completion. - - - - - help - - - Displays help about this program or one of - its subcommands. - - - - -
-
- trove optional arguments - - - --version - - - show program's version number and exit - - - - - --debug - - - Print debugging output. - - - - - --os-auth-system <auth-system> - - - Defaults to env[OS_AUTH_SYSTEM]. - - - - - --service-type <service-type> - - - Defaults to database for most actions. - - - - - --service-name <service-name> - - - Defaults to env[TROVE_SERVICE_NAME]. - - - - - --bypass-url <bypass-url> - - - Defaults to env[TROVE_BYPASS_URL]. - - - - - --database-service-name <database-service-name> - - - Defaults to - env[TROVE_DATABASE_SERVICE_NAME]. - - - - - --endpoint-type <endpoint-type> - - - Defaults to env[TROVE_ENDPOINT_TYPE] or - publicURL. - - - - - --os-database-api-version <database-api-ver> - - - Accepts 1, defaults to - env[OS_DATABASE_API_VERSION]. - - - - - --retries <retries> - - - Number of retries. - - - - - --json, --os-json-output - - - Output JSON instead of prettyprint. Defaults - to env[OS_JSON_OUTPUT]. - - - - - --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 <ca-certificate> - - - Specify a CA bundle file to use in verifying - a TLS (https) server certificate. Defaults - to env[OS_CACERT]. - - - - - --os-cert <certificate> - - - Defaults to env[OS_CERT]. - - - - - --os-key <key> - - - Defaults to env[OS_KEY]. - - - - - --timeout <seconds> - - - 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-user-name OS_USERNAME, --os-username 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 - - - - - --os-tenant-name <auth-tenant-name> - - - Tenant to request authorization on. Defaults - to env[OS_TENANT_NAME]. - - - - - --os-tenant-id <tenant-id> - - - Tenant to request authorization on. Defaults - to env[OS_TENANT_ID]. - - - - - --os-auth-token OS_AUTH_TOKEN - - - Defaults to env[OS_AUTH_TOKEN] - - - - - --os-region-name <region-name> - - - Specify the region to use. Defaults to - env[OS_REGION_NAME]. - - - - -
-
- trove backup-copy - usage: trove backup-copy <name> <backup> - [--region <region>] [--description <description>] - -Creates a backup from another backup. - - Positional arguments - - <name> - - - Name of the backup. - - - - - <backup> - - - Backup ID of the source backup. - - - - - - Optional arguments - - --region <region> - - - Region where the source backup resides. - - - - - --description <description> - - - An optional description for the backup. - - - - -
-
- trove backup-create - usage: trove backup-create <instance> <name> - [--description <description>] [--parent <parent>] - -Creates a backup of an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of the backup. - - - - - - Optional arguments - - --description <description> - - - An optional description for the backup. - - - - - --parent <parent> - - - Optional ID of the parent backup to perform an - incremental backup from. - - - - -
-
- trove backup-delete - usage: trove backup-delete <backup> - -Deletes a backup. - - Positional arguments - - <backup> - - - ID of the backup. - - - - -
-
- trove backup-list - usage: trove backup-list [--limit <limit>] [--marker <ID>] - [--datastore <datastore>] - -Lists available backups. - - Optional arguments - - --limit <limit> - - - Return up to N number of the most recent backups. - - - - - --marker <ID> - - - Begin displaying the results for IDs greater than - the specified marker. When used with --limit, set - this to the last ID displayed in the previous run. - - - - - --datastore <datastore> - - - Name or ID of the datastore to list backups for. - - - - -
-
- trove backup-list-instance - usage: trove backup-list-instance [--limit <limit>] [--marker <ID>] <instance> - -Lists available backups for an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - - Optional arguments - - --limit <limit> - - - Return up to N number of the most recent backups. - - - - - --marker <ID> - - - Begin displaying the results for IDs greater than the - specified marker. When used with --limit, set this to the - last ID displayed in the previous run. - - - - -
-
- trove backup-show - usage: trove backup-show <backup> - -Shows details of a backup. - - Positional arguments - - <backup> - - - ID of the backup. - - - - -
-
- trove cluster-create - usage: trove cluster-create <name> <datastore> <datastore_version> - [--instance <opt=value,opt=value,...>] - -Creates a new cluster. - - Positional arguments - - <name> - - - Name of the cluster. - - - - - <datastore> - - - A datastore name or ID. - - - - - <datastore_version> - - - A datastore version name or ID. - - - - - - Optional arguments - - --instance <opt=value,opt=value,...> - - - Create an instance for the cluster. Specify - multiple times to create multiple instances. - Valid options are: flavor=flavor_name_or_id, - volume=disk_size_in_GB, nic='net-id=net- - uuid,v4-fixed-ip=ip-addr,port-id=port-uuid' - (where net-id=network_id, v4-fixed- - ip=IPv4r_fixed_address, port-id=port_id), - availability_zone=AZ_hint_for_Nova. - - - - -
-
- trove cluster-delete - usage: trove cluster-delete <cluster> - -Deletes a cluster. - - Positional arguments - - <cluster> - - - ID or name of the cluster. - - - - -
-
- trove cluster-grow - usage: trove cluster-grow <cluster> - [--instance <name=name,flavor=flavor_name_or_id,volume=volume>] - -Adds more instances to a cluster. - - Positional arguments - - <cluster> - - - ID or name of the cluster. - - - - - - Optional arguments - - --instance <name=name,flavor=flavor_name_or_id,volume=volume> - - - Add an instance to the cluster. Specify - multiple times to create multiple instances. - - - - -
-
- trove cluster-instances - usage: trove cluster-instances <cluster> - -Lists all instances of a cluster. - - Positional arguments - - <cluster> - - - ID or name of the cluster. - - - - -
-
- trove cluster-list - usage: trove cluster-list [--limit <limit>] [--marker <ID>] - -Lists all the clusters. - - Optional arguments - - --limit <limit> - - - Limit the number of results displayed. - - - - - --marker <ID> - - - Begin displaying the results for IDs greater than the - specified marker. When used with --limit, set this to the - last ID displayed in the previous run. - - - - -
-
- trove cluster-show - usage: trove cluster-show <cluster> - -Shows details of a cluster. - - Positional arguments - - <cluster> - - - ID or name of the cluster. - - - - -
-
- trove cluster-shrink - usage: trove cluster-shrink <cluster> <instance> [<instance> ...] - -Drops instances from a cluster. - - Positional arguments - - <cluster> - - - ID or name of the cluster. - - - - - <instance> - - - Drop instance(s) from the cluster. Specify multiple ids to drop - multiple instances. - - - - -
-
- trove configuration-attach - usage: trove configuration-attach <instance> <configuration> - -Attaches a configuration group to an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <configuration> - - - ID of the configuration group to attach to the instance. - - - - -
-
- trove configuration-create - usage: trove configuration-create <name> <values> - [--datastore <datastore>] - [--datastore_version <datastore_version>] - [--description <description>] - -Creates a configuration group. - - Positional arguments - - <name> - - - Name of the configuration group. - - - - - <values> - - - Dictionary of the values to set. - - - - - - Optional arguments - - --datastore <datastore> - - - Datastore assigned to the configuration - group. Required if default datastore is not - configured. - - - - - --datastore_version <datastore_version> - - - Datastore version ID assigned to the - configuration group. - - - - - --description <description> - - - An optional description for the - configuration group. - - - - -
-
- trove configuration-default - usage: trove configuration-default <instance> - -Shows the default configuration of an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove configuration-delete - usage: trove configuration-delete <configuration_group> - -Deletes a configuration group. - - Positional arguments - - <configuration_group> - - - ID of the configuration group. - - - - -
-
- trove configuration-detach - usage: trove configuration-detach <instance> - -Detaches a configuration group from an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove configuration-instances - usage: trove configuration-instances <configuration_group> - -Lists all instances associated with a configuration group. - - Positional arguments - - <configuration_group> - - - ID of the configuration group. - - - - -
-
- trove configuration-list - usage: trove configuration-list - -Lists all configuration groups. - -
-
- trove configuration-parameter-list - usage: trove configuration-parameter-list <datastore_version> - [--datastore <datastore>] - -Lists available parameters for a configuration group. - - Positional arguments - - <datastore_version> - - - Datastore version name or ID assigned to the - configuration group. - - - - - - Optional arguments - - --datastore <datastore> - - - ID or name of the datastore to list configuration - parameters for. Optional if the ID of the - datastore_version is provided. - - - - -
-
- trove configuration-parameter-show - usage: trove configuration-parameter-show <datastore_version> <parameter> - [--datastore <datastore>] - -Shows details of a configuration parameter. - - Positional arguments - - <datastore_version> - - - Datastore version name or ID assigned to the - configuration group. - - - - - <parameter> - - - Name of the configuration parameter. - - - - - - Optional arguments - - --datastore <datastore> - - - ID or name of the datastore to list configuration - parameters for. Optional if the ID of the - datastore_version is provided. - - - - -
-
- trove configuration-patch - usage: trove configuration-patch <configuration_group> <values> - -Patches a configuration group. - - Positional arguments - - <configuration_group> - - - ID of the configuration group. - - - - - <values> - - - Dictionary of the values to set. - - - - -
-
- trove configuration-show - usage: trove configuration-show <configuration_group> - -Shows details of a configuration group. - - Positional arguments - - <configuration_group> - - - ID of the configuration group. - - - - -
-
- trove configuration-update - usage: trove configuration-update <configuration_group> <values> - [--name <name>] - [--description <description>] - -Updates a configuration group. - - Positional arguments - - <configuration_group> - - - ID of the configuration group. - - - - - <values> - - - Dictionary of the values to set. - - - - - - Optional arguments - - --name <name> - - - Name of the configuration group. - - - - - --description <description> - - - An optional description for the configuration - group. - - - - -
-
- trove create - usage: trove create <name> <flavor> - [--size <size>] - [--databases <databases> [<databases> ...]] - [--users <users> [<users> ...]] [--backup <backup>] - [--availability_zone <availability_zone>] - [--datastore <datastore>] - [--datastore_version <datastore_version>] - [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid>] - [--configuration <configuration>] - [--replica_of <source_instance>] [--replica_count <count>] - -Creates a new instance. - - Positional arguments - - <name> - - - Name of the instance. - - - - - <flavor> - - - Flavor ID or name of the instance. - - - - - - Optional arguments - - --size <size> - - - Size of the instance disk volume in GB. - Required when volume support is enabled. - - - - - --databases <databases> [<databases> ...] - - - Optional list of databases. - - - - - --users <users> [<users> ...] - - - Optional list of users in the form - user:password. - - - - - --backup <backup> - - - A backup ID. - - - - - --availability_zone <availability_zone> - - - The Zone hint to give to nova. - - - - - --datastore <datastore> - - - A datastore name or ID. - - - - - --datastore_version <datastore_version> - - - A datastore version name or ID. - - - - - --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid> - - - Create a NIC on the instance. Specify option - multiple times to create multiple NICs. net- - id: attach NIC to network with this ID - (either port-id or net-id must be - specified), v4-fixed-ip: IPv4 fixed address - for NIC (optional), port-id: attach NIC to - port with this ID (either port-id or net-id - must be specified). - - - - - --configuration <configuration> - - - ID of the configuration group to attach to - the instance. - - - - - --replica_of <source_instance> - - - ID or name of an existing instance to - replicate from. - - - - - --replica_count <count> - - - Number of replicas to create (defaults to - 1). - - - - -
-
- trove database-create - usage: trove database-create <instance> <name> - [--character_set <character_set>] - [--collate <collate>] - -Creates a database on an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of the database. - - - - - - Optional arguments - - --character_set <character_set> - - - Optional character set for database. - - - - - --collate <collate> - - - Optional collation type for database. - - - - -
-
- trove database-delete - usage: trove database-delete <instance> <database> - -Deletes a database from an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <database> - - - Name of the database. - - - - -
-
- trove database-list - usage: trove database-list <instance> - -Lists available databases on an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove datastore-list - usage: trove datastore-list - -Lists available datastores. - -
-
- trove datastore-show - usage: trove datastore-show <datastore> - -Shows details of a datastore. - - Positional arguments - - <datastore> - - - ID of the datastore. - - - - -
-
- trove datastore-version-list - usage: trove datastore-version-list <datastore> - -Lists available versions for a datastore. - - Positional arguments - - <datastore> - - - ID or name of the datastore. - - - - -
-
- trove datastore-version-show - usage: trove datastore-version-show <datastore_version> - [--datastore <datastore>] - -Shows details of a datastore version. - - Positional arguments - - <datastore_version> - - - ID or name of the datastore version. - - - - - - Optional arguments - - --datastore <datastore> - - - ID or name of the datastore. Optional if the ID of - the datastore_version is provided. - - - - -
-
- trove delete - usage: trove delete <instance> - -Deletes an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove detach-replica - usage: trove detach-replica <instance> - -Detaches a replica instance from its replication source. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove eject-replica-source - usage: trove eject-replica-source <instance> - -Ejects a replica source from its set. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove flavor-list - usage: trove flavor-list [--datastore_type <datastore_type>] - [--datastore_version_id <datastore_version_id>] - -Lists available flavors. - - Optional arguments - - --datastore_type <datastore_type> - - - Type of the datastore. For eg: mysql. - - - - - --datastore_version_id <datastore_version_id> - - - ID of the datastore version. - - - - -
-
- trove flavor-show - usage: trove flavor-show <flavor> - -Shows details of a flavor. - - Positional arguments - - <flavor> - - - ID or name of the flavor. - - - - -
-
- trove limit-list - usage: trove limit-list - -Lists the limits for a tenant. - -
-
- trove list - usage: trove list [--limit <limit>] [--marker <ID>] [--include-clustered] - -Lists all the instances. - - Optional arguments - - --limit <limit> - - - Limit the number of results displayed. - - - - - --marker <ID> - - - Begin displaying the results for IDs greater than the - specified marker. When used with --limit, set this to - the last ID displayed in the previous run. - - - - - --include-clustered - - - Include instances that are part of a cluster (default - false). - - - - -
-
- trove metadata-create - usage: trove metadata-create <instance_id> <key> <value> - -Creates metadata in the database for instance <id>. - - Positional arguments - - <instance_id> - - - UUID for instance. - - - - - <key> - - - Key for assignment. - - - - - <value> - - - Value to assign to <key>. - - - - -
-
- trove metadata-delete - usage: trove metadata-delete <instance_id> <key> - -Deletes metadata for instance <id>. - - Positional arguments - - <instance_id> - - - UUID for instance. - - - - - <key> - - - Metadata key to delete. - - - - -
-
- trove metadata-edit - usage: trove metadata-edit <instance_id> <key> <value> - -Replaces metadata value with a new one, this is non-destructive. - - Positional arguments - - <instance_id> - - - UUID for instance. - - - - - <key> - - - Key to replace. - - - - - <value> - - - New value to assign to <key>. - - - - -
-
- trove metadata-list - usage: trove metadata-list <instance_id> - -Shows all metadata for instance <id>. - - Positional arguments - - <instance_id> - - - UUID for instance. - - - - -
-
- trove metadata-show - usage: trove metadata-show <instance_id> <key> - -Shows metadata entry for key <key> and instance <id>. - - Positional arguments - - <instance_id> - - - UUID for instance. - - - - - <key> - - - Key to display. - - - - -
-
- trove metadata-update - usage: trove metadata-update <instance_id> <key> <newkey> <value> - -Updates metadata, this is destructive. - - Positional arguments - - <instance_id> - - - UUID for instance. - - - - - <key> - - - Key to update. - - - - - <newkey> - - - New key. - - - - - <value> - - - Value to assign to <newkey>. - - - - -
-
- trove promote-to-replica-source - usage: trove promote-to-replica-source <instance> - -Promotes a replica to be the new replica source of its set. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove resize-instance - usage: trove resize-instance <instance> <flavor> - -Resizes an instance with a new flavor. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <flavor> - - - New flavor of the instance. - - - - -
-
- trove resize-volume - usage: trove resize-volume <instance> <size> - -Resizes the volume size of an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <size> - - - New size of the instance disk volume in GB. - - - - -
-
- trove restart - usage: trove restart <instance> - -Restarts an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove root-enable - usage: trove root-enable <instance_or_cluster> - [--root_password <root_password>] - -Enables root for an instance and resets if already exists. - - Positional arguments - - <instance_or_cluster> - - - ID or name of the instance or cluster. - - - - - - Optional arguments - - --root_password <root_password> - - - Root password to set. - - - - -
-
- trove root-show - usage: trove root-show <instance_or_cluster> - -Gets status if root was ever enabled for an instance or cluster. - - Positional arguments - - <instance_or_cluster> - - - ID or name of the instance or cluster. - - - - -
-
- trove secgroup-add-rule - usage: trove secgroup-add-rule <security_group> <cidr> - -Creates a security group rule. - - Positional arguments - - <security_group> - - - Security group ID. - - - - - <cidr> - - - CIDR address. - - - - -
-
- trove secgroup-delete-rule - usage: trove secgroup-delete-rule <security_group_rule> - -Deletes a security group rule. - - Positional arguments - - <security_group_rule> - - - Name of security group rule. - - - - -
-
- trove secgroup-list - usage: trove secgroup-list - -Lists all security groups. - -
-
- trove secgroup-list-rules - usage: trove secgroup-list-rules <security_group> - -Lists all rules for a security group. - - Positional arguments - - <security_group> - - - Security group ID. - - - - -
-
- trove secgroup-show - usage: trove secgroup-show <security_group> - -Shows details of a security group. - - Positional arguments - - <security_group> - - - Security group ID. - - - - -
-
- trove show - usage: trove show <instance> - -Shows details of an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove update - usage: trove update <instance> - [--name <name>] [--configuration <configuration>] - [--detach-replica-source] [--remove_configuration] - -Updates an instance: Edits name, configuration, or replica source. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - - Optional arguments - - --name <name> - - - Name of the instance. - - - - - --configuration <configuration> - - - ID of the configuration reference to attach. - - - - - --detach-replica-source - - - Detach the replica instance from its - replication source. - - - - - --remove_configuration - - - Drops the current configuration reference. - - - - -
-
- trove user-create - usage: trove user-create <instance> <name> <password> - [--host <host>] - [--databases <databases> [<databases> ...]] - -Creates a user on an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of user. - - - - - <password> - - - Password of user. - - - - - - Optional arguments - - --host <host> - - - Optional host of user. - - - - - --databases <databases> [<databases> ...] - - - Optional list of databases. - - - - -
-
- trove user-delete - usage: trove user-delete [--host <host>] <instance> <name> - -Deletes a user from an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of user. - - - - - - Optional arguments - - --host <host> - - - Optional host of user. - - - - -
-
- trove user-grant-access - usage: trove user-grant-access <instance> <name> <databases> [<databases> ...] - [--host <host>] - -Grants access to a database(s) for a user. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of user. - - - - - <databases> - - - List of databases. - - - - - - Optional arguments - - --host <host> - - - Optional host of user. - - - - -
-
- trove user-list - usage: trove user-list <instance> - -Lists the users for an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - -
-
- trove user-revoke-access - usage: trove user-revoke-access [--host <host>] <instance> <name> <database> - -Revokes access to a database for a user. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of user. - - - - - <database> - - - A single database. - - - - - - Optional arguments - - --host <host> - - - Optional host of user. - - - - -
-
- trove user-show - usage: trove user-show [--host <host>] <instance> <name> - -Shows details of a user of an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of user. - - - - - - Optional arguments - - --host <host> - - - Optional host of user. - - - - -
-
- trove user-show-access - usage: trove user-show-access [--host <host>] <instance> <name> - -Shows access details of a user of an instance. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of user. - - - - - - Optional arguments - - --host <host> - - - Optional host of user. - - - - -
-
- trove user-update-attributes - usage: trove user-update-attributes <instance> <name> - [--host <host>] [--new_name <new_name>] - [--new_password <new_password>] - [--new_host <new_host>] - -Updates a user's attributes on an instance. At least one optional argument -must be provided. - - Positional arguments - - <instance> - - - ID or name of the instance. - - - - - <name> - - - Name of user. - - - - - - Optional arguments - - --host <host> - - - Optional host of user. - - - - - --new_name <new_name> - - - Optional new name of user. - - - - - --new_password <new_password> - - - Optional new password of user. - - - - - --new_host <new_host> - - - Optional new host of user. - - - - -
- diff --git a/doc/cli-reference/generated/ch_cli_tuskar_commands.xml b/doc/cli-reference/generated/ch_cli_tuskar_commands.xml deleted file mode 100644 index 38ad363016..0000000000 --- a/doc/cli-reference/generated/ch_cli_tuskar_commands.xml +++ /dev/null @@ -1,585 +0,0 @@ - - - - - - - - Deployment command-line client - - The tuskar client is the command-line - interface (CLI) for the Deployment API and its extensions. - - This chapter documents tuskar version - 0.1.18. - - - For help on a specific tuskar - command, enter: - - $ tuskar COMMAND - -
- tuskar usage - usage: tuskar [-h] [--version] [-d] [--os-username OS_USERNAME] - [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] - [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] - [--os-auth-token OS_AUTH_TOKEN] [--tuskar-url TUSKAR_URL] - [--tuskar-api-version TUSKAR_API_VERSION] - <subcommand> ... - <subcommand> - plan-add-role Associate role to a plan. - plan-create Create a new plan. - plan-delete Delete an plan by its UUID. - plan-flavor Change flavor of role in the plan. - plan-list Show a list of the Plans. - plan-patch Change an existing plan [Deprecated]. - plan-remove-role Remove role from a plan. - plan-scale Scale plan by changing count of roles. - plan-show Show an individual Plan by its UUID. - plan-show-flavors Show flavors assigned to roles of Plan. - plan-show-scale Show scale counts of Plan. - plan-templates Download the Heat templates for a Plan. - plan-update Change an existing plan. - role-list Show a list of the Roles. - help Display help about this program or one of its - subcommands. -
-
- tuskar optional arguments - - - -h, --help - - - Print this help message and exit. - - - - - --version - - - Shows the client version and exits. - - - - - -d, --debug - - - Defaults to env[TUSKARCLIENT_DEBUG]. - - - - - --os-username OS_USERNAME - - - Defaults to env[OS_USERNAME] - - - - - --os-password OS_PASSWORD - - - Defaults to env[OS_PASSWORD] - - - - - --os-tenant-id OS_TENANT_ID - - - Defaults to env[OS_TENANT_ID] - - - - - --os-tenant-name OS_TENANT_NAME - - - Defaults to env[OS_TENANT_NAME] - - - - - --os-auth-url OS_AUTH_URL - - - Defaults to env[OS_AUTH_URL] - - - - - --os-auth-token OS_AUTH_TOKEN - - - Defaults to env[OS_AUTH_TOKEN] - - - - - --tuskar-url TUSKAR_URL - - - Defaults to env[TUSKAR_URL] - - - - - --tuskar-api-version TUSKAR_API_VERSION - - - Defaults to env[TUSKAR_API_VERSION] or 2 - - - - -
-
- tuskar plan-add-role - usage: tuskar plan-add-role [-h] -r <ROLE UUID> plan_uuid - -Associate role to a plan. - - Positional arguments - - plan_uuid - - - UUID of the Plan to assign role to. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -r <ROLE UUID>, --role-uuid <ROLE UUID> - - - UUID of the Role to be assigned. - - - - -
-
- tuskar plan-create - usage: tuskar plan-create [-h] [-d <DESCRIPTION>] name - -Create a new plan. - - Positional arguments - - name - - - Name of the Plan to create. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -d <DESCRIPTION>, --description <DESCRIPTION> - - - User-readable text describing the Plan. - - - - -
-
- tuskar plan-delete - usage: tuskar plan-delete [-h] <PLAN> - -Delete an plan by its UUID. - - Positional arguments - - <PLAN> - - - UUID of the plan to delete. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- tuskar plan-flavor - usage: tuskar plan-flavor [-h] -F FLAVOR role_name plan_uuid - -Change flavor of role in the plan. - - Positional arguments - - role_name - - - Name of role which you want to flavor. - - - - - plan_uuid - - - UUID of the Plan to modify. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -F FLAVOR, --flavor FLAVOR - - - Flavor which shall be assigned to role. - - - - -
-
- tuskar plan-list - usage: tuskar plan-list [-h] - -Show a list of the Plans. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- tuskar plan-remove-role - usage: tuskar plan-remove-role [-h] -r <ROLE UUID> plan_uuid - -Remove role from a plan. - - Positional arguments - - plan_uuid - - - UUID of the Plan to remove role from. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -r <ROLE UUID>, --role-uuid <ROLE UUID> - - - UUID of the Role to be removed. - - - - -
-
- tuskar plan-scale - usage: tuskar plan-scale [-h] -C COUNT role_name plan_uuid - -Scale plan by changing count of roles. - - Positional arguments - - role_name - - - Name of role which you want scale. - - - - - plan_uuid - - - UUID of the Plan to modify. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -C COUNT, --count COUNT - - - Count of nodes to be set. - - - - -
-
- tuskar plan-show - usage: tuskar plan-show [-h] [--verbose] [--only-empty-parameters] <PLAN> - -Show an individual Plan by its UUID. - - Positional arguments - - <PLAN> - - - UUID of the Plan to show. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - --verbose - - - Display full plan details - - - - - --only-empty-parameters - - - Display only parameters with empty or None value - - - - -
-
- tuskar plan-show-flavors - usage: tuskar plan-show-flavors [-h] <PLAN> - -Show flavors assigned to roles of Plan. - - Positional arguments - - <PLAN> - - - UUID of the Plan to show a scale. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- tuskar plan-show-scale - usage: tuskar plan-show-scale [-h] <PLAN> - -Show scale counts of Plan. - - Positional arguments - - <PLAN> - - - UUID of the Plan to show a scale. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
-
- tuskar plan-templates - usage: tuskar plan-templates [-h] -O <OUTPUT DIR> plan_uuid - -Download the Heat templates for a Plan. - - Positional arguments - - plan_uuid - - - UUID of the Plan whose Templates will be retrieved. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -O <OUTPUT DIR>, --output-dir <OUTPUT DIR> - - - Directory to write template files into. It will be - created if it does not exist. - - - - -
-
- tuskar plan-update - usage: tuskar plan-update [-h] [-A <KEY1=VALUE1>] [-P <KEY1=VALUE1>] plan_uuid - -Change an existing plan. - - Positional arguments - - plan_uuid - - - UUID of the Plan to modify. - - - - - - Optional arguments - - -h, --help - - - show this help message and exit - - - - - -A <KEY1=VALUE1>, --attribute <KEY1=VALUE1> - - - This can be specified multiple times. This argument is - deprecated, use -P and --parameter instead. - - - - - -P <KEY1=VALUE1>, --parameter <KEY1=VALUE1> - - - This can be specified multiple times. - - - - -
-
- tuskar role-list - usage: tuskar role-list [-h] - -Show a list of the Roles. - - Optional arguments - - -h, --help - - - show this help message and exit - - - - -
- diff --git a/doc/cli-reference/pom.xml b/doc/cli-reference/pom.xml deleted file mode 100644 index 9ed6f9522a..0000000000 --- a/doc/cli-reference/pom.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - org.openstack.docs - parent-pom - 1.0.0-SNAPSHOT - ../pom.xml - - 4.0.0 - openstack-cli-reference - jar - OpenStack Command-Line Interface Reference - - - local - 0 - - - - - - - - com.rackspace.cloud.api - clouddocs-maven-plugin - - - - generate-webhelp - - generate-webhelp - - generate-sources - - - 0 - os-image-guide - 1 - UA-17511903-1 - - appendix toc,title - article/appendix nop - article toc,title - book toc,title,figure,table,example,equation - chapter toc - section toc - part toc - preface toc - qandadiv toc - qandaset toc - reference toc,title - set toc,title - - - 0 - 0 - 1 - 1 - 0 - cli-reference - cli-reference - - - - - - enduser - true - . - - bk-cli-reference.xml - - openstack - http://docs.openstack.org/cli-reference/content - - - - - diff --git a/doc/cli-reference/section_cli_glance_property_keys.xml b/doc/cli-reference/section_cli_glance_property_keys.xml deleted file mode 100644 index dd6ba21279..0000000000 --- a/doc/cli-reference/section_cli_glance_property_keys.xml +++ /dev/null @@ -1,482 +0,0 @@ - - -%openstack; -]> -
- - Image service property keys - The following keys, together with the components to which they are specific, can be used - with the option for both the glance - image-update and glance image-create commands. For - example: - $ glance image-update IMG-UUID --property architecture=x86_64 - Behavior set using image properties overrides - behavior set using flavors. For more information, refer to - - OpenStack Cloud Administrator Guide - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Property keys
Specific toKeyDescriptionSupported values
AllarchitectureThe CPU architecture that must be supported by - the hypervisor. For example, - x86_64, arm, or ppc64. Run - uname -m to get the architecture of a - machine. We strongly recommend using the architecture data vocabulary - defined by the libosinfo project - for this purpose. - - alpha—DEC 64-bit RISC - armv7l—ARM Cortex-A7 MPCore - cris—Ethernet, Token Ring, AXis—Code Reduced Instruction Set - i686—Intel sixth-generation x86 - (P6 micro architecture) - ia64—Itanium - lm32—Lattice Micro32 - m68k—Motorola 68000 - microblaze—Xilinx 32-bit FPGA (Big Endian) - microblazeel—Xilinx 32-bit FPGA (Little Endian) - mips—MIPS 32-bit RISC (Big Endian) - mipsel—MIPS 32-bit RISC (Little Endian) - mips64—MIPS 64-bit RISC (Big Endian) - mips64el—MIPS 64-bit RISC (Little Endian) - openrisc—OpenCores RISC - parisc—HP Precision Architecture RISC - parisc64—HP Precision Architecture 64-bit RISC - ppc—PowerPC 32-bit - ppc64—PowerPC 64-bit - ppcemb—PowerPC (Embedded 32-bit) - s390—IBM Enterprise Systems Architecture/390 - s390x—S/390 64-bit - sh4—SuperH SH-4 (Little Endian) - sh4eb—SuperH SH-4 (Big Endian) - sparc—Scalable Processor Architecture, 32-bit - sparc64—Scalable Processor Architecture, 64-bit - unicore32—Microprocessor Research and Development Center - RISC Unicore32 - x86_64—64-bit extension of IA-32 - xtensa—Tensilica Xtensa configurable microprocessor core - xtensaeb—Tensilica Xtensa configurable microprocessor core - (Big Endian) - -
Allhypervisor_typeThe hypervisor type. Note that - qemu is used for both QEMU and KVM - hypervisor types. - hyperv, - ironic, - lxc, - qemu, - uml, - vmware, or - xen. -
Allinstance_type_rxtx_factorOptional property allows created servers to have a different bandwidth cap than - that defined in the network they are attached to. This factor is multiplied by - the rxtx_base property of the network. The rxtx_base property defaults to 1.0, - which is the same as the attached network. This parameter is only available for - Xen or NSX based systems.Float (default value is 1.0)
Allinstance_uuidFor snapshot images, this is the UUID of the server used to create this image.Valid server UUID
Allimg_config_driveSpecifies whether the image needs a config drive.mandatory or optional (default if property is not used).
Allkernel_idThe ID of an image stored in the Image service that should be used as the kernel - when booting an AMI-style image.Valid image ID
Allos_distroThe common name of the operating system distribution in lowercase (uses the same - data vocabulary as the libosinfo - project). Specify only a recognized value for this field. Deprecated - values are listed to assist you in searching for the recognized value. - - arch—Arch Linux. Do not use archlinux or - org.archlinux - centos—Community Enterprise Operating System. Do not use - org.centos or - CentOS - debian—Debian. Do not use Debian or - org.debian - fedora—Fedora. Do not use Fedora, - org.fedora, or - org.fedoraproject - freebsd—FreeBSD. Do not use org.freebsd, - freeBSD, or FreeBSD - gentoo—Gentoo Linux. Do not use Gentoo or - org.gentoo - mandrake—Mandrakelinux (MandrakeSoft) distribution. Do not use - mandrakelinux or - MandrakeLinux - mandriva—Mandriva Linux. Do not use - mandrivalinux - mes—Mandriva Enterprise Server. Do not use - mandrivaent or - mandrivaES - msdos—Microsoft Disc Operating System. Do not use - ms-dos - netbsd—NetBSD. Do not use NetBSD or - org.netbsd - netware—Novell NetWare. Do not use novell or - NetWare - openbsd—OpenBSD. Do not use OpenBSD or - org.openbsd - opensolaris—OpenSolaris. Do not use OpenSolaris - or org.opensolaris - opensuse—openSUSE. Do not use suse, - SuSE, or - org.opensuse - rhel—Red Hat Enterprise Linux. Do not use - redhat, RedHat, or - com.redhat - sled—SUSE Linux Enterprise Desktop. Do not use - com.suse - ubuntu—Ubuntu. Do not use Ubuntu, - com.ubuntu, org.ubuntu, or - canonical - windows—Microsoft Windows. Do not use - com.microsoft.server or - windoze - -
Allos_versionThe operating system version as specified by the distributor.Version number (for example, "11.10")
Allramdisk_idThe ID of image stored in the Image service that should be used as the ramdisk - when booting an AMI-style image.Valid image ID
Allvm_modeThe virtual machine mode. This represents the host/guest ABI (application binary - interface) used for the virtual machine. - - hvm—Fully virtualized. This is the mode used by QEMU and - KVM. - xen—Xen 3.0 paravirtualized. - uml—User Mode Linux paravirtualized. - exe—Executables in containers. This is the mode used by - LXC. - -
libvirt API driverhw_cpu_socketsThe preferred number of sockets to expose to the guest.Integer
libvirt API driverhw_cpu_coresThe preferred number of cores to expose to the guest.Integer
libvirt API driverhw_cpu_threadsThe preferred number of threads to expose to the guest.Integer
libvirt API driverhw_disk_busSpecifies the type of disk controller to attach - disk devices to. - One of scsi, - virtio, uml, - xen, ide, or - usb. -
libvirt API driverhw_rng_modelAdds a random-number generator device to the image's instances. The cloud - administrator can enable and control device behavior by configuring the - instance's flavor. By default: - - The generator device is disabled. - /dev/random is used as the default entropy source. To specify a - physical HW RNG device, use the following option in the - nova.conf file: - rng_dev_path=/dev/hwrng - - virtio, or other supported device.
libvirt API driver, Hyper-V driverhw_machine_typelibvirt: Enables booting an ARM system using the specified machine type. By default, if - an ARM image is used and its type is not specified, Compute uses - vexpress-a15 (for ARMv7) or virt (for AArch64) machine types. - - - Hyper-V: Specifies whether the Hyper-V instance will be a generation 1 or generation 2 VM. - By default, if the property is not provided, the instances will be generation 1 VMs. If the image is specific - for generation 2 VMs but the property is not provided accordingly, the instance will fail to boot. - Libvirt machine type. Valid types can be viewed by using the - virsh capabilities command (machine types are - displayed in the machine tag). - Hyper-V machine type. Acceptable values are: hyperv-gen1 - or hyperv-gen2. -
libvirt API driverhw_scsi_modelEnables the use of VirtIO SCSI (virtio-scsi) to provide block device access for - compute instances; by default, instances use VirtIO Block (virtio-blk). VirtIO - SCSI is a para-virtualized SCSI controller device that provides improved - scalability and performance, and supports advanced SCSI hardware.virtio-scsi -
libvirt API driverhw_serial_port_countSpecifies the count of serial ports that should be provided. If - is not set in the flavor's , then any count is permitted. - If is set, then this provides the default serial port count. - It is permitted to override the default serial port count, but only with a lower value.Integer
libvirt API driverhw_video_modelThe video image driver used.vga, cirrus, vmvga, - xen, or qxl
libvirt API driverhw_video_ramMaximum RAM for the video image. Used only if a - value has been set in the flavor's - and that value is higher than the value set in - hw_video_ram.Integer in MB (for example, '64')
libvirt API driverhw_watchdog_actionEnables a virtual hardware watchdog device that carries out the specified action - if the server hangs. The watchdog uses the i6300esb device (emulating a PCI - Intel 6300ESB). If hw_watchdog_action is not specified, the - watchdog is disabled. - disabled—(default) The device is not - attached. Allows the user to disable the watchdog - for the image, even if it has been enabled using the image's flavor. - - reset—Forcefully reset the guest. - poweroff—Forcefully power off the guest. - pause—Pause the guest. - none—Only enable the watchdog; do nothing if the server - hangs. - -
libvirt API driveros_command_lineThe kernel command line to be used by the libvirt driver, instead of the - default. For Linux Containers (LXC), the value is used as arguments for - initialization. This key is valid only for Amazon kernel, ramdisk, - or machine images (aki, ari, or ami). -
libvirt API driver and VMware API driverhw_vif_modelSpecifies the model of virtual network interface device to use. - - The valid options depend on the configured - hypervisor. - - - - KVM and QEMU: e1000, - ne2k_pci, - pcnet, - rtl8139, and - virtio. - - - - VMware: e1000, - e1000e, - VirtualE1000, - VirtualE1000e, - VirtualPCNet32, - VirtualSriovEthernetCard, and - VirtualVmxnet. - - - - Xen: e1000, - netfront, - ne2k_pci, - pcnet, and - rtl8139. - - - -
libvirt API driverhw_vif_multiqueue_enabledIf true, this enables the virtio-net multiqueue feature. - In this case, the driver sets the number of - queues equal to the number of guest vCPUs. - This makes the network performance scale across - a number of vCPUs. - true | false
libvirt API driverhw_boot_menuIf true, enables the BIOS bootmenu. - In cases where both the image metadata and Extra Spec are set, the - Extra Spec setting is used. This allows for flexibility in - setting/overriding the default behavior as needed.true | false
VMware API drivervmware_adaptertypeThe virtual SCSI or IDE controller used by the hypervisor.lsiLogic, lsiLogicsas, - busLogic, ide, or - paraVirtual
VMware API drivervmware_ostypeA VMware GuestID which describes the operating system installed in the image. - This value is passed to the hypervisor when creating a virtual machine. If not - specified, the key defaults to otherGuest.See thinkvirt.com.
VMware API drivervmware_image_versionCurrently unused.1
XenAPI driverauto_disk_configIf true, the root partition on the disk is automatically resized before the - instance boots. This value is only taken into account by the Compute service - when using a Xen-based hypervisor with the XenAPI driver. The Compute service - will only attempt to resize if there is a single partition on the image, and - only if the partition is in ext3 or ext4 - format.true | false
XenAPI driveros_typeThe operating system installed on the image. The XenAPI driver contains logic - that takes different actions depending on the value of the - os_type parameter of the image. For example, for - os_type=windows images, it creates a FAT32-based swap - partition instead of a Linux swap partition, and it limits the injected host - name to less than 16 characters.linux or windows
-
diff --git a/doc/cli-ref-rst/setup.cfg b/doc/cli-reference/setup.cfg similarity index 100% rename from doc/cli-ref-rst/setup.cfg rename to doc/cli-reference/setup.cfg diff --git a/doc/cli-ref-rst/setup.py b/doc/cli-reference/setup.py similarity index 100% rename from doc/cli-ref-rst/setup.py rename to doc/cli-reference/setup.py diff --git a/doc/cli-ref-rst/source/barbican.rst b/doc/cli-reference/source/barbican.rst similarity index 100% rename from doc/cli-ref-rst/source/barbican.rst rename to doc/cli-reference/source/barbican.rst diff --git a/doc/cli-ref-rst/source/ceilometer.rst b/doc/cli-reference/source/ceilometer.rst similarity index 100% rename from doc/cli-ref-rst/source/ceilometer.rst rename to doc/cli-reference/source/ceilometer.rst diff --git a/doc/cli-ref-rst/source/cinder.rst b/doc/cli-reference/source/cinder.rst similarity index 100% rename from doc/cli-ref-rst/source/cinder.rst rename to doc/cli-reference/source/cinder.rst diff --git a/doc/cli-ref-rst/source/cloudkitty.rst b/doc/cli-reference/source/cloudkitty.rst similarity index 100% rename from doc/cli-ref-rst/source/cloudkitty.rst rename to doc/cli-reference/source/cloudkitty.rst diff --git a/doc/cli-ref-rst/source/common b/doc/cli-reference/source/common similarity index 100% rename from doc/cli-ref-rst/source/common rename to doc/cli-reference/source/common diff --git a/doc/cli-ref-rst/source/conf.py b/doc/cli-reference/source/conf.py similarity index 99% rename from doc/cli-ref-rst/source/conf.py rename to doc/cli-reference/source/conf.py index eee8ffe192..66874ae66f 100644 --- a/doc/cli-ref-rst/source/conf.py +++ b/doc/cli-reference/source/conf.py @@ -77,7 +77,7 @@ release = '0.9' # gitsha: The SHA checksum of the bug description. Automatically extracted from git log. # bug_tag: Tag for categorizing the bug. Must be set manually. # These variables are passed to the logabug code via html_context. -giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/cli-ref-rst/source' +giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/cli-reference/source' git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" gitsha = os.popen(git_cmd).read().strip('\n') html_context = {"gitsha": gitsha, "bug_tag": bug_tag, @@ -209,7 +209,7 @@ html_show_sourcelink = False # html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'cli-ref-rst' +htmlhelp_basename = 'cli-reference' # If true, publish source files html_copy_source = False diff --git a/doc/cli-ref-rst/source/designate.rst b/doc/cli-reference/source/designate.rst similarity index 100% rename from doc/cli-ref-rst/source/designate.rst rename to doc/cli-reference/source/designate.rst diff --git a/doc/cli-ref-rst/source/glance.rst b/doc/cli-reference/source/glance.rst similarity index 100% rename from doc/cli-ref-rst/source/glance.rst rename to doc/cli-reference/source/glance.rst diff --git a/doc/cli-ref-rst/source/glance_property_keys.rst b/doc/cli-reference/source/glance_property_keys.rst similarity index 100% rename from doc/cli-ref-rst/source/glance_property_keys.rst rename to doc/cli-reference/source/glance_property_keys.rst diff --git a/doc/cli-ref-rst/source/gnocchi.rst b/doc/cli-reference/source/gnocchi.rst similarity index 100% rename from doc/cli-ref-rst/source/gnocchi.rst rename to doc/cli-reference/source/gnocchi.rst diff --git a/doc/cli-ref-rst/source/heat.rst b/doc/cli-reference/source/heat.rst similarity index 100% rename from doc/cli-ref-rst/source/heat.rst rename to doc/cli-reference/source/heat.rst diff --git a/doc/cli-ref-rst/source/index.rst b/doc/cli-reference/source/index.rst similarity index 100% rename from doc/cli-ref-rst/source/index.rst rename to doc/cli-reference/source/index.rst diff --git a/doc/cli-ref-rst/source/ironic.rst b/doc/cli-reference/source/ironic.rst similarity index 100% rename from doc/cli-ref-rst/source/ironic.rst rename to doc/cli-reference/source/ironic.rst diff --git a/doc/cli-ref-rst/source/keystone.rst b/doc/cli-reference/source/keystone.rst similarity index 100% rename from doc/cli-ref-rst/source/keystone.rst rename to doc/cli-reference/source/keystone.rst diff --git a/doc/cli-ref-rst/source/magnum.rst b/doc/cli-reference/source/magnum.rst similarity index 100% rename from doc/cli-ref-rst/source/magnum.rst rename to doc/cli-reference/source/magnum.rst diff --git a/doc/cli-ref-rst/source/manila.rst b/doc/cli-reference/source/manila.rst similarity index 100% rename from doc/cli-ref-rst/source/manila.rst rename to doc/cli-reference/source/manila.rst diff --git a/doc/cli-ref-rst/source/mistral.rst b/doc/cli-reference/source/mistral.rst similarity index 100% rename from doc/cli-ref-rst/source/mistral.rst rename to doc/cli-reference/source/mistral.rst diff --git a/doc/cli-ref-rst/source/monasca.rst b/doc/cli-reference/source/monasca.rst similarity index 100% rename from doc/cli-ref-rst/source/monasca.rst rename to doc/cli-reference/source/monasca.rst diff --git a/doc/cli-ref-rst/source/murano.rst b/doc/cli-reference/source/murano.rst similarity index 100% rename from doc/cli-ref-rst/source/murano.rst rename to doc/cli-reference/source/murano.rst diff --git a/doc/cli-ref-rst/source/neutron-debug.rst b/doc/cli-reference/source/neutron-debug.rst similarity index 100% rename from doc/cli-ref-rst/source/neutron-debug.rst rename to doc/cli-reference/source/neutron-debug.rst diff --git a/doc/cli-ref-rst/source/neutron-misc.rst b/doc/cli-reference/source/neutron-misc.rst similarity index 100% rename from doc/cli-ref-rst/source/neutron-misc.rst rename to doc/cli-reference/source/neutron-misc.rst diff --git a/doc/cli-ref-rst/source/neutron-sanity-check.rst b/doc/cli-reference/source/neutron-sanity-check.rst similarity index 100% rename from doc/cli-ref-rst/source/neutron-sanity-check.rst rename to doc/cli-reference/source/neutron-sanity-check.rst diff --git a/doc/cli-ref-rst/source/neutron.rst b/doc/cli-reference/source/neutron.rst similarity index 100% rename from doc/cli-ref-rst/source/neutron.rst rename to doc/cli-reference/source/neutron.rst diff --git a/doc/cli-ref-rst/source/nova.rst b/doc/cli-reference/source/nova.rst similarity index 100% rename from doc/cli-ref-rst/source/nova.rst rename to doc/cli-reference/source/nova.rst diff --git a/doc/cli-ref-rst/source/openstack.rst b/doc/cli-reference/source/openstack.rst similarity index 100% rename from doc/cli-ref-rst/source/openstack.rst rename to doc/cli-reference/source/openstack.rst diff --git a/doc/cli-ref-rst/source/overview.rst b/doc/cli-reference/source/overview.rst similarity index 100% rename from doc/cli-ref-rst/source/overview.rst rename to doc/cli-reference/source/overview.rst diff --git a/doc/cli-ref-rst/source/sahara.rst b/doc/cli-reference/source/sahara.rst similarity index 100% rename from doc/cli-ref-rst/source/sahara.rst rename to doc/cli-reference/source/sahara.rst diff --git a/doc/cli-ref-rst/source/senlin.rst b/doc/cli-reference/source/senlin.rst similarity index 100% rename from doc/cli-ref-rst/source/senlin.rst rename to doc/cli-reference/source/senlin.rst diff --git a/doc/cli-ref-rst/source/swift.rst b/doc/cli-reference/source/swift.rst similarity index 100% rename from doc/cli-ref-rst/source/swift.rst rename to doc/cli-reference/source/swift.rst diff --git a/doc/cli-ref-rst/source/trove-manage.rst b/doc/cli-reference/source/trove-manage.rst similarity index 100% rename from doc/cli-ref-rst/source/trove-manage.rst rename to doc/cli-reference/source/trove-manage.rst diff --git a/doc/cli-ref-rst/source/trove-misc.rst b/doc/cli-reference/source/trove-misc.rst similarity index 100% rename from doc/cli-ref-rst/source/trove-misc.rst rename to doc/cli-reference/source/trove-misc.rst diff --git a/doc/cli-ref-rst/source/trove.rst b/doc/cli-reference/source/trove.rst similarity index 100% rename from doc/cli-ref-rst/source/trove.rst rename to doc/cli-reference/source/trove.rst diff --git a/doc/cli-ref-rst/source/tuskar.rst b/doc/cli-reference/source/tuskar.rst similarity index 100% rename from doc/cli-ref-rst/source/tuskar.rst rename to doc/cli-reference/source/tuskar.rst diff --git a/doc/pom.xml b/doc/pom.xml index 0a57688bb5..e82e80be2e 100644 --- a/doc/pom.xml +++ b/doc/pom.xml @@ -10,7 +10,6 @@ pom - cli-reference glossary diff --git a/tools/build-all-rst.sh b/tools/build-all-rst.sh index 066e768f3e..c0850e34fc 100755 --- a/tools/build-all-rst.sh +++ b/tools/build-all-rst.sh @@ -12,7 +12,7 @@ if [[ $# > 0 ]] ; then fi for guide in user-guide user-guide-admin admin-guide-cloud \ - contributor-guide image-guide arch-design; do + contributor-guide image-guide arch-design cli-reference; do tools/build-rst.sh doc/$guide $GLOSSARY --build build \ --target $guide $LINKCHECK # Build it only the first time @@ -22,7 +22,7 @@ done # Draft guides # This includes guides that we publish from stable branches # as versioned like the networking-guide. -for guide in networking-guide arch-design-draft config-reference cli-ref-rst; do +for guide in networking-guide arch-design-draft config-reference; do tools/build-rst.sh doc/$guide --build build \ --target "draft/$guide" $LINKCHECK done diff --git a/www/static/.htaccess b/www/static/.htaccess index 31e27c38af..a001f11d7b 100644 --- a/www/static/.htaccess +++ b/www/static/.htaccess @@ -161,6 +161,7 @@ redirectmatch 301 "^/user-guide-admin/content/.*" /user-guide-admin/index.html redirectmatch 301 "^/admin-guide-cloud/content/.*$" /admin-guide-cloud/index.html redirectmatch 301 "^/image-guide/content/.*$" /image-guide/index.html redirectmatch 301 "^/arch-design/content/.*$" /arch-design/index.html +redirectmatch 301 "^/cli-reference/content/.*$" /cli-reference/index.html # Hot-guide has moved to heat repo redirect 301 /user-guide/hot-guide/hot.html /developer/heat/template_guide/hot_guide.html