From 9b4268e85b6b2e1eb3fc20a1f5ca0d3260f897d8 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 6 Sep 2014 13:47:03 +0200 Subject: [PATCH] CLI Ref: Add openstack command Document python-openstackclient. Add it to list of clients. Add also sahara in one list. Change-Id: Id182feaaa6e8f56c356844af7de404798618f6f4 Partial-Bug: #1208038 --- doc/cli-reference/bk-cli-reference.xml | 11 + .../generated/ch_cli_openstack_commands.xml | 6253 +++++++++++++++++ doc/common/section_cli_install.xml | 9 + doc/common/section_cli_overview.xml | 8 +- 4 files changed, 6279 insertions(+), 2 deletions(-) create mode 100644 doc/cli-reference/generated/ch_cli_openstack_commands.xml diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml index 7c1f3128b9..6cef55b201 100644 --- a/doc/cli-reference/bk-cli-reference.xml +++ b/doc/cli-reference/bk-cli-reference.xml @@ -39,6 +39,16 @@ + + 2014-09-06 + + + + Document OpenStack client. + + + + 2014-04-16 @@ -91,5 +101,6 @@ + diff --git a/doc/cli-reference/generated/ch_cli_openstack_commands.xml b/doc/cli-reference/generated/ch_cli_openstack_commands.xml new file mode 100644 index 0000000000..4e1d718a86 --- /dev/null +++ b/doc/cli-reference/generated/ch_cli_openstack_commands.xml @@ -0,0 +1,6253 @@ + + + + + + + + OpenStack client + + The openstack client is a common + OpenStack command-line interface (CLI). + + This chapter documents openstack version + 0.4.0. + + + For help on a specific openstack + command, enter: + + $ openstack COMMAND + +
+ openstack usage + usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [--debug] + [--os-auth-url <auth-url>] + [--os-domain-name <auth-domain-name>] + [--os-domain-id <auth-domain-id>] + [--os-project-name <auth-project-name>] + [--os-project-id <auth-project-id>] + [--os-username <auth-username>] + [--os-password <auth-password>] + [--os-user-domain-name <auth-user-domain-name>] + [--os-user-domain-id <auth-user-domain-id>] + [--os-project-domain-name <auth-project-domain-name>] + [--os-project-domain-id <auth-project-domain-id>] + [--os-region-name <auth-region-name>] + [--os-cacert <ca-bundle-file>] [--verify | --insecure] + [--os-default-domain <auth-domain>] [--os-token <token>] + [--os-url <url>] [--os-use-keyring] + [--os-identity-api-version <identity-api-version>] + [--os-volume-api-version <volume-api-version>] + [--os-image-api-version <image-api-version>] + [--os-compute-api-version <compute-api-version>] + [--os-object-api-version <object-api-version>] [-h] +
+
+ 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 this help message and exit + + + + + --debug + + + show tracebacks on errors + + + + + --os-auth-url <auth-url> + + + Authentication URL (Env: OS_AUTH_URL) + + + + + --os-domain-name <auth-domain-name> + + + Domain name of the requested domain-level + authorization scope (Env: OS_DOMAIN_NAME) + + + + + --os-domain-id <auth-domain-id> + + + Domain ID of the requested domain-level authorization + scope (Env: OS_DOMAIN_ID) + + + + + --os-project-name <auth-project-name> + + + Project name of the requested project-level + authorization scope (Env: OS_PROJECT_NAME) + + + + + --os-project-id <auth-project-id> + + + Project ID of the requested project-level + authorization scope (Env: OS_PROJECT_ID) + + + + + --os-username <auth-username> + + + Authentication username (Env: OS_USERNAME) + + + + + --os-password <auth-password> + + + Authentication password (Env: OS_PASSWORD) + + + + + --os-user-domain-name <auth-user-domain-name> + + + Domain name of the user (Env: OS_USER_DOMAIN_NAME) + + + + + --os-user-domain-id <auth-user-domain-id> + + + Domain ID of the user (Env: OS_USER_DOMAIN_ID) + + + + + --os-project-domain-name <auth-project-domain-name> + + + Domain name of the project which is the requested + project-level authorization scope (Env: + OS_PROJECT_DOMAIN_NAME) + + + + + --os-project-domain-id <auth-project-domain-id> + + + Domain ID of the project which is the requested + project-level authorization scope (Env: + OS_PROJECT_DOMAIN_ID) + + + + + --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-token <token> + + + Defaults to env[OS_TOKEN] + + + + + --os-url <url> + + + Defaults to env[OS_URL] + + + + + --os-use-keyring + + + Use keyring to store password, default=False (Env: + OS_USE_KEYRING) + + + + + --os-identity-api-version <identity-api-version> + + + Identity API version, default=2.0 (Env: + OS_IDENTITY_API_VERSION) + + + + + --os-volume-api-version <volume-api-version> + + + Volume API version, default=1 (Env: + OS_VOLUME_API_VERSION) + + + + + --os-image-api-version <image-api-version> + + + Image API version, default=1 (Env: + OS_IMAGE_API_VERSION) + + + + + --os-compute-api-version <compute-api-version> + + + Compute API version, default=2 (Env: + OS_COMPUTE_API_VERSION) + + + + + --os-object-api-version <object-api-version> + + + Object API version, default=1 (Env: + OS_OBJECT_API_VERSION) + + + + + -h, --help + + + Show this help message and exit + + + + +
+
+ openstack aggregate add host command + usage: openstack aggregate add host [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--prefix PREFIX] + <aggregate> <host> + +Add host to aggregate + + Positional arguments + + <aggregate> + + + Name or ID of aggregate + + + + + <host> + + + Host to add to aggregate + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack aggregate create command + usage: openstack aggregate create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--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 command + usage: openstack aggregate delete [-h] <aggregate> + +Delete an existing aggregate + + Positional arguments + + <aggregate> + + + Name or ID of aggregate to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack aggregate list command + usage: openstack aggregate list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack aggregate remove host [-h] [-f {shell,table,value}] + [-c COLUMN] [--max-width <integer>] + [--variable VARIABLE] [--prefix PREFIX] + <aggregate> <host> + +Remove host from aggregate + + Positional arguments + + <aggregate> + + + Name or ID of aggregate + + + + + <host> + + + Host to remove from aggregate + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack aggregate set command + usage: openstack aggregate set [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--name <new-name>] + [--zone <availability-zone>] + [--property <key=value>] + <aggregate> + +Set aggregate properties + + Positional arguments + + <aggregate> + + + Name or ID of aggregate to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --name <new-name> + + + New aggregate name + + + + + --zone <availability-zone> + + + Availability zone name + + + + + --property <key=value> + + + Property to add/change for this aggregate (repeat + option to set multiple properties) + + + + +
+
+ openstack aggregate show command + usage: openstack aggregate show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <aggregate> + +Show a specific aggregate + + Positional arguments + + <aggregate> + + + Name or ID of aggregate to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack backup create command + usage: openstack backup create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--container <container>] + [--name <name>] [--description <description>] + <volume> + +Create backup command + + Positional arguments + + <volume> + + + The name or ID of the volume to backup + + + + + + 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 command + usage: openstack backup delete [-h] <backup> + +Delete backup command + + Positional arguments + + <backup> + + + Name or ID of backup to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack backup list command + usage: openstack backup list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + +List backup command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack backup restore command + usage: openstack backup restore [-h] <backup> <dest-volume> + +Restore backup command + + Positional arguments + + <backup> + + + ID of backup to restore + + + + + <dest-volume> + + + ID of volume to restore to + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack backup show command + usage: openstack backup show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <backup> + +Show backup command + + Positional arguments + + <backup> + + + Name or ID of backup to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack compute agent create command + usage: openstack compute agent create [-h] [-f {shell,table,value}] + [-c COLUMN] [--max-width <integer>] + [--variable VARIABLE] [--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 command + usage: openstack 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 command + usage: openstack compute agent list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack compute agent set [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--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 list command + usage: openstack compute service list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack compute service set [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 console log show command + usage: openstack console log show [-h] [--lines <num-lines>] <server> + +Show console-log command + + Positional arguments + + <server> + + + Name or ID of server to display console log + + + + + + 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 command + usage: openstack console url show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--prefix PREFIX] + [--novnc | --xvpvnc | --spice] + <server> + +Show console-url command + + Positional arguments + + <server> + + + Name or ID of server to display console log + + + + + + 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 list command + usage: openstack container list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 show command + usage: openstack container show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <container> + +Show container information + + Positional arguments + + <container> + + + Container name to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ec2 credentials create command + usage: openstack ec2 credentials create [-h] [-f {shell,table,value}] + [-c COLUMN] [--max-width <integer>] + [--variable VARIABLE] + [--prefix PREFIX] + [--project <project>] [--user <user>] + +Create EC2 credentials + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --project <project> + + + Specify a project [admin only] + + + + + --user <user> + + + Specify a user [admin only] + + + + +
+
+ openstack ec2 credentials delete command + usage: openstack 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> + + + Specify a user [admin only] + + + + +
+
+ openstack ec2 credentials list command + usage: openstack ec2 credentials list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--user <user>] + +List EC2 credentials + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --user <user> + + + Specify a user [admin only] + + + + +
+
+ openstack ec2 credentials show command + usage: openstack ec2 credentials show [-h] [-f {shell,table,value}] + [-c COLUMN] [--max-width <integer>] + [--variable VARIABLE] [--prefix PREFIX] + [--user <user>] + <access-key> + +Show EC2 credentials + + Positional arguments + + <access-key> + + + Credentials access key + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --user <user> + + + Specify a user [admin only] + + + + +
+
+ openstack endpoint create command + usage: openstack endpoint create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--region <region>] + --publicurl <public-url> + [--adminurl <admin-url>] + [--internalurl <internal-url>] + <endpoint-service> + +Create endpoint command + + Positional arguments + + <endpoint-service> + + + New endpoint service + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --region <region> + + + New endpoint region + + + + + --publicurl <public-url> + + + New endpoint public URL + + + + + --adminurl <admin-url> + + + New endpoint admin URL + + + + + --internalurl <internal-url> + + + New endpoint internal URL + + + + +
+
+ openstack endpoint delete command + usage: openstack endpoint delete [-h] <endpoint-id> + +Delete endpoint command + + Positional arguments + + <endpoint-id> + + + ID of endpoint to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack endpoint list command + usage: openstack endpoint list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--long] + +List endpoint command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --long + + + List additional fields in output + + + + +
+
+ openstack endpoint show command + usage: openstack endpoint show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <endpoint_or_service> + +Show endpoint command + + Positional arguments + + <endpoint_or_service> + + + Endpoint ID or name, type or ID of service to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack extension list command + usage: openstack extension list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--long] [--identity] + +List extension command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --long + + + List additional fields in output + + + + + --identity + + + List extensions for the Identity API + + + + +
+
+ openstack flavor create command + usage: openstack flavor create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--id <id>] [--ram <size-mb>] + [--disk <size-gb>] [--ephemeral <size-gb>] + [--swap <size-gb>] [--vcpus <vcpus>] + [--rxtx-factor <factor>] [--public | --private] + <name> + +Create flavor command + + Positional arguments + + <name> + + + Name of the new flavor + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --id <id> + + + Unique flavor ID; 'auto' will create 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 accessible to the public (default) + + + + + --private + + + Flavor is inaccessible to the public + + + + +
+
+ openstack flavor delete command + usage: openstack flavor delete [-h] <flavor> + +Delete flavor command + + Positional arguments + + <flavor> + + + Name or ID of flavor to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack flavor list command + usage: openstack flavor list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + +List flavor command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack flavor show command + usage: openstack flavor show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <flavor> + +Show flavor command + + Positional arguments + + <flavor> + + + Name or ID of flavor to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack host list command + usage: openstack host list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack host show [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack hypervisor list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--matching <hostname>] + +List hypervisor command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --matching <hostname> + + + List hypervisors with hostnames matching the given + substring + + + + +
+
+ openstack hypervisor show command + usage: openstack hypervisor show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <id> + +Show hypervisor command + + Positional arguments + + <id> + + + ID of the hypervisor to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack image create command + usage: openstack image create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--id <id>] [--store <store>] + [--container-format <container-format>] + [--disk-format <disk-format>] + [--owner <project>] [--size <size>] + [--min-disk <disk-gb>] [--min-ram <ram-mb>] + [--location <image-url>] + [--copy-from <image-url>] [--file <file>] + [--volume <volume>] [--force] + [--checksum <checksum>] + [--protected | --unprotected] + [--public | --private] [--property <key=value>] + <name> + +Create/upload an image + + Positional arguments + + <name> + + + New image name + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --id <id> + + + Image ID to reserve + + + + + --store <store> + + + Upload image to this store + + + + + --container-format <container-format> + + + Image container format (default: bare) + + + + + --disk-format <disk-format> + + + Image disk format (default: raw) + + + + + --owner <project> + + + Image owner project name or ID + + + + + --size <size> + + + Image size, in bytes (only used with --location and + --copy-from) + + + + + --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 + + + + + --location <image-url> + + + Download image from an existing URL + + + + + --copy-from <image-url> + + + Copy image from the data store (similar to --location) + + + + + --file <file> + + + Upload image from local file + + + + + --volume <volume> + + + Create image from a volume + + + + + --force + + + Force image creation if volume is in use (only + meaningful with --volume) + + + + + --checksum <checksum> + + + Image hash used for verification + + + + + --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 an image property (repeat option to set multiple + properties) + + + + +
+
+ openstack image delete command + usage: openstack image delete [-h] <image> + +Delete an image + + Positional arguments + + <image> + + + Name or ID of image to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack image list command + usage: openstack image list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--page-size <size>] + +List available images + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --page-size <size> + + + Number of images to request in each paginated request + + + + +
+
+ openstack image save command + usage: openstack image save [-h] [--file <filename>] <image> + +Save an image locally + + Positional arguments + + <image> + + + Name or ID of image to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --file <filename> + + + Downloaded image save filename [default: stdout] + + + + +
+
+ openstack image set command + usage: openstack image set [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--name <name>] + [--owner <project>] [--min-disk <disk-gb>] + [--min-ram <disk-ram>] + [--protected | --unprotected] + [--public | --private] [--property <key=value>] + <image> + +Change image properties + + Positional arguments + + <image> + + + Image name or ID to change + + + + + + 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 <disk-ram> + + + Minimum RAM size needed to boot image, in megabytes + + + + + --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 an image property (repeat option to set multiple + properties) + + + + +
+
+ openstack image show command + usage: openstack image show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <image> + +Show image details + + Positional arguments + + <image> + + + Name or ID of image to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ip fixed add command + usage: openstack ip fixed add [-h] <network> <server> + +Add fixed-ip command + + Positional arguments + + <network> + + + Name of the network to fetch an IP address from + + + + + <server> + + + Name of the server to receive the IP address + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ip fixed remove command + usage: openstack ip fixed remove [-h] <ip-address> <server> + +Remove fixed-ip command + + Positional arguments + + <ip-address> + + + IP address to remove from server + + + + + <server> + + + Name of the server to remove the IP address from + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ip floating add command + usage: openstack ip floating add [-h] <ip-address> <server> + +Add floating-ip command + + Positional arguments + + <ip-address> + + + IP address to add to server + + + + + <server> + + + Name of the server to receive the IP address + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ip floating create command + usage: openstack ip floating create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--prefix PREFIX] + <pool> + +Create floating-ip command + + Positional arguments + + <pool> + + + Pool to fetch floating IP from + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ip floating delete command + usage: openstack ip floating delete [-h] <ip-address> + +Delete floating-ip command + + Positional arguments + + <ip-address> + + + IP address to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ip floating list command + usage: openstack ip floating list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + +List floating-ip command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ip floating pool list command + usage: openstack ip floating pool list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + +List floating-ip-pool command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack ip floating remove command + usage: openstack ip floating remove [-h] <ip-address> <server> + +Remove floating-ip command + + Positional arguments + + <ip-address> + + + IP address to remove from server + + + + + <server> + + + Name of the server to remove the IP address from + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack keypair create command + usage: openstack keypair create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--public-key <file>] + <name> + +Create keypair command + + Positional arguments + + <name> + + + New keypair name + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --public-key <file> + + + Filename for public key to add + + + + +
+
+ openstack keypair delete command + usage: openstack keypair delete [-h] <name> + +Delete keypair command + + Positional arguments + + <name> + + + Name of keypair to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack keypair list command + usage: openstack keypair list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + +List keypair command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack keypair show command + usage: openstack keypair show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--public-key] + <name> + +Show keypair command + + Positional arguments + + <name> + + + Name of keypair to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --public-key + + + Include public key in output + + + + +
+
+ openstack limits show command + usage: openstack limits show [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--absolute | --rate] [--reserved] + +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] + + + + +
+
+ openstack module list command + usage: openstack module list [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--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 object list command + usage: openstack object list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--prefix <prefix>] [--delimiter <delimiter>] + [--marker <marker>] [--end-marker <end-marker>] + [--limit <limit>] [--long] [--all] + <container-name> + +List objects + + Positional arguments + + <container-name> + + + List contents of container-name + + + + + + 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 show command + usage: openstack object show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <container> <object> + +Show object information + + Positional arguments + + <container> + + + Container name for object to display + + + + + <object> + + + Object name to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack project create command + usage: openstack project create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + [--description <project-description>] + [--enable | --disable] + [--property <key=value>] + <project-name> + +Create new project + + Positional arguments + + <project-name> + + + New project name + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --description <project-description> + + + New project description + + + + + --enable + + + Enable project (default) + + + + + --disable + + + Disable project + + + + + --property <key=value> + + + Property to add for this project (repeat option to set + multiple properties) + + + + +
+
+ openstack project delete command + usage: openstack project delete [-h] <project> + +Delete project + + Positional arguments + + <project> + + + Project to delete (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack project list command + usage: openstack project list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack project set [-h] [--name <new-project-name>] + [--description <project-description>] + [--enable | --disable] [--property <key=value>] + <project> + +Set project properties + + Positional arguments + + <project> + + + Project to change (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --name <new-project-name> + + + New project name + + + + + --description <project-description> + + + New project description + + + + + --enable + + + Enable project + + + + + --disable + + + Disable project + + + + + --property <key=value> + + + Property to add for this project (repeat option to set + multiple properties) + + + + +
+
+ openstack project show command + usage: openstack project show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <project> + +Show project details + + Positional arguments + + <project> + + + Project to display (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack project usage list command + usage: openstack project usage list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 quota set command + usage: openstack quota set [-h] [--class] [--properties <new-properties>] + [--ram <new-ram>] + [--secgroup-rules <new-secgroup-rules>] + [--instances <new-instances>] + [--key-pairs <new-key-pairs>] + [--fixed-ips <new-fixed-ips>] + [--secgroups <new-secgroups>] + [--injected-file-size <new-injected-file-size>] + [--floating-ips <new-floating-ips>] + [--injected-files <new-injected-files>] + [--cores <new-cores>] + [--injected-path-size <new-injected-path-size>] + [--gigabytes <new-gigabytes>] + [--volumes <new-volumes>] + [--snapshots <new-snapshots>] + <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 <new-properties> + + + New value for the properties quota + + + + + --ram <new-ram> + + + New value for the ram quota + + + + + --secgroup-rules <new-secgroup-rules> + + + New value for the secgroup-rules quota + + + + + --instances <new-instances> + + + New value for the instances quota + + + + + --key-pairs <new-key-pairs> + + + New value for the key-pairs quota + + + + + --fixed-ips <new-fixed-ips> + + + New value for the fixed-ips quota + + + + + --secgroups <new-secgroups> + + + New value for the secgroups quota + + + + + --injected-file-size <new-injected-file-size> + + + New value for the injected-file-size quota + + + + + --floating-ips <new-floating-ips> + + + New value for the floating-ips quota + + + + + --injected-files <new-injected-files> + + + New value for the injected-files quota + + + + + --cores <new-cores> + + + New value for the cores quota + + + + + --injected-path-size <new-injected-path-size> + + + New value for the injected-path-size quota + + + + + --gigabytes <new-gigabytes> + + + New value for the gigabytes quota + + + + + --volumes <new-volumes> + + + New value for the volumes quota + + + + + --snapshots <new-snapshots> + + + New value for the snapshots quota + + + + +
+
+ openstack quota show command + usage: openstack quota show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--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 role add command + usage: openstack role add [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] --project <project> --user <user> + <role> + +Add role to project:user + + Positional arguments + + <role> + + + Role name or ID to add to user + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --project <project> + + + Include project (name or ID) + + + + + --user <user> + + + Name or ID of user to include + + + + +
+
+ openstack role create command + usage: openstack role create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <role-name> + +Create new role + + Positional arguments + + <role-name> + + + New role name + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack role delete command + usage: openstack role delete [-h] <role> + +Delete existing role + + Positional arguments + + <role> + + + Name or ID of role to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack role list command + usage: openstack role list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + +List roles + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack role remove command + usage: openstack role remove [-h] --project <project> --user <user> <role> + +Remove role from project:user + + Positional arguments + + <role> + + + Role name or ID to remove from user + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --project <project> + + + Project to include (name or ID) + + + + + --user <user> + + + Name or ID of user + + + + +
+
+ openstack role show command + usage: openstack role show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <role> + +Show single role + + Positional arguments + + <role> + + + Name or ID of role to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack security group create command + usage: openstack security group create [-h] [-f {shell,table,value}] + [-c COLUMN] [--max-width <integer>] + [--variable VARIABLE] [--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 command + usage: openstack security group delete [-h] <group> + +Delete a security group + + Positional arguments + + <group> + + + Name or ID of security group to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack security group list command + usage: openstack security group list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--all-projects] + +List all 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 command + usage: openstack security group rule create [-h] [-f {shell,table,value}] + [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] + [--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 + + + + + + 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 command + usage: openstack security group rule delete [-h] [--proto <proto>] + [--src-ip <ip-address>] + [--dst-port <port-range>] + <group> + +Delete a security group rule + + Positional arguments + + <group> + + + Create rule in this security group + + + + + + 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 list command + usage: openstack security group rule list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + <group> + +List all security group rules + + Positional arguments + + <group> + + + Create rule in this security group + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack security group set command + usage: openstack security group set [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--prefix PREFIX] + [--name <new-name>] + [--description <description>] + <group> + +Set security group properties + + Positional arguments + + <group> + + + Name or ID of security group to change + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --name <new-name> + + + New security group name + + + + + --description <description> + + + New security group name + + + + +
+
+ openstack security group show command + usage: openstack security group show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--prefix PREFIX] + <group> + +Show a specific security group + + Positional arguments + + <group> + + + Name or ID of security group to change + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server add security group command + usage: openstack server add security group [-h] <server> <group> + +Add security group to server + + Positional arguments + + <server> + + + Name or ID of server to use + + + + + <group> + + + Name or ID of security group to add to server + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server add volume command + usage: openstack 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 command + usage: openstack server create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] --image <image> --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 <nic-config-string>] + [--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 + + + + + --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 <nic-config-string> + + + Specify NIC configuration (optional extension) + + + + + --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 command + usage: openstack server delete [-h] <server> + +Delete server command + + Positional arguments + + <server> + + + Name or ID of server to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server image create command + usage: openstack server image create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--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 command + usage: openstack server list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--reservation-id <reservation-id>] + [--ip <ip-address-regex>] + [--ip6 <ip-address-regex>] [--name <name>] + [--status <status>] [--flavor <flavor>] + [--image <image>] [--host <hostname>] + [--instance-name <server-name>] [--all-projects] + [--long] + +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> + + + Regular expression to match names + + + + + --status <status> + + + Search by server status + + + + + --flavor <flavor> + + + Search by flavor ID + + + + + --image <image> + + + Search by image ID + + + + + --host <hostname> + + + Search by hostname + + + + + --instance-name <server-name> + + + Regular expression to match instance name (admin only) + + + + + --all-projects + + + Include all projects (admin only) + + + + + --long + + + List additional fields in output + + + + +
+
+ openstack server lock command + usage: openstack server lock [-h] <server> + +Lock server + + Positional arguments + + <server> + + + Server (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server migrate command + usage: openstack server migrate [-h] [--wait] [--live <hostname>] + [--shared-migration | --block-migration] + [--no-disk-overcommit | --disk-overcommit] + <server> + +Migrate server to different host + + Positional arguments + + <server> + + + Server to migrate (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --wait + + + Wait for resize to complete + + + + + --live <hostname> + + + Target hostname + + + + + --shared-migration + + + Perform a shared live migration (default) + + + + + --block-migration + + + Perform a block live migration + + + + + --no-disk-overcommit + + + Do not over-commit disk on the destination host + (default) + + + + + --disk-overcommit + + + Allow disk over-commit on the destination host + + + + +
+
+ openstack server pause command + usage: openstack server pause [-h] <server> + +Pause server + + Positional arguments + + <server> + + + Server (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server reboot command + usage: openstack 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 command + usage: openstack server rebuild [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--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 command + usage: openstack 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 command + usage: openstack 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 command + usage: openstack server rescue [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--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 command + usage: openstack server resize [-h] [--flavor <flavor> | --verify | --revert] + [--wait] + +Convert server to a new flavor + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --flavor <flavor> + + + Resize server to this flavor + + + + + --verify + + + Verify previous server resize + + + + + --revert + + + Restore server before resize + + + + + --wait + + + Wait for resize to complete + + + + +
+
+ openstack server resume command + usage: openstack server resume [-h] <server> + +Resume server + + Positional arguments + + <server> + + + Server (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server set command + usage: openstack 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 show command + usage: openstack server show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--diagnostics] + <server> + +Show server details + + Positional arguments + + <server> + + + Server to show (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --diagnostics + + + Display diagnostics information for a given server + + + + +
+
+ openstack server ssh command + usage: openstack 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 suspend command + usage: openstack server suspend [-h] <server> + +Suspend server + + Positional arguments + + <server> + + + Server (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server unlock command + usage: openstack server unlock [-h] <server> + +Unlock server + + Positional arguments + + <server> + + + Server (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server unpause command + usage: openstack server unpause [-h] <server> + +Unpause server + + Positional arguments + + <server> + + + Server (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack server unrescue command + usage: openstack 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 command + usage: openstack 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 set multiple + values) + + + + +
+
+ openstack service create command + usage: openstack service create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] --type <service-type> + [--description <service-description>] + <service-name> + +Create new service + + Positional arguments + + <service-name> + + + New service name + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --type <service-type> + + + New service type (compute, image, identity, volume, + etc) + + + + + --description <service-description> + + + New service description + + + + +
+
+ openstack service delete command + usage: openstack 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 command + usage: openstack service list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack service show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--catalog] + <service> + +Show 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 command + usage: openstack snapshot create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] --name <name> + [--description <description>] [--force] + <volume> + +Create snapshot command + + Positional arguments + + <volume> + + + The name or ID of the volume to snapshot + + + + + + 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 command + usage: openstack snapshot delete [-h] <snapshot> + +Delete snapshot command + + Positional arguments + + <snapshot> + + + Name or ID of snapshot to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack snapshot list command + usage: openstack snapshot list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + +List snapshot command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack snapshot set command + usage: openstack snapshot set [-h] [--name <new-snapshot-name>] + [--description <new-snapshot-description>] + <snapshot> + +Set snapshot command + + Positional arguments + + <snapshot> + + + Name or ID of snapshot to change + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --name <new-snapshot-name> + + + New snapshot name + + + + + --description <new-snapshot-description> + + + New snapshot description + + + + +
+
+ openstack snapshot show command + usage: openstack snapshot show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <snapshot> + +Show snapshot command + + Positional arguments + + <snapshot> + + + Name or ID of snapshot to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack token issue command + usage: openstack token issue [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + +Issue token command + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack token revoke command + usage: openstack token revoke [-h] <token> + +Revoke token command + + Positional arguments + + <token> + + + Token to be deleted + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack user create command + usage: openstack user create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] [--password <user-password>] + [--password-prompt] [--email <user-email>] + [--project <project>] [--enable | --disable] + <user-name> + +Create new user + + Positional arguments + + <user-name> + + + New user name + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --password <user-password> + + + New user password + + + + + --password-prompt + + + Prompt interactively for password + + + + + --email <user-email> + + + New user email address + + + + + --project <project> + + + Set default project (name or ID) + + + + + --enable + + + Enable user (default) + + + + + --disable + + + Disable user + + + + +
+
+ openstack user delete command + usage: openstack user delete [-h] <user> + +Delete user + + Positional arguments + + <user> + + + User to delete (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack user list command + usage: openstack user list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack user role list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--project <project>] + [<user>] + +List user-role assignments + + Positional arguments + + <user> + + + Name or ID of user to include + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --project <project> + + + Include project (name or ID) + + + + +
+
+ openstack user set command + usage: openstack user set [-h] [--name <new-user-name>] + [--password <user-password>] [--password-prompt] + [--email <user-email>] [--project <project>] + [--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 <new-user-name> + + + New user name + + + + + --password <user-password> + + + New user password + + + + + --password-prompt + + + Prompt interactively for password + + + + + --email <user-email> + + + New user email address + + + + + --project <project> + + + New default project (name or ID) + + + + + --enable + + + Enable user (default) + + + + + --disable + + + Disable user + + + + +
+
+ openstack user show command + usage: openstack user show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <user> + +Show user details + + Positional arguments + + <user> + + + User to display (name or ID) + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack volume create command + usage: openstack volume create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] --size <size> + [--snapshot-id <snapshot-id>] + [--description <description>] + [--type <volume-type>] [--user <user>] + [--project <project>] + [--availability-zone <availability-zone>] + [--property <key=value>] [--image <image>] + [--source <volume>] + <name> + +Create new volume + + Positional arguments + + <name> + + + Name of the volume + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --size <size> + + + New volume size + + + + + --snapshot-id <snapshot-id> + + + ID of the snapshot + + + + + --description <description> + + + Description of the volume + + + + + --type <volume-type> + + + Type of volume + + + + + --user <user> + + + Specify a different user (admin only) + + + + + --project <project> + + + Specify a different project (admin only) + + + + + --availability-zone <availability-zone> + + + Availability zone to use + + + + + --property <key=value> + + + Property to store for this volume (repeat option to + set multiple properties) + + + + + --image <image> + + + Reference to a stored image + + + + + --source <volume> + + + Source for volume clone + + + + +
+
+ openstack volume delete command + usage: openstack volume delete [-h] [--force] <volume> + +Delete volume + + Positional arguments + + <volume> + + + Name or ID of volume to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --force + + + Attempt forced removal of a volume, regardless of state + + + + +
+
+ openstack volume list command + usage: openstack volume list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--quote {all,minimal,none,nonnumeric}] + [--status <status>] [--name <name>] + [--all-projects] [--long] + +List volumes + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --status <status> + + + Filter results by status + + + + + --name <name> + + + Filter results by name + + + + + --all-projects + + + Include all projects (admin only) + + + + + --long + + + Display properties + + + + +
+
+ openstack volume set command + usage: openstack volume set [-h] [--name <new-name>] + [--description <new-description>] + [--property <key=value>] + <volume> + +Set volume properties + + Positional arguments + + <volume> + + + Name or ID of volume to change + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --name <new-name> + + + New volume name + + + + + --description <new-description> + + + New volume description + + + + + --property <key=value> + + + Property to add/change for this volume (repeat option + to set multiple properties) + + + + +
+
+ openstack volume show command + usage: openstack volume show [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] [--variable VARIABLE] + [--prefix PREFIX] + <volume> + +Show specific volume + + Positional arguments + + <volume> + + + Name or ID of volume to display + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack volume type create command + usage: openstack volume type create [-h] [-f {shell,table,value}] [-c COLUMN] + [--max-width <integer>] + [--variable VARIABLE] [--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 command + usage: openstack volume type delete [-h] <volume-type> + +Delete volume type + + Positional arguments + + <volume-type> + + + Name or ID of volume type to delete + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + +
+
+ openstack volume type list command + usage: openstack volume type list [-h] [-f {csv,table}] [-c COLUMN] + [--max-width <integer>] + [--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 command + usage: openstack volume type set [-h] [--property <key=value>] <volume-type> + +Set volume type property + + Positional arguments + + <volume-type> + + + Volume type name or ID to update + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key=value> + + + Property to add/change for this volume type (repeat + option to set multiple properties) + + + + +
+
+ openstack volume type unset command + usage: openstack volume type unset [-h] [--property <key>] <volume-type> + +Unset volume type property + + Positional arguments + + <volume-type> + + + Type ID or name to remove + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key> + + + Property key to remove from volume (repeat option to + remove multiple properties) + + + + +
+
+ openstack volume unset command + usage: openstack volume unset [-h] [--property <key>] <volume> + +Unset volume properties + + Positional arguments + + <volume> + + + Name or ID of volume to change + + + + + + Optional arguments + + -h, --help + + + show this help message and exit + + + + + --property <key> + + + Property key to remove from volume (repeat to set multiple + values) + + + + +
+ diff --git a/doc/common/section_cli_install.xml b/doc/common/section_cli_install.xml index 6b399b6524..cdf172fd12 100644 --- a/doc/common/section_cli_install.xml +++ b/doc/common/section_cli_install.xml @@ -190,6 +190,10 @@ nova - Compute API and extensions + + sahara - Database Processing + API + swift - Object Storage API @@ -198,6 +202,11 @@ trove - Database Service API + + common - Common OpenStack client + + + The following example shows the command for installing the nova client with diff --git a/doc/common/section_cli_overview.xml b/doc/common/section_cli_overview.xml index f8709f4c50..f831cc585d 100644 --- a/doc/common/section_cli_overview.xml +++ b/doc/common/section_cli_overview.xml @@ -108,10 +108,14 @@ python-saharaclient Creates and manages Hadoop clusters on OpenStack. + + Common client + openstack + python-openstackclient + Common client for the OpenStack project. + - An OpenStack common client is in - development. For client installation instructions, see Install the OpenStack command-line clients. For information about the OpenStack RC file,