Remove deprecated commands from the CLI reference
Change-Id: Iae5128a76c85ee09cd3ffb4f35bb60cf1b708b99
This commit is contained in:
Christian Berendt
parent
3785cb8bd9
commit
3d705df87d
@ -2743,227 +2743,6 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_alarm-update">
|
||||
<title>ceilometer alarm-update</title>
|
||||
<screen><computeroutput>usage: ceilometer alarm-update [--name <NAME>]
|
||||
[--project-id <ALARM_PROJECT_ID>]
|
||||
[--user-id <ALARM_USER_ID>]
|
||||
[--description <DESCRIPTION>] [--state <STATE>]
|
||||
[--severity <SEVERITY>]
|
||||
[--enabled {True|False}]
|
||||
[--alarm-action <Webhook URL>]
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
[--remove-time-constraint <Constraint names>]
|
||||
[--period <PERIOD>]
|
||||
[--evaluation-periods <COUNT>] [-m <METRIC>]
|
||||
[--statistic <STATISTIC>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
[--threshold <THRESHOLD>]
|
||||
[--matching-metadata <Matching Metadata>]
|
||||
[--repeat-actions {True|False}]
|
||||
[<ALARM_ID>]</computeroutput></screen>
|
||||
<para>
|
||||
Update an existing alarm (Deprecated).
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><ALARM_ID></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 <NAME></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the alarm (must be unique per tenant).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--project-id <ALARM_PROJECT_ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Tenant to associate with alarm (only settable
|
||||
by admin users).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--user-id <ALARM_USER_ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User to associate with alarm (only settable by
|
||||
admin users).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--description <DESCRIPTION></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Free text description of the alarm.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--state <STATE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
State of the alarm, one of: ['ok', 'alarm',
|
||||
'insufficient data']
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--severity <SEVERITY></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 <Webhook URL> 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 <Webhook URL> 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 <Webhook URL></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 <Time Constraint></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=<CONSTRAINT_NAME>;start=<CRON>;durati
|
||||
on=<SECONDS>;[description=<DESCRIPTION>;[timez
|
||||
one=<IANA Timezone>]] Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--remove-time-constraint <Constraint names></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or list of names of the time constraints
|
||||
to remove.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--period <PERIOD></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Length of each period (seconds) to evaluate
|
||||
over.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--evaluation-periods <COUNT></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of periods to evaluate over.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m <METRIC>, --meter-name <METRIC></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Metric to evaluate against.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--statistic <STATISTIC></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Statistic to evaluate, one of: ['max', 'min',
|
||||
'avg', 'sum', 'count']
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--comparison-operator <OPERATOR></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Operator to compare with, one of: ['lt', 'le',
|
||||
'eq', 'ne', 'ge', 'gt'].
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--threshold <THRESHOLD></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Threshold to evaluate against.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--matching-metadata <Matching Metadata></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>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_capabilities">
|
||||
|
||||
@ -2606,7 +2606,7 @@ Uploads volume to Image Service as an image.
|
||||
<title>Block Storage API v2 commands</title>
|
||||
<para>
|
||||
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:
|
||||
<screen><prompt>$</prompt> <userinput>export OS_VOLUME_API_VERSION=2</userinput></screen>
|
||||
</para>
|
||||
|
||||
@ -1100,6 +1100,7 @@ Describe sharing permissions by image or tenant.
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
<section xml:id="glance_cli_v2">
|
||||
|
||||
@ -1335,34 +1335,6 @@ Send a signal to a resource.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_resource-template">
|
||||
<title>heat resource-template</title>
|
||||
<screen><computeroutput>usage: heat resource-template [-F <FORMAT>] <RESOURCE_TYPE></computeroutput></screen>
|
||||
<para>
|
||||
<emphasis>DEPRECATED!</emphasis> Use resource-type-template instead.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><RESOURCE_TYPE></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 <FORMAT>, --format <FORMAT></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The template output format, one of: yaml, json.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="heatclient_subcommand_resource-type-list">
|
||||
|
||||
@ -12,7 +12,7 @@
|
||||
<title>Bare metal command-line client</title>
|
||||
|
||||
<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
|
||||
<literal>0.6.0</literal>.
|
||||
|
||||
@ -4912,73 +4912,6 @@ Print a list of migrations.
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="novaclient_subcommand_net">
|
||||
<title>nova net</title>
|
||||
<screen><computeroutput>usage: nova net <network_id></computeroutput></screen>
|
||||
<para>
|
||||
<emphasis>DEPRECATED</emphasis>, Use tenant-network-show instead.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><network_id></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 <network_label> <cidr></computeroutput></screen>
|
||||
<para>
|
||||
<emphasis>DEPRECATED</emphasis>, use tenant-network-create instead.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><network_label></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Network label (ex. my_new_network)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><cidr></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 <network_id></computeroutput></screen>
|
||||
<para>
|
||||
<emphasis>DEPRECATED</emphasis>, use tenant-network-delete instead.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><network_id></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">
|
||||
<title>nova network-associate-host</title>
|
||||
<screen><computeroutput>usage: nova network-associate-host <network> <host></computeroutput></screen>
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
|
||||
<?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
|
||||
interface (CLI) for the Database API and its extensions.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user