openstack/python-aodhclient
Code Issues Proposed changes

Expand help for alarm list CLI command arguments

Browse Source 
- mention that 'alarm list --query' uses different API
- give example of 'all_projects' filter usage.
  This is currently undocumented and is rather obscure,
  even though listing alarms for all projects is a standard
  admin/monitoring activity.

Change-Id: I3a21c80a913fee3df694af2b777455cede3bd08d
Signed-off-by: Pavlo Shchelokovskyy <shchelokovskyy@gmail.com>
This commit is contained in:
Pavlo Shchelokovskyy
2026-03-26 10:30:39 +00:00
parent fbf22d98f2
commit 38bd15b412
1 changed files with 15 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
aodhclient/v2/alarm_cli.py
View File

@@ -51,16 +51,21 @@ class CliAlarmList(lister.Lister):
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
exclusive_group = parser.add_mutually_exclusive_group()
exclusive_group.add_argument("--query",
help="Rich query supported by aodh, "
"e.g. project_id!=my-id "
"user_id=foo or user_id=bar")
exclusive_group.add_argument('--filter', dest='filter',
metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
type=self.split_filter_param,
action='append',
help='Filter parameters to apply on'
' returned alarms.')
exclusive_group.add_argument(
"--query",
help="List alarms using rich queries API, "
"e.g. project_id!=my-id user_id=foo or user_id=bar."
)
exclusive_group.add_argument(
'--filter',
dest='filter',
metavar='<KEY1=VALUE1;KEY2=VALUE2...>',
type=self.split_filter_param,
action='append',
help='Filter parameters to apply on returned alarms. '
'To list alarms in all projects, use all_projects=true '
'filter (admin only).'
)
parser.add_argument("--limit", type=int, metavar="<LIMIT>",
help="Number of resources to return "
"(Default is server default)")