openstack/openstack-manuals
Code Issues Proposed changes
96d208e736
openstack-manuals/doc/cli-reference/generated/ch_cli_cloudkitty_commands.xml
Atsushi SAKAI 384a85cc0e Add cloudkitty to common and CLI reference 
Add cloudkitty to Chapter 1 (for CLI Ref)
Add cloudkitty to Appendix (common part includes CLI Ref/Config Ref)
Add cloudkitty CLI Ref XML 0.4.1 (autogenerated)

Change-Id: I0a592a351589d9fac5b9381c4bbffa3487778da5
2015-12-01 10:37:44 +00:00

1304 lines
37 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="cloudkittyclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>Rating service command-line client</title>
<para>The <command>cloudkitty</command> client is the command-line
interface (CLI) for the Rating service API and its extensions.
This chapter documents <command>cloudkitty</command> version
<literal>0.4.1</literal>.
</para>
<para>For help on a specific <command>cloudkitty</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>cloudkitty</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="cloudkittyclient_command_usage">
<title>cloudkitty usage</title>
<screen><computeroutput>usage: cloudkitty [--version] [-d] [-v] [--timeout TIMEOUT]
[--cloudkitty-url &lt;CLOUDKITTY_URL&gt;]
[--cloudkitty-api-version CLOUDKITTY_API_VERSION]
[--os-tenant-id &lt;tenant-id&gt;]
[--os-region-name &lt;region-name&gt;]
[--os-auth-token &lt;auth-token&gt;]
[--os-service-type &lt;service-type&gt;]
[--os-endpoint-type &lt;endpoint-type&gt;] [--os-cacert &lt;cacert&gt;]
[--os-insecure &lt;insecure&gt;] [--os-cert-file &lt;cert-file&gt;]
[--os-key-file &lt;key-file&gt;] [--os-cert &lt;cert&gt;]
[--os-key &lt;key&gt;] [--os-project-name &lt;project-name&gt;]
[--os-project-id &lt;project-id&gt;]
[--os-user-domain-id &lt;user-domain-id&gt;]
[--os-user-domain-name &lt;user-domain-name&gt;]
[--os-endpoint &lt;endpoint&gt;] [--os-auth-system &lt;auth-system&gt;]
[--os-username &lt;username&gt;] [--os-password &lt;password&gt;]
[--os-tenant-name &lt;tenant-name&gt;] [--os-token &lt;token&gt;]
[--os-auth-url &lt;auth-url&gt;]
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
<term><command>module-disable</command></term>
<listitem>
<para>
Disable a module.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>module-enable</command></term>
<listitem>
<para>
Enable a module.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>module-list</command></term>
<listitem>
<para>
List the samples for this meters.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>collector-mapping-create</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>collector-mapping-delete</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>collector-mapping-get</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>collector-mapping-list</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>collector-state-disable</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>collector-state-enable</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>collector-state-get</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>report-tenant-list</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>total-get</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>storage-dataframe-list</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-field-create</command></term>
<listitem>
<para>
Create a field.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-field-delete</command></term>
<listitem>
<para>
Delete a field.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-field-list</command></term>
<listitem>
<para>
Create a field.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-group-create</command></term>
<listitem>
<para>
Create a group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-group-delete</command></term>
<listitem>
<para>
Delete a group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-group-list</command></term>
<listitem>
<para>
List groups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-mapping-create</command></term>
<listitem>
<para>
Create a mapping.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-mapping-delete</command></term>
<listitem>
<para>
Delete a mapping.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-mapping-list</command></term>
<listitem>
<para>
List mappings.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-mapping-update</command></term>
<listitem>
<para>
Update a mapping.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-service-create</command></term>
<listitem>
<para>
Create a service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-service-delete</command></term>
<listitem>
<para>
Delete a service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-service-list</command></term>
<listitem>
<para>
List services.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-threshold-create</command></term>
<listitem>
<para>
Create a mapping.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-threshold-delete</command></term>
<listitem>
<para>
Delete a threshold.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-threshold-get</command></term>
<listitem>
<para>
Get a threshold.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-threshold-group</command></term>
<listitem>
<para>
Get a threshold group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-threshold-list</command></term>
<listitem>
<para>
List thresholds.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hashmap-threshold-update</command></term>
<listitem>
<para>
Update a threshold.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bash-completion</command></term>
<listitem>
<para>
Prints all of the commands and options to
stdout.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>help</command></term>
<listitem>
<para>
Display help about this program or one of its
subcommands.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_command_optional">
<title>cloudkitty optional arguments</title>
<variablelist wordsize="10">
<varlistentry>
<term><command>--version</command></term>
<listitem>
<para>
show program's version number and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d, --debug</command></term>
<listitem>
<para>
Defaults to <code>env[CLOUDKITTYCLIENT_DEBUG]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-v, --verbose</command></term>
<listitem>
<para>
Print more verbose output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--timeout TIMEOUT</command></term>
<listitem>
<para>
Number of seconds to wait for a response.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--cloudkitty-url &lt;CLOUDKITTY_URL&gt;</command></term>
<listitem>
<para>
<emphasis>DEPRECATED</emphasis>, use --os-endpoint instead.
Defaults to <code>env[CLOUDKITTY_URL]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--cloudkitty-api-version CLOUDKITTY_API_VERSION</command></term>
<listitem>
<para>
Defaults to <code>env[CLOUDKITTY_API_VERSION]</code> or 1.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-id &lt;tenant-id&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_TENANT_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-region-name &lt;region-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_REGION_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-token &lt;auth-token&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_TOKEN]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-service-type &lt;service-type&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_SERVICE_TYPE]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-endpoint-type &lt;endpoint-type&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_ENDPOINT_TYPE]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert &lt;cacert&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_CACERT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-insecure &lt;insecure&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_INSECURE]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cert-file &lt;cert-file&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_CERT_FILE]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-key-file &lt;key-file&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_KEY_FILE]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cert &lt;cert&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_CERT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-key &lt;key&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_KEY]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-name &lt;project-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-id &lt;project-id&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-id &lt;user-domain-id&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-name &lt;user-domain-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-endpoint &lt;endpoint&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_ENDPOINT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-system &lt;auth-system&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_SYSTEM]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-username &lt;username&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USERNAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-password &lt;password&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PASSWORD]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-name &lt;tenant-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_TENANT_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-token &lt;token&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_TOKEN]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-url &lt;auth-url&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_URL]</code>.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_collector-mapping-create">
<title>cloudkitty collector-mapping-create</title>
<screen><computeroutput>usage: cloudkitty collector-mapping-create --collector COLLECTOR --service
SERVICE</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--collector COLLECTOR</command></term>
<listitem>
<para>
Map a service to this collector. Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--service SERVICE</command></term>
<listitem>
<para>
Map a collector to this service. Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_collector-mapping-delete">
<title>cloudkitty collector-mapping-delete</title>
<screen><computeroutput>usage: cloudkitty collector-mapping-delete --service SERVICE</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--service SERVICE</command></term>
<listitem>
<para>
Filter on this service. Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_collector-mapping-get">
<title>cloudkitty collector-mapping-get</title>
<screen><computeroutput>usage: cloudkitty collector-mapping-get --service SERVICE</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--service SERVICE</command></term>
<listitem>
<para>
Which service to get the mapping for. Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_collector-mapping-list">
<title>cloudkitty collector-mapping-list</title>
<screen><computeroutput>usage: cloudkitty collector-mapping-list [--collector COLLECTOR]</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--collector COLLECTOR</command></term>
<listitem>
<para>
Collector name to filter on. Defaults to None.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_collector-state-disable">
<title>cloudkitty collector-state-disable</title>
<screen><computeroutput>usage: cloudkitty collector-state-disable --name NAME</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Name of the collector. Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_collector-state-enable">
<title>cloudkitty collector-state-enable</title>
<screen><computeroutput>usage: cloudkitty collector-state-enable --name NAME</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Name of the collector. Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_collector-state-get">
<title>cloudkitty collector-state-get</title>
<screen><computeroutput>usage: cloudkitty collector-state-get --name NAME</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Name of the collector. Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-field-create">
<title>cloudkitty hashmap-field-create</title>
<screen><computeroutput>usage: cloudkitty hashmap-field-create -n NAME -s SERVICE_ID</computeroutput></screen>
<para>
Create a field.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-n NAME, --name NAME</command></term>
<listitem>
<para>
Field name Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-s SERVICE_ID, --service-id SERVICE_ID</command></term>
<listitem>
<para>
Service id Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-field-delete">
<title>cloudkitty hashmap-field-delete</title>
<screen><computeroutput>usage: cloudkitty hashmap-field-delete -f FIELD_ID</computeroutput></screen>
<para>
Delete a field.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-f FIELD_ID, --field-id FIELD_ID</command></term>
<listitem>
<para>
Field uuid Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-field-list">
<title>cloudkitty hashmap-field-list</title>
<screen><computeroutput>usage: cloudkitty hashmap-field-list -s SERVICE_ID</computeroutput></screen>
<para>
Create a field.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-s SERVICE_ID, --service-id SERVICE_ID</command></term>
<listitem>
<para>
Service id Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-group-create">
<title>cloudkitty hashmap-group-create</title>
<screen><computeroutput>usage: cloudkitty hashmap-group-create -n NAME</computeroutput></screen>
<para>
Create a group.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-n NAME, --name NAME</command></term>
<listitem>
<para>
Group name Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-group-delete">
<title>cloudkitty hashmap-group-delete</title>
<screen><computeroutput>usage: cloudkitty hashmap-group-delete -g GROUP_ID [-r RECURSIVE]</computeroutput></screen>
<para>
Delete a group.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-g GROUP_ID, --group-id GROUP_ID</command></term>
<listitem>
<para>
Group uuid Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-r RECURSIVE, --recursive RECURSIVE</command></term>
<listitem>
<para>
Delete the group's mappings Defaults to False.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-group-list">
<title>cloudkitty hashmap-group-list</title>
<screen><computeroutput>usage: cloudkitty hashmap-group-list</computeroutput></screen>
<para>
List groups.
</para>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-mapping-create">
<title>cloudkitty hashmap-mapping-create</title>
<screen><computeroutput>usage: cloudkitty hashmap-mapping-create -c COST [-v VALUE] [-t TYPE]
[-s SERVICE_ID] [-f FIELD_ID]
[-g GROUP_ID]</computeroutput></screen>
<para>
Create a mapping.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-c COST, --cost COST</command></term>
<listitem>
<para>
Mapping cost Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-v VALUE, --value VALUE</command></term>
<listitem>
<para>
Mapping value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-t TYPE, --type TYPE</command></term>
<listitem>
<para>
Mapping type (flat, rate)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-s SERVICE_ID, --service-id SERVICE_ID</command></term>
<listitem>
<para>
Service id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-f FIELD_ID, --field-id FIELD_ID</command></term>
<listitem>
<para>
Field id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-g GROUP_ID, --group-id GROUP_ID</command></term>
<listitem>
<para>
Group id
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-mapping-delete">
<title>cloudkitty hashmap-mapping-delete</title>
<screen><computeroutput>usage: cloudkitty hashmap-mapping-delete -m MAPPING_ID</computeroutput></screen>
<para>
Delete a mapping.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-m MAPPING_ID, --mapping-id MAPPING_ID</command></term>
<listitem>
<para>
Mapping uuid Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-mapping-list">
<title>cloudkitty hashmap-mapping-list</title>
<screen><computeroutput>usage: cloudkitty hashmap-mapping-list [-s SERVICE_ID] [-f FIELD_ID]
[-g GROUP_ID]</computeroutput></screen>
<para>
List mappings.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-s SERVICE_ID, --service-id SERVICE_ID</command></term>
<listitem>
<para>
Service id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-f FIELD_ID, --field-id FIELD_ID</command></term>
<listitem>
<para>
Field id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-g GROUP_ID, --group-id GROUP_ID</command></term>
<listitem>
<para>
Group id
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-mapping-update">
<title>cloudkitty hashmap-mapping-update</title>
<screen><computeroutput>usage: cloudkitty hashmap-mapping-update -m MAPPING_ID [-c COST] [-v VALUE]
[-t TYPE] [-g GROUP_ID]</computeroutput></screen>
<para>
Update a mapping.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-m MAPPING_ID, --mapping-id MAPPING_ID</command></term>
<listitem>
<para>
Mapping id Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-c COST, --cost COST</command></term>
<listitem>
<para>
Mapping cost
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-v VALUE, --value VALUE</command></term>
<listitem>
<para>
Mapping value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-t TYPE, --type TYPE</command></term>
<listitem>
<para>
Mapping type (flat, rate)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-g GROUP_ID, --group-id GROUP_ID</command></term>
<listitem>
<para>
Group id
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-service-create">
<title>cloudkitty hashmap-service-create</title>
<screen><computeroutput>usage: cloudkitty hashmap-service-create -n NAME</computeroutput></screen>
<para>
Create a service.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-n NAME, --name NAME</command></term>
<listitem>
<para>
Service name Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-service-delete">
<title>cloudkitty hashmap-service-delete</title>
<screen><computeroutput>usage: cloudkitty hashmap-service-delete -s SERVICE_ID</computeroutput></screen>
<para>
Delete a service.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-s SERVICE_ID, --service-id SERVICE_ID</command></term>
<listitem>
<para>
Service uuid Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-service-list">
<title>cloudkitty hashmap-service-list</title>
<screen><computeroutput>usage: cloudkitty hashmap-service-list</computeroutput></screen>
<para>
List services.
</para>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-threshold-create">
<title>cloudkitty hashmap-threshold-create</title>
<screen><computeroutput>usage: cloudkitty hashmap-threshold-create -l LEVEL -c COST [-m MAP_TYPE]
[-s SERVICE_ID] [-f FIELD_ID]
[-g GROUP_ID]</computeroutput></screen>
<para>
Create a mapping.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-l LEVEL, --level LEVEL</command></term>
<listitem>
<para>
Threshold level Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-c COST, --cost COST</command></term>
<listitem>
<para>
Threshold cost Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m MAP_TYPE, --map-type MAP_TYPE</command></term>
<listitem>
<para>
Threshold type (flat, rate)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-s SERVICE_ID, --service-id SERVICE_ID</command></term>
<listitem>
<para>
Service id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-f FIELD_ID, --field-id FIELD_ID</command></term>
<listitem>
<para>
Field id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-g GROUP_ID, --group-id GROUP_ID</command></term>
<listitem>
<para>
Group id
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-threshold-delete">
<title>cloudkitty hashmap-threshold-delete</title>
<screen><computeroutput>usage: cloudkitty hashmap-threshold-delete -t THRESHOLD_ID</computeroutput></screen>
<para>
Delete a threshold.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-t THRESHOLD_ID, --threshold-id THRESHOLD_ID</command></term>
<listitem>
<para>
Threshold uuid Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-threshold-get">
<title>cloudkitty hashmap-threshold-get</title>
<screen><computeroutput>usage: cloudkitty hashmap-threshold-get -t THRESHOLD_ID</computeroutput></screen>
<para>
Get a threshold.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-t THRESHOLD_ID, --threshold-id THRESHOLD_ID</command></term>
<listitem>
<para>
Threshold uuid Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-threshold-group">
<title>cloudkitty hashmap-threshold-group</title>
<screen><computeroutput>usage: cloudkitty hashmap-threshold-group -t THRESHOLD_ID</computeroutput></screen>
<para>
Get a threshold group.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-t THRESHOLD_ID, --threshold-id THRESHOLD_ID</command></term>
<listitem>
<para>
Threshold uuid Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-threshold-list">
<title>cloudkitty hashmap-threshold-list</title>
<screen><computeroutput>usage: cloudkitty hashmap-threshold-list [-s SERVICE_ID] [-f FIELD_ID]
[-g GROUP_ID]
[--no-group {True,False}]</computeroutput></screen>
<para>
List thresholds.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-s SERVICE_ID, --service-id SERVICE_ID</command></term>
<listitem>
<para>
Service id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-f FIELD_ID, --field-id FIELD_ID</command></term>
<listitem>
<para>
Field id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-g GROUP_ID, --group-id GROUP_ID</command></term>
<listitem>
<para>
Group id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--no-group {True,False}</command></term>
<listitem>
<para>
If True, list only orhpaned thresholds
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_hashmap-threshold-update">
<title>cloudkitty hashmap-threshold-update</title>
<screen><computeroutput>usage: cloudkitty hashmap-threshold-update -t THRESHOLD_ID [-l LEVEL]
[-c COST] [-m MAP_TYPE]
[-g GROUP_ID]</computeroutput></screen>
<para>
Update a threshold.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-t THRESHOLD_ID, --threshold-id THRESHOLD_ID</command></term>
<listitem>
<para>
Threshold id Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-l LEVEL, --level LEVEL</command></term>
<listitem>
<para>
Threshold level
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-c COST, --cost COST</command></term>
<listitem>
<para>
Threshold cost
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m MAP_TYPE, --map-type MAP_TYPE</command></term>
<listitem>
<para>
Threshold type (flat, rate)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-g GROUP_ID, --group-id GROUP_ID</command></term>
<listitem>
<para>
Group id
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_module-disable">
<title>cloudkitty module-disable</title>
<screen><computeroutput>usage: cloudkitty module-disable -n NAME</computeroutput></screen>
<para>
Disable a module.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-n NAME, --name NAME</command></term>
<listitem>
<para>
Module name Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_module-enable">
<title>cloudkitty module-enable</title>
<screen><computeroutput>usage: cloudkitty module-enable -n NAME</computeroutput></screen>
<para>
Enable a module.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-n NAME, --name NAME</command></term>
<listitem>
<para>
Module name Required.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_module-list">
<title>cloudkitty module-list</title>
<screen><computeroutput>usage: cloudkitty module-list</computeroutput></screen>
<para>
List the samples for this meters.
</para>
</section>
<section xml:id="cloudkittyclient_subcommand_report-tenant-list">
<title>cloudkitty report-tenant-list</title>
<screen><computeroutput>usage: cloudkitty report-tenant-list</computeroutput></screen>
<para>
</para>
</section>
<section xml:id="cloudkittyclient_subcommand_storage-dataframe-list">
<title>cloudkitty storage-dataframe-list</title>
<screen><computeroutput>usage: cloudkitty storage-dataframe-list --begin BEGIN --end END
[--tenant TENANT]
[--resource-type RESOURCE_TYPE]</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--begin BEGIN</command></term>
<listitem>
<para>
Starting date/time (YYYY-MM-ddThh:mm:ss)
Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--end END</command></term>
<listitem>
<para>
Ending date/time (YYYY-MM-ddThh:mm:ss)
Required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--tenant TENANT</command></term>
<listitem>
<para>
Tenant ID Defaults to None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-type RESOURCE_TYPE</command></term>
<listitem>
<para>
Resource type (compute, image, ...) Defaults
to None.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cloudkittyclient_subcommand_total-get">
<title>cloudkitty total-get</title>
<screen><computeroutput>usage: cloudkitty total-get [-t TOTAL_TENANT_ID] [-b BEGIN] [-e END]</computeroutput></screen>
<para>
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-t TOTAL_TENANT_ID, --tenant-id TOTAL_TENANT_ID</command></term>
<listitem>
<para>
Tenant id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-b BEGIN, --begin BEGIN</command></term>
<listitem>
<para>
Begin timestamp
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-e END, --end END</command></term>
<listitem>
<para>
End timestamp
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
View Git Blame Copy Permalink