theforeman.foreman.subscription_info 模块 – 获取订阅信息

注意

此模块是 theforeman.foreman 集合（版本 4.2.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：theforeman.foreman.subscription_info。

theforeman.foreman 2.1.0 中新增

概要 

获取订阅信息

要求 

执行此模块的主机需要以下要求。

requests

参数 

参数	注释
location 字符串	用于限定搜索范围的位置的标签。
name 字符串	要获取信息的资源的名称。与 search 互斥。
organization 字符串 / 必填	用于限定搜索范围的组织的名称。
password 字符串 / 必填	访问 Foreman 服务器的用户的密码。如果任务中未指定该值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
search 字符串	要使用的搜索查询如果为 None 且未设置 name，则返回所有资源。与 name 互斥。
server_url 字符串 / 必填	Foreman 服务器的 URL。如果任务中未指定该值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
username 字符串 / 必填	访问 Foreman 服务器的用户名。如果任务中未指定该值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果任务中未指定该值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全	可以在 check_mode 下运行并返回更改状态预测，而无需修改实体
diff_mode	支持：完全	当处于 diff 模式时，将返回有关已更改内容（或在 check_mode 下可能需要更改的内容）的详细信息

示例 

- name: "Show a subscription"
  theforeman.foreman.subscription_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Red Hat Satellite Infrastructure Subscription"

- name: "Show all subscriptions with a certain name"
  theforeman.foreman.subscription_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: name="Red Hat Satellite Infrastructure Subscription"

返回值 

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

键	描述
subscription 字典	有关找到的订阅的详细信息已返回：成功且已传递 name
subscriptions 列表 / 元素=字典	所有找到的订阅及其详细信息的列表已返回：成功且已传递 search

作者

Evgeni Golov (@evgeni)