openstack/openstack-manuals
Code Issues Proposed changes

Merge "Update CLI reference for python-ceilometerclient 2.0.0"

Browse Source
This commit is contained in:
Jenkins 2015-11-06 06:37:25 +00:00 committed by Gerrit Code Review
commit 0de1bee519
1 changed files with 200 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

266
doc/cli-reference/generated/ch_cli_ceilometer_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the Telemetry API and its extensions.
This chapter documents <command>ceilometer</command> version
<literal>1.5.0</literal>.
<literal>2.0.0</literal>.
</para>
<para>For help on a specific <command>ceilometer</command>
@ -665,8 +665,8 @@ Create a new alarm based on state of other alarms.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -674,8 +674,8 @@ Create a new alarm based on state of other alarms.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -831,8 +831,8 @@ Update an existing alarm based on state of other alarms.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -840,8 +840,8 @@ Update an existing alarm based on state of other alarms.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -1009,8 +1009,8 @@ Create a new alarm based on events.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -1018,8 +1018,8 @@ Create a new alarm based on events.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -1173,8 +1173,8 @@ Update an existing alarm based on events.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -1182,8 +1182,8 @@ Update an existing alarm based on events.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -1324,8 +1324,8 @@ Create a new alarm based on computed statistics.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -1333,8 +1333,8 @@ Create a new alarm based on computed statistics.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -1447,8 +1447,29 @@ Create a new alarm based on computed statistics.
<term><command>--aggregation-method &lt;AGGREATION&gt;</command></term>
<listitem>
<para>
Aggregation method to use, one of: ['max',
'min', 'avg', 'sum', 'count'].
Aggregation method to use, one of: ['last',
'min', 'median', 'sum', 'std', 'first',
'mean', 'count', 'moving-average', 'max',
'1pct', '2pct', '3pct', '4pct', '5pct',
'6pct', '7pct', '8pct', '9pct', '10pct',
'11pct', '12pct', '13pct', '14pct', '15pct',
'16pct', '17pct', '18pct', '19pct', '20pct',
'21pct', '22pct', '23pct', '24pct', '25pct',
'26pct', '27pct', '28pct', '29pct', '30pct',
'31pct', '32pct', '33pct', '34pct', '35pct',
'36pct', '37pct', '38pct', '39pct', '40pct',
'41pct', '42pct', '43pct', '44pct', '45pct',
'46pct', '47pct', '48pct', '49pct', '50pct',
'51pct', '52pct', '53pct', '54pct', '55pct',
'56pct', '57pct', '58pct', '59pct', '60pct',
'61pct', '62pct', '63pct', '64pct', '65pct',
'66pct', '67pct', '68pct', '69pct', '70pct',
'71pct', '72pct', '73pct', '74pct', '75pct',
'76pct', '77pct', '78pct', '79pct', '80pct',
'81pct', '82pct', '83pct', '84pct', '85pct',
'86pct', '87pct', '88pct', '89pct', '90pct',
'91pct', '92pct', '93pct', '94pct', '95pct',
'96pct', '97pct', '98pct', '99pct'].
</para>
</listitem>
</varlistentry>
@ -1520,8 +1541,8 @@ Update an existing alarm based on computed statistics.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -1529,8 +1550,8 @@ Update an existing alarm based on computed statistics.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -1643,8 +1664,29 @@ Update an existing alarm based on computed statistics.
<term><command>--aggregation-method &lt;AGGREATION&gt;</command></term>
<listitem>
<para>
Aggregation method to use, one of: ['max',
'min', 'avg', 'sum', 'count'].
Aggregation method to use, one of: ['last',
'min', 'median', 'sum', 'std', 'first',
'mean', 'count', 'moving-average', 'max',
'1pct', '2pct', '3pct', '4pct', '5pct',
'6pct', '7pct', '8pct', '9pct', '10pct',
'11pct', '12pct', '13pct', '14pct', '15pct',
'16pct', '17pct', '18pct', '19pct', '20pct',
'21pct', '22pct', '23pct', '24pct', '25pct',
'26pct', '27pct', '28pct', '29pct', '30pct',
'31pct', '32pct', '33pct', '34pct', '35pct',
'36pct', '37pct', '38pct', '39pct', '40pct',
'41pct', '42pct', '43pct', '44pct', '45pct',
'46pct', '47pct', '48pct', '49pct', '50pct',
'51pct', '52pct', '53pct', '54pct', '55pct',
'56pct', '57pct', '58pct', '59pct', '60pct',
'61pct', '62pct', '63pct', '64pct', '65pct',
'66pct', '67pct', '68pct', '69pct', '70pct',
'71pct', '72pct', '73pct', '74pct', '75pct',
'76pct', '77pct', '78pct', '79pct', '80pct',
'81pct', '82pct', '83pct', '84pct', '85pct',
'86pct', '87pct', '88pct', '89pct', '90pct',
'91pct', '92pct', '93pct', '94pct', '95pct',
'96pct', '97pct', '98pct', '99pct'].
</para>
</listitem>
</varlistentry>
@ -1714,8 +1756,8 @@ Create a new alarm based on computed statistics.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -1723,8 +1765,8 @@ Create a new alarm based on computed statistics.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -1837,8 +1879,29 @@ Create a new alarm based on computed statistics.
<term><command>--aggregation-method &lt;AGGREATION&gt;</command></term>
<listitem>
<para>
Aggregation method to use, one of: ['max',
'min', 'avg', 'sum', 'count'].
Aggregation method to use, one of: ['last',
'min', 'median', 'sum', 'std', 'first',
'mean', 'count', 'moving-average', 'max',
'1pct', '2pct', '3pct', '4pct', '5pct',
'6pct', '7pct', '8pct', '9pct', '10pct',
'11pct', '12pct', '13pct', '14pct', '15pct',
'16pct', '17pct', '18pct', '19pct', '20pct',
'21pct', '22pct', '23pct', '24pct', '25pct',
'26pct', '27pct', '28pct', '29pct', '30pct',
'31pct', '32pct', '33pct', '34pct', '35pct',
'36pct', '37pct', '38pct', '39pct', '40pct',
'41pct', '42pct', '43pct', '44pct', '45pct',
'46pct', '47pct', '48pct', '49pct', '50pct',
'51pct', '52pct', '53pct', '54pct', '55pct',
'56pct', '57pct', '58pct', '59pct', '60pct',
'61pct', '62pct', '63pct', '64pct', '65pct',
'66pct', '67pct', '68pct', '69pct', '70pct',
'71pct', '72pct', '73pct', '74pct', '75pct',
'76pct', '77pct', '78pct', '79pct', '80pct',
'81pct', '82pct', '83pct', '84pct', '85pct',
'86pct', '87pct', '88pct', '89pct', '90pct',
'91pct', '92pct', '93pct', '94pct', '95pct',
'96pct', '97pct', '98pct', '99pct'].
</para>
</listitem>
</varlistentry>
@ -1928,8 +1991,8 @@ Update an existing alarm based on computed statistics.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -1937,8 +2000,8 @@ Update an existing alarm based on computed statistics.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -2051,8 +2114,29 @@ Update an existing alarm based on computed statistics.
<term><command>--aggregation-method &lt;AGGREATION&gt;</command></term>
<listitem>
<para>
Aggregation method to use, one of: ['max',
'min', 'avg', 'sum', 'count'].
Aggregation method to use, one of: ['last',
'min', 'median', 'sum', 'std', 'first',
'mean', 'count', 'moving-average', 'max',
'1pct', '2pct', '3pct', '4pct', '5pct',
'6pct', '7pct', '8pct', '9pct', '10pct',
'11pct', '12pct', '13pct', '14pct', '15pct',
'16pct', '17pct', '18pct', '19pct', '20pct',
'21pct', '22pct', '23pct', '24pct', '25pct',
'26pct', '27pct', '28pct', '29pct', '30pct',
'31pct', '32pct', '33pct', '34pct', '35pct',
'36pct', '37pct', '38pct', '39pct', '40pct',
'41pct', '42pct', '43pct', '44pct', '45pct',
'46pct', '47pct', '48pct', '49pct', '50pct',
'51pct', '52pct', '53pct', '54pct', '55pct',
'56pct', '57pct', '58pct', '59pct', '60pct',
'61pct', '62pct', '63pct', '64pct', '65pct',
'66pct', '67pct', '68pct', '69pct', '70pct',
'71pct', '72pct', '73pct', '74pct', '75pct',
'76pct', '77pct', '78pct', '79pct', '80pct',
'81pct', '82pct', '83pct', '84pct', '85pct',
'86pct', '87pct', '88pct', '89pct', '90pct',
'91pct', '92pct', '93pct', '94pct', '95pct',
'96pct', '97pct', '98pct', '99pct'].
</para>
</listitem>
</varlistentry>
@ -2150,8 +2234,8 @@ Create a new alarm based on computed statistics.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -2159,8 +2243,8 @@ Create a new alarm based on computed statistics.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -2273,8 +2357,29 @@ Create a new alarm based on computed statistics.
<term><command>--aggregation-method &lt;AGGREATION&gt;</command></term>
<listitem>
<para>
Aggregation method to use, one of: ['max',
'min', 'avg', 'sum', 'count'].
Aggregation method to use, one of: ['last',
'min', 'median', 'sum', 'std', 'first',
'mean', 'count', 'moving-average', 'max',
'1pct', '2pct', '3pct', '4pct', '5pct',
'6pct', '7pct', '8pct', '9pct', '10pct',
'11pct', '12pct', '13pct', '14pct', '15pct',
'16pct', '17pct', '18pct', '19pct', '20pct',
'21pct', '22pct', '23pct', '24pct', '25pct',
'26pct', '27pct', '28pct', '29pct', '30pct',
'31pct', '32pct', '33pct', '34pct', '35pct',
'36pct', '37pct', '38pct', '39pct', '40pct',
'41pct', '42pct', '43pct', '44pct', '45pct',
'46pct', '47pct', '48pct', '49pct', '50pct',
'51pct', '52pct', '53pct', '54pct', '55pct',
'56pct', '57pct', '58pct', '59pct', '60pct',
'61pct', '62pct', '63pct', '64pct', '65pct',
'66pct', '67pct', '68pct', '69pct', '70pct',
'71pct', '72pct', '73pct', '74pct', '75pct',
'76pct', '77pct', '78pct', '79pct', '80pct',
'81pct', '82pct', '83pct', '84pct', '85pct',
'86pct', '87pct', '88pct', '89pct', '90pct',
'91pct', '92pct', '93pct', '94pct', '95pct',
'96pct', '97pct', '98pct', '99pct'].
</para>
</listitem>
</varlistentry>
@ -2372,8 +2477,8 @@ Update an existing alarm based on computed statistics.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -2381,8 +2486,8 @@ Update an existing alarm based on computed statistics.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -2495,8 +2600,29 @@ Update an existing alarm based on computed statistics.
<term><command>--aggregation-method &lt;AGGREATION&gt;</command></term>
<listitem>
<para>
Aggregation method to use, one of: ['max',
'min', 'avg', 'sum', 'count'].
Aggregation method to use, one of: ['last',
'min', 'median', 'sum', 'std', 'first',
'mean', 'count', 'moving-average', 'max',
'1pct', '2pct', '3pct', '4pct', '5pct',
'6pct', '7pct', '8pct', '9pct', '10pct',
'11pct', '12pct', '13pct', '14pct', '15pct',
'16pct', '17pct', '18pct', '19pct', '20pct',
'21pct', '22pct', '23pct', '24pct', '25pct',
'26pct', '27pct', '28pct', '29pct', '30pct',
'31pct', '32pct', '33pct', '34pct', '35pct',
'36pct', '37pct', '38pct', '39pct', '40pct',
'41pct', '42pct', '43pct', '44pct', '45pct',
'46pct', '47pct', '48pct', '49pct', '50pct',
'51pct', '52pct', '53pct', '54pct', '55pct',
'56pct', '57pct', '58pct', '59pct', '60pct',
'61pct', '62pct', '63pct', '64pct', '65pct',
'66pct', '67pct', '68pct', '69pct', '70pct',
'71pct', '72pct', '73pct', '74pct', '75pct',
'76pct', '77pct', '78pct', '79pct', '80pct',
'81pct', '82pct', '83pct', '84pct', '85pct',
'86pct', '87pct', '88pct', '89pct', '90pct',
'91pct', '92pct', '93pct', '94pct', '95pct',
'96pct', '97pct', '98pct', '99pct'].
</para>
</listitem>
</varlistentry>
@ -2700,8 +2826,8 @@ Create a new alarm based on computed statistics.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -2709,8 +2835,8 @@ Create a new alarm based on computed statistics.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -2914,8 +3040,8 @@ Update an existing alarm based on computed statistics.
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
Tenant to associate with alarm (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -2923,8 +3049,8 @@ Update an existing alarm based on computed statistics.
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
User to associate with alarm (configurable by
admin users only).
</para>
</listitem>
</varlistentry>
@ -3299,7 +3425,7 @@ Query samples.
</section>
<section xml:id="ceilometerclient_subcommand_resource-list">
<title>ceilometer resource-list</title>
<screen><computeroutput>usage: ceilometer resource-list [-q &lt;QUERY&gt;] [-l &lt;NUMBER&gt;]</computeroutput></screen>
<screen><computeroutput>usage: ceilometer resource-list [-q &lt;QUERY&gt;] [--meter-links] [-l &lt;NUMBER&gt;]</computeroutput></screen>
<para>
List the resources.
</para> <variablelist wordsize="10">
@ -3314,6 +3440,14 @@ List the resources.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--meter-links</command></term>
<listitem>
<para>
If specified, meter links will be generated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-l &lt;NUMBER&gt;, --limit &lt;NUMBER&gt;</command></term>
<listitem>
@ -3358,8 +3492,8 @@ Create a sample.
<term><command>--project-id &lt;SAMPLE_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with sample (only settable
by admin users).
Tenant to associate with sample (configurable
by admin users only).
</para>
</listitem>
</varlistentry>
@ -3367,8 +3501,8 @@ Create a sample.
<term><command>--user-id &lt;SAMPLE_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with sample (only settable
by admin users).
User to associate with sample (configurable by
admin users only).
</para>
</listitem>
</varlistentry>