Use utils.search_query_builder to provide easier query usage for alarm history search CLI. Change-Id: Ie49b28b43e230a3d18adbf7734db23ce2aae3927
2.5 KiB
The aodh
shell utility
aodh
The aodh
shell
utility interacts with Aodh API from the command line. It supports the
entirety of the Aodh API excluding deprecated combination alarms.
You'll need to provide aodh
with your OpenStack credentials. You can do
this with the --os-username
, --os-password
, --os-tenant-id
and --os-auth-url
options, but it's easier to just set
them as environment variables:
OS_USERNAME
Your OpenStack username.
OS_PASSWORD
Your password.
OS_TENANT_NAME
Project to work on.
OS_AUTH_URL
The OpenStack auth server URL (keystone).
For example, in Bash you would use:
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
The command line tool will attempt to reauthenticate using your
provided credentials for every request. You can override this behavior
by manually supplying an auth token using --aodh-endpoint
and --os-auth-token
. You can alternatively set these
environment variables:
export AODH_ENDPOINT=http://aodh.example.org:8041
export OS_AUTH_PLUGIN=token
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
Also, if the server doesn't support authentication, you can provide
--os-auth-plugon
aodh-noauth, --aodh-endpoint
, --user-id
and --project-id
. You can alternatively set these
environment variables:
export OS_AUTH_PLUGIN=aodh-noauth
export AODH_ENDPOINT=http://aodh.example.org:8041
export AODH_USER_ID=99aae-4dc2-4fbc-b5b8-9688c470d9cc
export AODH_PROJECT_ID=c8d27445-48af-457c-8e0d-1de7103eae1f
From there, all shell commands take the form:
aodh <command> [arguments...]
Run aodh help
to
get a full list of all possible commands, and run aodh help <command>
to get detailed help for that command.
Examples
Create an alarm:
aodh alarm create -t threshold --name alarm1 -m cpu_util --threshold 5
List alarms:
aodh alarm list
List alarm with query parameters:
aodh alarm list --query "state=alarm and type=threshold"
Show an alarm's history:
aodh alarm-history show <ALARM_ID>
Search alarm history data:
aodh --debug alarm-history search --query 'timestamp>"2016-03-09T01:22:35"'