基本使用¶

安装¶

在 Red Hat Enterprise Linux 8 上，Controller CLI 可以通过 dnf 安装

dnf install --enablerepo=ansible-automation-platform-2.4-for-rhel-8-x86_64-rpms automation-controller-cli

在 Red Hat Enterprise Linux 9 上，Controller CLI 可以通过 dnf 安装

dnf install --enablerepo=ansible-automation-platform-2.4-for-rhel-9-x86_64-rpms automation-controller-cli

注意

对于 AWX 部署，CLI 可以通过 pip 安装。您应该首先尝试使用与您的安装匹配的特定 awxkit 版本，方法是指定版本。例如

pip install --upgrade awxkit==21.7.0

要下载安装程序或了解有关 CLI 的 awx 版本的更多信息，请参见 https://pypi.ac.cn/project/awxkit/.

awx 命令遵循简单的格式

awx [<global-options>] <resource> <action> [<arguments>]
awx --help

The resource 是 AWX 中的一种对象类型（名词），例如 users 或 organizations.

The action 是您想要执行的操作（动词）。资源通常具有一组基本操作 (get, list, create, modify 和 delete)，并且具有与 AWX 中对象上的字段相对应的选项。某些资源具有特殊操作，例如 job_templates launch.

使用 awx 需要一些初始配置。以下是如何与 AWX 或 Red Hat Ansible 自动化平台控制器服务器交互的简单示例

awx --conf.host https://awx.example.org \
    --conf.username joe --conf.password secret \
    --conf.insecure \
    users list

有多种方法可以配置和验证与 AWX 或 Red Hat Ansible 自动化平台控制器服务器的身份验证。有关更多详细信息，请参见身份验证.

默认情况下，awx 为成功的命令打印有效的 JSON。某些命令（例如用于打印作业标准输出的命令）打印原始文本，并且不允许自定义格式。有关自定义 awx 输出格式的详细信息，请参见输出格式.

要获取可用资源的列表

awx --conf.host https://awx.example.org --help

要获取特定资源的描述，并列出其可用操作（及其参数）

awx --conf.host https://awx.example.org users --help
awx --conf.host https://awx.example.org users create --help

注意

资源和操作的列表可能会因上下文而异。例如，某些资源可能无法根据基于角色的访问控制（RBAC）使用（例如，如果您没有权限启动某些作业模板，则某些 job_templates 对象可能不会显示 launch 作为操作）。

awx 接受控制整体行为的全局选项。除了 CLI 标志外，大多数全局选项还具有相应的环境变量，可用于设置值。如果同时提供两者，则命令行选项优先。

以下是一些最重要的选项

-h, --help: 打印 awx 工具的使用信息
-v, --verbose: 打印调试级日志，包括发出的 HTTP(s) 请求
-f, --conf.format: 用于指定自定义输出格式（默认值为 json）
--conf.host, CONTROLLER_HOST: AWX/Red Hat Ansible 自动化平台控制器主机（即 https://my.awx.example.org）的完整 URL
-k, --conf.insecure, CONTROLLER_VERIFY_SSL: 在使用 SSL 时允许不安全的服务器连接
--conf.username, CONTROLLER_USERNAME: 用于身份验证的 AWX 用户名
--conf.password, CONTROLLER_PASSWORD: 用于身份验证的 AWX 密码
--conf.token, CONTROLLER_OAUTH_TOKEN: 用于身份验证的 OAuth2.0 令牌