From 95310dfc9429e833d3295f10f835652188260af1 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 5 Mar 2014 20:58:55 +0100 Subject: [PATCH] Update cli commands to latest *released* version Previously I've created the files with the latest git versions of the python packages. Now I've created them with the latest released versions: python-ceilometerclient 1.0.9 python-cinderclient 1.0.8 python-glanceclient 0.12.0 python-heatclient 0.2.8 python-keystoneclient 0.6.0 python-neutronclient 2.3.4 python-novaclient 2.16.0 python-swiftclient 2.0.3 Also, change permissions of section_cli_cinder_manage_volumes.xml. Change-Id: I6a5f01bef8ffebb1d1471f35804c153ab5f6025e --- doc/common/ch_cli_ceilometer_commands.xml | 3 +- doc/common/ch_cli_cinder_commands.xml | 7 +- doc/common/ch_cli_glance_commands.xml | 14 +- doc/common/ch_cli_heat_commands.xml | 283 +++++++++++++++--- doc/common/ch_cli_keystone_commands.xml | 3 +- doc/common/ch_cli_neutron_commands.xml | 13 +- doc/common/ch_cli_nova_commands.xml | 272 ++++++++--------- doc/common/ch_cli_swift_commands.xml | 19 +- .../section_cli_cinder_manage_volumes.xml | 0 9 files changed, 420 insertions(+), 194 deletions(-) mode change 100755 => 100644 doc/common/section_cli_cinder_manage_volumes.xml diff --git a/doc/common/ch_cli_ceilometer_commands.xml b/doc/common/ch_cli_ceilometer_commands.xml index 7faf039df1..8eeb5f35e8 100644 --- a/doc/common/ch_cli_ceilometer_commands.xml +++ b/doc/common/ch_cli_ceilometer_commands.xml @@ -10,7 +10,8 @@ Telemetry command-line client The ceilometer client is the command-line interface - (CLI) for the Telemetry API and its extensions. + (CLI) for the Telemetry API and its extensions. This chapter documents + ceilometer version 1.0.9. For help on a specific ceilometer command, enter: diff --git a/doc/common/ch_cli_cinder_commands.xml b/doc/common/ch_cli_cinder_commands.xml index a51ed87a5e..25035e7035 100644 --- a/doc/common/ch_cli_cinder_commands.xml +++ b/doc/common/ch_cli_cinder_commands.xml @@ -10,7 +10,8 @@ Block Storage command-line client The cinder client is the command-line interface - (CLI) for the OpenStack Block Storage API and its extensions. + (CLI) for the OpenStack Block Storage API and its extensions. This chapter documents + cinder version 1.0.8. For help on a specific cinder command, enter: @@ -1019,8 +1020,8 @@ Create a new encryption type for a volume type (Admin Only). Notional service where encryption is performed (e.g., - front-end=Nova) Values: 'front-end', 'back-end' - (Default='front-end') + front-end=Nova). Values: 'front-end', 'back-end' + (Optional, Default=None) diff --git a/doc/common/ch_cli_glance_commands.xml b/doc/common/ch_cli_glance_commands.xml index fcf4d7e3f2..5cc8d0f5c2 100644 --- a/doc/common/ch_cli_glance_commands.xml +++ b/doc/common/ch_cli_glance_commands.xml @@ -10,7 +10,8 @@ Image Service command-line client The glance client is the command-line interface - (CLI) for the OpenStack Image Service API and its extensions. + (CLI) for the OpenStack Image Service API and its extensions. This chapter documents + glance version 0.12.0. For help on a specific glance command, enter: @@ -846,8 +847,7 @@ List images you can access.
glance image-show command - usage: glance image-show [--human-readable] [--max-column-width <integer>] - <IMAGE> + usage: glance image-show [--human-readable] <IMAGE> Describe a specific image. @@ -872,14 +872,6 @@ Describe a specific image. - - --max-column-width <integer> - - - The max column width of the printed table. - - -
diff --git a/doc/common/ch_cli_heat_commands.xml b/doc/common/ch_cli_heat_commands.xml index 61a68c4cbb..568e16a7e3 100644 --- a/doc/common/ch_cli_heat_commands.xml +++ b/doc/common/ch_cli_heat_commands.xml @@ -10,7 +10,8 @@ Orchestration command-line client The heat client is the command-line interface - (CLI) for the Orchestration API and its extensions. + (CLI) for the Orchestration API and its extensions. This chapter documents + heat version 0.2.8. For help on a specific heat command, enter: @@ -119,6 +120,22 @@ + + output-list + + + Show available outputs. + + + + + output-show + + + Show a specific stack output. + + + resource @@ -151,6 +168,14 @@ + + resource-signal + + + Send a signal to a resource. + + + resource-template @@ -183,6 +208,14 @@ + + stack-adopt + + + Adopt a stack. + + + stack-create @@ -281,7 +314,7 @@ --version - Shows the client version and exits + Shows the client version and exits. @@ -289,7 +322,7 @@ -d, --debug - Defaults to env[HEATCLIENT_DEBUG] + Defaults to env[HEATCLIENT_DEBUG]. @@ -297,7 +330,7 @@ -v, --verbose - Print more verbose output + Print more verbose output. @@ -305,7 +338,7 @@ -k, --insecure - Explicitly allow the client to perform"insecure" SSL + 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. @@ -317,7 +350,7 @@ Path of certificate file to use in SSL connection. - This file can optionally be prependedwith the private + This file can optionally be prepended with the private key. @@ -346,7 +379,7 @@ --timeout TIMEOUT - Number of seconds to wait for a response + Number of seconds to wait for a response. @@ -354,7 +387,7 @@ --os-username OS_USERNAME - Defaults to env[OS_USERNAME] + Defaults to env[OS_USERNAME]. @@ -362,7 +395,7 @@ --os-password OS_PASSWORD - Defaults to env[OS_PASSWORD] + Defaults to env[OS_PASSWORD]. @@ -370,7 +403,7 @@ --os-tenant-id OS_TENANT_ID - Defaults to env[OS_TENANT_ID] + Defaults to env[OS_TENANT_ID]. @@ -378,7 +411,7 @@ --os-tenant-name OS_TENANT_NAME - Defaults to env[OS_TENANT_NAME] + Defaults to env[OS_TENANT_NAME]. @@ -386,7 +419,7 @@ --os-auth-url OS_AUTH_URL - Defaults to env[OS_AUTH_URL] + Defaults to env[OS_AUTH_URL]. @@ -394,7 +427,7 @@ --os-region-name OS_REGION_NAME - Defaults to env[OS_REGION_NAME] + Defaults to env[OS_REGION_NAME]. @@ -402,7 +435,7 @@ --os-auth-token OS_AUTH_TOKEN - Defaults to env[OS_AUTH_TOKEN] + Defaults to env[OS_AUTH_TOKEN]. @@ -411,7 +444,7 @@ Do not contact keystone for a token. Defaults to - env[OS_NO_CLIENT_AUTH] + env[OS_NO_CLIENT_AUTH]. @@ -419,7 +452,7 @@ --heat-url HEAT_URL - Defaults to env[HEAT_URL] + Defaults to env[HEAT_URL]. @@ -427,7 +460,7 @@ --heat-api-version HEAT_API_VERSION - Defaults to env[HEAT_API_VERSION] or 1 + Defaults to env[HEAT_API_VERSION] or 1. @@ -435,7 +468,7 @@ --os-service-type OS_SERVICE_TYPE - Defaults to env[OS_SERVICE_TYPE] + Defaults to env[OS_SERVICE_TYPE]. @@ -443,7 +476,7 @@ --os-endpoint-type OS_ENDPOINT_TYPE - Defaults to env[OS_ENDPOINT_TYPE] + Defaults to env[OS_ENDPOINT_TYPE]. @@ -451,7 +484,7 @@ --include-password - Send os-username and os-password to heat + Send os-username and os-password to heat. @@ -523,7 +556,7 @@ List events for a stack. -r <RESOURCE>, --resource <RESOURCE> - Name of the resource to filter events by + Name of the resource to filter events by. @@ -557,7 +590,51 @@ Describe the event. <EVENT> - ID of event to display details for + ID of event to display details for. + + + + +
+
+ heat output-list command + 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 command + usage: heat output-show <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. @@ -631,6 +708,52 @@ Describe the resource. + +
+
+ heat resource-signal command + 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. + + +
@@ -656,7 +779,7 @@ Generate a template based on a resource. -F <FORMAT>, --format <FORMAT> - The template output format, one of: yaml, json + The template output format, one of: yaml, json. @@ -681,7 +804,7 @@ Show the resource type. <RESOURCE_TYPE> - Resource Type to get the details for. + Resource type to get the details for. @@ -703,6 +826,96 @@ Abandon the stack. + +
+
+ heat stack-adopt command + usage: heat stack-adopt [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] + [-c <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 + + -f <FILE>, --template-file <FILE> + + + Path to the template. + + + + + -e <FILE or URL>, --environment-file <FILE or URL> + + + Path to the environment. + + + + + -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. Default: 60. + + + + + -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. + + +
@@ -754,7 +967,7 @@ Create the stack. -o <URL>, --template-object <URL> - URL to retrieve template object (e.g from swift) + URL to retrieve template object (e.g. from swift). @@ -762,7 +975,7 @@ Create the stack. -c <TIMEOUT>, --create-timeout <TIMEOUT> - Stack creation timeout in minutes. Default: 60 + Stack creation timeout in minutes. Default: 60. @@ -770,7 +983,7 @@ Create the stack. -r, --enable-rollback - Enable rollback on create/update failure + Enable rollback on create/update failure. @@ -780,7 +993,7 @@ Create the stack. Parameter values used to create the stack. This can be specified multiple times, or once with parameters - separated by semicolon. + separated by a semicolon. @@ -819,7 +1032,7 @@ List the user's stacks. Filter parameters to apply on returned stacks. This can be specified multiple times, or once with - parameters separated by semicolon. + parameters separated by a semicolon. @@ -827,7 +1040,7 @@ List the user's stacks. -l <LIMIT>, --limit <LIMIT> - Limit the number of stacks returned + Limit the number of stacks returned. @@ -836,7 +1049,7 @@ List the user's stacks. Only return stacks that appear after the given stack - ID + ID. @@ -909,7 +1122,7 @@ Update the stack. -o <URL>, --template-object <URL> - URL to retrieve template object (e.g from swift) + URL to retrieve template object (e.g. from swift). @@ -919,7 +1132,7 @@ Update the stack. Parameter values used to create the stack. This can be specified multiple times, or once with parameters - separated by semicolon. + separated by a semicolon. @@ -980,7 +1193,7 @@ Validate a template with parameters. -o <URL>, --template-object <URL> - URL to retrieve template object (e.g from swift) + URL to retrieve template object (e.g. from swift). @@ -989,7 +1202,7 @@ Validate a template with parameters. Parameter values to validate. This can be specified - multiple times, or once with parameters separated by + multiple times, or once with parameters separated by a semicolon. diff --git a/doc/common/ch_cli_keystone_commands.xml b/doc/common/ch_cli_keystone_commands.xml index a068bdd3a2..48c13978cd 100644 --- a/doc/common/ch_cli_keystone_commands.xml +++ b/doc/common/ch_cli_keystone_commands.xml @@ -10,7 +10,8 @@ Identity Service command-line client The keystone client is the command-line interface - (CLI) for the OpenStack Identity API and its extensions. + (CLI) for the OpenStack Identity API and its extensions. This chapter documents + keystone version 0.6.0. For help on a specific keystone command, enter: diff --git a/doc/common/ch_cli_neutron_commands.xml b/doc/common/ch_cli_neutron_commands.xml index 85036490d1..4e0507eabd 100644 --- a/doc/common/ch_cli_neutron_commands.xml +++ b/doc/common/ch_cli_neutron_commands.xml @@ -10,7 +10,8 @@ Networking command-line client The neutron client is the command-line interface - (CLI) for the OpenStack Networking API and its extensions. + (CLI) for the OpenStack Networking API and its extensions. This chapter documents + neutron version 2.3.4. For help on a specific neutron command, enter: @@ -1063,7 +1064,7 @@ quota-list - List defined quotas of all tenants. + List quotas of all tenants who have non-default quota values. @@ -7222,7 +7223,7 @@ Update network's information. [--tenant-id TENANT_ID] [--name NAME] [--admin-state-down] [--mac-address MAC_ADDRESS] [--device-id DEVICE_ID] - [--fixed-ip ip_address=IP_ADDR] + [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] [--security-group SECURITY_GROUP | --no-security-groups] [--extra-dhcp-opt EXTRA_DHCP_OPTS] NETWORK @@ -7302,8 +7303,8 @@ Create a port for a given tenant. --fixed-ip - ip_address=IP_ADDR - Desired IP for this port: + subnet_id=SUBNET,ip_address=IP_ADDR + Desired IP and/or subnet for this port: subnet_id=<name_or_id>,ip_address=<ip>, (This option can be repeated.) @@ -7849,7 +7850,7 @@ Delete defined quotas of a given tenant. [--request-format {json,xml}] -List defined quotas of all tenants. +List quotas of all tenants who have non-default quota values. Optional arguments diff --git a/doc/common/ch_cli_nova_commands.xml b/doc/common/ch_cli_nova_commands.xml index 310d14a02b..d3296c6f33 100644 --- a/doc/common/ch_cli_nova_commands.xml +++ b/doc/common/ch_cli_nova_commands.xml @@ -10,7 +10,8 @@ Compute command-line client The nova client is the command-line interface - (CLI) for the OpenStack Compute API and its extensions. + (CLI) for the OpenStack Compute API and its extensions. This chapter documents + nova version 2.16.0. For help on a specific nova command, enter: @@ -495,6 +496,14 @@ + + get-rdp-console + + + Get a rdp console to a server. + + + get-spice-console @@ -1312,6 +1321,54 @@ + + force-delete + + + Force delete a server. + + + + + restore + + + Restore a soft-deleted server. + + + + + net + + + Show a network + + + + + net-create + + + Create a network + + + + + net-delete + + + Delete a network + + + + + net-list + + + List networks + + + baremetal-interface-add @@ -1369,103 +1426,6 @@ - - cell-capacities - - - Get cell capacities for all cells or a given cell. - - - - - cell-show - - - Show details of a given cell. - - - - - force-delete - - - Force delete a server. - - - - - restore - - - Restore a soft-deleted server. - - - - - host-servers-migrate - - - Migrate all instances of the specified host to other - available hosts. - - - - - list-extensions - - - List all the os-api extensions that are available. - - - - - host-meta - - - Set or Delete metadata on all instances of a host. - - - - - net - - - Show a network - - - - - net-create - - - Create a network - - - - - net-delete - - - Delete a network - - - - - net-list - - - List networks - - - - - migration-list - - - Print a list of migrations. - - - host-evacuate @@ -1491,6 +1451,55 @@ + + migration-list + + + Print a list of migrations. + + + + + host-servers-migrate + + + 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. + + + + + host-meta + + + Set or Delete metadata on all instances of a host. + + + + + list-extensions + + + List all the os-api extensions that are available. + + +
@@ -2411,7 +2420,7 @@ Boot a new server. --snapshot <snapshot_id> - Sapshot ID to boot from (will create a volume). + Snapshot ID to boot from (will create a volume). @@ -3550,6 +3559,32 @@ Get password for a server. + +
+
+ nova get-rdp-console command + 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"). + + +
@@ -4907,9 +4942,7 @@ List the quotas for a quota class.
nova quota-class-update command usage: nova quota-class-update [--instances <instances>] [--cores <cores>] - [--ram <ram>] [--volumes <volumes>] - [--gigabytes <gigabytes>] - [--floating-ips <floating-ips>] + [--ram <ram>] [--floating-ips <floating-ips>] [--metadata-items <metadata-items>] [--injected-files <injected-files>] [--injected-file-content-bytes <injected-file-content-bytes>] @@ -4958,22 +4991,6 @@ Update the quotas for a quota class. - - --volumes <volumes> - - - New value for the "volumes" quota. - - - - - --gigabytes <gigabytes> - - - New value for the "gigabytes" quota. - - - --floating-ips <floating-ips> @@ -5113,8 +5130,7 @@ List the quotas for a tenant/user.
nova quota-update command usage: nova quota-update [--user <user-id>] [--instances <instances>] - [--cores <cores>] [--ram <ram>] [--volumes <volumes>] - [--gigabytes <gigabytes>] + [--cores <cores>] [--ram <ram>] [--floating-ips <floating-ips>] [--fixed-ips <fixed-ips>] [--metadata-items <metadata-items>] @@ -5174,22 +5190,6 @@ Update the quotas for a tenant/user. - - --volumes <volumes> - - - New value for the "volumes" quota. - - - - - --gigabytes <gigabytes> - - - New value for the "gigabytes" quota. - - - --floating-ips <floating-ips> diff --git a/doc/common/ch_cli_swift_commands.xml b/doc/common/ch_cli_swift_commands.xml index d4c0a535e3..d5eb27247b 100644 --- a/doc/common/ch_cli_swift_commands.xml +++ b/doc/common/ch_cli_swift_commands.xml @@ -10,7 +10,8 @@ Object Storage command-line client The swift client is the command-line interface - (CLI) for the OpenStack Object Storage API and its extensions. + (CLI) for the OpenStack Object Storage API and its extensions. This chapter documents + swift version 2.0.3. For help on a specific swift command, enter: @@ -492,6 +493,14 @@ + + --skip-identical + + + Skip downloading files that are identical on both sides + + +
@@ -712,6 +721,14 @@ If the container is not found, it will be created automatically. + + --skip-identical + + + Skip uploading files that are identical on both sides + + + --segment-size <size> diff --git a/doc/common/section_cli_cinder_manage_volumes.xml b/doc/common/section_cli_cinder_manage_volumes.xml old mode 100755 new mode 100644