The monasca client is the command-line interface (CLI) for the Monitoring API and its extensions. This chapter documents monasca version 1.0.24. For help on a specific monasca command, enter: $ monasca help COMMAND

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] <subcommand> ... <subcommand> 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.

-j, --json output raw json response --version Shows the client version and exits. -d, --debug Defaults to env[MONASCA_DEBUG]. -v, --verbose Print more verbose output. -k, --insecure 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. --cert-file CERT_FILE Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key. --key-file KEY_FILE Path of client key to use in SSL connection. This option is not necessary if your key is prepended to your cert file. --os-cacert OS_CACERT Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]. Without either of these, the client looks for the default system CA certificates. --keystone_timeout KEYSTONE_TIMEOUT Number of seconds to wait for a response from keystone. --os-username OS_USERNAME Defaults to env[OS_USERNAME]. --os-password OS_PASSWORD Defaults to env[OS_PASSWORD]. --os-user-domain-id OS_USER_DOMAIN_ID Defaults to env[OS_USER_DOMAIN_ID]. --os-user-domain-name OS_USER_DOMAIN_NAME Defaults to env[OS_USER_DOMAIN_NAME]. --os-project-id OS_PROJECT_ID Defaults to env[OS_PROJECT_ID]. --os-project-name OS_PROJECT_NAME Defaults to env[OS_PROJECT_NAME]. --os-domain-id OS_DOMAIN_ID Defaults to env[OS_DOMAIN_ID]. --os-domain-name OS_DOMAIN_NAME Defaults to env[OS_DOMAIN_NAME]. --os-auth-url OS_AUTH_URL Defaults to env[OS_AUTH_URL]. --os-region-name OS_REGION_NAME Defaults to env[OS_REGION_NAME]. --os-auth-token OS_AUTH_TOKEN Defaults to env[OS_AUTH_TOKEN]. --os-no-client-auth Do not contact keystone for a token. Defaults to env[OS_NO_CLIENT_AUTH]. --monasca-api-url MONASCA_API_URL Defaults to env[MONASCA_API_URL]. --monasca-api-version MONASCA_API_VERSION Defaults to env[MONASCA_API_VERSION] or 2_0 --os-service-type OS_SERVICE_TYPE Defaults to env[OS_SERVICE_TYPE]. --os-endpoint-type OS_ENDPOINT_TYPE Defaults to env[OS_ENDPOINT_TYPE].

usage: monasca alarm-definition-create [--description <DESCRIPTION>] [--severity <SEVERITY>] [--match-by <DIMENSION_KEY1,DIMENSION_KEY2,...>] [--alarm-actions <NOTIFICATION-ID>] [--ok-actions <NOTIFICATION-ID>] [--undetermined-actions <NOTIFICATION-ID>] <ALARM_DEFINITION_NAME> <EXPRESSION> Create an alarm definition. <ALARM_DEFINITION_NAME> Name of the alarm definition to create. <EXPRESSION> The alarm expression to evaluate. Quoted. --description <DESCRIPTION> Description of the alarm. --severity <SEVERITY> Severity is one of [LOW, MEDIUM, HIGH, CRITICAL]. --match-by <DIMENSION_KEY1,DIMENSION_KEY2,...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --alarm-actions <NOTIFICATION-ID> The notification method to use when an alarm state is ALARM. This param may be specified multiple times. --ok-actions <NOTIFICATION-ID> The notification method to use when an alarm state is OK. This param may be specified multiple times. --undetermined-actions <NOTIFICATION-ID> The notification method to use when an alarm state is UNDETERMINED. This param may be specified multiple times.

usage: monasca alarm-definition-delete <ALARM_DEFINITION_ID> Delete the alarm definition. <ALARM_DEFINITION_ID> The ID of the alarm definition.

usage: monasca alarm-definition-list [--name <ALARM_DEFINITION_NAME>] [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] [--offset <OFFSET LOCATION>] [--limit <RETURN LIMIT>] List alarm definitions for this tenant. --name <ALARM_DEFINITION_NAME> Name of the alarm definition. --dimensions <KEY1=VALUE1,KEY2=VALUE2...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --offset <OFFSET LOCATION> The offset used to paginate the return data. --limit <RETURN LIMIT> The amount of data to be returned up to the API maximum limit.

usage: monasca alarm-definition-patch [--name <ALARM_DEFINITION_NAME>] [--description <DESCRIPTION>] [--expression <EXPRESSION>] [--alarm-actions <NOTIFICATION-ID>] [--ok-actions <NOTIFICATION-ID>] [--undetermined-actions <NOTIFICATION-ID>] [--actions-enabled <ACTIONS-ENABLED>] [--severity <SEVERITY>] <ALARM_DEFINITION_ID> Patch the alarm definition. <ALARM_DEFINITION_ID> The ID of the alarm definition. --name <ALARM_DEFINITION_NAME> Name of the alarm definition. --description <DESCRIPTION> Description of the alarm. --expression <EXPRESSION> The alarm expression to evaluate. Quoted. --alarm-actions <NOTIFICATION-ID> The notification method to use when an alarm state is ALARM. This param may be specified multiple times. --ok-actions <NOTIFICATION-ID> The notification method to use when an alarm state is OK. This param may be specified multiple times. --undetermined-actions <NOTIFICATION-ID> The notification method to use when an alarm state is UNDETERMINED. This param may be specified multiple times. --actions-enabled <ACTIONS-ENABLED> The actions-enabled boolean is one of [true,false] --severity <SEVERITY> Severity is one of [LOW, MEDIUM, HIGH, CRITICAL].

usage: monasca alarm-definition-show <ALARM_DEFINITION_ID> Describe the alarm definition. <ALARM_DEFINITION_ID> The ID of the alarm definition.

usage: monasca alarm-definition-update [--description <DESCRIPTION>] [--alarm-actions <NOTIFICATION-ID>] [--ok-actions <NOTIFICATION-ID>] [--undetermined-actions <NOTIFICATION-ID>] [--match-by <DIMENSION_KEY1,DIMENSION_KEY2,...>] [--severity <SEVERITY>] <ALARM_DEFINITION_ID> <ALARM_DEFINITION_NAME> <EXPRESSION> <ACTIONS-ENABLED> Update the alarm definition. <ALARM_DEFINITION_ID> The ID of the alarm definition. <ALARM_DEFINITION_NAME> Name of the alarm definition. <EXPRESSION> The alarm expression to evaluate. Quoted. <ACTIONS-ENABLED> The actions-enabled boolean is one of [true,false] --description <DESCRIPTION> Description of the alarm. --alarm-actions <NOTIFICATION-ID> The notification method to use when an alarm state is ALARM. This param may be specified multiple times. --ok-actions <NOTIFICATION-ID> The notification method to use when an alarm state is OK. This param may be specified multiple times. --undetermined-actions <NOTIFICATION-ID> The notification method to use when an alarm state is UNDETERMINED. This param may be specified multiple times. --match-by <DIMENSION_KEY1,DIMENSION_KEY2,...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --severity <SEVERITY> Severity is one of [LOW, MEDIUM, HIGH, CRITICAL].

usage: monasca alarm-delete <ALARM_ID> Delete the alarm. <ALARM_ID> The ID of the alarm.

usage: monasca alarm-history [--offset <OFFSET LOCATION>] [--limit <RETURN LIMIT>] <ALARM_ID> Alarm state transition history. <ALARM_ID> The ID of the alarm. --offset <OFFSET LOCATION> The offset used to paginate the return data. --limit <RETURN LIMIT> The amount of data to be returned up to the API maximum limit.

usage: monasca alarm-history-list [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] [--starttime <UTC_START_TIME>] [--endtime <UTC_END_TIME>] [--offset <OFFSET LOCATION>] [--limit <RETURN LIMIT>] List alarms state history. --dimensions <KEY1=VALUE1,KEY2=VALUE2...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --starttime <UTC_START_TIME> measurements >= UTC time. format: 2014-01-01T00:00:00Z. OR format: -120 (for previous 2 hours) --endtime <UTC_END_TIME> measurements <= UTC time. format: 2014-01-01T00:00:00Z. --offset <OFFSET LOCATION> The offset used to paginate the return data. --limit <RETURN LIMIT> The amount of data to be returned up to the API maximum limit.

usage: monasca alarm-list [--alarm-definition-id <ALARM_DEFINITION_ID>] [--metric-name <METRIC_NAME>] [--metric-dimensions <KEY1=VALUE1,KEY2=VALUE2...>] [--state <ALARM_STATE>] [--state-updated-start-time <UTC_STATE_UPDATED_START>] [--lifecycle-state <LIFECYCLE_STATE>] [--link <LINK>] [--offset <OFFSET LOCATION>] [--limit <RETURN LIMIT>] List alarms for this tenant. --alarm-definition-id <ALARM_DEFINITION_ID> The ID of the alarm definition. --metric-name <METRIC_NAME> Name of the metric. --metric-dimensions <KEY1=VALUE1,KEY2=VALUE2...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --state <ALARM_STATE> ALARM_STATE is one of [UNDETERMINED, OK, ALARM]. --state-updated-start-time <UTC_STATE_UPDATED_START> Return all alarms whose state was updated on or after the time specified --lifecycle-state <LIFECYCLE_STATE> The lifecycle state of the alarm --link <LINK> The link to external data associated with the alarm --offset <OFFSET LOCATION> The offset used to paginate the return data. --limit <RETURN LIMIT> The amount of data to be returned up to the API maximum limit.

usage: monasca alarm-patch [--state <ALARM_STATE>] [--lifecycle-state <LIFECYCLE_STATE>] [--link <LINK>] <ALARM_ID> Patch the alarm state. <ALARM_ID> The ID of the alarm. --state <ALARM_STATE> ALARM_STATE is one of [UNDETERMINED, OK, ALARM]. --lifecycle-state <LIFECYCLE_STATE> The lifecycle state of the alarm --link <LINK> A link to an external resource with information about the alarm

usage: monasca alarm-show <ALARM_ID> Describe the alarm. <ALARM_ID> The ID of the alarm.

usage: monasca alarm-update <ALARM_ID> <ALARM_STATE> <LIFECYCLE_STATE> <LINK> Update the alarm state. <ALARM_ID> The ID of the alarm. <ALARM_STATE> ALARM_STATE is one of [UNDETERMINED, OK, ALARM]. <LIFECYCLE_STATE> The lifecycle state of the alarm <LINK> A link to an external resource with information about the alarm

usage: monasca measurement-list [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] [--endtime <UTC_END_TIME>] [--offset <OFFSET LOCATION>] [--limit <RETURN LIMIT>] [--merge_metrics] <METRIC_NAME> <UTC_START_TIME> List measurements for the specified metric. <METRIC_NAME> Name of the metric to list measurements. <UTC_START_TIME> measurements >= UTC time. format: 2014-01-01T00:00:00Z. OR Format: -120 (previous 120 minutes --dimensions <KEY1=VALUE1,KEY2=VALUE2...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --endtime <UTC_END_TIME> measurements <= UTC time. format: 2014-01-01T00:00:00Z. --offset <OFFSET LOCATION> The offset used to paginate the return data. --limit <RETURN LIMIT> The amount of data to be returned up to the API maximum limit. --merge_metrics Merge multiple metrics into a single result.

usage: monasca metric-create [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] [--value-meta <KEY1=VALUE1,KEY2=VALUE2...>] [--time <UNIX_TIMESTAMP>] [--project-id <CROSS_PROJECT_ID>] <METRIC_NAME> <METRIC_VALUE> Create metric. <METRIC_NAME> Name of the metric to create. <METRIC_VALUE> Metric value. --dimensions <KEY1=VALUE1,KEY2=VALUE2...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --value-meta <KEY1=VALUE1,KEY2=VALUE2...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --time <UNIX_TIMESTAMP> Metric timestamp in milliseconds. Default: current timestamp. --project-id <CROSS_PROJECT_ID> The Project ID to create metric on behalf of. Requires monitoring-delegate role in keystone.

usage: monasca metric-create-raw <JSON_BODY> Create metric from raw json body. <JSON_BODY> The raw JSON body in single quotes. See api doc.

usage: monasca metric-list [--name <METRIC_NAME>] [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] [--offset <OFFSET LOCATION>] [--limit <RETURN LIMIT>] List metrics for this tenant. --name <METRIC_NAME> Name of the metric to list. --dimensions <KEY1=VALUE1,KEY2=VALUE2...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --offset <OFFSET LOCATION> The offset used to paginate the return data. --limit <RETURN LIMIT> The amount of data to be returned up to the API maximum limit.

usage: monasca metric-statistics [--dimensions <KEY1=VALUE1,KEY2=VALUE2...>] [--endtime <UTC_END_TIME>] [--period <PERIOD>] [--offset <OFFSET LOCATION>] [--limit <RETURN LIMIT>] [--merge_metrics] <METRIC_NAME> <STATISTICS> <UTC_START_TIME> List measurement statistics for the specified metric. <METRIC_NAME> Name of the metric to report measurement statistics. <STATISTICS> Statistics is one or more (separated by commas) of [AVG, MIN, MAX, COUNT, SUM]. <UTC_START_TIME> measurements >= UTC time. format: 2014-01-01T00:00:00Z. OR Format: -120 (previous 120 minutes --dimensions <KEY1=VALUE1,KEY2=VALUE2...> 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 [&,(,),{,},>,<] that confuse the CLI parser. --endtime <UTC_END_TIME> measurements <= UTC time. format: 2014-01-01T00:00:00Z. --period <PERIOD> number of seconds per interval (default is 300) --offset <OFFSET LOCATION> The offset used to paginate the return data. --limit <RETURN LIMIT> The amount of data to be returned up to the API maximum limit. --merge_metrics Merge multiple metrics into a single result.

usage: monasca notification-create <NOTIFICATION_NAME> <TYPE> <ADDRESS> Create notification. <NOTIFICATION_NAME> Name of the notification to create. <TYPE> The notification type. Type must be EMAIL, WEBHOOK, or PAGERDUTY. <ADDRESS> A valid EMAIL Address, URL, or SERVICE KEY

usage: monasca notification-delete <NOTIFICATION_ID> Delete notification. <NOTIFICATION_ID> The ID of the notification.

usage: monasca notification-list [--offset <OFFSET LOCATION>] [--limit <RETURN LIMIT>] List notifications for this tenant. --offset <OFFSET LOCATION> The offset used to paginate the return data. --limit <RETURN LIMIT> The amount of data to be returned up to the API maximum limit.

usage: monasca notification-show <NOTIFICATION_ID> Describe the notification. <NOTIFICATION_ID> The ID of the notification. If not specified returns all.

usage: monasca notification-update <NOTIFICATION_ID> <NOTIFICATION_NAME> <TYPE> <ADDRESS> Update notification. <NOTIFICATION_ID> The ID of the notification. <NOTIFICATION_NAME> Name of the notification. <TYPE> The notification type. Type must be either EMAIL, WEBHOOK, or PAGERDUTY. <ADDRESS> A valid EMAIL Address, URL, or SERVICE KEY