openstack/openstack-manuals
Code Issues Proposed changes

Remove deprecated commands from the CLI reference

Browse Source 
Change-Id: Iae5128a76c85ee09cd3ffb4f35bb60cf1b708b99
This commit is contained in:
Christian Berendt 2015-05-06 10:20:03 +02:00
parent 3785cb8bd9
commit 3d705df87d
7 changed files with 4 additions and 319 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2743,227 +2743,6 @@ Update an existing alarm based on computed statistics.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</section>
<section xml:id="ceilometerclient_subcommand_alarm-update">
<title>ceilometer alarm-update</title>
<screen><computeroutput>usage: ceilometer alarm-update [--name &lt;NAME&gt;]
[--project-id &lt;ALARM_PROJECT_ID&gt;]
[--user-id &lt;ALARM_USER_ID&gt;]
[--description &lt;DESCRIPTION&gt;] [--state &lt;STATE&gt;]
[--severity &lt;SEVERITY&gt;]
[--enabled {True|False}]
[--alarm-action &lt;Webhook URL&gt;]
[--ok-action &lt;Webhook URL&gt;]
[--insufficient-data-action &lt;Webhook URL&gt;]
[--time-constraint &lt;Time Constraint&gt;]
[--remove-time-constraint &lt;Constraint names&gt;]
[--period &lt;PERIOD&gt;]
[--evaluation-periods &lt;COUNT&gt;] [-m &lt;METRIC&gt;]
[--statistic &lt;STATISTIC&gt;]
[--comparison-operator &lt;OPERATOR&gt;]
[--threshold &lt;THRESHOLD&gt;]
[--matching-metadata &lt;Matching Metadata&gt;]
[--repeat-actions {True|False}]
[&lt;ALARM_ID&gt;]</computeroutput></screen>
<para>
Update an existing alarm (Deprecated).
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_ID&gt;</command></term>
<listitem>
<para>
ID of the alarm to update.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;NAME&gt;</command></term>
<listitem>
<para>
Name of the alarm (must be unique per tenant).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project-id &lt;ALARM_PROJECT_ID&gt;</command></term>
<listitem>
<para>
Tenant to associate with alarm (only settable
by admin users).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user-id &lt;ALARM_USER_ID&gt;</command></term>
<listitem>
<para>
User to associate with alarm (only settable by
admin users).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;DESCRIPTION&gt;</command></term>
<listitem>
<para>
Free text description of the alarm.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--state &lt;STATE&gt;</command></term>
<listitem>
<para>
State of the alarm, one of: ['ok', 'alarm',
'insufficient data']
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--severity &lt;SEVERITY&gt;</command></term>
<listitem>
<para>
Severity of the alarm, one of: ['low',
'moderate', 'critical']
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--enabled {True|False}</command></term>
<listitem>
<para>
True if alarm evaluation/actioning is enabled.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term>
<listitem>
<para>
to invoke when state transitions to alarm.
May be used multiple times. Defaults to None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term>
<listitem>
<para>
to invoke when state transitions to OK.
May be used multiple times. Defaults to None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--insufficient-data-action &lt;Webhook URL&gt;</command></term>
<listitem>
<para>
URL to invoke when state transitions to
insufficient data. May be used multiple times.
Defaults to None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--time-constraint &lt;Time Constraint&gt;</command></term>
<listitem>
<para>
Only evaluate the alarm if the time at
evaluation is within this time constraint.
Start point(s) of the constraint are specified
with a cron expression, whereas its duration
is given in seconds. Can be specified multiple
times for multiple time constraints, format
is: name=&lt;CONSTRAINT_NAME&gt;;start=&lt;CRON&gt;;durati
on=&lt;SECONDS&gt;;[description=&lt;DESCRIPTION&gt;;[timez
one=&lt;IANA Timezone&gt;]] Defaults to None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--remove-time-constraint &lt;Constraint names&gt;</command></term>
<listitem>
<para>
Name or list of names of the time constraints
to remove.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--period &lt;PERIOD&gt;</command></term>
<listitem>
<para>
Length of each period (seconds) to evaluate
over.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--evaluation-periods &lt;COUNT&gt;</command></term>
<listitem>
<para>
Number of periods to evaluate over.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m &lt;METRIC&gt;, --meter-name &lt;METRIC&gt;</command></term>
<listitem>
<para>
Metric to evaluate against.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--statistic &lt;STATISTIC&gt;</command></term>
<listitem>
<para>
Statistic to evaluate, one of: ['max', 'min',
'avg', 'sum', 'count']
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--comparison-operator &lt;OPERATOR&gt;</command></term>
<listitem>
<para>
Operator to compare with, one of: ['lt', 'le',
'eq', 'ne', 'ge', 'gt'].
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--threshold &lt;THRESHOLD&gt;</command></term>
<listitem>
<para>
Threshold to evaluate against.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--matching-metadata &lt;Matching Metadata&gt;</command></term>
<listitem>
<para>
A meter should match this resource metadata
(key=value) additionally to the meter_name.
Defaults to None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--repeat-actions {True|False}</command></term>
<listitem>
<para>
True if actions should be repeatedly notified
while alarm remains in target state.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="ceilometerclient_subcommand_capabilities"> <section xml:id="ceilometerclient_subcommand_capabilities">

2
doc/cli-reference/generated/ch_cli_cinder_commands.xml
View File

@ -2606,7 +2606,7 @@ Uploads volume to Image Service as an image.
<title>Block Storage API v2 commands</title> <title>Block Storage API v2 commands</title>
<para> <para>
You can select an API version to use by adding the You can select an API version to use by adding the
<parameter>--os-volume-api-version</parameter> option or by setting <parameter>--os-volume-api-version</parameter> parameter or by setting
the corresponding environment variable: the corresponding environment variable:
<screen><prompt>$</prompt> <userinput>export OS_VOLUME_API_VERSION=2</userinput></screen> <screen><prompt>$</prompt> <userinput>export OS_VOLUME_API_VERSION=2</userinput></screen>
</para> </para>

1
doc/cli-reference/generated/ch_cli_glance_commands.xml
View File

@ -1100,6 +1100,7 @@ Describe sharing permissions by image or tenant.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </section>
<section xml:id="glance_cli_v2"> <section xml:id="glance_cli_v2">

28
doc/cli-reference/generated/ch_cli_heat_commands.xml
View File

@ -1335,34 +1335,6 @@ Send a signal to a resource.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
</section>
<section xml:id="heatclient_subcommand_resource-template">
<title>heat resource-template</title>
<screen><computeroutput>usage: heat resource-template [-F &lt;FORMAT&gt;] &lt;RESOURCE_TYPE&gt;</computeroutput></screen>
<para>
<emphasis>DEPRECATED!</emphasis> Use resource-type-template instead.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;RESOURCE_TYPE&gt;</command></term>
<listitem>
<para>
Resource type to generate a template for.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-F &lt;FORMAT&gt;, --format &lt;FORMAT&gt;</command></term>
<listitem>
<para>
The template output format, one of: yaml, json.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="heatclient_subcommand_resource-type-list"> <section xml:id="heatclient_subcommand_resource-type-list">

2
doc/cli-reference/generated/ch_cli_ironic_commands.xml
View File

@ -12,7 +12,7 @@
<title>Bare metal command-line client</title> <title>Bare metal command-line client</title>
<para>The <command>ironic</command> client is the command-line <para>The <command>ironic</command> client is the command-line
interface (CLI) for the Bare metal and its extensions. interface (CLI) for the Bare metal API and its extensions.
This chapter documents <command>ironic</command> version This chapter documents <command>ironic</command> version
<literal>0.6.0</literal>. <literal>0.6.0</literal>.

67
doc/cli-reference/generated/ch_cli_nova_commands.xml
View File

@ -4912,73 +4912,6 @@ Print a list of migrations.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="novaclient_subcommand_net">
<title>nova net</title>
<screen><computeroutput>usage: nova net &lt;network_id&gt;</computeroutput></screen>
<para>
<emphasis>DEPRECATED</emphasis>, Use tenant-network-show instead.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;network_id&gt;</command></term>
<listitem>
<para>
ID of network
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="novaclient_subcommand_net-create">
<title>nova net-create</title>
<screen><computeroutput>usage: nova net-create &lt;network_label&gt; &lt;cidr&gt;</computeroutput></screen>
<para>
<emphasis>DEPRECATED</emphasis>, use tenant-network-create instead.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;network_label&gt;</command></term>
<listitem>
<para>
Network label (ex. my_new_network)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;cidr&gt;</command></term>
<listitem>
<para>
IP block to allocate from (ex. 172.16.0.0/24 or
2001:DB8::/64)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="novaclient_subcommand_net-delete">
<title>nova net-delete</title>
<screen><computeroutput>usage: nova net-delete &lt;network_id&gt;</computeroutput></screen>
<para>
<emphasis>DEPRECATED</emphasis>, use tenant-network-delete instead.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;network_id&gt;</command></term>
<listitem>
<para>
ID of network
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="novaclient_subcommand_net-list">
<title>nova net-list</title>
<screen><computeroutput>usage: nova net-list</computeroutput></screen>
<para>
<emphasis>DEPRECATED</emphasis>, use tenant-network-list instead.
</para>
</section>
<section xml:id="novaclient_subcommand_network-associate-host"> <section xml:id="novaclient_subcommand_network-associate-host">
<title>nova network-associate-host</title> <title>nova network-associate-host</title>
<screen><computeroutput>usage: nova network-associate-host &lt;network&gt; &lt;host&gt;</computeroutput></screen> <screen><computeroutput>usage: nova network-associate-host &lt;network&gt; &lt;host&gt;</computeroutput></screen>

2
doc/cli-reference/generated/ch_cli_trove_commands.xml
View File

@ -9,7 +9,7 @@
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<title>Database Service command-line client</title> <title>Database service command-line client</title>
<para>The <command>trove</command> client is the command-line <para>The <command>trove</command> client is the command-line
interface (CLI) for the Database API and its extensions. interface (CLI) for the Database API and its extensions.