openstack/openstack-manuals
Code Issues Proposed changes

Merge "Autogenerate python cli page"

Browse Source
This commit is contained in:
Jenkins 2014-01-22 22:14:09 +00:00 committed by Gerrit Code Review
commit 9a330eb0c2
13 changed files with 10872 additions and 403 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

655
doc/common/section_cli_ceilometer_commands.xml
View File

@ -1,19 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ceilometer_client_commands">
<title>ceilometer commands</title>
<para>The ceilometer client is the command-line interface for the
OpenStack Telemetry API.</para>
<para>For help on a specific ceilometer command, enter:</para>
<screen><prompt>$</prompt> <userinput><command>ceilometer</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput>ceilometer [--version] [-d] [-v] [-k] [--cert-file CERT_FILE]
[--key-file KEY_FILE] [--ca-file CA_FILE]
[--timeout TIMEOUT] [--os-username OS_USERNAME]
[--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID]
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ceilometerclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>ceilometer commands</title>
<para>The ceilometer client is the command-line interface (CLI) for the
OpenStack Telemetry API and its extensions.</para>
<para>For help on a specific <command>ceilometer</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>ceilometer</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="ceilometerclient_command_usage">
<title>ceilometer usage</title>
<screen><computeroutput> [--key-file KEY_FILE] [--os-cacert &lt;ca-certificate-file>]
[--ca-file OS_CACERT] [--timeout TIMEOUT]
[--os-username OS_USERNAME] [--os-password OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID]
[--os-tenant-name OS_TENANT_NAME]
[--os-auth-url OS_AUTH_URL]
[--os-region-name OS_REGION_NAME]
@ -23,29 +31,48 @@
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE]
&lt;subcommand> ...</computeroutput></screen>
</example>
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
alarm-create Create a new alarm.
</section>
<section xml:id="ceilometerclient_command_pos">
<title>ceilometer positional arguments</title>
<screen><computeroutput> &lt;subcommand>
alarm-combination-create
Create a new alarm based on state of other alarms.
alarm-combination-update
Update an existing alarm based on state of other
alarms.
alarm-create Create a new alarm (Deprecated).
alarm-delete Delete an alarm.
alarm-history Display the change history of an alarm.
alarm-list List the user's alarms.
alarm-show Show an alarm.
alarm-state-get Get the state of an alarm.
alarm-state-set Set the state of an alarm.
alarm-threshold-create
Create a new alarm based on computed statistics.
alarm-threshold-update
Update an existing alarm based on computed statistics.
alarm-update Update an existing alarm.
event-list List events.
event-show Show a particular event.
event-type-list List event types.
meter-list List the user's meters.
resource-list List the resources.
resource-show Show the resource.
sample-create Create a sample.
sample-list List the samples for this meters.
statistics List the statistics for this meter.
sample-list List the samples for a meter.
statistics List the statistics for a meter.
trait-description-list
List trait info for an event type.
trait-list List trait all traits with name &lt;trait_name> for Event
Type
bash-completion Prints all of the commands and options to stdout.
help Display help about this program or one of its
subcommands.</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
<screen><computeroutput> -d, --debug Defaults to env[HEATCLIENT_DEBUG]
--version show program's version number and exit
subcommands.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_command_optional">
<title>ceilometer optional arguments</title>
<screen><computeroutput> --version show program's version number and exit
-d, --debug Defaults to env[CEILOMETERCLIENT_DEBUG]
-v, --verbose Print more verbose output
-k, --insecure Explicitly allow ceilometerclient to perform
@ -60,10 +87,11 @@
--key-file KEY_FILE Path of client key to use in SSL connection. This
option is not necessary if your key is prepended to
your cert file.
--ca-file CA_FILE Path of CA SSL certificate(s) used to verify the
remote server certificate. Without this option
ceilometer looks for the default system CA
certificates.
--os-cacert &lt;ca-certificate-file>
Path of CA TLS certificate(s) used to verifythe remote
server's certificate. Without this option ceilometer
looks for the default system CA certificates.
--ca-file OS_CACERT DEPRECATED! Use --os-cacert.
--timeout TIMEOUT Number of seconds to wait for a response
--os-username OS_USERNAME
Defaults to env[OS_USERNAME]
@ -86,6 +114,565 @@
--os-service-type OS_SERVICE_TYPE
Defaults to env[OS_SERVICE_TYPE]
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE]</computeroutput></screen>
</example>
Defaults to env[OS_ENDPOINT_TYPE]
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-combination-create">
<title>ceilometer alarm-combination-create command</title>
<screen><computeroutput>usage: ceilometer alarm-combination-create --name &lt;NAME>
[--project-id &lt;PROJECT_ID>]
[--user-id &lt;USER_ID>]
[--description &lt;DESCRIPTION>]
[--state &lt;STATE>]
[--enabled {True|False}]
[--alarm-action &lt;Webhook URL>]
[--ok-action &lt;Webhook URL>]
[--insufficient-data-action &lt;Webhook URL>]
--alarm_ids &lt;ALARM IDS>
[--operator &lt;OPERATOR>]
[--repeat-actions {True|False}]
Create a new alarm based on state of other alarms.
Optional arguments:
--name &lt;NAME> Name of the alarm (must be unique per tenant)
Required.
--project-id &lt;PROJECT_ID>
Tenant to associate with alarm (only settable by admin
users)
--user-id &lt;USER_ID> User to associate with alarm (only settable by admin
users)
--description &lt;DESCRIPTION>
Free text description of the alarm
--state &lt;STATE> State of the alarm, one of: ['ok', 'alarm',
'insufficient_data']
--enabled {True|False}
True if alarm evaluation/actioning is enabled
--alarm-action &lt;Webhook URL>
URL to invoke when state transitions to alarm. May be
used multiple times. Defaults to None.
--ok-action &lt;Webhook URL>
URL to invoke when state transitions to OK. May be
used multiple times. Defaults to None.
--insufficient-data-action &lt;Webhook URL>
URL to invoke when state transitions to unkown. May be
used multiple times. Defaults to None.
--alarm_ids &lt;ALARM IDS>
List of alarm id Required.
--operator &lt;OPERATOR>
Operator to compare with, one of: ['and', 'or']
--repeat-actions {True|False}
True if actions should be repeatedly notified while
alarm remains in target state Defaults to False.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-combination-update">
<title>ceilometer alarm-combination-update command</title>
<screen><computeroutput>usage: ceilometer alarm-combination-update -a &lt;ALARM_ID> [--name &lt;NAME>]
[--project-id &lt;PROJECT_ID>]
[--user-id &lt;USER_ID>]
[--description &lt;DESCRIPTION>]
[--state &lt;STATE>]
[--enabled {True|False}]
[--alarm-action &lt;Webhook URL>]
[--ok-action &lt;Webhook URL>]
[--insufficient-data-action &lt;Webhook URL>]
[--alarm_ids &lt;ALARM IDS>]
[--operator &lt;OPERATOR>]
[--repeat-actions {True|False}]
Update an existing alarm based on state of other alarms.
Optional arguments:
-a &lt;ALARM_ID>, --alarm_id &lt;ALARM_ID>
ID of the alarm to update. Required.
--name &lt;NAME> Name of the alarm (must be unique per tenant)
--project-id &lt;PROJECT_ID>
Tenant to associate with alarm (only settable by admin
users)
--user-id &lt;USER_ID> User to associate with alarm (only settable by admin
users)
--description &lt;DESCRIPTION>
Free text description of the alarm
--state &lt;STATE> State of the alarm, one of: ['ok', 'alarm',
'insufficient_data']
--enabled {True|False}
True if alarm evaluation/actioning is enabled
--alarm-action &lt;Webhook URL>
URL to invoke when state transitions to alarm. May be
used multiple times. Defaults to None.
--ok-action &lt;Webhook URL>
URL to invoke when state transitions to OK. May be
used multiple times. Defaults to None.
--insufficient-data-action &lt;Webhook URL>
URL to invoke when state transitions to unkown. May be
used multiple times. Defaults to None.
--alarm_ids &lt;ALARM IDS>
List of alarm id
--operator &lt;OPERATOR>
Operator to compare with, one of: ['and', 'or']
--repeat-actions {True|False}
True if actions should be repeatedly notified while
alarm remains in target state
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-delete">
<title>ceilometer alarm-delete command</title>
<screen><computeroutput>usage: ceilometer alarm-delete -a &lt;ALARM_ID>
Delete an alarm.
Optional arguments:
-a &lt;ALARM_ID>, --alarm_id &lt;ALARM_ID>
ID of the alarm to delete. Required.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-history">
<title>ceilometer alarm-history command</title>
<screen><computeroutput>usage: ceilometer alarm-history -a &lt;ALARM_ID> [-q &lt;QUERY>]
Display the change history of an alarm.
Optional arguments:
-a &lt;ALARM_ID>, --alarm_id &lt;ALARM_ID>
ID of the alarm for which history is shown. Required.
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, float, or
boolean
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-list">
<title>ceilometer alarm-list command</title>
<screen><computeroutput>usage: ceilometer alarm-list [-q &lt;QUERY>]
List the user's alarms.
Optional arguments:
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, float, or
boolean
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-show">
<title>ceilometer alarm-show command</title>
<screen><computeroutput>usage: ceilometer alarm-show -a &lt;ALARM_ID>
Show an alarm.
Optional arguments:
-a &lt;ALARM_ID>, --alarm_id &lt;ALARM_ID>
ID of the alarm to show. Required.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-state-get">
<title>ceilometer alarm-state-get command</title>
<screen><computeroutput>usage: ceilometer alarm-state-get -a &lt;ALARM_ID>
Get the state of an alarm.
Optional arguments:
-a &lt;ALARM_ID>, --alarm_id &lt;ALARM_ID>
ID of the alarm state to show. Required.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-state-set">
<title>ceilometer alarm-state-set command</title>
<screen><computeroutput>usage: ceilometer alarm-state-set -a &lt;ALARM_ID> --state &lt;STATE>
Set the state of an alarm.
Optional arguments:
-a &lt;ALARM_ID>, --alarm_id &lt;ALARM_ID>
ID of the alarm state to set. Required.
--state &lt;STATE> State of the alarm, one of: ['ok', 'alarm',
'insufficient_data'] Required.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-threshold-create">
<title>ceilometer alarm-threshold-create command</title>
<screen><computeroutput>usage: ceilometer alarm-threshold-create --name &lt;NAME>
[--project-id &lt;PROJECT_ID>]
[--user-id &lt;USER_ID>]
[--description &lt;DESCRIPTION>]
[--state &lt;STATE>]
[--enabled {True|False}]
[--alarm-action &lt;Webhook URL>]
[--ok-action &lt;Webhook URL>]
[--insufficient-data-action &lt;Webhook URL>]
--meter-name &lt;METRIC>
[--period &lt;PERIOD>]
[--evaluation-periods &lt;COUNT>]
[--statistic &lt;STATISTIC>]
[--comparison-operator &lt;OPERATOR>]
--threshold &lt;THRESHOLD> [-q &lt;QUERY>]
[--repeat-actions {True|False}]
Create a new alarm based on computed statistics.
Optional arguments:
--name &lt;NAME> Name of the alarm (must be unique per tenant)
Required.
--project-id &lt;PROJECT_ID>
Tenant to associate with alarm (only settable by admin
users)
--user-id &lt;USER_ID> User to associate with alarm (only settable by admin
users)
--description &lt;DESCRIPTION>
Free text description of the alarm
--state &lt;STATE> State of the alarm, one of: ['ok', 'alarm',
'insufficient_data']
--enabled {True|False}
True if alarm evaluation/actioning is enabled
--alarm-action &lt;Webhook URL>
URL to invoke when state transitions to alarm. May be
used multiple times. Defaults to None.
--ok-action &lt;Webhook URL>
URL to invoke when state transitions to OK. May be
used multiple times. Defaults to None.
--insufficient-data-action &lt;Webhook URL>
URL to invoke when state transitions to unkown. May be
used multiple times. Defaults to None.
--meter-name &lt;METRIC>
Metric to evaluate against Required.
--period &lt;PERIOD> Length of each period (seconds) to evaluate over
--evaluation-periods &lt;COUNT>
Number of periods to evaluate over
--statistic &lt;STATISTIC>
Statistic to evaluate, one of: ['max', 'min', 'avg',
'sum', 'count']
--comparison-operator &lt;OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq',
'ne', 'ge', 'gt']
--threshold &lt;THRESHOLD>
Threshold to evaluate against Required.
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, float, or
boolean
--repeat-actions {True|False}
True if actions should be repeatedly notified while
alarm remains in target state Defaults to False.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-threshold-update">
<title>ceilometer alarm-threshold-update command</title>
<screen><computeroutput>usage: ceilometer alarm-threshold-update -a &lt;ALARM_ID> [--name &lt;NAME>]
[--project-id &lt;PROJECT_ID>]
[--user-id &lt;USER_ID>]
[--description &lt;DESCRIPTION>]
[--state &lt;STATE>]
[--enabled {True|False}]
[--alarm-action &lt;Webhook URL>]
[--ok-action &lt;Webhook URL>]
[--insufficient-data-action &lt;Webhook URL>]
[--meter-name &lt;METRIC>]
[--period &lt;PERIOD>]
[--evaluation-periods &lt;COUNT>]
[--statistic &lt;STATISTIC>]
[--comparison-operator &lt;OPERATOR>]
[--threshold &lt;THRESHOLD>]
[-q &lt;QUERY>]
[--repeat-actions {True|False}]
Update an existing alarm based on computed statistics.
Optional arguments:
-a &lt;ALARM_ID>, --alarm_id &lt;ALARM_ID>
ID of the alarm to update. Required.
--name &lt;NAME> Name of the alarm (must be unique per tenant)
--project-id &lt;PROJECT_ID>
Tenant to associate with alarm (only settable by admin
users)
--user-id &lt;USER_ID> User to associate with alarm (only settable by admin
users)
--description &lt;DESCRIPTION>
Free text description of the alarm
--state &lt;STATE> State of the alarm, one of: ['ok', 'alarm',
'insufficient_data']
--enabled {True|False}
True if alarm evaluation/actioning is enabled
--alarm-action &lt;Webhook URL>
URL to invoke when state transitions to alarm. May be
used multiple times. Defaults to None.
--ok-action &lt;Webhook URL>
URL to invoke when state transitions to OK. May be
used multiple times. Defaults to None.
--insufficient-data-action &lt;Webhook URL>
URL to invoke when state transitions to unkown. May be
used multiple times. Defaults to None.
--meter-name &lt;METRIC>
Metric to evaluate against
--period &lt;PERIOD> Length of each period (seconds) to evaluate over
--evaluation-periods &lt;COUNT>
Number of periods to evaluate over
--statistic &lt;STATISTIC>
Statistic to evaluate, one of: ['max', 'min', 'avg',
'sum', 'count']
--comparison-operator &lt;OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq',
'ne', 'ge', 'gt']
--threshold &lt;THRESHOLD>
Threshold to evaluate against
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, float, or
boolean
--repeat-actions {True|False}
True if actions should be repeatedly notified while
alarm remains in target state
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-update">
<title>ceilometer alarm-update command</title>
<screen><computeroutput>usage: ceilometer alarm-update -a &lt;ALARM_ID> [--name &lt;NAME>]
[--project-id &lt;PROJECT_ID>]
[--user-id &lt;USER_ID>]
[--description &lt;DESCRIPTION>] [--state &lt;STATE>]
[--enabled {True|False}]
[--alarm-action &lt;Webhook URL>]
[--ok-action &lt;Webhook URL>]
[--insufficient-data-action &lt;Webhook URL>]
[--period &lt;PERIOD>]
[--evaluation-periods &lt;COUNT>]
[--meter-name &lt;METRIC>]
[--statistic &lt;STATISTIC>]
[--comparison-operator &lt;OPERATOR>]
[--threshold &lt;THRESHOLD>]
[--matching-metadata &lt;Matching Metadata>]
[--repeat-actions {True|False}]
Update an existing alarm.
Optional arguments:
-a &lt;ALARM_ID>, --alarm_id &lt;ALARM_ID>
ID of the alarm to update. Required.
--name &lt;NAME> Name of the alarm (must be unique per tenant)
--project-id &lt;PROJECT_ID>
Tenant to associate with alarm (only settable by admin
users)
--user-id &lt;USER_ID> User to associate with alarm (only settable by admin
users)
--description &lt;DESCRIPTION>
Free text description of the alarm
--state &lt;STATE> State of the alarm, one of: ['ok', 'alarm',
'insufficient_data']
--enabled {True|False}
True if alarm evaluation/actioning is enabled
--alarm-action &lt;Webhook URL>
URL to invoke when state transitions to alarm. May be
used multiple times. Defaults to None.
--ok-action &lt;Webhook URL>
URL to invoke when state transitions to OK. May be
used multiple times. Defaults to None.
--insufficient-data-action &lt;Webhook URL>
URL to invoke when state transitions to unkown. May be
used multiple times. Defaults to None.
--period &lt;PERIOD> Length of each period (seconds) to evaluate over
--evaluation-periods &lt;COUNT>
Number of periods to evaluate over
--meter-name &lt;METRIC>
Metric to evaluate against
--statistic &lt;STATISTIC>
Statistic to evaluate, one of: ['max', 'min', 'avg',
'sum', 'count']
--comparison-operator &lt;OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq',
'ne', 'ge', 'gt']
--threshold &lt;THRESHOLD>
Threshold to evaluate against
--matching-metadata &lt;Matching Metadata>
A meter should match this resource metadata
(key=value) additionally to the meter_name Defaults to
None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while
alarm remains in target state
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_event-list">
<title>ceilometer event-list command</title>
<screen><computeroutput>usage: ceilometer event-list [-q &lt;QUERY>]
List events.
Optional arguments:
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, floator
datetime.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_event-show">
<title>ceilometer event-show command</title>
<screen><computeroutput>usage: ceilometer event-show -m &lt;message_id>
Show a particular event.
Optional arguments:
-m &lt;message_id>, --message_id &lt;message_id>
The id of the event. Should be a UUID Required.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_event-type-list">
<title>ceilometer event-type-list command</title>
<screen><computeroutput>usage: ceilometer event-type-list
List event types.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_meter-list">
<title>ceilometer meter-list command</title>
<screen><computeroutput>usage: ceilometer meter-list [-q &lt;QUERY>]
List the user's meters.
Optional arguments:
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, float, or
boolean
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_resource-list">
<title>ceilometer resource-list command</title>
<screen><computeroutput>usage: ceilometer resource-list [-q &lt;QUERY>]
List the resources.
Optional arguments:
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, float, or
boolean.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_resource-show">
<title>ceilometer resource-show command</title>
<screen><computeroutput>usage: ceilometer resource-show -r &lt;RESOURCE_ID>
Show the resource.
Optional arguments:
-r &lt;RESOURCE_ID>, --resource_id &lt;RESOURCE_ID>
ID of the resource to show. Required.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_sample-create">
<title>ceilometer sample-create command</title>
<screen><computeroutput>usage: ceilometer sample-create [--project-id &lt;PROJECT_ID>]
[--user-id &lt;USER_ID>] -r &lt;RESOURCE_ID> -m
&lt;METER_NAME> --meter-type &lt;METER_TYPE>
--meter-unit &lt;METER_UNIT> --sample-volume
&lt;SAMPLE_VOLUME>
[--resource-metadata &lt;RESOURCE_METADATA>]
[--timestamp &lt;TIMESTAMP>]
Create a sample.
Optional arguments:
--project-id &lt;PROJECT_ID>
Tenant to associate with sample (only settable by
admin users)
--user-id &lt;USER_ID> User to associate with sample (only settable by admin
users)
-r &lt;RESOURCE_ID>, --resource-id &lt;RESOURCE_ID>
ID of the resource. Required.
-m &lt;METER_NAME>, --meter-name &lt;METER_NAME>
the meter name Required.
--meter-type &lt;METER_TYPE>
the meter type Required.
--meter-unit &lt;METER_UNIT>
the meter unit Required.
--sample-volume &lt;SAMPLE_VOLUME>
The sample volume Required.
--resource-metadata &lt;RESOURCE_METADATA>
resource metadata
--timestamp &lt;TIMESTAMP>
the sample timestamp
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_sample-list">
<title>ceilometer sample-list command</title>
<screen><computeroutput>usage: ceilometer sample-list [-q &lt;QUERY>] -m &lt;NAME> [-l &lt;NUMBER>]
List the samples for a meter.
Optional arguments:
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, float, or
boolean
-m &lt;NAME>, --meter &lt;NAME>
Name of meter to show samples for. Required.
-l &lt;NUMBER>, --limit &lt;NUMBER>
Maximum number of samples to return.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_statistics">
<title>ceilometer statistics command</title>
<screen><computeroutput>usage: ceilometer statistics [-q &lt;QUERY>] -m &lt;NAME> [-p &lt;PERIOD>]
List the statistics for a meter.
Optional arguments:
-q &lt;QUERY>, --query &lt;QUERY>
key[op]data_type::value; list. data_type is optional,
but if supplied must be string, integer, float, or
boolean
-m &lt;NAME>, --meter &lt;NAME>
Name of meter to show samples for. Required.
-p &lt;PERIOD>, --period &lt;PERIOD>
Period in seconds over which to group samples.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_trait-description-list">
<title>ceilometer trait-description-list command</title>
<screen><computeroutput>usage: ceilometer trait-description-list -e &lt;EVENT_TYPE>
List trait info for an event type.
Optional arguments:
-e &lt;EVENT_TYPE>, --event_type &lt;EVENT_TYPE>
Type of the event for which traits will be shown
Required.
</computeroutput></screen>
</section>
<section xml:id="ceilometerclient_subcommand_trait-list">
<title>ceilometer trait-list command</title>
<screen><computeroutput>usage: ceilometer trait-list -e &lt;EVENT_TYPE> -t &lt;TRAIT_NAME>
List trait all traits with name &lt;trait_name> for Event Type &lt;event_type>.
Optional arguments:
-e &lt;EVENT_TYPE>, --event_type &lt;EVENT_TYPE>
Type of the event for which traits will listed
Required.
-t &lt;TRAIT_NAME>, --trait_name &lt;TRAIT_NAME>
The name of the trait to list Required.
</computeroutput></screen>
</section>
</section>

975
doc/common/section_cli_cinder_commands.xml
View File

File diff suppressed because it is too large Load Diff

322
doc/common/section_cli_glance_commands.xml
View File

@ -1,34 +1,41 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="glance_commands">
<title>glance commands</title>
<para>The glance client is the command-line interface (CLI) for the
OpenStack Image Service API.</para>
<para>For help on a specific glance command, enter:</para>
<screen><prompt>$</prompt> <userinput><command>glance</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput> glance [--version] [-d] [-v] [-k] [--cert-file CERT_FILE]
[--key-file KEY_FILE] [--os-cacert &lt;ca-certificate-file>]
[--ca-file OS_CACERT] [--timeout TIMEOUT] [--no-ssl-compression]
[-f] [--dry-run] [--ssl] [-H ADDRESS] [-p PORT]
[--os-username OS_USERNAME] [-I OS_USERNAME]
[--os-password OS_PASSWORD] [-K OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[-T OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [-N OS_AUTH_URL]
[--os-region-name OS_REGION_NAME] [-R OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [-A OS_AUTH_TOKEN]
[--os-image-url OS_IMAGE_URL] [-U OS_IMAGE_URL]
[--os-image-api-version OS_IMAGE_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-S OS_AUTH_STRATEGY]
&lt;subcommand> ...</computeroutput></screen>
</example>
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="glanceclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>glance commands</title>
<para>The glance client is the command-line interface (CLI) for the
OpenStack Image Service API and its extensions.</para>
<para>For help on a specific <command>glance</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>glance</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="glanceclient_command_usage">
<title>glance usage</title>
<screen><computeroutput> [--cert-file CERT_FILE] [--key-file KEY_FILE]
[--os-cacert &lt;ca-certificate-file>] [--ca-file OS_CACERT]
[--timeout TIMEOUT] [--no-ssl-compression] [-f] [--dry-run]
[--ssl] [-H ADDRESS] [-p PORT] [--os-username OS_USERNAME]
[-I OS_USERNAME] [--os-password OS_PASSWORD] [-K OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[-T OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [-N OS_AUTH_URL]
[--os-region-name OS_REGION_NAME] [-R OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [-A OS_AUTH_TOKEN]
[--os-image-url OS_IMAGE_URL] [-U OS_IMAGE_URL]
[--os-image-api-version OS_IMAGE_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-S OS_AUTH_STRATEGY]
&lt;subcommand> ...</computeroutput></screen>
</section>
<section xml:id="glanceclient_command_pos">
<title>glance positional arguments</title>
<screen><computeroutput> &lt;subcommand>
add DEPRECATED! Use image-create instead.
clear DEPRECATED!
delete DEPRECATED! Use image-delete instead.
@ -50,13 +57,17 @@
show DEPRECATED! Use image-show instead.
update DEPRECATED! Use image-update instead.
help Display help about this program or one of its
subcommands.</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
<screen><computeroutput> --version show program's version number and exit
subcommands.
</computeroutput></screen>
</section>
<section xml:id="glanceclient_command_optional">
<title>glance optional arguments</title>
<screen><computeroutput> --version show program's version number and exit
-d, --debug Defaults to env[GLANCECLIENT_DEBUG]
-v, --verbose Print more verbose output
--get-schema Force retrieving the schema used to generate portions
of the help text rather than using a cached copy.
Ignored with api version 1
-k, --insecure Explicitly allow glanceclient to perform "insecure
SSL" (https) requests. The server's certificate will
not be verified against any certificate authorities.
@ -117,6 +128,245 @@
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE]
-S OS_AUTH_STRATEGY, --os_auth_strategy OS_AUTH_STRATEGY
DEPRECATED! This option is completely ignored.</computeroutput></screen>
</example>
DEPRECATED! This option is completely ignored.
</computeroutput></screen>
</section>
<section xml:id="glanceclient_subcommand_image-create">
<title>glance image-create command</title>
<screen><computeroutput>usage: glance image-create [--id &lt;IMAGE_ID>] [--name &lt;NAME>] [--store &lt;STORE>]
[--disk-format &lt;DISK_FORMAT>]
[--container-format &lt;CONTAINER_FORMAT>]
[--owner &lt;TENANT_ID>] [--size &lt;SIZE>]
[--min-disk &lt;DISK_GB>] [--min-ram &lt;DISK_RAM>]
[--location &lt;IMAGE_URL>] [--file &lt;FILE>]
[--checksum &lt;CHECKSUM>] [--copy-from &lt;IMAGE_URL>]
[--is-public {True,False}]
[--is-protected {True,False}]
[--property &lt;key=value>] [--human-readable]
[--progress]
Create a new image.
Optional arguments:
--id &lt;IMAGE_ID> ID of image to reserve.
--name &lt;NAME> Name of image.
--store &lt;STORE> Store to upload image to.
--disk-format &lt;DISK_FORMAT>
Disk format of image. Acceptable formats: ami, ari,
aki, vhd, vmdk, raw, qcow2, vdi, and iso.
--container-format &lt;CONTAINER_FORMAT>
Container format of image. Acceptable formats: ami,
ari, aki, bare, and ovf.
--owner &lt;TENANT_ID> Tenant who should own image.
--size &lt;SIZE> Size of image data (in bytes). Only used with '--
location' and '--copy_from'.
--min-disk &lt;DISK_GB> Minimum size of disk needed to boot image (in
gigabytes).
--min-ram &lt;DISK_RAM> Minimum amount of ram needed to boot image (in
megabytes).
--location &lt;IMAGE_URL>
URL where the data for this image already resides. For
example, if the image data is stored in swift, you
could specify
'swift://account:key@example.com/container/obj'.
--file &lt;FILE> Local file that contains disk image to be uploaded
during creation. Alternatively, images can be passed
to the client via stdin.
--checksum &lt;CHECKSUM>
Hash of image data used Glance can use for
verification. Provide a md5 checksum here.
--copy-from &lt;IMAGE_URL>
Similar to '--location' in usage, but this indicates
that the Glance server should immediately copy the
data and store it in its configured image store.
--is-public {True,False}
Make image accessible to the public.
--is-protected {True,False}
Prevent image from being deleted.
--property &lt;key=value>
Arbitrary property to associate with image. May be
used multiple times.
--human-readable Print image size in a human-friendly format.
--progress Show upload progress bar.
</computeroutput></screen>
</section>
<section xml:id="glanceclient_subcommand_image-delete">
<title>glance image-delete command</title>
<screen><computeroutput>usage: glance image-delete &lt;IMAGE> [&lt;IMAGE> ...]
Delete specified image(s).
Positional arguments:
&lt;IMAGE> Name or ID of image(s) to delete.
</computeroutput></screen>
</section>
<section xml:id="glanceclient_subcommand_image-list">
<title>glance image-list command</title>
<screen><computeroutput>usage: glance image-list [--name &lt;NAME>] [--status &lt;STATUS>]
[--container-format &lt;CONTAINER_FORMAT>]
[--disk-format &lt;DISK_FORMAT>] [--size-min &lt;SIZE>]
[--size-max &lt;SIZE>] [--property-filter &lt;KEY=VALUE>]
[--page-size &lt;SIZE>] [--human-readable]
[--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}]
[--sort-dir {asc,desc}] [--is-public {True,False}]
[--owner &lt;TENANT_ID>] [--all-tenants]
List images you can access.
Optional arguments:
--name &lt;NAME> Filter images to those that have this name.
--status &lt;STATUS> Filter images to those that have this status.
--container-format &lt;CONTAINER_FORMAT>
Filter images to those that have this container
format. Acceptable formats: ami, ari, aki, bare, and
ovf.
--disk-format &lt;DISK_FORMAT>
Filter images to those that have this disk format.
Acceptable formats: ami, ari, aki, vhd, vmdk, raw,
qcow2, vdi, and iso.
--size-min &lt;SIZE> Filter images to those with a size greater than this.
--size-max &lt;SIZE> Filter images to those with a size less than this.
--property-filter &lt;KEY=VALUE>
Filter images by a user-defined image property.
--page-size &lt;SIZE> Number of images to request in each paginated request.
--human-readable Print image size in a human-friendly format.
--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}
Sort image list by specified field.
--sort-dir {asc,desc}
Sort image list in specified direction.
--is-public {True,False}
Allows the user to select a listing of public or non
public images.
--owner &lt;TENANT_ID> Display only images owned by this tenant id. Filtering
occurs on the client side so may be inefficient. This
option is mainly intended for admin use. Use an empty
string ('') to list images with no owner. Note: This
option overrides the --is-public argument if present.
Note: the v2 API supports more efficient server-side
owner based filtering.
--all-tenants Allows the admin user to list all images irrespective
of the image's owner or is_public value.
</computeroutput></screen>
</section>
<section xml:id="glanceclient_subcommand_image-show">
<title>glance image-show command</title>
<screen><computeroutput>usage: glance image-show [--human-readable] &lt;IMAGE>
Describe a specific image.
Positional arguments:
&lt;IMAGE> Name or ID of image to describe.
Optional arguments:
--human-readable Print image size in a human-friendly format.
</computeroutput></screen>
</section>
<section xml:id="glanceclient_subcommand_image-update">
<title>glance image-update command</title>
<screen><computeroutput>usage: glance image-update [--name &lt;NAME>] [--disk-format &lt;DISK_FORMAT>]
[--container-format &lt;CONTAINER_FORMAT>]
[--owner &lt;TENANT_ID>] [--size &lt;SIZE>]
[--min-disk &lt;DISK_GB>] [--min-ram &lt;DISK_RAM>]
[--location &lt;IMAGE_URL>] [--file &lt;FILE>]
[--checksum &lt;CHECKSUM>] [--copy-from &lt;IMAGE_URL>]
[--is-public {True,False}]
[--is-protected {True,False}]
[--property &lt;key=value>] [--purge-props]
[--human-readable] [--progress]
&lt;IMAGE>
Update a specific image.
Positional arguments:
&lt;IMAGE> Name or ID of image to modify.
Optional arguments:
--name &lt;NAME> Name of image.
--disk-format &lt;DISK_FORMAT>
Disk format of image. Acceptable formats: ami, ari,
aki, vhd, vmdk, raw, qcow2, vdi, and iso.
--container-format &lt;CONTAINER_FORMAT>
Container format of image. Acceptable formats: ami,
ari, aki, bare, and ovf.
--owner &lt;TENANT_ID> Tenant who should own image.
--size &lt;SIZE> Size of image data (in bytes).
--min-disk &lt;DISK_GB> Minimum size of disk needed to boot image (in
gigabytes).
--min-ram &lt;DISK_RAM> Minimum amount of ram needed to boot image (in
megabytes).
--location &lt;IMAGE_URL>
URL where the data for this image already resides. For
example, if the image data is stored in swift, you
could specify
'swift://account:key@example.com/container/obj'.
--file &lt;FILE> Local file that contains disk image to be uploaded
during update. Alternatively, images can be passed to
the client via stdin.
--checksum &lt;CHECKSUM>
Hash of image data used Glance can use for
verification.
--copy-from &lt;IMAGE_URL>
Similar to '--location' in usage, but this indicates
that the Glance server should immediately copy the
data and store it in its configured image store.
--is-public {True,False}
Make image accessible to the public.
--is-protected {True,False}
Prevent image from being deleted.
--property &lt;key=value>
Arbitrary property to associate with image. May be
used multiple times.
--purge-props If this flag is present, delete all image properties
not explicitly set in the update request. Otherwise,
those properties not referenced are preserved.
--human-readable Print image size in a human-friendly format.
--progress Show upload progress bar.
</computeroutput></screen>
</section>
<section xml:id="glanceclient_subcommand_member-create">
<title>glance member-create command</title>
<screen><computeroutput>usage: glance member-create [--can-share] &lt;IMAGE> &lt;TENANT_ID>
Share a specific image with a tenant.
Positional arguments:
&lt;IMAGE> Image to add member to.
&lt;TENANT_ID> Tenant to add as member
Optional arguments:
--can-share Allow the specified tenant to share this image.
</computeroutput></screen>
</section>
<section xml:id="glanceclient_subcommand_member-delete">
<title>glance member-delete command</title>
<screen><computeroutput>usage: glance member-delete &lt;IMAGE> &lt;TENANT_ID>
Remove a shared image from a tenant.
Positional arguments:
&lt;IMAGE> Image from which to remove member
&lt;TENANT_ID> Tenant to remove as member
</computeroutput></screen>
</section>
<section xml:id="glanceclient_subcommand_member-list">
<title>glance member-list command</title>
<screen><computeroutput>usage: glance member-list [--image-id &lt;IMAGE_ID>] [--tenant-id &lt;TENANT_ID>]
Describe sharing permissions by image or tenant.
Optional arguments:
--image-id &lt;IMAGE_ID>
Filter results by an image ID.
--tenant-id &lt;TENANT_ID>
Filter results by a tenant ID.
</computeroutput></screen>
</section>
</section>

369
doc/common/section_cli_heat_commands.xml
View File

@ -1,69 +1,81 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="heat_client_commands">
<title>heat commands</title>
<para>The heat client is the command-line interface for the
OpenStack Orchestration API.</para>
<para>For help on a specific heat command, enter:</para>
<screen><prompt>$</prompt> <userinput><command>heat</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput>heat [-d] [-v] [-k] [--cert-file CERT_FILE] [--key-file KEY_FILE]
[--ca-file CA_FILE] [--timeout TIMEOUT]
[--os-username OS_USERNAME] [--os-password OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth]
[--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-t]
&lt;subcommand> ...</computeroutput></screen>
</example>
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="heatclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>heat commands</title>
<para>The heat client is the command-line interface (CLI) for the
OpenStack Orchestration API and its extensions.</para>
<para>For help on a specific <command>heat</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>heat</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="heatclient_command_usage">
<title>heat usage</title>
<screen><computeroutput> [--key-file KEY_FILE] [--ca-file CA_FILE] [--timeout TIMEOUT]
[--os-username OS_USERNAME] [--os-password OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth]
[--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [--include-password]
&lt;subcommand> ...</computeroutput></screen>
</section>
<section xml:id="heatclient_command_pos">
<title>heat positional arguments</title>
<screen><computeroutput> &lt;subcommand>
action-resume Resume the stack.
action-suspend Suspend the stack.
create DEPRECATED! Use stack-create instead
delete DEPRECATED! Use stack-delete instead
describe DEPRECATED! Use stack-show instead
event DEPRECATED! Use event-show instead
event-list List events for a stack
event-show Describe the event
gettemplate DEPRECATED! Use template-show instead
list DEPRECATED! Use stack-list instead
resource DEPRECATED! Use resource-show instead
resource-list Show list of resources belonging to a stack
resource-metadata List resource metadata
resource-show Describe the resource
stack-create Create the stack
stack-delete Delete the stack
stack-list List the user's stacks
stack-show Describe the stack
stack-update Update the stack
template-show Get the template for the specified stack
template-validate Validate a template with parameters
update DEPRECATED! Use stack-update instead
validate DEPRECATED! Use template-validate instead
create DEPRECATED! Use stack-create instead.
delete DEPRECATED! Use stack-delete instead.
describe DEPRECATED! Use stack-show instead.
event DEPRECATED! Use event-show instead.
event-list List events for a stack.
event-show Describe the event.
gettemplate DEPRECATED! Use template-show instead.
list DEPRECATED! Use stack-list instead.
resource DEPRECATED! Use resource-show instead.
resource-list Show list of resources belonging to a stack.
resource-metadata List resource metadata.
resource-show Describe the resource.
resource-template Generate a template based on a resource.
resource-type-list List the available resource types.
resource-type-show Show the resource type.
stack-create Create the stack.
stack-delete Delete the stack(s).
stack-list List the user's stacks.
stack-show Describe the stack.
stack-update Update the stack.
template-show Get the template for the specified stack.
template-validate Validate a template with parameters.
update DEPRECATED! Use stack-update instead.
validate DEPRECATED! Use template-validate instead.
bash-completion Prints all of the commands and options to stdout.
help Display help about this program or one of its
subcommands.</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
<screen><computeroutput> -d, --debug Defaults to env[HEATCLIENT_DEBUG]
subcommands.
</computeroutput></screen>
</section>
<section xml:id="heatclient_command_optional">
<title>heat optional arguments</title>
<screen><computeroutput> --version Shows the client version and exits
-d, --debug Defaults to env[HEATCLIENT_DEBUG]
-v, --verbose Print more verbose output
-k, --insecure Explicitly allow the client to perform "insecure" SSL
-k, --insecure Explicitly allow the client to perform"insecure" SSL
(https) requests. The server's certificate will not be
verified against any certificate authorities. This
option should be used with caution.
--cert-file CERT_FILE
Path of certificate file to use in SSL connection.
This file can optionally be prepended with the private
This file can optionally be prependedwith the private
key.
--key-file KEY_FILE Path of client key to use in SSL connection. This
--key-file KEY_FILE Path of client key to use in SSL connection.This
option is not necessary if your key is prepended to
your cert file.
--ca-file CA_FILE Path of CA SSL certificate(s) used to verify the
@ -84,7 +96,7 @@
Defaults to env[OS_REGION_NAME]
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN]
--os-no-client-auth Do not contact heat for a token. Defaults to
--os-no-client-auth Do not contact keystone for a token. Defaults to
env[OS_NO_CLIENT_AUTH]
--heat-url HEAT_URL Defaults to env[HEAT_URL]
--heat-api-version HEAT_API_VERSION
@ -93,7 +105,248 @@
Defaults to env[OS_SERVICE_TYPE]
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE]
-t, --token-only Only send a token for auth, do not send username and
password as well.</computeroutput></screen>
</example>
--include-password Send os-username and os-password to heat
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_action-resume">
<title>heat action-resume command</title>
<screen><computeroutput>usage: heat action-resume &lt;NAME or ID>
Resume the stack.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to resume.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_action-suspend">
<title>heat action-suspend command</title>
<screen><computeroutput>usage: heat action-suspend &lt;NAME or ID>
Suspend the stack.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to suspend.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_event-list">
<title>heat event-list command</title>
<screen><computeroutput>usage: heat event-list [-r &lt;RESOURCE>] &lt;NAME or ID>
List events for a stack.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to show the events for.
Optional arguments:
-r &lt;RESOURCE>, --resource &lt;RESOURCE>
Name of the resource to filter events by
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_event-show">
<title>heat event-show command</title>
<screen><computeroutput>usage: heat event-show &lt;NAME or ID> &lt;RESOURCE> &lt;EVENT>
Describe the event.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to show the events for.
&lt;RESOURCE> Name of the resource the event belongs to.
&lt;EVENT> ID of event to display details for
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_resource-list">
<title>heat resource-list command</title>
<screen><computeroutput>usage: heat resource-list &lt;NAME or ID>
Show list of resources belonging to a stack.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to show the resources for.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_resource-metadata">
<title>heat resource-metadata command</title>
<screen><computeroutput>usage: heat resource-metadata &lt;NAME or ID> &lt;RESOURCE>
List resource metadata.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to show the resource metadata for.
&lt;RESOURCE> Name of the resource to show the metadata for.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_resource-show">
<title>heat resource-show command</title>
<screen><computeroutput>usage: heat resource-show &lt;NAME or ID> &lt;RESOURCE>
Describe the resource.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to show the resource for.
&lt;RESOURCE> Name of the resource to show the details for.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_resource-template">
<title>heat resource-template command</title>
<screen><computeroutput>usage: heat resource-template [-F &lt;FORMAT>] &lt;RESOURCE>
Generate a template based on a resource.
Positional arguments:
&lt;RESOURCE> Name of the resource to generate a template for.
Optional arguments:
-F &lt;FORMAT>, --format &lt;FORMAT>
The template output format, one of: yaml, json
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_resource-type-list">
<title>heat resource-type-list command</title>
<screen><computeroutput>usage: heat resource-type-list
List the available resource types.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_resource-type-show">
<title>heat resource-type-show command</title>
<screen><computeroutput>usage: heat resource-type-show &lt;RESOURCE_TYPE>
Show the resource type.
Positional arguments:
&lt;RESOURCE_TYPE> Resource Type to get the details for.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_stack-create">
<title>heat stack-create command</title>
<screen><computeroutput>usage: heat stack-create [-f &lt;FILE>] [-e &lt;FILE>] [-u &lt;URL>] [-o &lt;URL>]
[-c &lt;TIMEOUT>] [-r] [-P &lt;KEY1=VALUE1;KEY2=VALUE2...>]
&lt;STACK_NAME>
Create the stack.
Positional arguments:
&lt;STACK_NAME> Name of the stack to create.
Optional arguments:
-f &lt;FILE>, --template-file &lt;FILE>
Path to the template.
-e &lt;FILE>, --environment-file &lt;FILE>
Path to the environment.
-u &lt;URL>, --template-url &lt;URL>
URL of template.
-o &lt;URL>, --template-object &lt;URL>
URL to retrieve template object (e.g from swift)
-c &lt;TIMEOUT>, --create-timeout &lt;TIMEOUT>
Stack creation timeout in minutes. Default: 60
-r, --enable-rollback
Enable rollback on create/update failure
-P &lt;KEY1=VALUE1;KEY2=VALUE2...>, --parameters &lt;KEY1=VALUE1;KEY2=VALUE2...>
Parameter values used to create the stack. This can be
specified multiple times, or once with parameters
separated by semicolon.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_stack-delete">
<title>heat stack-delete command</title>
<screen><computeroutput>usage: heat stack-delete &lt;NAME or ID> [&lt;NAME or ID> ...]
Delete the stack(s).
Positional arguments:
&lt;NAME or ID> Name or ID of stack(s) to delete.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_stack-list">
<title>heat stack-list command</title>
<screen><computeroutput>usage: heat stack-list
List the user's stacks.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_stack-show">
<title>heat stack-show command</title>
<screen><computeroutput>usage: heat stack-show &lt;NAME or ID>
Describe the stack.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to describe.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_stack-update">
<title>heat stack-update command</title>
<screen><computeroutput>usage: heat stack-update [-f &lt;FILE>] [-e &lt;FILE>] [-u &lt;URL>] [-o &lt;URL>]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...>]
&lt;NAME or ID>
Update the stack.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to update.
Optional arguments:
-f &lt;FILE>, --template-file &lt;FILE>
Path to the template.
-e &lt;FILE>, --environment-file &lt;FILE>
Path to the environment.
-u &lt;URL>, --template-url &lt;URL>
URL of template.
-o &lt;URL>, --template-object &lt;URL>
URL to retrieve template object (e.g from swift)
-P &lt;KEY1=VALUE1;KEY2=VALUE2...>, --parameters &lt;KEY1=VALUE1;KEY2=VALUE2...>
Parameter values used to create the stack. This can be
specified multiple times, or once with parameters
separated by semicolon.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_template-show">
<title>heat template-show command</title>
<screen><computeroutput>usage: heat template-show &lt;NAME or ID>
Get the template for the specified stack.
Positional arguments:
&lt;NAME or ID> Name or ID of stack to get the template for.
</computeroutput></screen>
</section>
<section xml:id="heatclient_subcommand_template-validate">
<title>heat template-validate command</title>
<screen><computeroutput>usage: heat template-validate [-u &lt;URL>] [-f &lt;FILE>] [-e &lt;FILE>] [-o &lt;URL>]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...>]
Validate a template with parameters.
Optional arguments:
-u &lt;URL>, --template-url &lt;URL>
URL of template.
-f &lt;FILE>, --template-file &lt;FILE>
Path to the template.
-e &lt;FILE>, --environment-file &lt;FILE>
Path to the environment.
-o &lt;URL>, --template-object &lt;URL>
URL to retrieve template object (e.g from swift)
-P &lt;KEY1=VALUE1;KEY2=VALUE2...>, --parameters &lt;KEY1=VALUE1;KEY2=VALUE2...>
Parameter values to validate. This can be specified
multiple times, or once with parameters separated by
semicolon.
</computeroutput></screen>
</section>
</section>

589
doc/common/section_cli_keystone_commands.xml
View File

@ -2,81 +2,88 @@
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="keystone_client_commands">
xml:id="keystoneclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>keystone commands</title>
<para>The keystone client is the command-line interface (CLI) for
the OpenStack Identity API.</para>
<para>For help on a specific keystone command, enter:</para>
<para>The keystone client is the command-line interface (CLI) for the
OpenStack Identity API and its extensions.</para>
<para>For help on a specific <command>keystone</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>keystone</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput>
keystone [--version] [--timeout &lt;seconds>]
[--os-username &lt;auth-user-name>]
[--os-password &lt;auth-password>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-tenant-id &lt;tenant-id>] [--os-auth-url &lt;auth-url>]
[--os-region-name &lt;region-name>]
[--os-identity-api-version &lt;identity-api-version>]
[--os-token &lt;service-token>]
[--os-endpoint &lt;service-endpoint>]
[--os-cacert &lt;ca-certificate>] [--insecure]
[--os-cert &lt;certificate>] [--os-key &lt;key>] [--os-cache]
[--force-new-token] [--stale-duration &lt;seconds>]
&lt;subcommand> ...</computeroutput></screen>
</example>
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
<section xml:id="keystoneclient_command_usage">
<title>keystone usage</title>
<screen><computeroutput> [--os-username &lt;auth-user-name>]
[--os-password &lt;auth-password>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-tenant-id &lt;tenant-id>] [--os-auth-url &lt;auth-url>]
[--os-region-name &lt;region-name>]
[--os-identity-api-version &lt;identity-api-version>]
[--os-token &lt;service-token>]
[--os-endpoint &lt;service-endpoint>]
[--os-cacert &lt;ca-certificate>] [--insecure]
[--os-cert &lt;certificate>] [--os-key &lt;key>] [--os-cache]
[--force-new-token] [--stale-duration &lt;seconds>]
&lt;subcommand> ...</computeroutput></screen>
</section>
<section xml:id="keystoneclient_command_pos">
<title>keystone positional arguments</title>
<screen><computeroutput> &lt;subcommand>
catalog List service catalog, possibly filtered by service.
ec2-credentials-create
Create EC2-compatible credentials for user per tenant
Create EC2-compatible credentials for user per tenant.
ec2-credentials-delete
Delete EC2-compatible credentials
Delete EC2-compatible credentials.
ec2-credentials-get
Display EC2-compatible credentials
Display EC2-compatible credentials.
ec2-credentials-list
List EC2-compatible credentials for a user
endpoint-create Create a new endpoint associated with a service
endpoint-delete Delete a service endpoint
endpoint-create Create a new endpoint associated with a service.
endpoint-delete Delete a service endpoint.
endpoint-get Find endpoint filtered by a specific attribute or
service type
endpoint-list List configured service endpoints
password-update Update own password
role-create Create new role
role-delete Delete role
role-get Display role details
role-list List all roles
service-create Add service to Service Catalog
service-delete Delete service from Service Catalog
service-get Display service from Service Catalog
service-list List all services in Service Catalog
tenant-create Create new tenant
tenant-delete Delete tenant
tenant-get Display tenant details
tenant-list List all tenants
tenant-update Update tenant name, description, enabled status
token-get Display the current user token
service type.
endpoint-list List configured service endpoints.
password-update Update own password.
role-create Create new role.
role-delete Delete role.
role-get Display role details.
role-list List all roles.
service-create Add service to Service Catalog.
service-delete Delete service from Service Catalog.
service-get Display service from Service Catalog.
service-list List all services in Service Catalog.
tenant-create Create new tenant.
tenant-delete Delete tenant.
tenant-get Display tenant details.
tenant-list List all tenants.
tenant-update Update tenant name, description, enabled status.
token-get Display the current user token.
user-create Create new user
user-delete Delete user
user-get Display user details.
user-list List users
user-list List users.
user-password-update
Update user password
Update user password.
user-role-add Add role to user
user-role-list List roles granted to a user
user-role-remove Remove role from user
user-update Update user's name, email, and enabled status
user-update Update user's name, email, and enabled status.
discover Discover Keystone servers, supported API versions and
extensions.
bootstrap Grants a new role to a new user on a new tenant, after
creating each.
bash-completion Prints all of the commands and options to stdout.
help Display help about this program or one of its
subcommands.</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
subcommands.
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_command_optional">
<title>keystone optional arguments</title>
<screen><computeroutput> --version Shows the client version and exits
--timeout &lt;seconds> Set request timeout (in seconds)
--os-username &lt;auth-user-name>
@ -125,6 +132,478 @@ keystone [--version] [--timeout &lt;seconds>]
Stale duration (in seconds) used to determine whether
a token has expired when retrieving it from keyring.
This is useful in mitigating process or network
delays. Default is 30 seconds.</computeroutput></screen>
</example>
delays. Default is 30 seconds.
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_bootstrap">
<title>keystone bootstrap command</title>
<screen><computeroutput>usage: keystone bootstrap [--user-name &lt;user-name>] --pass &lt;password>
[--role-name &lt;role-name>]
[--tenant-name &lt;tenant-name>]
Grants a new role to a new user on a new tenant, after creating each.
Arguments:
--user-name &lt;user-name>
The name of the user to be created (default="admin").
--pass &lt;password> The password for the new user.
--role-name &lt;role-name>
The name of the role to be created and granted to the
user (default="admin").
--tenant-name &lt;tenant-name>
The name of the tenant to be created
(default="admin").
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_catalog">
<title>keystone catalog command</title>
<screen><computeroutput>usage: keystone catalog [--service &lt;service-type>]
List service catalog, possibly filtered by service.
Arguments:
--service &lt;service-type>
Service type to return
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_discover">
<title>keystone discover command</title>
<screen><computeroutput>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
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-create">
<title>keystone ec2-credentials-create command</title>
<screen><computeroutput>usage: keystone ec2-credentials-create [--user-id &lt;user-id>]
[--tenant-id &lt;tenant-id>]
Create EC2-compatible credentials for user per tenant.
Arguments:
--user-id &lt;user-id> User ID
--tenant-id &lt;tenant-id>
Tenant ID
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-delete">
<title>keystone ec2-credentials-delete command</title>
<screen><computeroutput>usage: keystone ec2-credentials-delete [--user-id &lt;user-id>] --access
&lt;access-key>
Delete EC2-compatible credentials.
Arguments:
--user-id &lt;user-id> User ID
--access &lt;access-key>
Access Key
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-get">
<title>keystone ec2-credentials-get command</title>
<screen><computeroutput>usage: keystone ec2-credentials-get [--user-id &lt;user-id>] --access
&lt;access-key>
Display EC2-compatible credentials.
Arguments:
--user-id &lt;user-id> User ID
--access &lt;access-key>
Access Key
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-list">
<title>keystone ec2-credentials-list command</title>
<screen><computeroutput>usage: keystone ec2-credentials-list [--user-id &lt;user-id>]
List EC2-compatible credentials for a user
Arguments:
--user-id &lt;user-id> User ID
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_endpoint-create">
<title>keystone endpoint-create command</title>
<screen><computeroutput>usage: keystone endpoint-create [--region &lt;endpoint-region>] --service
&lt;service> --publicurl &lt;public-url>
[--adminurl &lt;admin-url>]
[--internalurl &lt;internal-url>]
Create a new endpoint associated with a service.
Arguments:
--region &lt;endpoint-region>
Endpoint region
--service &lt;service>, --service-id &lt;service>, --service_id &lt;service>
Name or ID of service associated with Endpoint
--publicurl &lt;public-url>
Public URL endpoint
--adminurl &lt;admin-url>
Admin URL endpoint
--internalurl &lt;internal-url>
Internal URL endpoint
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_endpoint-delete">
<title>keystone endpoint-delete command</title>
<screen><computeroutput>usage: keystone endpoint-delete &lt;endpoint-id>
Delete a service endpoint.
Arguments:
&lt;endpoint-id> ID of endpoint to delete
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_endpoint-get">
<title>keystone endpoint-get command</title>
<screen><computeroutput>usage: keystone endpoint-get --service &lt;service-type>
[--endpoint-type &lt;endpoint-type>]
[--attr &lt;service-attribute>] [--value &lt;value>]
Find endpoint filtered by a specific attribute or service type.
Arguments:
--service &lt;service-type>
Service type to select
--endpoint-type &lt;endpoint-type>
Endpoint type to select
--attr &lt;service-attribute>
Service attribute to match for selection
--value &lt;value> Value of attribute to match
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_endpoint-list">
<title>keystone endpoint-list command</title>
<screen><computeroutput>usage: keystone endpoint-list
List configured service endpoints.
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_password-update">
<title>keystone password-update command</title>
<screen><computeroutput>usage: keystone password-update [--current-password &lt;current-password>]
[--new-password &lt;new-password>]
Update own password.
Arguments:
--current-password &lt;current-password>
Current password, Defaults to the password as set by
--os-password or OS_PASSWORD
--new-password &lt;new-password>
Desired new password
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_role-create">
<title>keystone role-create command</title>
<screen><computeroutput>usage: keystone role-create --name &lt;role-name>
Create new role.
Arguments:
--name &lt;role-name> Name of new role
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_role-delete">
<title>keystone role-delete command</title>
<screen><computeroutput>usage: keystone role-delete &lt;role>
Delete role.
Arguments:
&lt;role> Name or ID of role to delete
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_role-get">
<title>keystone role-get command</title>
<screen><computeroutput>usage: keystone role-get &lt;role>
Display role details.
Arguments:
&lt;role> Name or ID of role to display
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_role-list">
<title>keystone role-list command</title>
<screen><computeroutput>usage: keystone role-list
List all roles.
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_service-create">
<title>keystone service-create command</title>
<screen><computeroutput>usage: keystone service-create --name &lt;name> --type &lt;type>
[--description &lt;service-description>]
Add service to Service Catalog.
Arguments:
--name &lt;name> Name of new service (must be unique)
--type &lt;type> Service type (one of: identity, compute, network,
image, object-store, or other service identifier
string)
--description &lt;service-description>
Description of service
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_service-delete">
<title>keystone service-delete command</title>
<screen><computeroutput>usage: keystone service-delete &lt;service>
Delete service from Service Catalog.
Arguments:
&lt;service> Name or ID of service to delete
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_service-get">
<title>keystone service-get command</title>
<screen><computeroutput>usage: keystone service-get &lt;service>
Display service from Service Catalog.
Arguments:
&lt;service> Name or ID of service to display
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_service-list">
<title>keystone service-list command</title>
<screen><computeroutput>usage: keystone service-list
List all services in Service Catalog.
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_tenant-create">
<title>keystone tenant-create command</title>
<screen><computeroutput>usage: keystone tenant-create --name &lt;tenant-name>
[--description &lt;tenant-description>]
[--enabled &lt;true|false>]
Create new tenant.
Arguments:
--name &lt;tenant-name> New tenant name (must be unique)
--description &lt;tenant-description>
Description of new tenant (default is none)
--enabled &lt;true|false>
Initial tenant enabled status (default true)
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_tenant-delete">
<title>keystone tenant-delete command</title>
<screen><computeroutput>usage: keystone tenant-delete &lt;tenant>
Delete tenant.
Arguments:
&lt;tenant> Name or ID of tenant to delete
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_tenant-get">
<title>keystone tenant-get command</title>
<screen><computeroutput>usage: keystone tenant-get &lt;tenant>
Display tenant details.
Arguments:
&lt;tenant> Name or ID of tenant to display
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_tenant-list">
<title>keystone tenant-list command</title>
<screen><computeroutput>usage: keystone tenant-list
List all tenants.
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_tenant-update">
<title>keystone tenant-update command</title>
<screen><computeroutput>usage: keystone tenant-update [--name &lt;tenant_name>]
[--description &lt;tenant-description>]
[--enabled &lt;true|false>]
&lt;tenant>
Update tenant name, description, enabled status.
Arguments:
--name &lt;tenant_name> Desired new name of tenant
--description &lt;tenant-description>
Desired new description of tenant
--enabled &lt;true|false>
Enable or disable tenant
&lt;tenant> Name or ID of tenant to update
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_token-get">
<title>keystone token-get command</title>
<screen><computeroutput>usage: keystone token-get [--wrap &lt;integer>]
Display the current user token.
Arguments:
--wrap &lt;integer> wrap PKI tokens to a specified length, or 0 to disable
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-create">
<title>keystone user-create command</title>
<screen><computeroutput>usage: keystone user-create --name &lt;user-name> [--tenant &lt;tenant>]
[--pass &lt;pass>] [--email &lt;email>]
[--enabled &lt;true|false>]
Create new user
Arguments:
--name &lt;user-name> New user name (must be unique)
--tenant &lt;tenant>, --tenant-id &lt;tenant>
New user default tenant
--pass &lt;pass> New user password
--email &lt;email> New user email address
--enabled &lt;true|false>
Initial user enabled status (default true)
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-delete">
<title>keystone user-delete command</title>
<screen><computeroutput>usage: keystone user-delete &lt;user>
Delete user
Arguments:
&lt;user> Name or ID of user to delete
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-get">
<title>keystone user-get command</title>
<screen><computeroutput>usage: keystone user-get &lt;user>
Display user details.
Arguments:
&lt;user> Name or ID of user to display
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-list">
<title>keystone user-list command</title>
<screen><computeroutput>usage: keystone user-list [--tenant &lt;tenant>]
List users.
Arguments:
--tenant &lt;tenant>, --tenant-id &lt;tenant>
Tenant; lists all users if not specified
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-password-update">
<title>keystone user-password-update command</title>
<screen><computeroutput>usage: keystone user-password-update [--pass &lt;password>] &lt;user>
Update user password.
Arguments:
--pass &lt;password> Desired new password
&lt;user> Name or ID of user to update password
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-role-add">
<title>keystone user-role-add command</title>
<screen><computeroutput>usage: keystone user-role-add --user &lt;user> --role &lt;role> [--tenant &lt;tenant>]
Add role to user
Arguments:
--user &lt;user>, --user-id &lt;user>, --user_id &lt;user>
Name or ID of user
--role &lt;role>, --role-id &lt;role>, --role_id &lt;role>
Name or ID of role
--tenant &lt;tenant>, --tenant-id &lt;tenant>
Name or ID of tenant
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-role-list">
<title>keystone user-role-list command</title>
<screen><computeroutput>usage: keystone user-role-list [--user &lt;user>] [--tenant &lt;tenant>]
List roles granted to a user
Arguments:
--user &lt;user>, --user-id &lt;user>
List roles granted to a user
--tenant &lt;tenant>, --tenant-id &lt;tenant>
List roles granted on a tenant
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-role-remove">
<title>keystone user-role-remove command</title>
<screen><computeroutput>usage: keystone user-role-remove --user &lt;user> --role &lt;role>
[--tenant &lt;tenant>]
Remove role from user
Arguments:
--user &lt;user>, --user-id &lt;user>, --user_id &lt;user>
Name or ID of user
--role &lt;role>, --role-id &lt;role>, --role_id &lt;role>
Name or ID of role
--tenant &lt;tenant>, --tenant-id &lt;tenant>
Name or ID of tenant
</computeroutput></screen>
</section>
<section xml:id="keystoneclient_subcommand_user-update">
<title>keystone user-update command</title>
<screen><computeroutput>usage: keystone user-update [--name &lt;user-name>] [--email &lt;email>]
[--enabled &lt;true|false>]
&lt;user>
Update user's name, email, and enabled status.
Arguments:
--name &lt;user-name> Desired new user name
--email &lt;email> Desired new email address
--enabled &lt;true|false>
Enable or disable user
&lt;user> Name or ID of user to update
</computeroutput></screen>
</section>
</section>

5046
doc/common/section_cli_neutron_commands.xml
View File

File diff suppressed because it is too large Load Diff

2621
doc/common/section_cli_nova_commands.xml
View File

File diff suppressed because it is too large Load Diff

688
doc/common/section_cli_swift_commands.xml
View File

@ -1,52 +1,682 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="swift_commands">
<title>swift commands</title>
<para>The swift client is the command-line interface for the
OpenStack Object Storage API.</para>
<para>For help on a specific swift command, enter:</para>
<screen><prompt>$</prompt> <userinput>swift <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput>swift [--version] [--help] [--snet] [--verbose]
[--debug] [--quiet] [--auth &lt;auth_url>]
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="swiftclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>swift commands</title>
<para>The swift client is the command-line interface (CLI) for the
OpenStack Object Storage API and its extensions.</para>
<para>For help on a specific <command>swift</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>swift</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="swiftclient_command_usage">
<title>swift usage</title>
<screen><computeroutput> [--debug] [--info] [--quiet] [--auth &lt;auth_url>]
[--auth-version &lt;auth_version>] [--user &lt;username>]
[--key &lt;api_key>] [--retries &lt;num_retries>]
[--os-username &lt;auth-user-name>] [--os-password &lt;auth-password>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-tenant-id &lt;auth-tenant-id>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-auth-url &lt;auth-url>] [--os-auth-token &lt;auth-token>]
[--os-storage-url &lt;storage-url>] [--os-region-name &lt;region-name>]
[--os-service-type &lt;service-type>]
[--os-endpoint-type &lt;endpoint-type>]
[--os-cacert &lt;ca-certificate>] [--insecure]
[--no-ssl-compression]
&lt;subcommand> ... </computeroutput></screen>
</example>
<example>
<title>Commands</title>
<screen><computeroutput>&lt;subcommand>
&lt;subcommand> ...</computeroutput></screen>
</section>
<section xml:id="swiftclient_command_pos">
<title>swift positional arguments</title>
<screen><computeroutput> &lt;subcommand>
delete Delete a container or objects within a container
download Download objects from containers
list Lists the containers for the account or the objects
for a container
post Updates meta information for the account, container,
or object
or object; creates containers if not present
stat Displays information for the account, container,
or object
upload Uploads files or directories to the given container
</computeroutput></screen>
</example>
<example>
<title>Examples</title>
<screen><prompt>$</prompt> <userinput>swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K key stat</userinput></screen>
<screen><prompt>$</prompt> <userinput>swift --os-auth-url https://api.example.com/v2.0 --os-tenant-name tenant \
--os-usernameuser --os-password password list</userinput></screen>
<screen><prompt>$</prompt> <userinput>swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \
</section>
<section xml:id="swiftclient_command_examples">
<title>swift examples</title>
<screen><computeroutput> swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K api_key stat -v
swift --os-auth-url https://api.example.com/v2.0 --os-tenant-name tenant \
--os-username user --os-password password list
swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \
--os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \
list</userinput></screen>
<screen><prompt>$</prompt> <userinput>swift list --lh</userinput></screen>
</example>
list
swift list --lh
</computeroutput></screen>
</section>
<section xml:id="swiftclient_command_optional">
<title>swift optional arguments</title>
<screen><computeroutput> --version show program's version number and exit
-h, --help show this help message and exit
-s, --snet Use SERVICENET internal network
-v, --verbose Print more info
--debug Show the curl commands and results of all http queries
regardless of result status.
--info Show the curl commands and results of all http
queries which return an error.
-q, --quiet Suppress status output
-A AUTH, --auth=AUTH URL for obtaining an auth token
-V AUTH_VERSION, --auth-version=AUTH_VERSION
Specify a version for authentication. Defaults to 1.0.
-U USER, --user=USER User name for obtaining an auth token.
-K KEY, --key=KEY Key for obtaining an auth token.
-R RETRIES, --retries=RETRIES
The number of times to retry a failed connection.
--os-username=&lt;auth-user-name>
Openstack username. Defaults to env[OS_USERNAME].
--os-password=&lt;auth-password>
Openstack password. Defaults to env[OS_PASSWORD].
--os-tenant-id=&lt;auth-tenant-id>
OpenStack tenant ID. Defaults to env[OS_TENANT_ID]
--os-tenant-name=&lt;auth-tenant-name>
Openstack tenant name. Defaults to
env[OS_TENANT_NAME].
--os-auth-url=&lt;auth-url>
Openstack auth URL. Defaults to env[OS_AUTH_URL].
--os-auth-token=&lt;auth-token>
Openstack token. Defaults to env[OS_AUTH_TOKEN]. Used
with --os-storage-url to bypass the usual
username/password authentication.
--os-storage-url=&lt;storage-url>
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.
--os-region-name=&lt;region-name>
Openstack region name. Defaults to env[OS_REGION_NAME]
--os-service-type=&lt;service-type>
Openstack Service type. Defaults to
env[OS_SERVICE_TYPE]
--os-endpoint-type=&lt;endpoint-type>
Openstack Endpoint type. Defaults to
env[OS_ENDPOINT_TYPE]
--os-cacert=&lt;ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--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).
--no-ssl-compression Disable SSL compression when using https. This may
increase performance.
</computeroutput></screen>
</section>
<section xml:id="swiftclient_subcommand_delete">
<title>swift delete command</title>
<screen><computeroutput>Usage: Delete a container or objects within a container
Positional arguments:
&lt;container> Name of container to delete from
[object] Name of object to delete. Specify multiple times
for multiple objects
Optional arguments:
--all Delete all containers and objects
--leave-segments Do not delete segments of manifest objects
--object-threads &lt;threads>
Number of threads to use for deleting objects
--container-threads &lt;threads>
Number of threads to use for deleting containers
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-s, --snet Use SERVICENET internal network
-v, --verbose Print more info
--debug Show the curl commands and results of all http queries
regardless of result status.
--info Show the curl commands and results of all http
queries which return an error.
-q, --quiet Suppress status output
-A AUTH, --auth=AUTH URL for obtaining an auth token
-V AUTH_VERSION, --auth-version=AUTH_VERSION
Specify a version for authentication. Defaults to 1.0.
-U USER, --user=USER User name for obtaining an auth token.
-K KEY, --key=KEY Key for obtaining an auth token.
-R RETRIES, --retries=RETRIES
The number of times to retry a failed connection.
--os-username=&lt;auth-user-name>
Openstack username. Defaults to env[OS_USERNAME].
--os-password=&lt;auth-password>
Openstack password. Defaults to env[OS_PASSWORD].
--os-tenant-id=&lt;auth-tenant-id>
OpenStack tenant ID. Defaults to env[OS_TENANT_ID]
--os-tenant-name=&lt;auth-tenant-name>
Openstack tenant name. Defaults to
env[OS_TENANT_NAME].
--os-auth-url=&lt;auth-url>
Openstack auth URL. Defaults to env[OS_AUTH_URL].
--os-auth-token=&lt;auth-token>
Openstack token. Defaults to env[OS_AUTH_TOKEN]. Used
with --os-storage-url to bypass the usual
username/password authentication.
--os-storage-url=&lt;storage-url>
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.
--os-region-name=&lt;region-name>
Openstack region name. Defaults to env[OS_REGION_NAME]
--os-service-type=&lt;service-type>
Openstack Service type. Defaults to
env[OS_SERVICE_TYPE]
--os-endpoint-type=&lt;endpoint-type>
Openstack Endpoint type. Defaults to
env[OS_ENDPOINT_TYPE]
--os-cacert=&lt;ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--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).
--no-ssl-compression Disable SSL compression when using https. This may
increase performance.
-a, --all Indicates that you really want to delete everything in
the account
--leave-segments Indicates that you want the segments of
manifestobjects left alone
--object-threads=OBJECT_THREADS
Number of threads to use for deleting objects
--container-threads=CONTAINER_THREADS
Number of threads to use for deleting containers
</computeroutput></screen>
</section>
<section xml:id="swiftclient_subcommand_download">
<title>swift download command</title>
<screen><computeroutput>Usage: Download objects from containers
Positional arguments:
&lt;container> Name of container to download from. To download a
whole account, omit this and specify --all.
&lt;object> Name of object to download. Specify multiple times
for multiple objects. Omit this to download all
objects from the container.
Optional arguments:
--all Indicates that you really want to download
everything in the account
--marker Marker to use when starting a container or account
download
--prefix &lt;prefix> Only download items beginning with &lt;prefix>
--output &lt;out_file> For a single file download, stream the output to
&lt;out_file>. Specifying "-" as &lt;out_file> will
redirect to stdout
--object-threads &lt;threads>
Number of threads to use for downloading objects
--container-threads &lt;threads>
Number of threads to use for deleting containers
--no-download Perform download(s), but don't actually write anything
to disk
--header &lt;header_name:header_value>
Adds a customized request header to the query, like
"Range" or "If-Match". This argument is repeatable.
Example --header "content-type:text/plain"
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-s, --snet Use SERVICENET internal network
-v, --verbose Print more info
--debug Show the curl commands and results of all http queries
regardless of result status.
--info Show the curl commands and results of all http
queries which return an error.
-q, --quiet Suppress status output
-A AUTH, --auth=AUTH URL for obtaining an auth token
-V AUTH_VERSION, --auth-version=AUTH_VERSION
Specify a version for authentication. Defaults to 1.0.
-U USER, --user=USER User name for obtaining an auth token.
-K KEY, --key=KEY Key for obtaining an auth token.
-R RETRIES, --retries=RETRIES
The number of times to retry a failed connection.
--os-username=&lt;auth-user-name>
Openstack username. Defaults to env[OS_USERNAME].
--os-password=&lt;auth-password>
Openstack password. Defaults to env[OS_PASSWORD].
--os-tenant-id=&lt;auth-tenant-id>
OpenStack tenant ID. Defaults to env[OS_TENANT_ID]
--os-tenant-name=&lt;auth-tenant-name>
Openstack tenant name. Defaults to
env[OS_TENANT_NAME].
--os-auth-url=&lt;auth-url>
Openstack auth URL. Defaults to env[OS_AUTH_URL].
--os-auth-token=&lt;auth-token>
Openstack token. Defaults to env[OS_AUTH_TOKEN]. Used
with --os-storage-url to bypass the usual
username/password authentication.
--os-storage-url=&lt;storage-url>
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.
--os-region-name=&lt;region-name>
Openstack region name. Defaults to env[OS_REGION_NAME]
--os-service-type=&lt;service-type>
Openstack Service type. Defaults to
env[OS_SERVICE_TYPE]
--os-endpoint-type=&lt;endpoint-type>
Openstack Endpoint type. Defaults to
env[OS_ENDPOINT_TYPE]
--os-cacert=&lt;ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--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).
--no-ssl-compression Disable SSL compression when using https. This may
increase performance.
-a, --all Indicates that you really want to download everything
in the account
-m MARKER, --marker=MARKER
Marker to use when starting a container or account
download
-p PREFIX, --prefix=PREFIX
Will only download items beginning with the prefix
-o OUT_FILE, --output=OUT_FILE
For a single file download, stream the output to an
alternate location
--object-threads=OBJECT_THREADS
Number of threads to use for downloading objects
--container-threads=CONTAINER_THREADS
Number of threads to use for listing containers
--no-download Perform download(s), but don't actually write anything
to disk
-H HEADER, --header=HEADER
Specify a request header, as --header NAME:VALUE. Adds
a customized request header to the query, like "Range"
or "If-Match". This argument is repeatable. Example
--header "content-type:text/plain"
</computeroutput></screen>
</section>
<section xml:id="swiftclient_subcommand_list">
<title>swift list command</title>
<screen><computeroutput>Usage: Lists the containers for the account or the objects for a container
Positional arguments:
[container] Name of container to list object in
Optional arguments:
--long Long listing format, similar to ls -l
--lh Report sizes in human readable format similar to ls -lh
--totals Used with -l or --ls, only report totals
--prefix Only list items beginning with the prefix
--delimiter Roll up items with the given delimiter. For containers
only. See OpenStack Swift API documentation for what
this means.
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-s, --snet Use SERVICENET internal network
-v, --verbose Print more info
--debug Show the curl commands and results of all http queries
regardless of result status.
--info Show the curl commands and results of all http
queries which return an error.
-q, --quiet Suppress status output
-A AUTH, --auth=AUTH URL for obtaining an auth token
-V AUTH_VERSION, --auth-version=AUTH_VERSION
Specify a version for authentication. Defaults to 1.0.
-U USER, --user=USER User name for obtaining an auth token.
-K KEY, --key=KEY Key for obtaining an auth token.
-R RETRIES, --retries=RETRIES
The number of times to retry a failed connection.
--os-username=&lt;auth-user-name>
Openstack username. Defaults to env[OS_USERNAME].
--os-password=&lt;auth-password>
Openstack password. Defaults to env[OS_PASSWORD].
--os-tenant-id=&lt;auth-tenant-id>
OpenStack tenant ID. Defaults to env[OS_TENANT_ID]
--os-tenant-name=&lt;auth-tenant-name>
Openstack tenant name. Defaults to
env[OS_TENANT_NAME].
--os-auth-url=&lt;auth-url>
Openstack auth URL. Defaults to env[OS_AUTH_URL].
--os-auth-token=&lt;auth-token>
Openstack token. Defaults to env[OS_AUTH_TOKEN]. Used
with --os-storage-url to bypass the usual
username/password authentication.
--os-storage-url=&lt;storage-url>
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.
--os-region-name=&lt;region-name>
Openstack region name. Defaults to env[OS_REGION_NAME]
--os-service-type=&lt;service-type>
Openstack Service type. Defaults to
env[OS_SERVICE_TYPE]
--os-endpoint-type=&lt;endpoint-type>
Openstack Endpoint type. Defaults to
env[OS_ENDPOINT_TYPE]
--os-cacert=&lt;ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--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).
--no-ssl-compression Disable SSL compression when using https. This may
increase performance.
-l, --long Long listing similar to ls -l command
--lh report sizes as human similar to ls -lh switch, but -h
taken
-t, --totals used with -l or --ls, only report totals
-p PREFIX, --prefix=PREFIX
Will only list items beginning with the prefix
-d DELIMITER, --delimiter=DELIMITER
Will roll up items with the given delimiter (see
OpenStack Swift API documentation for what this means)
</computeroutput></screen>
</section>
<section xml:id="swiftclient_subcommand_post">
<title>swift post command</title>
<screen><computeroutput>Usage: Updates meta information for the account, container, or object.
If the container is not found, it will be created automatically.
Positional arguments:
&lt;container> Name of container to post to
[object] Name of object to post. Specify multiple times
for multiple objects
Optional arguments:
--read-acl &lt;acl> Read ACL for containers. Quick summary of ACL syntax:
.r:*, .r:-.example.com, .r:www.example.com, account1,
account2:user2
--write-acl &lt;acl> Write ACL for containers. Quick summary of ACL syntax:
account1 account2:user2
--sync-to &lt;sync-to> Sync To for containers, for multi-cluster replication
--sync-key &lt;sync-key> Sync Key for containers, for multi-cluster replication
--meta &lt;name:value> Sets a meta data item. This option may be repeated.
Example: -m Color:Blue -m Size:Large
--header &lt;header> Set request headers. This option may be repeated.
Example -H "content-type:text/plain"
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-s, --snet Use SERVICENET internal network
-v, --verbose Print more info
--debug Show the curl commands and results of all http queries
regardless of result status.
--info Show the curl commands and results of all http
queries which return an error.
-q, --quiet Suppress status output
-A AUTH, --auth=AUTH URL for obtaining an auth token
-V AUTH_VERSION, --auth-version=AUTH_VERSION
Specify a version for authentication. Defaults to 1.0.
-U USER, --user=USER User name for obtaining an auth token.
-K KEY, --key=KEY Key for obtaining an auth token.
-R RETRIES, --retries=RETRIES
The number of times to retry a failed connection.
--os-username=&lt;auth-user-name>
Openstack username. Defaults to env[OS_USERNAME].
--os-password=&lt;auth-password>
Openstack password. Defaults to env[OS_PASSWORD].
--os-tenant-id=&lt;auth-tenant-id>
OpenStack tenant ID. Defaults to env[OS_TENANT_ID]
--os-tenant-name=&lt;auth-tenant-name>
Openstack tenant name. Defaults to
env[OS_TENANT_NAME].
--os-auth-url=&lt;auth-url>
Openstack auth URL. Defaults to env[OS_AUTH_URL].
--os-auth-token=&lt;auth-token>
Openstack token. Defaults to env[OS_AUTH_TOKEN]. Used
with --os-storage-url to bypass the usual
username/password authentication.
--os-storage-url=&lt;storage-url>
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.
--os-region-name=&lt;region-name>
Openstack region name. Defaults to env[OS_REGION_NAME]
--os-service-type=&lt;service-type>
Openstack Service type. Defaults to
env[OS_SERVICE_TYPE]
--os-endpoint-type=&lt;endpoint-type>
Openstack Endpoint type. Defaults to
env[OS_ENDPOINT_TYPE]
--os-cacert=&lt;ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--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).
--no-ssl-compression Disable SSL compression when using https. This may
increase performance.
-r READ_ACL, --read-acl=READ_ACL
Sets the Read ACL for containers. Quick summary of ACL
syntax: .r:*, .r:-.example.com, .r:www.example.com,
account1, account2:user2
-w WRITE_ACL, --write-acl=WRITE_ACL
Sets the Write ACL for containers. Quick summary of
ACL syntax: account1, account2:user2
-t SYNC_TO, --sync-to=SYNC_TO
Sets the Sync To for containers, for multi-cluster
replication.
-k SYNC_KEY, --sync-key=SYNC_KEY
Sets the Sync Key for containers, for multi-cluster
replication.
-m META, --meta=META Sets a meta data item with the syntax name:value. This
option may be repeated. Example: -m Color:Blue -m
Size:Large
-H HEADER, --header=HEADER
Set request headers with the syntax header:value.
This option may be repeated. Example -H "content-
type:text/plain" -H "Content-Length: 4000"
</computeroutput></screen>
</section>
<section xml:id="swiftclient_subcommand_stat">
<title>swift stat command</title>
<screen><computeroutput>Usage: Displays information for the account, container, or object
Positional arguments:
&lt;container> Name of container to stat from
&lt;object> Name of object to stat. Specify multiple times
for multiple objects
Optional arguments:
--lh Report sizes in human readable format similar to ls -lh
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-s, --snet Use SERVICENET internal network
-v, --verbose Print more info
--debug Show the curl commands and results of all http queries
regardless of result status.
--info Show the curl commands and results of all http
queries which return an error.
-q, --quiet Suppress status output
-A AUTH, --auth=AUTH URL for obtaining an auth token
-V AUTH_VERSION, --auth-version=AUTH_VERSION
Specify a version for authentication. Defaults to 1.0.
-U USER, --user=USER User name for obtaining an auth token.
-K KEY, --key=KEY Key for obtaining an auth token.
-R RETRIES, --retries=RETRIES
The number of times to retry a failed connection.
--os-username=&lt;auth-user-name>
Openstack username. Defaults to env[OS_USERNAME].
--os-password=&lt;auth-password>
Openstack password. Defaults to env[OS_PASSWORD].
--os-tenant-id=&lt;auth-tenant-id>
OpenStack tenant ID. Defaults to env[OS_TENANT_ID]
--os-tenant-name=&lt;auth-tenant-name>
Openstack tenant name. Defaults to
env[OS_TENANT_NAME].
--os-auth-url=&lt;auth-url>
Openstack auth URL. Defaults to env[OS_AUTH_URL].
--os-auth-token=&lt;auth-token>
Openstack token. Defaults to env[OS_AUTH_TOKEN]. Used
with --os-storage-url to bypass the usual
username/password authentication.
--os-storage-url=&lt;storage-url>
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.
--os-region-name=&lt;region-name>
Openstack region name. Defaults to env[OS_REGION_NAME]
--os-service-type=&lt;service-type>
Openstack Service type. Defaults to
env[OS_SERVICE_TYPE]
--os-endpoint-type=&lt;endpoint-type>
Openstack Endpoint type. Defaults to
env[OS_ENDPOINT_TYPE]
--os-cacert=&lt;ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--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).
--no-ssl-compression Disable SSL compression when using https. This may
increase performance.
--lh report totals like 'list --lh'
</computeroutput></screen>
</section>
<section xml:id="swiftclient_subcommand_upload">
<title>swift upload command</title>
<screen><computeroutput>Usage: Uploads specified files and directories to the given container
Positional arguments:
&lt;container> Name of container to upload to
&lt;file_or_directory> Name of file or directory to upload. Specify multiple
times for multiple uploads
Optional arguments:
--changed Only upload files that have changed since the last
upload
--segment-size &lt;size> Upload files in segments no larger than &lt;size> and
then create a "manifest" file that will download all
the segments as if it were the original file
--segment-container &lt;container>
Upload the segments into the specified container. If
not specified, the segments will be uploaded to a
&lt;container>_segments container so as to not pollute the
main &lt;container> listings.
--leave-segments Indicates that you want the older segments of manifest
objects left alone (in the case of overwrites)
--object-threads &lt;threads>
Number of threads to use for uploading full objects.
Default is 10.
--segment-threads &lt;threads>
Number of threads to use for uploading object segments.
Default is 10.
--header &lt;header> Set request headers with the syntax header:value.
This option may be repeated.
Example -H "content-type:text/plain".
--use-slo When used in conjunction with --segment-size will
create a Static Large Object instead of the default
Dynamic Large Object.
--object-name &lt;object-name>
Upload file and name object to &lt;object-name> or upload
dir and use &lt;object-name> as object prefix instead of
folder name
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-s, --snet Use SERVICENET internal network
-v, --verbose Print more info
--debug Show the curl commands and results of all http queries
regardless of result status.
--info Show the curl commands and results of all http
queries which return an error.
-q, --quiet Suppress status output
-A AUTH, --auth=AUTH URL for obtaining an auth token
-V AUTH_VERSION, --auth-version=AUTH_VERSION
Specify a version for authentication. Defaults to 1.0.
-U USER, --user=USER User name for obtaining an auth token.
-K KEY, --key=KEY Key for obtaining an auth token.
-R RETRIES, --retries=RETRIES
The number of times to retry a failed connection.
--os-username=&lt;auth-user-name>
Openstack username. Defaults to env[OS_USERNAME].
--os-password=&lt;auth-password>
Openstack password. Defaults to env[OS_PASSWORD].
--os-tenant-id=&lt;auth-tenant-id>
OpenStack tenant ID. Defaults to env[OS_TENANT_ID]
--os-tenant-name=&lt;auth-tenant-name>
Openstack tenant name. Defaults to
env[OS_TENANT_NAME].
--os-auth-url=&lt;auth-url>
Openstack auth URL. Defaults to env[OS_AUTH_URL].
--os-auth-token=&lt;auth-token>
Openstack token. Defaults to env[OS_AUTH_TOKEN]. Used
with --os-storage-url to bypass the usual
username/password authentication.
--os-storage-url=&lt;storage-url>
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.
--os-region-name=&lt;region-name>
Openstack region name. Defaults to env[OS_REGION_NAME]
--os-service-type=&lt;service-type>
Openstack Service type. Defaults to
env[OS_SERVICE_TYPE]
--os-endpoint-type=&lt;endpoint-type>
Openstack Endpoint type. Defaults to
env[OS_ENDPOINT_TYPE]
--os-cacert=&lt;ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--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).
--no-ssl-compression Disable SSL compression when using https. This may
increase performance.
-c, --changed Will only upload files that have changed since the
last upload
-S SEGMENT_SIZE, --segment-size=SEGMENT_SIZE
Will upload files in segments no larger than &lt;size>
and then create a "manifest" file that will download
all the segments as if it were the original file.
-C SEGMENT_CONTAINER, --segment-container=SEGMENT_CONTAINER
Will upload the segments into the specified
container.If not specified, the segments will be
uploaded to &lt;container>_segments container so as to
not pollute the main &lt;container> listings.
--leave-segments Indicates that you want the older segments of manifest
objects left alone (in the case of overwrites)
--object-threads=OBJECT_THREADS
Number of threads to use for uploading full objects
--segment-threads=SEGMENT_THREADS
Number of threads to use for uploading object segments
-H HEADER, --header=HEADER
Set request headers with the syntax header:value.
This option may be repeated. Example -H "content-
type:text/plain" -H "Content-Length: 4000"
--use-slo When used in conjunction with --segment-size will
create a Static Large Object instead of the default
Dynamic Large Object.
--object-name=OBJECT_NAME
Upload file and name object to the name specified
</computeroutput></screen>
</section>
</section>

2
doc/training-guides/bk001-ch003-associate-controller-node.xml
View File

@ -50,7 +50,7 @@
<section xml:id="associate-glance-cli-commands">
<title>Image CLI Commands</title>
<xi:include href="../common/section_cli_glance_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'glance_commands']/*[not(self::db:title)])">
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'glanceclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include>
</section>

2
doc/training-guides/bk001-ch005-associate-compute-node.xml
View File

@ -36,7 +36,7 @@
<section xml:id="associate-block-storage-commands">
<title>Block Storage CLI Commands</title>
<xi:include href="../common/section_cli_cinder_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'cinder_commands']/*[not(self::db:title)])">
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'cinderclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include>
</section>

2
doc/training-guides/bk001-ch007-associate-network-node.xml
View File

@ -29,7 +29,7 @@
<section xml:id="associate-network-cli-commands">
<title>Network CLI Commands</title>
<xi:include href="../common/section_cli_neutron_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'neutron_client_commands']/*[not(self::db:title)])">
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'neutronclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include>
</section>

2
doc/training-guides/bk001-ch009-associate-object-storage-node.xml
View File

@ -29,7 +29,7 @@
<section xml:id="associate-object-store-cli-commands">
<title>Object Storage CLI Commands</title>
<xi:include href="../common/section_cli_swift_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'swift_commands']/*[not(self::db:title)])">
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'swiftclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include>
</section>

2
doc/user-guide-admin/section_cli_admin_manage_stacks.xml
View File

@ -20,7 +20,7 @@
<link xlink:href="http://docs.openstack.org/user-guide/content/dashboard_stacks.html">End User Guide</link>.</para>
</listitem>
<listitem>
<para><systemitem>heat</systemitem> CLI commands, see <xref linkend="heat_client_commands"/></para>
<para><systemitem>heat</systemitem> CLI commands, see <xref linkend="heatclient_commands"/></para>
</listitem>
</itemizedlist>
</para>