CLI Reference¶
V1 Client¶
collector disable¶
(DEPRECATED) Disable a collector.
cloudkitty collector disable
[-h]
[--sort-ascending | --sort-descending]
name
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
name
¶
Name of the collector
This command is provided by the python-cloudkittyclient plugin.
collector enable¶
(DEPRECATED) Enable a collector.
cloudkitty collector enable
[-h]
[--sort-ascending | --sort-descending]
name
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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
[-h]
[--sort-ascending | --sort-descending]
name
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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
[-h]
[--sort-ascending | --sort-descending]
service
collector
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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 [-h] service
-
-h
,
--help
¶
show this help message and exit
-
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
[-h]
[--sort-ascending | --sort-descending]
service
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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
[-h]
[--sort-ascending | --sort-descending]
[--collector COLLECTOR]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
--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
[-h]
[--sort-ascending | --sort-descending]
[-b BEGIN]
[-e END]
[-p TENANT_ID]
[-r RESOURCE_TYPE]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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
[-h]
[--sort-ascending | --sort-descending]
service_id
name
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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 [-h] field_id
-
-h
,
--help
¶
show this help message and exit
-
field_id
¶
Field ID
This command is provided by the python-cloudkittyclient plugin.
hashmap field get¶
Get a Hashmap field.
cloudkitty hashmap field get
[-h]
[--sort-ascending | --sort-descending]
field_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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
[-h]
[--sort-ascending | --sort-descending]
service_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
service_id
¶
Service ID
This command is provided by the python-cloudkittyclient plugin.
hashmap group create¶
Create a Hashmap group.
cloudkitty hashmap group create
[-h]
[--sort-ascending | --sort-descending]
name
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
name
¶
Group Name
This command is provided by the python-cloudkittyclient plugin.
hashmap group delete¶
Create a Hashmap group.
cloudkitty hashmap group delete [-h] [--recursive] group_id
-
-h
,
--help
¶
show this help message and exit
-
--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
[-h]
[--sort-ascending | --sort-descending]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
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
[-h]
[--sort-ascending | --sort-descending]
group_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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
[-h]
[--sort-ascending | --sort-descending]
group_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
group_id
¶
Group ID
This command is provided by the python-cloudkittyclient plugin.
hashmap mapping create¶
Create a Hashmap mapping.
cloudkitty hashmap mapping create
[-h]
[--sort-ascending | --sort-descending]
[-s SERVICE_ID]
[-g GROUP_ID]
[--field-id FIELD_ID]
[-p TENANT_ID]
[-t TYPE]
[--value VALUE]
cost
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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 [-h] mapping_id
-
-h
,
--help
¶
show this help message and exit
-
mapping_id
¶
Mapping ID
This command is provided by the python-cloudkittyclient plugin.
hashmap mapping get¶
Get a hashmap mapping.
cloudkitty hashmap mapping get
[-h]
[--sort-ascending | --sort-descending]
mapping_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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
[-h]
[--sort-ascending | --sort-descending]
[-s SERVICE_ID]
[-g GROUP_ID]
[--field-id FIELD_ID]
[-p TENANT_ID]
[--filter-tenant]
[--no-group]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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
[-h]
[--sort-ascending | --sort-descending]
[-s SERVICE_ID]
[-g GROUP_ID]
[--field-id FIELD_ID]
[-p TENANT_ID]
[--value VALUE]
[--cost COST]
mapping_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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
[-h]
[--sort-ascending | --sort-descending]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
This command is provided by the python-cloudkittyclient plugin.
hashmap service create¶
Create a hashmap service.
cloudkitty hashmap service create
[-h]
[--sort-ascending | --sort-descending]
name
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
name
¶
Service Name
This command is provided by the python-cloudkittyclient plugin.
hashmap service delete¶
Delete a hashmap service
cloudkitty hashmap service delete [-h] service_id
-
-h
,
--help
¶
show this help message and exit
-
service_id
¶
Service ID
This command is provided by the python-cloudkittyclient plugin.
hashmap service get¶
Get a hashmap service
cloudkitty hashmap service get
[-h]
[--sort-ascending | --sort-descending]
service_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
service_id
¶
Service ID
This command is provided by the python-cloudkittyclient plugin.
hashmap service list¶
List hashmap services.
cloudkitty hashmap service list
[-h]
[--sort-ascending | --sort-descending]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
This command is provided by the python-cloudkittyclient plugin.
hashmap threshold create¶
Create a Hashmap threshold.
cloudkitty hashmap threshold create
[-h]
[--sort-ascending | --sort-descending]
[-s SERVICE_ID]
[-g GROUP_ID]
[--field-id FIELD_ID]
[-p TENANT_ID]
[-t TYPE]
level
cost
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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 [-h] threshold_id
-
-h
,
--help
¶
show this help message and exit
-
threshold_id
¶
Threshold ID
This command is provided by the python-cloudkittyclient plugin.
hashmap threshold get¶
Get a Hashmap threshold.
cloudkitty hashmap threshold get
[-h]
[--sort-ascending | --sort-descending]
threshold_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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
[-h]
[--sort-ascending | --sort-descending]
[-s SERVICE_ID]
[-g GROUP_ID]
[--field-id FIELD_ID]
[-p TENANT_ID]
[--filter-tenant]
[--no-group]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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
[-h]
[--sort-ascending | --sort-descending]
[-s SERVICE_ID]
[-g GROUP_ID]
[--field-id FIELD_ID]
[-p TENANT_ID]
[-l LEVEL]
[--cost COST]
threshold_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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 [-h] [--sort-ascending | --sort-descending]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
This command is provided by the python-cloudkittyclient plugin.
info metric get¶
Get information about current metrics.
cloudkitty info metric get
[-h]
[--sort-ascending | --sort-descending]
metric_name
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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 [-h] [--sort-ascending | --sort-descending]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
This command is provided by the python-cloudkittyclient plugin.
module disable¶
Disable a rating module.
cloudkitty module disable
[-h]
[--sort-ascending | --sort-descending]
module_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
module_id
¶
Module name
This command is provided by the python-cloudkittyclient plugin.
module enable¶
Enable a rating module.
cloudkitty module enable
[-h]
[--sort-ascending | --sort-descending]
module_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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
[-h]
[--sort-ascending | --sort-descending]
module_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
module_id
¶
Module name
This command is provided by the python-cloudkittyclient plugin.
module list¶
List loaded rating modules.
cloudkitty module list [-h] [--sort-ascending | --sort-descending]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
This command is provided by the python-cloudkittyclient plugin.
module set priority¶
Set the priority of a rating module.
cloudkitty module set priority
[-h]
[--sort-ascending | --sort-descending]
module_id
priority
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
module_id
¶
Module name
-
priority
¶
Priority (int)
This command is provided by the python-cloudkittyclient plugin.
pyscript create¶
Create a PyScript.
cloudkitty pyscript create
[-h]
[--sort-ascending | --sort-descending]
name
data
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
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 [-h] script_id
-
-h
,
--help
¶
show this help message and exit
-
script_id
¶
Script ID
This command is provided by the python-cloudkittyclient plugin.
pyscript get¶
Get a PyScript.
cloudkitty pyscript get
[-h]
[--sort-ascending | --sort-descending]
script_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
script_id
¶
Script ID
This command is provided by the python-cloudkittyclient plugin.
pyscript list¶
List existing PyScripts.
cloudkitty pyscript list
[-h]
[--sort-ascending | --sort-descending]
[-n]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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
[-h]
[--sort-ascending | --sort-descending]
[-n NAME]
[-d DATA]
script_id
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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
[-h]
[--sort-ascending | --sort-descending]
[-b BEGIN]
[-e END]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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
[-h]
[--sort-ascending | --sort-descending]
[-t TENANT_ID]
[-b BEGIN]
[-e END]
[-s SERVICE]
[-g GROUPBY [GROUPBY ...]]
[-a]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
-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
[-h]
[--prefix PREFIX]
[-t TENANT_ID]
[-b BEGIN]
[-e END]
[-s SERVICE]
[-g GROUPBY [GROUPBY ...]]
[-a]
-
-h
,
--help
¶
show this help message and exit
-
--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.
V2 Client¶
dataframes add¶
Add one or several DataFrame objects to the storage backend.
cloudkitty dataframes add [-h] datafile
-
-h
,
--help
¶
show this help message and exit
-
datafile
¶
File formatted as a JSON object having a DataFrame listunder a ‘dataframes’ key.’-‘ (hyphen) can be specified for using stdin.
This command is provided by the python-cloudkittyclient plugin.
scope state get¶
Get information about current state of several scopes.
cloudkitty scope state get
[-h]
[--sort-ascending | --sort-descending]
[--scope-id SCOPE_ID]
[--scope-key SCOPE_KEY]
[--collector COLLECTOR]
[--fetcher FETCHER]
[--offset OFFSET]
[--limit LIMIT]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
--scope-id
<SCOPE_ID>
¶ Optional filter on Scope ID
-
--scope-key
<SCOPE_KEY>
¶ Optional filter on Scope Key
-
--collector
<COLLECTOR>
¶ Optional filter on Collector
-
--fetcher
<FETCHER>
¶ Optional filter on Fetcher
-
--offset
<OFFSET>
¶ Index of the first scope
-
--limit
<LIMIT>
¶ Maximal number of scopes
This command is provided by the python-cloudkittyclient plugin.
summary get¶
Get a summary for a given period.
cloudkitty summary get
[-h]
[--sort-ascending | --sort-descending]
[--offset OFFSET]
[--limit LIMIT]
[-g GROUPBY]
[--filter FILTER]
[-b BEGIN]
[-e END]
-
-h
,
--help
¶
show this help message and exit
-
--sort-ascending
¶
sort the column(s) in ascending order
-
--sort-descending
¶
sort the column(s) in descending order
-
--offset
<OFFSET>
¶ Index of the first element
-
--limit
<LIMIT>
¶ Maximal number of elements
-
-g
<GROUPBY>
,
--groupby
<GROUPBY>
¶ Attribute to group the summary by. Can be specified several times
-
--filter
<FILTER>
¶ Optional filter, in ‘key:value’ format. Can be specified several times.
-
-b
<BEGIN>
,
--begin
<BEGIN>
¶ Start of the period to query, in iso8601 format. Example: 2019-05-01T00:00:00Z.
-
-e
<END>
,
--end
<END>
¶ End of the period to query, in iso8601 format. Example: 2019-06-01T00:00:00Z.
This command is provided by the python-cloudkittyclient plugin.