1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
The :program:`aodh` shell utility
=========================================
.. program:: aodh
.. highlight:: bash
The :program:`aodh` shell utility interacts with Aodh API
from the command line. It supports the entirety of the Aodh API.
You'll need to provide :program:`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:
.. envvar:: OS_USERNAME
Your OpenStack username.
.. envvar:: OS_PASSWORD
Your password.
.. envvar:: OS_TENANT_NAME
Project to work on.
.. envvar:: 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-plugin`` 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 :program:`aodh help` to get a full list of all possible commands,
and run :program:`aodh help <command>` to get detailed help for that
command.
Examples
--------
Create a Ceilometer threshold alarm::
openstack alarm create --name alarm1 --description 'CPU High Average' \
--type threshold --meter-name cpu_util \
--threshold 5 --comparison-operator gt --statistic avg \
--period 60 --evaluation-periods 3 \
--query "metadata.user_metadata.stack=$heat_stack_id" \
--alarm-action 'log://'
Create a Gnocchi threshold alarm::
openstack alarm create -t gnocchi_resources_threshold --name alarm1 \
--metric cpu_util --threshold 5 --resource_id <RES_ID> \
--resource_type generic --aggregation_method mean --project-id <PROJ_ID>
List alarms::
openstack alarm list
List alarm with query parameters::
openstack alarm list --query "state=alarm and type=gnocchi_resources_threshold"
Show an alarm's history::
openstack alarm-history show <ALARM_ID>
Search alarm history data::
openstack alarm-history search --query 'timestamp>"2016-03-09T01:22:35"'
|
