.. ## WARNING ###################################### .. This file is automatically generated, do not edit .. ################################################# ================================== Rating service command-line client ================================== The cloudkitty client is the command-line interface (CLI) for the Rating service API and its extensions. This chapter documents :command:`cloudkitty` version ``0.4.1``. For help on a specific :command:`cloudkitty` command, enter: .. code-block:: console $ cloudkitty help COMMAND .. _cloudkitty_command_usage: cloudkitty usage ~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty [--version] [-d] [-v] [--timeout TIMEOUT] [--cloudkitty-url ] [--cloudkitty-api-version CLOUDKITTY_API_VERSION] [--os-tenant-id ] [--os-region-name ] [--os-auth-token ] [--os-service-type ] [--os-endpoint-type ] [--os-cacert ] [--os-insecure ] [--os-cert-file ] [--os-key-file ] [--os-cert ] [--os-key ] [--os-project-name ] [--os-project-id ] [--os-user-domain-id ] [--os-user-domain-name ] [--os-endpoint ] [--os-auth-system ] [--os-username ] [--os-password ] [--os-tenant-name ] [--os-token ] [--os-auth-url ] ... Subcommands ----------- ``module-disable`` Disable a module. ``module-enable`` Enable a module. ``module-list`` List the samples for this meters. ``collector-mapping-create`` ``collector-mapping-delete`` ``collector-mapping-get`` ``collector-mapping-list`` ``collector-state-disable`` ``collector-state-enable`` ``collector-state-get`` ``report-tenant-list`` ``total-get`` ``storage-dataframe-list`` ``hashmap-field-create`` Create a field. ``hashmap-field-delete`` Delete a field. ``hashmap-field-list`` Create a field. ``hashmap-group-create`` Create a group. ``hashmap-group-delete`` Delete a group. ``hashmap-group-list`` List groups. ``hashmap-mapping-create`` Create a mapping. ``hashmap-mapping-delete`` Delete a mapping. ``hashmap-mapping-list`` List mappings. ``hashmap-mapping-update`` Update a mapping. ``hashmap-service-create`` Create a service. ``hashmap-service-delete`` Delete a service. ``hashmap-service-list`` List services. ``hashmap-threshold-create`` Create a mapping. ``hashmap-threshold-delete`` Delete a threshold. ``hashmap-threshold-get`` Get a threshold. ``hashmap-threshold-group`` Get a threshold group. ``hashmap-threshold-list`` List thresholds. ``hashmap-threshold-update`` Update a threshold. ``bash-completion`` Prints all of the commands and options to stdout. ``help`` Display help about this program or one of its subcommands. .. _cloudkitty_command_options: cloudkitty optional arguments ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``--version`` show program's version number and exit ``-d, --debug`` Defaults to ``env[CLOUDKITTYCLIENT_DEBUG]``. ``-v, --verbose`` Print more verbose output. ``--timeout TIMEOUT`` Number of seconds to wait for a response. ``--cloudkitty-url `` **DEPRECATED**, use :option:`--os-endpoint` instead. Defaults to ``env[CLOUDKITTY_URL]``. ``--cloudkitty-api-version CLOUDKITTY_API_VERSION`` Defaults to ``env[CLOUDKITTY_API_VERSION]`` or 1. ``--os-tenant-id `` Defaults to ``env[OS_TENANT_ID]``. ``--os-region-name `` Defaults to ``env[OS_REGION_NAME]``. ``--os-auth-token `` Defaults to ``env[OS_AUTH_TOKEN]``. ``--os-service-type `` Defaults to ``env[OS_SERVICE_TYPE]``. ``--os-endpoint-type `` Defaults to ``env[OS_ENDPOINT_TYPE]``. ``--os-cacert `` Defaults to ``env[OS_CACERT]``. ``--os-insecure `` Defaults to ``env[OS_INSECURE]``. ``--os-cert-file `` Defaults to ``env[OS_CERT_FILE]``. ``--os-key-file `` Defaults to ``env[OS_KEY_FILE]``. ``--os-cert `` Defaults to ``env[OS_CERT]``. ``--os-key `` Defaults to ``env[OS_KEY]``. ``--os-project-name `` Defaults to ``env[OS_PROJECT_NAME]``. ``--os-project-id `` Defaults to ``env[OS_PROJECT_ID]``. ``--os-user-domain-id `` Defaults to ``env[OS_USER_DOMAIN_ID]``. ``--os-user-domain-name `` Defaults to ``env[OS_USER_DOMAIN_NAME]``. ``--os-endpoint `` Defaults to ``env[OS_ENDPOINT]``. ``--os-auth-system `` Defaults to ``env[OS_AUTH_SYSTEM]``. ``--os-username `` Defaults to ``env[OS_USERNAME]``. ``--os-password `` Defaults to ``env[OS_PASSWORD]``. ``--os-tenant-name `` Defaults to ``env[OS_TENANT_NAME]``. ``--os-token `` Defaults to ``env[OS_TOKEN]``. ``--os-auth-url `` Defaults to ``env[OS_AUTH_URL]``. .. _cloudkitty_collector-mapping-create: cloudkitty collector-mapping-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty collector-mapping-create --collector COLLECTOR --service SERVICE Optional arguments ------------------ ``--collector COLLECTOR`` Map a service to this collector. Required. ``--service SERVICE`` Map a collector to this service. Required. .. _cloudkitty_collector-mapping-delete: cloudkitty collector-mapping-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty collector-mapping-delete --service SERVICE Optional arguments ------------------ ``--service SERVICE`` Filter on this service. Required. .. _cloudkitty_collector-mapping-get: cloudkitty collector-mapping-get ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty collector-mapping-get --service SERVICE Optional arguments ------------------ ``--service SERVICE`` Which service to get the mapping for. Required. .. _cloudkitty_collector-mapping-list: cloudkitty collector-mapping-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty collector-mapping-list [--collector COLLECTOR] Optional arguments ------------------ ``--collector COLLECTOR`` Collector name to filter on. Defaults to None. .. _cloudkitty_collector-state-disable: cloudkitty collector-state-disable ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty collector-state-disable --name NAME Optional arguments ------------------ ``--name NAME`` Name of the collector. Required. .. _cloudkitty_collector-state-enable: cloudkitty collector-state-enable ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty collector-state-enable --name NAME Optional arguments ------------------ ``--name NAME`` Name of the collector. Required. .. _cloudkitty_collector-state-get: cloudkitty collector-state-get ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty collector-state-get --name NAME Optional arguments ------------------ ``--name NAME`` Name of the collector. Required. .. _cloudkitty_hashmap-field-create: cloudkitty hashmap-field-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-field-create -n NAME -s SERVICE_ID Create a field. Optional arguments ------------------ ``-n NAME, --name NAME`` Field name Required. ``-s SERVICE_ID, --service-id SERVICE_ID`` Service id Required. .. _cloudkitty_hashmap-field-delete: cloudkitty hashmap-field-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-field-delete -f FIELD_ID Delete a field. Optional arguments ------------------ ``-f FIELD_ID, --field-id FIELD_ID`` Field uuid Required. .. _cloudkitty_hashmap-field-list: cloudkitty hashmap-field-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-field-list -s SERVICE_ID Create a field. Optional arguments ------------------ ``-s SERVICE_ID, --service-id SERVICE_ID`` Service id Required. .. _cloudkitty_hashmap-group-create: cloudkitty hashmap-group-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-group-create -n NAME Create a group. Optional arguments ------------------ ``-n NAME, --name NAME`` Group name Required. .. _cloudkitty_hashmap-group-delete: cloudkitty hashmap-group-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-group-delete -g GROUP_ID [-r RECURSIVE] Delete a group. Optional arguments ------------------ ``-g GROUP_ID, --group-id GROUP_ID`` Group uuid Required. ``-r RECURSIVE, --recursive RECURSIVE`` Delete the group's mappings Defaults to False. .. _cloudkitty_hashmap-group-list: cloudkitty hashmap-group-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-group-list List groups. .. _cloudkitty_hashmap-mapping-create: cloudkitty hashmap-mapping-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-mapping-create -c COST [-v VALUE] [-t TYPE] [-s SERVICE_ID] [-f FIELD_ID] [-g GROUP_ID] Create a mapping. Optional arguments ------------------ ``-c COST, --cost COST`` Mapping cost Required. ``-v VALUE, --value VALUE`` Mapping value ``-t TYPE, --type TYPE`` Mapping type (flat, rate) ``-s SERVICE_ID, --service-id SERVICE_ID`` Service id ``-f FIELD_ID, --field-id FIELD_ID`` Field id ``-g GROUP_ID, --group-id GROUP_ID`` Group id .. _cloudkitty_hashmap-mapping-delete: cloudkitty hashmap-mapping-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-mapping-delete -m MAPPING_ID Delete a mapping. Optional arguments ------------------ ``-m MAPPING_ID, --mapping-id MAPPING_ID`` Mapping uuid Required. .. _cloudkitty_hashmap-mapping-list: cloudkitty hashmap-mapping-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-mapping-list [-s SERVICE_ID] [-f FIELD_ID] [-g GROUP_ID] List mappings. Optional arguments ------------------ ``-s SERVICE_ID, --service-id SERVICE_ID`` Service id ``-f FIELD_ID, --field-id FIELD_ID`` Field id ``-g GROUP_ID, --group-id GROUP_ID`` Group id .. _cloudkitty_hashmap-mapping-update: cloudkitty hashmap-mapping-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-mapping-update -m MAPPING_ID [-c COST] [-v VALUE] [-t TYPE] [-g GROUP_ID] Update a mapping. Optional arguments ------------------ ``-m MAPPING_ID, --mapping-id MAPPING_ID`` Mapping id Required. ``-c COST, --cost COST`` Mapping cost ``-v VALUE, --value VALUE`` Mapping value ``-t TYPE, --type TYPE`` Mapping type (flat, rate) ``-g GROUP_ID, --group-id GROUP_ID`` Group id .. _cloudkitty_hashmap-service-create: cloudkitty hashmap-service-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-service-create -n NAME Create a service. Optional arguments ------------------ ``-n NAME, --name NAME`` Service name Required. .. _cloudkitty_hashmap-service-delete: cloudkitty hashmap-service-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-service-delete -s SERVICE_ID Delete a service. Optional arguments ------------------ ``-s SERVICE_ID, --service-id SERVICE_ID`` Service uuid Required. .. _cloudkitty_hashmap-service-list: cloudkitty hashmap-service-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-service-list List services. .. _cloudkitty_hashmap-threshold-create: cloudkitty hashmap-threshold-create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-threshold-create -l LEVEL -c COST [-m MAP_TYPE] [-s SERVICE_ID] [-f FIELD_ID] [-g GROUP_ID] Create a mapping. Optional arguments ------------------ ``-l LEVEL, --level LEVEL`` Threshold level Required. ``-c COST, --cost COST`` Threshold cost Required. ``-m MAP_TYPE, --map-type MAP_TYPE`` Threshold type (flat, rate) ``-s SERVICE_ID, --service-id SERVICE_ID`` Service id ``-f FIELD_ID, --field-id FIELD_ID`` Field id ``-g GROUP_ID, --group-id GROUP_ID`` Group id .. _cloudkitty_hashmap-threshold-delete: cloudkitty hashmap-threshold-delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-threshold-delete -t THRESHOLD_ID Delete a threshold. Optional arguments ------------------ ``-t THRESHOLD_ID, --threshold-id THRESHOLD_ID`` Threshold uuid Required. .. _cloudkitty_hashmap-threshold-get: cloudkitty hashmap-threshold-get ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-threshold-get -t THRESHOLD_ID Get a threshold. Optional arguments ------------------ ``-t THRESHOLD_ID, --threshold-id THRESHOLD_ID`` Threshold uuid Required. .. _cloudkitty_hashmap-threshold-group: cloudkitty hashmap-threshold-group ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-threshold-group -t THRESHOLD_ID Get a threshold group. Optional arguments ------------------ ``-t THRESHOLD_ID, --threshold-id THRESHOLD_ID`` Threshold uuid Required. .. _cloudkitty_hashmap-threshold-list: cloudkitty hashmap-threshold-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-threshold-list [-s SERVICE_ID] [-f FIELD_ID] [-g GROUP_ID] [--no-group {True,False}] List thresholds. Optional arguments ------------------ ``-s SERVICE_ID, --service-id SERVICE_ID`` Service id ``-f FIELD_ID, --field-id FIELD_ID`` Field id ``-g GROUP_ID, --group-id GROUP_ID`` Group id ``--no-group {True,False}`` If True, list only orhpaned thresholds .. _cloudkitty_hashmap-threshold-update: cloudkitty hashmap-threshold-update ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty hashmap-threshold-update -t THRESHOLD_ID [-l LEVEL] [-c COST] [-m MAP_TYPE] [-g GROUP_ID] Update a threshold. Optional arguments ------------------ ``-t THRESHOLD_ID, --threshold-id THRESHOLD_ID`` Threshold id Required. ``-l LEVEL, --level LEVEL`` Threshold level ``-c COST, --cost COST`` Threshold cost ``-m MAP_TYPE, --map-type MAP_TYPE`` Threshold type (flat, rate) ``-g GROUP_ID, --group-id GROUP_ID`` Group id .. _cloudkitty_module-disable: cloudkitty module-disable ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty module-disable -n NAME Disable a module. Optional arguments ------------------ ``-n NAME, --name NAME`` Module name Required. .. _cloudkitty_module-enable: cloudkitty module-enable ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty module-enable -n NAME Enable a module. Optional arguments ------------------ ``-n NAME, --name NAME`` Module name Required. .. _cloudkitty_module-list: cloudkitty module-list ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty module-list List the samples for this meters. .. _cloudkitty_report-tenant-list: cloudkitty report-tenant-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty report-tenant-list .. _cloudkitty_storage-dataframe-list: cloudkitty storage-dataframe-list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty storage-dataframe-list --begin BEGIN --end END [--tenant TENANT] [--resource-type RESOURCE_TYPE] Optional arguments ------------------ ``--begin BEGIN`` Starting date/time (YYYY-MM-ddThh:mm:ss) Required. ``--end END`` Ending date/time (YYYY-MM-ddThh:mm:ss) Required. ``--tenant TENANT`` Tenant ID Defaults to None. ``--resource-type RESOURCE_TYPE`` Resource type (compute, image, ...) Defaults to None. .. _cloudkitty_total-get: cloudkitty total-get ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: cloudkitty total-get [-t TOTAL_TENANT_ID] [-b BEGIN] [-e END] Optional arguments ------------------ ``-t TOTAL_TENANT_ID, --tenant-id TOTAL_TENANT_ID`` Tenant id ``-b BEGIN, --begin BEGIN`` Begin timestamp ``-e END, --end END`` End timestamp