awx.awx.ad_hoc_command_wait 模块 – 等待自动化平台控制器临时命令完成。

注意

此模块是 awx.awx 集合 (版本 24.6.1) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install awx.awx。

要在剧本中使用它，请指定： awx.awx.ad_hoc_command_wait。

概要 

等待自动化平台控制器临时命令完成并报告成功或失败。有关概述，请参阅 https://ansible.org.cn/tower。

别名：tower_ad_hoc_command_wait

参数 

参数	注释
command_id 整数 / 必需	要监控的临时命令的 ID。
controller_config_file 别名：tower_config_file 路径	控制器配置文件的路径。如果提供，则不会考虑其他配置文件位置。
controller_host 别名：tower_host 字符串	指向您的自动化平台控制器实例的 URL。如果未设置值，将尝试使用环境变量 `CONTROLLER_HOST`，然后是配置文件如果任何方式都没有指定值，则将使用 `127.0.0.1` 的值
controller_oauthtoken 别名：tower_oauthtoken 任意在 awx.awx 3.7.0 中添加	要使用的 OAuth 令牌。此值可以采用两种格式之一。一个字符串，即令牌本身。（例如：bqV5txm97wqJqtkxlMkhQz0pKhRMMX）令牌模块返回的字典结构。如果未设置值，将尝试使用环境变量 `CONTROLLER_OAUTH_TOKEN`，然后是配置文件
controller_password 别名：tower_password 字符串	控制器实例的密码。如果未设置值，将尝试使用环境变量 `CONTROLLER_PASSWORD`，然后是配置文件
controller_username 别名：tower_username 字符串	控制器实例的用户名。如果未设置值，将尝试使用环境变量 `CONTROLLER_USERNAME`，然后是配置文件
interval 浮点数	向控制器请求更新的间隔（秒）。默认值： `2.0`
request_timeout 浮点数	指定 Ansible 应在对控制器主机请求中使用的超时时间。默认为 10 秒，但这由共享的 module_utils 代码处理
timeout 整数	等待临时命令完成的最大时间（秒）。
validate_certs 别名：tower_verify_ssl 布尔值	是否允许与 AWX 建立不安全连接。如果为 `no`，则不会验证 SSL 证书。这仅应在使用自签名证书的个人控制站点上使用。如果未设置值，将尝试使用环境变量 `CONTROLLER_VERIFY_SSL`，然后是配置文件选项 `false` `true`

备注 

注意

如果没有提供 *config_file*，我们将尝试使用 tower-cli 库默认值来查找您的主机信息。
*config_file* 应采用以下格式：host=主机名 username=用户名 password=密码

示例 

- name: Launch an ad hoc command
  ad_hoc_command:
    inventory: "Demo Inventory"
    credential: "Demo Credential"
    wait: false
  register: command

- name: Wait for ad joc command max 120s
  ad_hoc_command_wait:
    command_id: "{{ command.id }}"
    timeout: 120

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
elapsed 浮点数	命令运行的总时间（秒）返回：成功示例： `10.879`
finished 字符串	命令完成运行的时间戳返回：成功示例： `"2017-03-01T17:04:04.078782Z"`
id 整数	正在等待的临时命令 ID 返回：成功示例： `99`
started 字符串	命令开始运行的时间戳返回：成功示例： `"2017-03-01T17:03:53.200234Z"`
status 字符串	命令的当前状态返回：成功示例： `"successful"`

作者

John Westcott IV (@john-westcott-iv)