OS Manuals

/opt/chainguard/openstack-barbican-2026.1/bin/aodh

OpenStack Key Manager (Barbican) — 2026.1 Gazpacho

From openstack-barbican-2026.1 22.0.0_git20260928-r12 (enterprise-packages), captured 2026-11-08 by running aodh --help (exit 0). permalink

usage: aodh [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
            [--os-region-name <auth-region-name>] [--os-interface <interface>]
            [--aodh-api-version AODH_API_VERSION] [--insecure] [--os-cacert <ca-certificate>]
            [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--collect-timing]
            [--os-auth-type <name>] [--os-auth-url OS_AUTH_URL]
            [--os-system-scope OS_SYSTEM_SCOPE] [--os-domain-id OS_DOMAIN_ID]
            [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID]
            [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
            [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID]
            [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
            [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME] [--os-user-id OS_USER_ID]
            [--os-username OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID]
            [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD]
            [--aodh-endpoint <endpoint>]

Aodh command line client

options:
  --version             show program's version number and exit
  -v, --verbose         Increase verbosity of output. Can be repeated.
  -q, --quiet           Suppress output except warnings and errors.
  --log-file LOG_FILE   Specify a file to log output. Disabled by default.
  -h, --help            Show help message and exit.
  --debug               Show tracebacks on errors.
  --os-region-name <auth-region-name>
                        Authentication region name (Env: OS_REGION_NAME)
  --os-interface <interface>
                        Select an interface type. Valid interface types: [admin, public,
                        internal]. (Env: OS_INTERFACE)
  --aodh-api-version AODH_API_VERSION
                        Defaults to env[AODH_API_VERSION] or 2.
  --os-auth-type, --os-auth-plugin <name>
                        Authentication type to use
  --aodh-endpoint <endpoint>
                        Aodh endpoint (Env: AODH_ENDPOINT)

API Connection Options:
  Options controlling the HTTP API Connections

  --insecure            Explicitly allow client to perform "insecure" TLS (https) requests. The
                        server's certificate will not be verified against any certificate
                        authorities. This option should be used with caution.
  --os-cacert <ca-certificate>
                        Specify a CA bundle file to use in verifying a TLS (https) server
                        certificate. Defaults to env[OS_CACERT].
  --os-cert <certificate>
                        The location for the keystore (PEM formatted) containing the public key of
                        this client. Defaults to env[OS_CERT].
  --os-key <key>        The location for the keystore (PEM formatted) containing the private key
                        of this client. Defaults to env[OS_KEY].
  --timeout <seconds>   Set request timeout (in seconds).
  --collect-timing      Collect per-API call timing information.

Authentication Options:
  Options specific to the password plugin.

  --os-auth-url OS_AUTH_URL
                        Authentication URL
  --os-system-scope OS_SYSTEM_SCOPE
                        Scope for system operations
  --os-domain-id OS_DOMAIN_ID
                        Domain ID to scope to
  --os-domain-name OS_DOMAIN_NAME
                        Domain name to scope to
  --os-project-id, --os-tenant-id OS_PROJECT_ID
                        Project ID to scope to
  --os-project-name, --os-tenant-name OS_PROJECT_NAME
                        Project name to scope to
  --os-project-domain-id OS_PROJECT_DOMAIN_ID
                        Domain ID containing project
  --os-project-domain-name OS_PROJECT_DOMAIN_NAME
                        Domain name containing project
  --os-trust-id OS_TRUST_ID
                        ID of the trust to use as a trustee use
  --os-default-domain-id OS_DEFAULT_DOMAIN_ID
                        Optional domain ID to use with v3 and v2 parameters. It will be used for
                        both the user and project domain in v3 and ignored in v2 authentication.
  --os-default-domain-name OS_DEFAULT_DOMAIN_NAME
                        Optional domain name to use with v3 API and v2 parameters. It will be used
                        for both the user and project domain in v3 and ignored in v2
                        authentication.
  --os-user-id OS_USER_ID
                        User id
  --os-username, --os-user-name OS_USERNAME
                        Username
  --os-user-domain-id OS_USER_DOMAIN_ID
                        User's domain id
  --os-user-domain-name OS_USER_DOMAIN_NAME
                        User's domain name
  --os-password OS_PASSWORD
                        User's password

Commands:
  alarm create   Create an alarm
  alarm delete   Delete an alarm
  alarm list     List alarms
  alarm metrics  Get Metrics
  alarm show     Show an alarm
  alarm state get  Get state of an alarm
  alarm state set  Set state of an alarm
  alarm update   Update an alarm
  alarm-history search  Show history for all alarms based on query
  alarm-history show  Show history for an alarm
  capabilities list  List capabilities of alarming service
  complete       print bash completion command (cliff)
  help           print detailed help for another command (cliff)
Options (33)
OptionDescriptionSource
--versionshow program's version number and exithelp
-v, --verboseIncrease verbosity of output.help
-q, --quietSuppress output except warnings and errors.help
--log-file LOG_FILESpecify a file to log output.help
-h, --helpShow help message and exit.help
--debugShow tracebacks on errors.help
--os-region-name auth-region-nameAuthentication region name (Env: OS_REGION_NAME)help
--os-interface interfaceSelect an interface type.help
--aodh-api-version AODH_API_VERSIONDefaults to env[AODH_API_VERSION] or 2.help
--os-auth-type, --os-auth-plugin nameAuthentication type to usehelp
--aodh-endpoint endpointAodh endpoint (Env: AODH_ENDPOINT)help
--insecureExplicitly allow client to perform "insecure" TLS (https) requests.help
--os-cacert ca-certificateSpecify a CA bundle file to use in verifying a TLS (https) server certificate.help
--os-cert certificateThe location for the keystore (PEM formatted) containing the public key of this client.help
--os-key keyThe location for the keystore (PEM formatted) containing the private key of this client.help
--timeout secondsSet request timeout (in seconds).help
--collect-timingCollect per-API call timing information.help
--os-auth-url OS_AUTH_URLAuthentication URLhelp
--os-system-scope OS_SYSTEM_SCOPEScope for system operationshelp
--os-domain-id OS_DOMAIN_IDDomain ID to scope tohelp
--os-domain-name OS_DOMAIN_NAMEDomain name to scope tohelp
--os-project-id, --os-tenant-id OS_PROJECT_IDProject ID to scope tohelp
--os-project-name, --os-tenant-name OS_PROJECT_NAMEProject name to scope tohelp
--os-project-domain-id OS_PROJECT_DOMAIN_IDDomain ID containing projecthelp
--os-project-domain-name OS_PROJECT_DOMAIN_NAMEDomain name containing projecthelp
--os-trust-id OS_TRUST_IDID of the trust to use as a trustee usehelp
--os-default-domain-id OS_DEFAULT_DOMAIN_IDOptional domain ID to use with v3 and v2 parameters.help
--os-default-domain-name OS_DEFAULT_DOMAIN_NAMEOptional domain name to use with v3 API and v2 parameters.help
--os-user-id OS_USER_IDUser idhelp
--os-username, --os-user-name OS_USERNAMEUsernamehelp
--os-user-domain-id OS_USER_DOMAIN_IDUser's domain idhelp
--os-user-domain-name OS_USER_DOMAIN_NAMEUser's domain namehelp
--os-password OS_PASSWORDUser's passwordhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.