awx.awx.controller_meta 模块 – 返回有关此模块所在集合的元数据。

注意

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

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

要安装它,请使用:ansible-galaxy collection install awx.awx

要在 playbook 中使用它,请指定:awx.awx.controller_meta

概要

  • 允许用户查找此模块所在的集合。

  • 这需要通用的模块参数,但不对它们进行任何处理。

别名:tower_meta

参数

参数

注释

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,然后尝试配置文件

request_timeout

浮点数

指定 Ansible 在向控制器主机发出请求时应使用的超时。

默认为 10 秒,但这由共享的 module_utils 代码处理

validate_certs

别名:tower_verify_ssl

布尔值

是否允许与 AWX 建立不安全的连接。

如果为 no,则不会验证 SSL 证书。

这应该只在个人控制的、使用自签名证书的站点上使用。

如果未设置值,将尝试环境变量 CONTROLLER_VERIFY_SSL,然后尝试配置文件

选项

  • false

  • true

说明

注意

  • 如果未提供 config_file,我们将尝试使用 tower-cli 库的默认值来查找您的主机信息。

  • config_file 应采用以下格式:host=hostname username=username password=password

示例

- controller_meta:
  register: result

- name: Show details about the collection
  debug: var=result

- name: Load the UI setting without hard-coding the collection name
  debug:
    msg: "{{ lookup(result.prefix + '.controller_api', 'settings/ui') }}"

返回值

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

描述

名称

字符串

集合名称

返回: 成功

示例: "awx"

命名空间

字符串

集合命名空间

返回: 成功

示例: "awx"

前缀

字符串

命名空间中的集合命名空间和名称,格式为 namespace.name

返回: 成功

示例: "awx.awx"

版本

字符串

集合的版本

返回: 成功

示例: "0.0.1-devel"

作者

  • Alan Rominger (@alancoding)