watcher 命令行界面 (CLI)

概要

watcher [选项] <命令> [命令选项]

watcher help

watcher help <命令>

描述

watcher 命令行界面 (CLI) 与 OpenStack infra-optim 服务 (Watcher) 交互。

为了使用 CLI,您必须提供您的 OpenStack 用户名、密码、项目(历史上称为租户)和认证端点。您可以使用配置选项 :option:--os-username、:option:--os-password、:option:--os-tenant-id (或 :option:--os-tenant-name) 和 :option:--os-auth-url,或者设置相应的环境变量

$ export OS_USERNAME=user
$ export OS_PASSWORD=password
$ export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b   # or OS_TENANT_NAME
$ export OS_TENANT_NAME=project                          # or OS_TENANT_ID
$ export OS_AUTH_URL=http://auth.example.com:5000/v3/

命令行工具将尝试使用提供的凭据对每个请求进行重新认证。您可以通过手动提供认证令牌来覆盖此行为,使用 :option:--watcher-url 和 :option:--os-auth-token,或者设置相应的环境变量

$ export WATCHER_URL=http://watcher.example.org:9322/
$ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155

由于 Keystone 可以返回 Service Catalog 中的多个区域,您可以使用 :option:--os-region-name 或设置以下环境变量来指定您想要使用的区域。(默认情况下,它使用返回列表中第一个区域。)

$ export OS_REGION_NAME=region

Watcher CLI 支持 bash 补全。命令行工具可以自动填充部分输入的命令。要使用此功能,请将以下文件(可在 https://opendev.org/openstack/python-watcherclient/src/branch/2025.2/tools/watcher.bash_completion 处获取)导入到您的终端,然后 bash 补全应该就可以工作

$ . watcher.bash_completion

为了避免每次都这样做,请将此添加到您的 .bashrc 或将 watcher.bash_completion 文件复制到您的 Linux 发行版的默认 bash 补全脚本目录。

选项

要获取可用(子)命令和选项的列表,请运行

$ watcher help

要获取命令的使用方法和选项,请运行

$ watcher help <command>

示例

获取 audit-create 命令的信息

$ watcher help audit create

获取可用的目标列表

$ watcher goal list

获取审计列表

$ watcher audit list