基本用法¶

安装¶

在 Red Hat Enterprise Linux 7 上，可以通过 yum 安装 AWX CLI

yum-config-manager --add-repo https://releases.ansible.com/ansible-tower/cli/ansible-tower-cli-el7.repo
yum install ansible-tower-cli

在 CentOS 7 上，可以通过 yum 安装 AWX CLI

yum-config-manager --add-repo https://releases.ansible.com/ansible-tower/cli/ansible-tower-cli-centos7.repo
yum install ansible-tower-cli

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

dnf config-manager --add-repo https://releases.ansible.com/ansible-tower/cli/ansible-tower-cli-el8.repo
dnf install ansible-tower-cli

在 CentOS 8 上，可以通过 dnf 安装 AWX CLI

dnf config-manager --add-repo https://releases.ansible.com/ansible-tower/cli/ansible-tower-cli-centos8.repo
dnf install ansible-tower-cli

在所有其他平台上，可以通过 pip 安装（需要 python3 或 python）

pip3 install --user https://releases.ansible.com/ansible-tower/cli/ansible-tower-cli-latest.tar.gz

概述¶

awx 命令遵循简单的格式

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

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

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

入门¶

使用 awx 需要一些初始配置。以下是如何与 AWX 或 Red Hat Ansible Tower 服务器进行交互的简单示例

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

有多种方法可以配置和认证 AWX 或 Red Hat Ansible Tower 服务器。有关更多详细信息，请参阅 身份验证。

默认情况下，awx 会为成功命令打印有效的 JSON。某些命令（例如用于打印作业 stdout 的命令）会打印原始文本，并且不允许自定义格式。有关自定义 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

全局选项¶

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

其中一些最重要的选项是

-h, --help

打印 awx 工具的使用信息

-v, --verbose

打印调试级别的日志，包括发出的 HTTP(s) 请求

-f, --conf.format

用于指定自定义输出格式（默认值为 json）

--conf.host, TOWER_HOST

AWX/Red Hat Ansible Tower 主机的完整 URL（例如，https://my.awx.example.org）

-k, --conf.insecure, TOWER_VERIFY_SSL

允许在使用 SSL 时进行不安全的服务器连接

--conf.username, TOWER_USERNAME

用于身份验证的 AWX 用户名

--conf.password, TOWER_PASSWORD

用于身份验证的 AWX 密码

--conf.token, TOWER_OAUTH_TOKEN

用于身份验证的 OAuth2.0 令牌