usage: vitrage [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--vitrage-api-version VITRAGE_API_VERSION] [--os-region-name <auth-region-name>]
[--os-interface <interface>] [--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]
[--endpoint ENDPOINT]
Vitrage command line interface
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.
--vitrage-api-version VITRAGE_API_VERSION
Defaults to env[VITRAGE_API_VERSION] or 1.
--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)
--os-auth-type, --os-auth-plugin <name>
Authentication type to use
--endpoint ENDPOINT Vitrage endpoint (Env: VITRAGE_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 count Show a count of all alarms
alarm history List the alarm history
alarm list List all alarms
alarm show Show an alarm
complete print bash completion command (cliff)
event post Post an event to Vitrage
healthcheck Check api health status
help print detailed help for another command (cliff)
rca show Show the Root Cause Analysis for a certain alarm
resource count Show a count of all resources
resource list List resources
resource show Show a resource
service list List all services
status Check api health status
template add Add a template
template delete Delete a template
template list List all templates
template show Show a template
template validate Validate a template file
template versions List all template versions
topology show Show the topology of the system
webhook add Add a new webhook to the database
webhook delete Delete a webhook
webhook list List all webhooks in the database
webhook show Show a webhook
Options (33)
| Option | Description | Source |
|---|---|---|
--version | show program's version number and exit | help |
-v, --verbose | Increase verbosity of output. | help |
-q, --quiet | Suppress output except warnings and errors. | help |
--log-file LOG_FILE | Specify a file to log output. | help |
-h, --help | Show help message and exit. | help |
--debug | Show tracebacks on errors. | help |
--vitrage-api-version VITRAGE_API_VERSION | Defaults to env[VITRAGE_API_VERSION] or 1. | help |
--os-region-name auth-region-name | Authentication region name (Env: OS_REGION_NAME) | help |
--os-interface interface | Select an interface type. | help |
--os-auth-type, --os-auth-plugin name | Authentication type to use | help |
--endpoint ENDPOINT | Vitrage endpoint (Env: VITRAGE_ENDPOINT) | help |
--insecure | Explicitly allow client to perform "insecure" TLS (https) requests. | help |
--os-cacert ca-certificate | Specify a CA bundle file to use in verifying a TLS (https) server certificate. | help |
--os-cert certificate | The location for the keystore (PEM formatted) containing the public key of this client. | help |
--os-key key | The location for the keystore (PEM formatted) containing the private key of this client. | help |
--timeout seconds | Set request timeout (in seconds). | help |
--collect-timing | Collect per-API call timing information. | help |
--os-auth-url OS_AUTH_URL | Authentication URL | help |
--os-system-scope OS_SYSTEM_SCOPE | Scope for system operations | help |
--os-domain-id OS_DOMAIN_ID | Domain ID to scope to | help |
--os-domain-name OS_DOMAIN_NAME | Domain name to scope to | help |
--os-project-id, --os-tenant-id OS_PROJECT_ID | Project ID to scope to | help |
--os-project-name, --os-tenant-name OS_PROJECT_NAME | Project name to scope to | help |
--os-project-domain-id OS_PROJECT_DOMAIN_ID | Domain ID containing project | help |
--os-project-domain-name OS_PROJECT_DOMAIN_NAME | Domain name containing project | help |
--os-trust-id OS_TRUST_ID | ID of the trust to use as a trustee use | help |
--os-default-domain-id OS_DEFAULT_DOMAIN_ID | Optional domain ID to use with v3 and v2 parameters. | help |
--os-default-domain-name OS_DEFAULT_DOMAIN_NAME | Optional domain name to use with v3 API and v2 parameters. | help |
--os-user-id OS_USER_ID | User id | help |
--os-username, --os-user-name OS_USERNAME | Username | help |
--os-user-domain-id OS_USER_DOMAIN_ID | User's domain id | help |
--os-user-domain-name OS_USER_DOMAIN_NAME | User's domain name | help |
--os-password OS_PASSWORD | User's password | help |