CLI Reference¶

collector disable¶

(DEPRECATED) Disable a collector.

cloudkitty collector disable name

name¶

Name of the collector

This command is provided by the python-cloudkittyclient plugin.

collector enable¶

(DEPRECATED) Enable a collector.

cloudkitty collector enable name

name¶

Name of the collector

This command is provided by the python-cloudkittyclient plugin.

collector state get¶

(DEPRECATED) Get the state of a collector.

cloudkitty collector state get name

name¶

Name of the collector

This command is provided by the python-cloudkittyclient plugin.

collector-mapping create¶

(DEPRECATED) Create a service to collector mapping.

cloudkitty collector-mapping create service collector

service¶

Name of the service

collector¶

Name of the collector

This command is provided by the python-cloudkittyclient plugin.

collector-mapping delete¶

(DEPRECATED) Delete a service to collector mapping.

cloudkitty collector-mapping delete service

service¶

Name of the service

This command is provided by the python-cloudkittyclient plugin.

collector-mapping get¶

(DEPRECATED) Get a service to collector mapping.

cloudkitty collector-mapping get service

service¶

Name of the service to filter on

This command is provided by the python-cloudkittyclient plugin.

collector-mapping list¶

(DEPRECATED) List service to collector mappings.

cloudkitty collector-mapping list [--collector COLLECTOR]

--collector <COLLECTOR>¶

Name of the collector to filter on

This command is provided by the python-cloudkittyclient plugin.

dataframes get¶

List stored dataframes or generate CSV reports.

Dataframes can be filtered on resource_type and project_id. CSV reports can be generated with the ‘df-to-csv’ formatter. A config file may be provided to configure the output of that formatter. See documentation for more details.

cloudkitty dataframes get
    [-b BEGIN]
    [-e END]
    [-p TENANT_ID]
    [-r RESOURCE_TYPE]

-b <BEGIN>, --begin <BEGIN>¶

Begin timestamp

-e <END>, --end <END>¶

End timestamp

-p <TENANT_ID>, --project-id <TENANT_ID>¶

Id of the tenant to filter on

-r <RESOURCE_TYPE>, --resource_type <RESOURCE_TYPE>¶

Resource type to filter on

This command is provided by the python-cloudkittyclient plugin.

hashmap field create¶

Create a hashmap field.

cloudkitty hashmap field create service_id name

service_id¶

Service ID

name¶

Field name

This command is provided by the python-cloudkittyclient plugin.

hashmap field delete¶

Delete a hashmap field.

cloudkitty hashmap field delete field_id

field_id¶

Field ID

This command is provided by the python-cloudkittyclient plugin.

hashmap field get¶

Get a Hashmap field.

cloudkitty hashmap field get field_id

field_id¶

Field ID

This command is provided by the python-cloudkittyclient plugin.

hashmap field list¶

List hashmap fields for the given service.

cloudkitty hashmap field list service_id

service_id¶

Service ID

This command is provided by the python-cloudkittyclient plugin.

hashmap group create¶

Create a Hashmap group.

cloudkitty hashmap group create name

name¶

Group Name

This command is provided by the python-cloudkittyclient plugin.

hashmap group delete¶

Create a Hashmap group.

cloudkitty hashmap group delete [--recursive] group_id

--recursive¶

Delete mappings recursively

group_id¶

Group ID

This command is provided by the python-cloudkittyclient plugin.

hashmap group list¶

List existing hashmap groups.

cloudkitty hashmap group list

This command is provided by the python-cloudkittyclient plugin.

hashmap group mappings get¶

Get all Hashmap mappings for the given group.

cloudkitty hashmap group mappings get group_id

group_id¶

Group ID

This command is provided by the python-cloudkittyclient plugin.

hashmap group thresholds get¶

Get all thresholds for the given group.

cloudkitty hashmap group thresholds get group_id

group_id¶

Group ID

This command is provided by the python-cloudkittyclient plugin.

hashmap mapping create¶

Create a Hashmap mapping.

cloudkitty hashmap mapping create
    [-s SERVICE_ID]
    [-g GROUP_ID]
    [--field-id FIELD_ID]
    [-p TENANT_ID]
    [-t TYPE]
    [--value VALUE]
    cost

-s <SERVICE_ID>, --service-id <SERVICE_ID>¶

Service ID

-g <GROUP_ID>, --group-id <GROUP_ID>¶

Group ID

--field-id <FIELD_ID>¶

Field ID

-p <TENANT_ID>, --project-id <TENANT_ID>¶

Project ID

-t <TYPE>, --type <TYPE>¶

Mapping type

--value <VALUE>¶

Value

cost¶

Cost

This command is provided by the python-cloudkittyclient plugin.

hashmap mapping delete¶

Delete a Hashmap mapping.

cloudkitty hashmap mapping delete mapping_id

mapping_id¶

Mapping ID

This command is provided by the python-cloudkittyclient plugin.

hashmap mapping get¶

Get a hashmap mapping.

cloudkitty hashmap mapping get mapping_id

mapping_id¶

Mapping ID to filter on

This command is provided by the python-cloudkittyclient plugin.

hashmap mapping list¶

List hashmap mappings.

cloudkitty hashmap mapping list
    [-s SERVICE_ID]
    [-g GROUP_ID]
    [--field-id FIELD_ID]
    [-p TENANT_ID]
    [--filter-tenant]
    [--no-group]

-s <SERVICE_ID>, --service-id <SERVICE_ID>¶

Service ID to filter on

-g <GROUP_ID>, --group-id <GROUP_ID>¶

Group ID to filter on

--field-id <FIELD_ID>¶

Field ID to filter on

-p <TENANT_ID>, --project-id <TENANT_ID>¶

Project ID to filter on

--filter-tenant¶

Explicitly filter on given tenant (allows to filter on tenant being None)

--no-group¶

Filter on orphaned mappings

This command is provided by the python-cloudkittyclient plugin.

hashmap mapping update¶

Update a Hashmap mapping.

cloudkitty hashmap mapping update
    [-s SERVICE_ID]
    [-g GROUP_ID]
    [--field-id FIELD_ID]
    [-p TENANT_ID]
    [--value VALUE]
    [--cost COST]
    mapping_id

-s <SERVICE_ID>, --service-id <SERVICE_ID>¶

Service ID

-g <GROUP_ID>, --group-id <GROUP_ID>¶

Group ID

--field-id <FIELD_ID>¶

Field ID

-p <TENANT_ID>, --project-id <TENANT_ID>¶

Project ID

--value <VALUE>¶

Value

--cost <COST>¶

Cost

mapping_id¶

Mapping ID

This command is provided by the python-cloudkittyclient plugin.

hashmap mapping-types list¶

Get hashmap mapping types/

cloudkitty hashmap mapping-types list

This command is provided by the python-cloudkittyclient plugin.

hashmap service create¶

Create a hashmap service.

cloudkitty hashmap service create name

name¶

Service Name

This command is provided by the python-cloudkittyclient plugin.

hashmap service delete¶

Delete a hashmap service

cloudkitty hashmap service delete service_id

service_id¶

Service ID

This command is provided by the python-cloudkittyclient plugin.

hashmap service get¶

Get a hashmap service

cloudkitty hashmap service get service_id

service_id¶

Service ID

This command is provided by the python-cloudkittyclient plugin.

hashmap service list¶

List hashmap services.

cloudkitty hashmap service list

This command is provided by the python-cloudkittyclient plugin.

hashmap threshold create¶

Create a Hashmap threshold.

cloudkitty hashmap threshold create
    [-s SERVICE_ID]
    [-g GROUP_ID]
    [--field-id FIELD_ID]
    [-p TENANT_ID]
    [-t TYPE]
    level
    cost

-s <SERVICE_ID>, --service-id <SERVICE_ID>¶

Service ID

-g <GROUP_ID>, --group-id <GROUP_ID>¶

Group ID

--field-id <FIELD_ID>¶

Field ID

-p <TENANT_ID>, --project-id <TENANT_ID>¶

Project ID

-t <TYPE>, --type <TYPE>¶

Threshold type

level¶

Threshold level

cost¶

Cost

This command is provided by the python-cloudkittyclient plugin.

hashmap threshold delete¶

Delete a Hashmap threshold.

cloudkitty hashmap threshold delete threshold_id

threshold_id¶

Threshold ID

This command is provided by the python-cloudkittyclient plugin.

hashmap threshold get¶

Get a Hashmap threshold.

cloudkitty hashmap threshold get threshold_id

threshold_id¶

Threshold ID to filter on

This command is provided by the python-cloudkittyclient plugin.

hashmap threshold list¶

List Hashmap thresholds

cloudkitty hashmap threshold list
    [-s SERVICE_ID]
    [-g GROUP_ID]
    [--field-id FIELD_ID]
    [-p TENANT_ID]
    [--filter-tenant]
    [--no-group]

-s <SERVICE_ID>, --service-id <SERVICE_ID>¶

Service ID to filter on

-g <GROUP_ID>, --group-id <GROUP_ID>¶

Group ID to filter on

--field-id <FIELD_ID>¶

Field ID to filter on

-p <TENANT_ID>, --project-id <TENANT_ID>¶

Project ID to filter on

--filter-tenant¶

Explicitly filter on given tenant (allows to filter on tenant being None)

--no-group¶

Filter on orphaned thresholds

This command is provided by the python-cloudkittyclient plugin.

hashmap threshold update¶

Update a Hashmap threshold.

cloudkitty hashmap threshold update
    [-s SERVICE_ID]
    [-g GROUP_ID]
    [--field-id FIELD_ID]
    [-p TENANT_ID]
    [-l LEVEL]
    [--cost COST]
    threshold_id

-s <SERVICE_ID>, --service-id <SERVICE_ID>¶

Service ID

-g <GROUP_ID>, --group-id <GROUP_ID>¶

Group ID

--field-id <FIELD_ID>¶

Field ID

-p <TENANT_ID>, --project-id <TENANT_ID>¶

Project ID

-l <LEVEL>, --level <LEVEL>¶

Threshold level

--cost <COST>¶

Cost

threshold_id¶

Threshold ID

This command is provided by the python-cloudkittyclient plugin.

info config get¶

Get information about the current configuration.

cloudkitty info config get

This command is provided by the python-cloudkittyclient plugin.

info metric get¶

Get information about current metrics.

cloudkitty info metric get metric_name

metric_name¶

Metric name

This command is provided by the python-cloudkittyclient plugin.

info metric list¶

Get information about a single metric.

cloudkitty info metric list

This command is provided by the python-cloudkittyclient plugin.

module disable¶

Disable a rating module.

cloudkitty module disable module_id

module_id¶

Module name

This command is provided by the python-cloudkittyclient plugin.

module enable¶

Enable a rating module.

cloudkitty module enable module_id

module_id¶

Module name

This command is provided by the python-cloudkittyclient plugin.

module get¶

Get a rating module or list loaded rating modules.

If module_id is not specified, returns a list of all loaded rating modules.

cloudkitty module get module_id

module_id¶

Module name

This command is provided by the python-cloudkittyclient plugin.

module list¶

List loaded rating modules.

cloudkitty module list

This command is provided by the python-cloudkittyclient plugin.

module set priority¶

Set the priority of a rating module.

cloudkitty module set priority module_id priority

module_id¶

Module name

priority¶

Priority (int)

This command is provided by the python-cloudkittyclient plugin.

pyscript create¶

Create a PyScript.

cloudkitty pyscript create name data

name¶

Script Name

data¶

Script Data or data file

This command is provided by the python-cloudkittyclient plugin.

pyscript delete¶

Delete a PyScript.

cloudkitty pyscript delete script_id

script_id¶

Script ID

This command is provided by the python-cloudkittyclient plugin.

pyscript get¶

Get a PyScript.

cloudkitty pyscript get script_id

script_id¶

Script ID

This command is provided by the python-cloudkittyclient plugin.

pyscript list¶

List existing PyScripts.

cloudkitty pyscript list [-n]

-n, --no-data¶

Set to true to remove script data from output

This command is provided by the python-cloudkittyclient plugin.

pyscript update¶

Update a PyScript.

cloudkitty pyscript update [-n NAME] [-d DATA] script_id

-n <NAME>, --name <NAME>¶

Script Name

-d <DATA>, --data <DATA>¶

Script Data or data file

script_id¶

Script ID

This command is provided by the python-cloudkittyclient plugin.

report tenant list¶

Get rated tenants for the given period.

Begin defaults to the beginning of the current month and end defaults to the beginning of the next month.

cloudkitty report tenant list [-b BEGIN] [-e END]

-b <BEGIN>, --begin <BEGIN>¶

Begin timestamp.

-e <END>, --end <END>¶

End timestamp.

This command is provided by the python-cloudkittyclient plugin.

summary get¶

Get a summary report.

cloudkitty summary get
    [-t TENANT_ID]
    [-b BEGIN]
    [-e END]
    [-s SERVICE]
    [-g GROUPBY [GROUPBY ...]]
    [-a]

-t <TENANT_ID>, --tenant-id <TENANT_ID>¶

Tenant id.

-b <BEGIN>, --begin <BEGIN>¶

Begin timestamp.

-e <END>, --end <END>¶

End timestamp.

-s <SERVICE>, --service <SERVICE>¶

Service Type.

-g <GROUPBY>, --groupby <GROUPBY>¶

Fields to group by, space-separated. (res_type and tenant_id are supported for now)

-a, --all-tenants¶

Allows to get summary from all tenants (admin only). Defaults to False.

This command is provided by the python-cloudkittyclient plugin.

total get¶

(DEPRECATED) Get total reports.

cloudkitty total get
    [--prefix PREFIX]
    [-t TENANT_ID]
    [-b BEGIN]
    [-e END]
    [-s SERVICE]
    [-g GROUPBY [GROUPBY ...]]
    [-a]

--prefix <PREFIX>¶

add a prefix to all variable names

-t <TENANT_ID>, --tenant-id <TENANT_ID>¶

Tenant id.

-b <BEGIN>, --begin <BEGIN>¶

Begin timestamp.

-e <END>, --end <END>¶

End timestamp.

-s <SERVICE>, --service <SERVICE>¶

Service Type.

-g <GROUPBY>, --groupby <GROUPBY>¶

Fields to group by, space-separated. (res_type and tenant_id are supported for now)

-a, --all-tenants¶

Allows to get summary from all tenants (admin only). Defaults to False.

This command is provided by the python-cloudkittyclient plugin.