文档

16. awx-manage 实用程序

awx-manage(以前称为 tower-manage)实用程序用于访问 Tower 的详细内部信息。 awx-manage 的命令只能以 awx 用户身份运行。

警告

不建议或不支持通过剧本运行 awx-manage 命令。

16.1. 清单导入

awx-manage 是一种机制,允许 Tower 管理员将清单直接导入 Tower,适用于无法使用自定义清单脚本的人员。

要正确使用 awx-manage,您必须首先在 Tower 中创建一个清单,作为导入的目的地。

有关 awx-manage 的帮助,请运行以下命令:awx-manage inventory_import [--help]

inventory_import 命令将 Tower 清单对象与基于文本的清单文件、动态清单脚本或一个或多个以上目录同步,如核心 Ansible 支持的那样。

运行此命令时,请指定 --inventory-id--inventory-name,以及 Ansible 清单源的路径 (--source)。

awx-manage inventory_import --source=/ansible/inventory/ --inventory-id=1

默认情况下,已存储在 Tower 中的清单数据与来自外部源的数据融合。要仅使用外部数据,请指定 --overwrite。要指定任何现有主机仅从 --source 获取变量数据,请指定 --overwrite_vars。默认行为会添加来自外部源的任何新变量,覆盖已存在的键,但会保留未从外部数据源获取的任何变量。

awx-manage inventory_import --source=/ansible/inventory/ --inventory-id=1 --overwrite

注意

对清单主机变量的编辑和添加会持续存在于清单同步之外,只要 --overwrite_vars 未被设置。

16.2. 清理旧数据

awx-manage 有多种用于从 Tower 清理旧数据的命令。Tower 管理员可以使用 Tower 管理作业界面进行访问,也可以使用命令行。

  • awx-manage cleanup_jobs [--help]

这将永久删除比指定天数更旧的作业详细信息和作业输出。

  • awx-manage cleanup_activitystream [--help]

这将永久删除比特定天数更旧的任何 活动流 数据。

16.3. 集群管理

请参阅 集群 部分,了解有关 awx-manage provision_instanceawx-manage deprovision_instance 命令的详细信息。

注意

除非 Ansible 支持人员指示,否则请勿运行其他 awx-manage 命令。

16.4. 令牌和会话管理

Ansible Tower 支持以下用于 OAuth2 令牌管理的命令

16.4.1. create_oauth2_token

使用此命令创建 OAuth2 令牌(在下面的 example_user 中指定实际用户名)

$ awx-manage create_oauth2_token --user=example_user

New OAuth2 token for example_user: j89ia8OO79te6IAZ97L7E8bMgXCON2

创建令牌时,请确保提供有效的用户。否则,您将收到一条错误消息,指出您尝试在未指定用户或提供不存在的用户名的情况下发出命令。

16.4.2. revoke_oauth2_tokens

使用此命令撤销 OAuth2 令牌(包括应用程序令牌和个人访问令牌 (PAT))。默认情况下,它会撤销所有应用程序令牌(但不撤销其关联的刷新令牌),以及撤销所有个人访问令牌。但是,您也可以指定要撤销所有令牌的用户。

要撤销所有现有的 OAuth2 令牌

$ awx-manage revoke_oauth2_tokens

要撤销所有 OAuth2 令牌及其刷新令牌

$ awx-manage revoke_oauth2_tokens --all

要撤销用户名为 example_user 的用户的 OAuth2 令牌(在下面的 example_user 中指定实际用户名)

$ awx-manage revoke_oauth2_tokens --user=example_user

要撤销用户名为 example_user 的用户的所有 OAuth2 令牌和刷新令牌(请在下面将 example_user 替换为实际用户名)。

$ awx-manage revoke_oauth2_tokens --user=example_user --all

16.4.3. cleartokens

使用此命令清除已撤销的令牌。有关更多详细信息,请参阅 Django 的 Oauth Toolkit 文档关于 cleartokens

16.4.4. expire_sessions

使用此命令终止所有会话或特定用户的会话。当用户在组织中更改角色、从 LDAP/AD 中的各种组中删除或管理员希望确保用户由于这些组的成员资格而不再能够执行作业时,请考虑使用此命令。

$ awx-manage expire_sessions

默认情况下,此命令会终止所有会话。与这些会话关联的用户将被注销。要仅使特定用户的会话过期,可以使用 --user 标志传递其用户名(请在下面将 example_user 替换为实际用户名)。

$ awx-manage expire_sessions --user=example_user

16.4.5. clearsessions

使用此命令删除所有已过期的会话。有关更多详细信息,请参阅 Django 的 clearsessions 文档

有关 Tower 用户界面中 OAuth2 令牌管理的更多信息,请参见 应用程序 部分的 *Ansible Tower 用户指南*。

16.5. 分析收集

使用此命令在预定义窗口之外按需收集分析(默认值为 4 小时)。

$ awx-manage gather_analytics --ship