openstack/openstack-manuals
Code Issues Proposed changes
f72cc60015
openstack-manuals/doc/cli-reference/generated/ch_cli_monasca_commands.xml
Atsushi SAKAI 62677c5052 Add monasca to common and CLI reference 
Add monasca to Chapter 1 (for CLI Ref)
Add monasca to Appendix (common part includes CLI Ref/Config Ref)
Add monasca CLI Ref XML 1.0.24 (autogenerated)

Also fixes typo trove => barbican

Change-Id: If221b39c82a36d59965baebc5745ccf016be6340
2015-11-26 21:04:33 +09:00

1444 lines
46 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<chapter 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="monascaclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>Monitoring command-line client</title>
<para>The <command>monasca</command> client is the command-line
interface (CLI) for the Monitoring API and its extensions.
This chapter documents <command>monasca</command> version
<literal>1.0.24</literal>.
</para>
<para>For help on a specific <command>monasca</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>monasca</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="monascaclient_command_usage">
<title>monasca usage</title>
<screen><computeroutput>usage: monasca [-j] [--version] [-d] [-v] [-k] [--cert-file CERT_FILE]
[--key-file KEY_FILE] [--os-cacert OS_CACERT]
[--keystone_timeout KEYSTONE_TIMEOUT]
[--os-username OS_USERNAME] [--os-password OS_PASSWORD]
[--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-project-id OS_PROJECT_ID]
[--os-project-name OS_PROJECT_NAME]
[--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
[--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth]
[--monasca-api-url MONASCA_API_URL]
[--monasca-api-version MONASCA_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE]
&lt;subcommand&gt; ...
&lt;subcommand&gt;
alarm-definition-create Create an alarm definition.
alarm-definition-delete Delete the alarm definition.
alarm-definition-list List alarm definitions for this tenant.
alarm-definition-patch Patch the alarm definition.
alarm-definition-show Describe the alarm definition.
alarm-definition-update Update the alarm definition.
alarm-delete Delete the alarm.
alarm-history Alarm state transition history.
alarm-history-list List alarms state history.
alarm-list List alarms for this tenant.
alarm-patch Patch the alarm state.
alarm-show Describe the alarm.
alarm-update Update the alarm state.
measurement-list List measurements for the specified metric.
metric-create Create metric.
metric-create-raw Create metric from raw json body.
metric-list List metrics for this tenant.
metric-statistics List measurement statistics for the specified
metric.
notification-create Create notification.
notification-delete Delete notification.
notification-list List notifications for this tenant.
notification-show Describe the notification.
notification-update Update notification.
bash-completion Prints all of the commands and options to stdout.
help Display help about this program or one of its
subcommands.</computeroutput></screen>
</section>
<section xml:id="monascaclient_command_optional">
<title>monasca optional arguments</title>
<variablelist wordsize="10">
<varlistentry>
<term><command>-j, --json</command></term>
<listitem>
<para>
output raw json response
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--version</command></term>
<listitem>
<para>
Shows the client version and exits.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d, --debug</command></term>
<listitem>
<para>
Defaults to <code>env[MONASCA_DEBUG]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-v, --verbose</command></term>
<listitem>
<para>
Print more verbose output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-k, --insecure</command></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--cert-file CERT_FILE</command></term>
<listitem>
<para>
Path of certificate file to use in SSL
connection. This file can optionally be prepended
with the private key.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--key-file KEY_FILE</command></term>
<listitem>
<para>
Path of client key to use in SSL connection. This
option is not necessary if your key is prepended
to your cert file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert OS_CACERT</command></term>
<listitem>
<para>
Specify a CA bundle file to use in verifying a
TLS (https) server certificate. Defaults to
<code>env[OS_CACERT]</code>. Without either of these, the
client looks for the default system CA
certificates.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--keystone_timeout KEYSTONE_TIMEOUT</command></term>
<listitem>
<para>
Number of seconds to wait for a response from
keystone.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-username OS_USERNAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USERNAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-password OS_PASSWORD</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PASSWORD]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-id OS_USER_DOMAIN_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-name OS_USER_DOMAIN_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-id OS_PROJECT_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-name OS_PROJECT_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-id OS_DOMAIN_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-name OS_DOMAIN_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-url OS_AUTH_URL</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_URL]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-region-name OS_REGION_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_REGION_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_TOKEN]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-no-client-auth</command></term>
<listitem>
<para>
Do not contact keystone for a token. Defaults to
<code>env[OS_NO_CLIENT_AUTH]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--monasca-api-url MONASCA_API_URL</command></term>
<listitem>
<para>
Defaults to <code>env[MONASCA_API_URL]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--monasca-api-version MONASCA_API_VERSION</command></term>
<listitem>
<para>
Defaults to <code>env[MONASCA_API_VERSION]</code> or 2_0
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-service-type OS_SERVICE_TYPE</command></term>
<listitem>
<para>
Defaults to <code>env[OS_SERVICE_TYPE]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-endpoint-type OS_ENDPOINT_TYPE</command></term>
<listitem>
<para>
Defaults to <code>env[OS_ENDPOINT_TYPE]</code>.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-definition-create">
<title>monasca alarm-definition-create</title>
<screen><computeroutput>usage: monasca alarm-definition-create [--description &lt;DESCRIPTION&gt;]
[--severity &lt;SEVERITY&gt;]
[--match-by &lt;DIMENSION_KEY1,DIMENSION_KEY2,...&gt;]
[--alarm-actions &lt;NOTIFICATION-ID&gt;]
[--ok-actions &lt;NOTIFICATION-ID&gt;]
[--undetermined-actions &lt;NOTIFICATION-ID&gt;]
&lt;ALARM_DEFINITION_NAME&gt; &lt;EXPRESSION&gt;</computeroutput></screen>
<para>
Create an alarm definition.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_DEFINITION_NAME&gt;</command></term>
<listitem>
<para>
Name of the alarm definition to create.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;EXPRESSION&gt;</command></term>
<listitem>
<para>
The alarm expression to evaluate. Quoted.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--description &lt;DESCRIPTION&gt;</command></term>
<listitem>
<para>
Description of the alarm.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--severity &lt;SEVERITY&gt;</command></term>
<listitem>
<para>
Severity is one of [LOW, MEDIUM, HIGH, CRITICAL].
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--match-by &lt;DIMENSION_KEY1,DIMENSION_KEY2,...&gt;</command></term>
<listitem>
<para>
The metric dimensions to match to the alarm
dimensions. One or more dimension key names separated
by a comma. Key names need quoting when they contain
special chars [&amp;,(,),{,},&gt;,&lt;] that confuse the CLI
parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--alarm-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
ALARM. This param may be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ok-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
OK. This param may be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--undetermined-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
UNDETERMINED. This param may be specified multiple
times.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-definition-delete">
<title>monasca alarm-definition-delete</title>
<screen><computeroutput>usage: monasca alarm-definition-delete &lt;ALARM_DEFINITION_ID&gt;</computeroutput></screen>
<para>
Delete the alarm definition.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_DEFINITION_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm definition.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-definition-list">
<title>monasca alarm-definition-list</title>
<screen><computeroutput>usage: monasca alarm-definition-list [--name &lt;ALARM_DEFINITION_NAME&gt;]
[--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;]
[--offset &lt;OFFSET LOCATION&gt;]
[--limit &lt;RETURN LIMIT&gt;]</computeroutput></screen>
<para>
List alarm definitions for this tenant.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;ALARM_DEFINITION_NAME&gt;</command></term>
<listitem>
<para>
Name of the alarm definition.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
key value pair used to specify a metric dimension.
This can be specified multiple times, or once with
parameters separated by a comma. Dimensions need
quoting when they contain special chars
[&amp;,(,),{,},&gt;,&lt;] that confuse the CLI parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;OFFSET LOCATION&gt;</command></term>
<listitem>
<para>
The offset used to paginate the return data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;RETURN LIMIT&gt;</command></term>
<listitem>
<para>
The amount of data to be returned up to the API
maximum limit.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-definition-patch">
<title>monasca alarm-definition-patch</title>
<screen><computeroutput>usage: monasca alarm-definition-patch [--name &lt;ALARM_DEFINITION_NAME&gt;]
[--description &lt;DESCRIPTION&gt;]
[--expression &lt;EXPRESSION&gt;]
[--alarm-actions &lt;NOTIFICATION-ID&gt;]
[--ok-actions &lt;NOTIFICATION-ID&gt;]
[--undetermined-actions &lt;NOTIFICATION-ID&gt;]
[--actions-enabled &lt;ACTIONS-ENABLED&gt;]
[--severity &lt;SEVERITY&gt;]
&lt;ALARM_DEFINITION_ID&gt;</computeroutput></screen>
<para>
Patch the alarm definition.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_DEFINITION_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm definition.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;ALARM_DEFINITION_NAME&gt;</command></term>
<listitem>
<para>
Name of the alarm definition.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;DESCRIPTION&gt;</command></term>
<listitem>
<para>
Description of the alarm.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--expression &lt;EXPRESSION&gt;</command></term>
<listitem>
<para>
The alarm expression to evaluate. Quoted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--alarm-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
ALARM. This param may be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ok-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
OK. This param may be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--undetermined-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
UNDETERMINED. This param may be specified multiple
times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--actions-enabled &lt;ACTIONS-ENABLED&gt;</command></term>
<listitem>
<para>
The actions-enabled boolean is one of [true,false]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--severity &lt;SEVERITY&gt;</command></term>
<listitem>
<para>
Severity is one of [LOW, MEDIUM, HIGH, CRITICAL].
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-definition-show">
<title>monasca alarm-definition-show</title>
<screen><computeroutput>usage: monasca alarm-definition-show &lt;ALARM_DEFINITION_ID&gt;</computeroutput></screen>
<para>
Describe the alarm definition.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_DEFINITION_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm definition.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-definition-update">
<title>monasca alarm-definition-update</title>
<screen><computeroutput>usage: monasca alarm-definition-update [--description &lt;DESCRIPTION&gt;]
[--alarm-actions &lt;NOTIFICATION-ID&gt;]
[--ok-actions &lt;NOTIFICATION-ID&gt;]
[--undetermined-actions &lt;NOTIFICATION-ID&gt;]
[--match-by &lt;DIMENSION_KEY1,DIMENSION_KEY2,...&gt;]
[--severity &lt;SEVERITY&gt;]
&lt;ALARM_DEFINITION_ID&gt;
&lt;ALARM_DEFINITION_NAME&gt; &lt;EXPRESSION&gt;
&lt;ACTIONS-ENABLED&gt;</computeroutput></screen>
<para>
Update the alarm definition.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_DEFINITION_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm definition.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;ALARM_DEFINITION_NAME&gt;</command></term>
<listitem>
<para>
Name of the alarm definition.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;EXPRESSION&gt;</command></term>
<listitem>
<para>
The alarm expression to evaluate. Quoted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;ACTIONS-ENABLED&gt;</command></term>
<listitem>
<para>
The actions-enabled boolean is one of [true,false]
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--description &lt;DESCRIPTION&gt;</command></term>
<listitem>
<para>
Description of the alarm.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--alarm-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
ALARM. This param may be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ok-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
OK. This param may be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--undetermined-actions &lt;NOTIFICATION-ID&gt;</command></term>
<listitem>
<para>
The notification method to use when an alarm state is
UNDETERMINED. This param may be specified multiple
times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--match-by &lt;DIMENSION_KEY1,DIMENSION_KEY2,...&gt;</command></term>
<listitem>
<para>
The metric dimensions to match to the alarm
dimensions. One or more dimension key names separated
by a comma. Key names need quoting when they contain
special chars [&amp;,(,),{,},&gt;,&lt;] that confuse the CLI
parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--severity &lt;SEVERITY&gt;</command></term>
<listitem>
<para>
Severity is one of [LOW, MEDIUM, HIGH, CRITICAL].
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-delete">
<title>monasca alarm-delete</title>
<screen><computeroutput>usage: monasca alarm-delete &lt;ALARM_ID&gt;</computeroutput></screen>
<para>
Delete the alarm.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-history">
<title>monasca alarm-history</title>
<screen><computeroutput>usage: monasca alarm-history [--offset &lt;OFFSET LOCATION&gt;]
[--limit &lt;RETURN LIMIT&gt;]
&lt;ALARM_ID&gt;</computeroutput></screen>
<para>
Alarm state transition history.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--offset &lt;OFFSET LOCATION&gt;</command></term>
<listitem>
<para>
The offset used to paginate the return data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;RETURN LIMIT&gt;</command></term>
<listitem>
<para>
The amount of data to be returned up to the API
maximum limit.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-history-list">
<title>monasca alarm-history-list</title>
<screen><computeroutput>usage: monasca alarm-history-list [--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;]
[--starttime &lt;UTC_START_TIME&gt;]
[--endtime &lt;UTC_END_TIME&gt;]
[--offset &lt;OFFSET LOCATION&gt;]
[--limit &lt;RETURN LIMIT&gt;]</computeroutput></screen>
<para>
List alarms state history.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
key value pair used to specify a metric dimension.
This can be specified multiple times, or once with
parameters separated by a comma. Dimensions need
quoting when they contain special chars
[&amp;,(,),{,},&gt;,&lt;] that confuse the CLI parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--starttime &lt;UTC_START_TIME&gt;</command></term>
<listitem>
<para>
measurements &gt;= UTC time. format:
2014-01-01T00:00:00Z. OR format: -120 (for previous 2
hours)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--endtime &lt;UTC_END_TIME&gt;</command></term>
<listitem>
<para>
measurements &lt;= UTC time. format:
2014-01-01T00:00:00Z.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;OFFSET LOCATION&gt;</command></term>
<listitem>
<para>
The offset used to paginate the return data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;RETURN LIMIT&gt;</command></term>
<listitem>
<para>
The amount of data to be returned up to the API
maximum limit.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-list">
<title>monasca alarm-list</title>
<screen><computeroutput>usage: monasca alarm-list [--alarm-definition-id &lt;ALARM_DEFINITION_ID&gt;]
[--metric-name &lt;METRIC_NAME&gt;]
[--metric-dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;]
[--state &lt;ALARM_STATE&gt;]
[--state-updated-start-time &lt;UTC_STATE_UPDATED_START&gt;]
[--lifecycle-state &lt;LIFECYCLE_STATE&gt;]
[--link &lt;LINK&gt;] [--offset &lt;OFFSET LOCATION&gt;]
[--limit &lt;RETURN LIMIT&gt;]</computeroutput></screen>
<para>
List alarms for this tenant.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--alarm-definition-id &lt;ALARM_DEFINITION_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm definition.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--metric-name &lt;METRIC_NAME&gt;</command></term>
<listitem>
<para>
Name of the metric.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--metric-dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
key value pair used to specify a metric dimension.
This can be specified multiple times, or once with
parameters separated by a comma. Dimensions need
quoting when they contain special chars
[&amp;,(,),{,},&gt;,&lt;] that confuse the CLI parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--state &lt;ALARM_STATE&gt;</command></term>
<listitem>
<para>
ALARM_STATE is one of [UNDETERMINED, OK, ALARM].
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--state-updated-start-time &lt;UTC_STATE_UPDATED_START&gt;</command></term>
<listitem>
<para>
Return all alarms whose state was updated on or after
the time specified
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--lifecycle-state &lt;LIFECYCLE_STATE&gt;</command></term>
<listitem>
<para>
The lifecycle state of the alarm
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--link &lt;LINK&gt;</command></term>
<listitem>
<para>
The link to external data associated with the alarm
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;OFFSET LOCATION&gt;</command></term>
<listitem>
<para>
The offset used to paginate the return data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;RETURN LIMIT&gt;</command></term>
<listitem>
<para>
The amount of data to be returned up to the API
maximum limit.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-patch">
<title>monasca alarm-patch</title>
<screen><computeroutput>usage: monasca alarm-patch [--state &lt;ALARM_STATE&gt;]
[--lifecycle-state &lt;LIFECYCLE_STATE&gt;]
[--link &lt;LINK&gt;]
&lt;ALARM_ID&gt;</computeroutput></screen>
<para>
Patch the alarm state.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--state &lt;ALARM_STATE&gt;</command></term>
<listitem>
<para>
ALARM_STATE is one of [UNDETERMINED, OK, ALARM].
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--lifecycle-state &lt;LIFECYCLE_STATE&gt;</command></term>
<listitem>
<para>
The lifecycle state of the alarm
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--link &lt;LINK&gt;</command></term>
<listitem>
<para>
A link to an external resource with information about
the alarm
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-show">
<title>monasca alarm-show</title>
<screen><computeroutput>usage: monasca alarm-show &lt;ALARM_ID&gt;</computeroutput></screen>
<para>
Describe the alarm.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_alarm-update">
<title>monasca alarm-update</title>
<screen><computeroutput>usage: monasca alarm-update &lt;ALARM_ID&gt; &lt;ALARM_STATE&gt; &lt;LIFECYCLE_STATE&gt; &lt;LINK&gt;</computeroutput></screen>
<para>
Update the alarm state.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ALARM_ID&gt;</command></term>
<listitem>
<para>
The ID of the alarm.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;ALARM_STATE&gt;</command></term>
<listitem>
<para>
ALARM_STATE is one of [UNDETERMINED, OK, ALARM].
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;LIFECYCLE_STATE&gt;</command></term>
<listitem>
<para>
The lifecycle state of the alarm
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;LINK&gt;</command></term>
<listitem>
<para>
A link to an external resource with information about the
alarm
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_measurement-list">
<title>monasca measurement-list</title>
<screen><computeroutput>usage: monasca measurement-list [--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;]
[--endtime &lt;UTC_END_TIME&gt;]
[--offset &lt;OFFSET LOCATION&gt;]
[--limit &lt;RETURN LIMIT&gt;] [--merge_metrics]
&lt;METRIC_NAME&gt; &lt;UTC_START_TIME&gt;</computeroutput></screen>
<para>
List measurements for the specified metric.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;METRIC_NAME&gt;</command></term>
<listitem>
<para>
Name of the metric to list measurements.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;UTC_START_TIME&gt;</command></term>
<listitem>
<para>
measurements &gt;= UTC time. format:
2014-01-01T00:00:00Z. OR Format: -120 (previous 120
minutes
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
key value pair used to specify a metric dimension.
This can be specified multiple times, or once with
parameters separated by a comma. Dimensions need
quoting when they contain special chars
[&amp;,(,),{,},&gt;,&lt;] that confuse the CLI parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--endtime &lt;UTC_END_TIME&gt;</command></term>
<listitem>
<para>
measurements &lt;= UTC time. format:
2014-01-01T00:00:00Z.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;OFFSET LOCATION&gt;</command></term>
<listitem>
<para>
The offset used to paginate the return data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;RETURN LIMIT&gt;</command></term>
<listitem>
<para>
The amount of data to be returned up to the API
maximum limit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--merge_metrics</command></term>
<listitem>
<para>
Merge multiple metrics into a single result.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_metric-create">
<title>monasca metric-create</title>
<screen><computeroutput>usage: monasca metric-create [--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;]
[--value-meta &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;]
[--time &lt;UNIX_TIMESTAMP&gt;]
[--project-id &lt;CROSS_PROJECT_ID&gt;]
&lt;METRIC_NAME&gt; &lt;METRIC_VALUE&gt;</computeroutput></screen>
<para>
Create metric.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;METRIC_NAME&gt;</command></term>
<listitem>
<para>
Name of the metric to create.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;METRIC_VALUE&gt;</command></term>
<listitem>
<para>
Metric value.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
key value pair used to create a metric dimension. This
can be specified multiple times, or once with
parameters separated by a comma. Dimensions need
quoting when they contain special chars
[&amp;,(,),{,},&gt;,&lt;] that confuse the CLI parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--value-meta &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
key value pair for extra information about a value.
This can be specified multiple times, or once with
parameters separated by a comma. value_meta need
quoting when they contain special chars
[&amp;,(,),{,},&gt;,&lt;] that confuse the CLI parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--time &lt;UNIX_TIMESTAMP&gt;</command></term>
<listitem>
<para>
Metric timestamp in milliseconds. Default: current
timestamp.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project-id &lt;CROSS_PROJECT_ID&gt;</command></term>
<listitem>
<para>
The Project ID to create metric on behalf of. Requires
monitoring-delegate role in keystone.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_metric-create-raw">
<title>monasca metric-create-raw</title>
<screen><computeroutput>usage: monasca metric-create-raw &lt;JSON_BODY&gt;</computeroutput></screen>
<para>
Create metric from raw json body.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;JSON_BODY&gt;</command></term>
<listitem>
<para>
The raw JSON body in single quotes. See api doc.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_metric-list">
<title>monasca metric-list</title>
<screen><computeroutput>usage: monasca metric-list [--name &lt;METRIC_NAME&gt;]
[--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;]
[--offset &lt;OFFSET LOCATION&gt;]
[--limit &lt;RETURN LIMIT&gt;]</computeroutput></screen>
<para>
List metrics for this tenant.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;METRIC_NAME&gt;</command></term>
<listitem>
<para>
Name of the metric to list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
key value pair used to specify a metric dimension.
This can be specified multiple times, or once with
parameters separated by a comma. Dimensions need
quoting when they contain special chars
[&amp;,(,),{,},&gt;,&lt;] that confuse the CLI parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;OFFSET LOCATION&gt;</command></term>
<listitem>
<para>
The offset used to paginate the return data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;RETURN LIMIT&gt;</command></term>
<listitem>
<para>
The amount of data to be returned up to the API
maximum limit.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_metric-statistics">
<title>monasca metric-statistics</title>
<screen><computeroutput>usage: monasca metric-statistics [--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;]
[--endtime &lt;UTC_END_TIME&gt;]
[--period &lt;PERIOD&gt;]
[--offset &lt;OFFSET LOCATION&gt;]
[--limit &lt;RETURN LIMIT&gt;] [--merge_metrics]
&lt;METRIC_NAME&gt; &lt;STATISTICS&gt; &lt;UTC_START_TIME&gt;</computeroutput></screen>
<para>
List measurement statistics for the specified metric.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;METRIC_NAME&gt;</command></term>
<listitem>
<para>
Name of the metric to report measurement statistics.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;STATISTICS&gt;</command></term>
<listitem>
<para>
Statistics is one or more (separated by commas) of
[AVG, MIN, MAX, COUNT, SUM].
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;UTC_START_TIME&gt;</command></term>
<listitem>
<para>
measurements &gt;= UTC time. format:
2014-01-01T00:00:00Z. OR Format: -120 (previous 120
minutes
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--dimensions &lt;KEY1=VALUE1,KEY2=VALUE2...&gt;</command></term>
<listitem>
<para>
key value pair used to specify a metric dimension.
This can be specified multiple times, or once with
parameters separated by a comma. Dimensions need
quoting when they contain special chars
[&amp;,(,),{,},&gt;,&lt;] that confuse the CLI parser.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--endtime &lt;UTC_END_TIME&gt;</command></term>
<listitem>
<para>
measurements &lt;= UTC time. format:
2014-01-01T00:00:00Z.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--period &lt;PERIOD&gt;</command></term>
<listitem>
<para>
number of seconds per interval (default is 300)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--offset &lt;OFFSET LOCATION&gt;</command></term>
<listitem>
<para>
The offset used to paginate the return data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;RETURN LIMIT&gt;</command></term>
<listitem>
<para>
The amount of data to be returned up to the API
maximum limit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--merge_metrics</command></term>
<listitem>
<para>
Merge multiple metrics into a single result.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_notification-create">
<title>monasca notification-create</title>
<screen><computeroutput>usage: monasca notification-create &lt;NOTIFICATION_NAME&gt; &lt;TYPE&gt; &lt;ADDRESS&gt;</computeroutput></screen>
<para>
Create notification.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;NOTIFICATION_NAME&gt;</command></term>
<listitem>
<para>
Name of the notification to create.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;TYPE&gt;</command></term>
<listitem>
<para>
The notification type. Type must be EMAIL, WEBHOOK, or
PAGERDUTY.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;ADDRESS&gt;</command></term>
<listitem>
<para>
A valid EMAIL Address, URL, or SERVICE KEY
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_notification-delete">
<title>monasca notification-delete</title>
<screen><computeroutput>usage: monasca notification-delete &lt;NOTIFICATION_ID&gt;</computeroutput></screen>
<para>
Delete notification.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;NOTIFICATION_ID&gt;</command></term>
<listitem>
<para>
The ID of the notification.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_notification-list">
<title>monasca notification-list</title>
<screen><computeroutput>usage: monasca notification-list [--offset &lt;OFFSET LOCATION&gt;]
[--limit &lt;RETURN LIMIT&gt;]</computeroutput></screen>
<para>
List notifications for this tenant.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--offset &lt;OFFSET LOCATION&gt;</command></term>
<listitem>
<para>
The offset used to paginate the return data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;RETURN LIMIT&gt;</command></term>
<listitem>
<para>
The amount of data to be returned up to the API
maximum limit.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_notification-show">
<title>monasca notification-show</title>
<screen><computeroutput>usage: monasca notification-show &lt;NOTIFICATION_ID&gt;</computeroutput></screen>
<para>
Describe the notification.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;NOTIFICATION_ID&gt;</command></term>
<listitem>
<para>
The ID of the notification. If not specified returns all.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="monascaclient_subcommand_notification-update">
<title>monasca notification-update</title>
<screen><computeroutput>usage: monasca notification-update &lt;NOTIFICATION_ID&gt; &lt;NOTIFICATION_NAME&gt;
&lt;TYPE&gt; &lt;ADDRESS&gt;</computeroutput></screen>
<para>
Update notification.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;NOTIFICATION_ID&gt;</command></term>
<listitem>
<para>
The ID of the notification.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;NOTIFICATION_NAME&gt;</command></term>
<listitem>
<para>
Name of the notification.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;TYPE&gt;</command></term>
<listitem>
<para>
The notification type. Type must be either EMAIL,
WEBHOOK, or PAGERDUTY.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;ADDRESS&gt;</command></term>
<listitem>
<para>
A valid EMAIL Address, URL, or SERVICE KEY
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
View Git Blame Copy Permalink