From 4113bb218e7792692130a017bbacfe040d5569d5 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 14 Feb 2014 10:54:22 +0100 Subject: [PATCH] Regenerate cli commands with new auto-commands Change-Id: I410067be5b489f5547f9fced3f7db841088fb8eb --- doc/common/ch_cli_ceilometer_commands.xml | 57 +++--- doc/common/ch_cli_cinder_commands.xml | 44 ++++- doc/common/ch_cli_glance_commands.xml | 18 +- doc/common/ch_cli_heat_commands.xml | 97 +++++++++-- doc/common/ch_cli_keystone_commands.xml | 15 +- doc/common/ch_cli_neutron_commands.xml | 24 +-- doc/common/ch_cli_nova_commands.xml | 201 +++++++++++----------- doc/common/ch_cli_swift_commands.xml | 67 +++++--- 8 files changed, 323 insertions(+), 200 deletions(-) diff --git a/doc/common/ch_cli_ceilometer_commands.xml b/doc/common/ch_cli_ceilometer_commands.xml index 049c3bb5cf..7faf039df1 100644 --- a/doc/common/ch_cli_ceilometer_commands.xml +++ b/doc/common/ch_cli_ceilometer_commands.xml @@ -8,9 +8,10 @@ - ceilometer commands - The ceilometer client is the command-line interface (CLI) for the - Telemetry API and its extensions. + Telemetry command-line client + The ceilometer client is the command-line interface + (CLI) for the Telemetry API and its extensions. + For help on a specific ceilometer command, enter: @@ -507,8 +508,9 @@ Create a new alarm based on state of other alarms. --insufficient-data-action <Webhook URL> - URL to invoke when state transitions to unkown. May be - used multiple times. Defaults to None. + URL to invoke when state transitions to + insufficient_data. May be used multiple times. + Defaults to None. @@ -639,8 +641,9 @@ Update an existing alarm based on state of other alarms. --insufficient-data-action <Webhook URL> - URL to invoke when state transitions to unkown. May be - used multiple times. Defaults to None. + URL to invoke when state transitions to + insufficient_data. May be used multiple times. + Defaults to None. @@ -811,8 +814,7 @@ Set the state of an alarm. [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] - --meter-name <METRIC> - [--period <PERIOD>] + -m <METRIC> [--period <PERIOD>] [--evaluation-periods <COUNT>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] @@ -897,13 +899,14 @@ Create a new alarm based on computed statistics. --insufficient-data-action <Webhook URL> - URL to invoke when state transitions to unkown. May be - used multiple times. Defaults to None. + URL to invoke when state transitions to + insufficient_data. May be used multiple times. + Defaults to None. - --meter-name <METRIC> + -m <METRIC>, --meter-name <METRIC> Metric to evaluate against Required. @@ -984,8 +987,7 @@ Create a new alarm based on computed statistics. [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] - [--meter-name <METRIC>] - [--period <PERIOD>] + [-m <METRIC>] [--period <PERIOD>] [--evaluation-periods <COUNT>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] @@ -1078,13 +1080,14 @@ Update an existing alarm based on computed statistics. --insufficient-data-action <Webhook URL> - URL to invoke when state transitions to unkown. May be - used multiple times. Defaults to None. + URL to invoke when state transitions to + insufficient_data. May be used multiple times. + Defaults to None. - --meter-name <METRIC> + -m <METRIC>, --meter-name <METRIC> Metric to evaluate against @@ -1165,8 +1168,7 @@ Update an existing alarm based on computed statistics. [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--period <PERIOD>] - [--evaluation-periods <COUNT>] - [--meter-name <METRIC>] + [--evaluation-periods <COUNT>] [-m <METRIC>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] @@ -1258,8 +1260,9 @@ Update an existing alarm. --insufficient-data-action <Webhook URL> - URL to invoke when state transitions to unkown. May be - used multiple times. Defaults to None. + URL to invoke when state transitions to + insufficient_data. May be used multiple times. + Defaults to None. @@ -1280,7 +1283,7 @@ Update an existing alarm. - --meter-name <METRIC> + -m <METRIC>, --meter-name <METRIC> Metric to evaluate against @@ -1565,7 +1568,7 @@ List the samples for a meter.
ceilometer statistics command - usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] + usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>] List the statistics for a meter. @@ -1597,6 +1600,14 @@ List the statistics for a meter. + + -g <FIELD>, --groupby <FIELD> + + + Field for group aggregation. + + +
diff --git a/doc/common/ch_cli_cinder_commands.xml b/doc/common/ch_cli_cinder_commands.xml index 26a4474857..a51ed87a5e 100644 --- a/doc/common/ch_cli_cinder_commands.xml +++ b/doc/common/ch_cli_cinder_commands.xml @@ -8,9 +8,10 @@ - cinder commands - The cinder client is the command-line interface (CLI) for the - OpenStack Block Storage API and its extensions. + Block Storage command-line client + The cinder client is the command-line interface + (CLI) for the OpenStack Block Storage API and its extensions. + For help on a specific cinder command, enter: @@ -120,6 +121,15 @@ + + encryption-type-delete + + + Delete the encryption type for a volume type (Admin + Only). + + + encryption-type-list @@ -921,10 +931,9 @@ Add a new volume. - --metadata [<key=value> [<key=value> + --metadata [<key=value> [<key=value> ...]] - ...]] Metadata key=value pairs (Optional, Default=None) @@ -1010,8 +1019,26 @@ 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' - (Optional, Default=None) + front-end=Nova) Values: 'front-end', 'back-end' + (Default='front-end') + + + + +
+
+ cinder encryption-type-delete command + usage: cinder encryption-type-delete <volume_type> + + +Delete the encryption type for a volume type (Admin Only). + + Positional arguments + + <volume_type> + + + Name or ID of the volume type @@ -1135,10 +1162,9 @@ List all the volumes. - --metadata [<key=value> [<key=value> + --metadata [<key=value> [<key=value> ...]] - ...]] Filter results by metadata diff --git a/doc/common/ch_cli_glance_commands.xml b/doc/common/ch_cli_glance_commands.xml index 6baac5f7c0..fcf4d7e3f2 100644 --- a/doc/common/ch_cli_glance_commands.xml +++ b/doc/common/ch_cli_glance_commands.xml @@ -8,9 +8,10 @@ - glance commands - The glance client is the command-line interface (CLI) for the - OpenStack Image Service API and its extensions. + Image Service command-line client + The glance client is the command-line interface + (CLI) for the OpenStack Image Service API and its extensions. + For help on a specific glance command, enter: @@ -845,7 +846,8 @@ List images you can access.
glance image-show command - usage: glance image-show [--human-readable] <IMAGE> + usage: glance image-show [--human-readable] [--max-column-width <integer>] + <IMAGE> Describe a specific image. @@ -870,6 +872,14 @@ 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 0bd03cc694..61a68c4cbb 100644 --- a/doc/common/ch_cli_heat_commands.xml +++ b/doc/common/ch_cli_heat_commands.xml @@ -8,9 +8,10 @@ - heat commands - The heat client is the command-line interface (CLI) for the - Orchestration API and its extensions. + Orchestration command-line client + The heat client is the command-line interface + (CLI) for the Orchestration API and its extensions. + For help on a specific heat command, enter: @@ -46,6 +47,14 @@ + + build-info + + + Retrieve build information. + + + create @@ -166,6 +175,14 @@ + + stack-abandon + + + Abandon the stack. + + + stack-create @@ -476,6 +493,13 @@ Suspend the stack.
+
+ heat build-info command + usage: heat build-info + + +Retrieve build information. +
heat event-list command usage: heat event-list [-r <RESOURCE>] <NAME or ID> @@ -661,11 +685,29 @@ Show the resource type. + +
+
+ heat stack-abandon command + usage: heat stack-abandon <NAME or ID> + + +Abandon the stack. + + Positional arguments + + <NAME or ID> + + + Name or ID of stack to abandon. + + +
heat stack-create command - usage: heat stack-create [-f <FILE>] [-e <FILE>] [-u <URL>] [-o <URL>] + usage: heat stack-create [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-c <TIMEOUT>] [-r] [-P <KEY1=VALUE1;KEY2=VALUE2...>] <STACK_NAME> @@ -693,7 +735,7 @@ Create the stack. - -e <FILE>, --environment-file <FILE> + -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment. @@ -764,11 +806,42 @@ Delete the stack(s).
heat stack-list command - usage: heat stack-list + usage: heat stack-list [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>] + [-m <ID>] List the user's stacks. -
+ + Optional arguments + + -f <KEY1=VALUE1;KEY2=VALUE2...>, --filters <KEY1=VALUE1;KEY2=VALUE2...> + + + Filter parameters to apply on returned stacks. This + can be specified multiple times, or once with + parameters separated by semicolon. + + + + + -l <LIMIT>, --limit <LIMIT> + + + Limit the number of stacks returned + + + + + -m <ID>, --marker <ID> + + + Only return stacks that appear after the given stack + ID + + + + +
heat stack-show command usage: heat stack-show <NAME or ID> @@ -789,7 +862,7 @@ Describe the stack.
heat stack-update command - usage: heat stack-update [-f <FILE>] [-e <FILE>] [-u <URL>] [-o <URL>] + usage: heat stack-update [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>] [-P <KEY1=VALUE1;KEY2=VALUE2...>] <NAME or ID> @@ -817,7 +890,7 @@ Update the stack. - -e <FILE>, --environment-file <FILE> + -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment. @@ -872,8 +945,8 @@ Get the template for the specified stack.
heat template-validate command - usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE>] [-o <URL>] - [-P <KEY1=VALUE1;KEY2=VALUE2...>] + usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>] + [-o <URL>] [-P <KEY1=VALUE1;KEY2=VALUE2...>] Validate a template with parameters. @@ -896,7 +969,7 @@ Validate a template with parameters. - -e <FILE>, --environment-file <FILE> + -e <FILE or URL>, --environment-file <FILE or URL> Path to the environment. diff --git a/doc/common/ch_cli_keystone_commands.xml b/doc/common/ch_cli_keystone_commands.xml index 4e10b0e921..a068bdd3a2 100644 --- a/doc/common/ch_cli_keystone_commands.xml +++ b/doc/common/ch_cli_keystone_commands.xml @@ -8,9 +8,10 @@ - keystone commands - The keystone client is the command-line interface (CLI) for the - OpenStack Identity API and its extensions. + Identity Service command-line client + The keystone client is the command-line interface + (CLI) for the OpenStack Identity API and its extensions. + For help on a specific keystone command, enter: @@ -572,13 +573,7 @@ List service catalog, possibly filtered by service. usage: keystone discover -Discover Keystone servers, supported API versions and extensions. Usage:: $ -keystone discover Keystone found at http://localhost:35357 - supports version -v1.0 (DEPRECATED) here http://localhost:35357/v1.0 - supports version v1.1 -(CURRENT) here http://localhost:35357/v1.1 - supports version v2.0 (CURRENT) -here http://localhost:35357/v2.0 - and RAX-KSKEY: Rackspace API Key -Authentication Admin Extension - and RAX-KSGRP: Rackspace Keystone Group -Extensions +Discover Keystone servers, supported API versions and extensions.
keystone ec2-credentials-create command diff --git a/doc/common/ch_cli_neutron_commands.xml b/doc/common/ch_cli_neutron_commands.xml index 4ae8891d61..85036490d1 100644 --- a/doc/common/ch_cli_neutron_commands.xml +++ b/doc/common/ch_cli_neutron_commands.xml @@ -8,9 +8,10 @@ - neutron commands - The neutron client is the command-line interface (CLI) for the - OpenStack Networking API and its extensions. + Networking command-line client + The neutron client is the command-line interface + (CLI) for the OpenStack Networking API and its extensions. + For help on a specific neutron command, enter: @@ -18,7 +19,7 @@
neutron usage - [--os-auth-strategy <auth-strategy>] [--os-auth-url <auth-url>] + [--os-auth-url <auth-url>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-username <auth-username>] [--os-password <auth-password>] @@ -39,10 +40,11 @@ - -v, --verbose + -v, --verbose, --debug - Increase verbosity of output. Can be repeated. + Increase verbosity of output and show tracebacks on + errors. Can be repeated. @@ -62,14 +64,6 @@ - - --debug - - - Show tracebacks on errors - - - --os-auth-strategy <auth-strategy> @@ -8039,7 +8033,7 @@ Create a router for a given tenant. distributed - Create a distributed router (Nicira plugin only) + Create a distributed router (VMware NSX plugin only) diff --git a/doc/common/ch_cli_nova_commands.xml b/doc/common/ch_cli_nova_commands.xml index e1fa3761b6..310d14a02b 100644 --- a/doc/common/ch_cli_nova_commands.xml +++ b/doc/common/ch_cli_nova_commands.xml @@ -8,9 +8,10 @@ - nova commands - The nova client is the command-line interface (CLI) for the - OpenStack Compute API and its extensions. + Compute command-line client + The nova client is the command-line interface + (CLI) for the OpenStack Compute API and its extensions. + For help on a specific nova command, enter: @@ -1311,54 +1312,6 @@ - - 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 @@ -1416,6 +1369,103 @@ + + 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 @@ -1441,55 +1491,6 @@ - - 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. - - -
diff --git a/doc/common/ch_cli_swift_commands.xml b/doc/common/ch_cli_swift_commands.xml index 2ef04ec881..d4c0a535e3 100644 --- a/doc/common/ch_cli_swift_commands.xml +++ b/doc/common/ch_cli_swift_commands.xml @@ -8,9 +8,10 @@ - swift commands - The swift client is the command-line interface (CLI) for the - OpenStack Object Storage API and its extensions. + Object Storage command-line client + The swift client is the command-line interface + (CLI) for the OpenStack Object Storage API and its extensions. + For help on a specific swift command, enter: @@ -85,6 +86,14 @@ + + capabilities + + + List cluster capabilities + + +
@@ -203,7 +212,7 @@ --os-username=<auth-user-name> - Openstack username. Defaults to env[OS_USERNAME]. + OpenStack username. Defaults to env[OS_USERNAME]. @@ -211,7 +220,7 @@ --os-password=<auth-password> - Openstack password. Defaults to env[OS_PASSWORD]. + OpenStack password. Defaults to env[OS_PASSWORD]. @@ -227,7 +236,7 @@ --os-tenant-name=<auth-tenant-name> - Openstack tenant name. Defaults to + OpenStack tenant name. Defaults to env[OS_TENANT_NAME]. @@ -236,7 +245,7 @@ --os-auth-url=<auth-url> - Openstack auth URL. Defaults to env[OS_AUTH_URL]. + OpenStack auth URL. Defaults to env[OS_AUTH_URL]. @@ -244,7 +253,7 @@ --os-auth-token=<auth-token> - Openstack token. Defaults to env[OS_AUTH_TOKEN]. Used + OpenStack token. Defaults to env[OS_AUTH_TOKEN]. Used with --os-storage-url to bypass the usual username/password authentication. @@ -254,7 +263,7 @@ --os-storage-url=<storage-url> - Openstack storage URL. Defaults to + OpenStack storage URL. Defaults to env[OS_STORAGE_URL]. Overrides the storage url returned during auth. Will bypass authentication when used with --os-auth-token. @@ -265,7 +274,7 @@ --os-region-name=<region-name> - Openstack region name. Defaults to env[OS_REGION_NAME] + OpenStack region name. Defaults to env[OS_REGION_NAME] @@ -273,7 +282,7 @@ --os-service-type=<service-type> - Openstack Service type. Defaults to + OpenStack Service type. Defaults to env[OS_SERVICE_TYPE] @@ -282,7 +291,7 @@ --os-endpoint-type=<endpoint-type> - Openstack Endpoint type. Defaults to + OpenStack Endpoint type. Defaults to env[OS_ENDPOINT_TYPE] @@ -300,10 +309,9 @@ --insecure - Allow swiftclient to access insecure keystone server. - The keystone's certificate will not be verified. - Defaults to env[SWIFTCLIENT_INSECURE] (set to 'true' - to enable). + Allow swiftclient to access servers without having to + verify the SSL certificate. Defaults to + env[SWIFTCLIENT_INSECURE] (set to 'true' to enable). @@ -311,8 +319,9 @@ --no-ssl-compression - Disable SSL compression when using https. This may - increase performance. + This option is deprecated and not used anymore. SSL + compression should be disabled by default by the + system SSL library @@ -365,7 +374,8 @@ --object-threads <threads> - Number of threads to use for deleting objects + Number of threads to use for deleting objects. + Default is 10 @@ -373,7 +383,8 @@ --container-threads <threads> - Number of threads to use for deleting containers + Number of threads to use for deleting containers. + Default is 10 @@ -396,7 +407,7 @@ - <object> + [object] Name of object to download. Specify multiple times @@ -448,7 +459,8 @@ --object-threads <threads> - Number of threads to use for downloading objects + Number of threads to use for downloading objects. + Default is 10 @@ -456,7 +468,8 @@ --container-threads <threads> - Number of threads to use for deleting containers + Number of threads to use for downloading containers. + Default is 10 @@ -519,7 +532,7 @@ --totals - Used with -l or --ls, only report totals + Used with -l or --lh, only report totals @@ -552,7 +565,7 @@ If the container is not found, it will be created automatically. Positional arguments - <container> + [container] Name of container to post to @@ -634,7 +647,7 @@ If the container is not found, it will be created automatically. Positional arguments - <container> + [container] Name of container to stat from @@ -642,7 +655,7 @@ If the container is not found, it will be created automatically. - <object> + [object] Name of object to stat. Specify multiple times