theforeman.foreman.activation_key 模块 – 管理激活密钥

注意

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

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

要安装它，请使用： ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此模块，请参阅需求以了解详情。

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

theforeman.foreman 1.0.0 中的新增功能

概要 

创建和管理激活密钥

别名：katello_activation_key

需求 

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

requests

参数 

参数	注释
auto_attach 布尔值	设置自动附加开启或关闭选项 `false` `true`
content_overrides 列表 / 元素=字典	包含标签和覆盖状态的内容覆盖列表标签指仓库 `content_label`，例如 rhel-7-server-rpms 覆盖状态（‘enabled’、‘disabled’ 或 ‘default’）设置新注册主机仓库的初始状态
label 字符串 / 必需	使用激活密钥注册主机时要覆盖的仓库 `content_label`
override 字符串 / 必需	使用激活密钥注册主机时要用于仓库的覆盖值选项 `"enabled"` `"disabled"` `"default"`
content_view 字符串	内容视图的名称
description 字符串	激活密钥的描述
host_collections 列表 / 元素=字符串	要添加到激活密钥的主机集合列表
lifecycle_environment 字符串	生命周期环境的名称
max_hosts 整数	已注册内容主机的最大数量。如果 unlimited_hosts=false，则为必需
name 字符串 / 必需	激活密钥的名称
new_name 字符串	当 state == copied 时新激活密钥的名称
organization 字符串 / 必需	实体所在的组织
password 字符串 / 必需	访问 Foreman 服务器的用户的密码。如果任务中未指定该值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
purpose_addons 列表 / 元素=字符串	设置系统用途附加组件
purpose_role 字符串	设置系统用途角色
purpose_usage 字符串	设置系统用途用法
release_version 字符串	设置内容发行版本
server_url 字符串 / 必需	Foreman 服务器的 URL。如果任务中未指定该值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
service_level 字符串	设置服务级别选项 `"Self-Support"` `"Standard"` `"Premium"`
state 字符串	激活密钥的状态如果 `copied`，则密钥将被复制到一个新的密钥，其名称为 new_name，所有其他字段保持不变 `present_with_defaults` 将确保实体存在，但不会更新现有实体选项 `"present"` ← (默认) `"present_with_defaults"` `"absent"` `"copied"`
subscriptions 列表 / 元素=字典	订阅列表，包括名称、池 ID 或上游池 ID。由于名称和上游池 ID 不保证唯一，因此首选池 ID。如果找到多个匹配项，模块将失败。此参数在 SCA 模式下不受支持。
name 字符串	要添加的订阅的名称。与 pool_id 和 upstream_pool_id 互斥。
pool_id 字符串	要添加的订阅的池 ID。与 name 和 upstream_pool_id 互斥。在订阅的 CSV 导出中也称为 `Candlepin Id`，它也是 `hammer subscription list` 输出的 `UUID`。
upstream_pool_id 字符串	要添加的订阅的上游池 ID。与 name 和 pool_id 互斥。在 Red Hat 门户中也称为 `Master Pools`。
unlimited_hosts 布尔值	激活密钥可以拥有无限数量的主机吗？选项 `false` `true`
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果任务中未指定该值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果任务中未指定该值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: "Create client activation key"
  theforeman.foreman.activation_key:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Clients"
    organization: "Default Organization"
    lifecycle_environment: "Library"
    content_view: 'client content view'
    host_collections:
      - rhel7-servers
      - rhel7-production
    content_overrides:
      - label: rhel-7-server-optional-rpms
        override: enabled
    auto_attach: false
    release_version: 7Server
    service_level: Standard

返回值 

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

键	描述
entity 字典	按其类型分组的受影响实体的最终状态。返回：成功
activation_keys 列表 / 元素=字典	激活密钥列表。返回：成功

作者

Andrew Kofink (@akofink)