theforeman.foreman.global_parameter 模块 – 管理全局参数

注意

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

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

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 Playbook 中使用它，请指定：theforeman.foreman.global_parameter。

theforeman.foreman 1.0.0 中的新增功能

概要

  • 管理全局参数实体

别名：foreman_global_parameter

要求

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

  • requests

参数

参数

注释

hidden_value

boolean

该值是否应在 GUI 中隐藏

选择

  • false

  • true

name

string / 必需

全局参数的名称

parameter_type

string

值的类型

选择

  • "string" ← (默认)

  • "boolean"

  • "integer"

  • "real"

  • "array"

  • "hash"

  • "yaml"

  • "json"

password

string / 必需

访问 Foreman 服务器的用户的密码。

如果在任务中未指定该值，则将使用环境变量 FOREMAN_PASSWORD 的值。

server_url

string / 必需

Foreman 服务器的 URL。

如果在任务中未指定该值，则将使用环境变量 FOREMAN_SERVER_URL 的值。

state

string

实体的状态

present_with_defaults 将确保实体存在，但不会更新现有的实体

选择

  • "present" ← (默认)

  • "present_with_defaults"

  • "absent"

updated_name

string

全局参数的新名称。当设置此参数时，模块将不是幂等的。

username

string / 必需

访问 Foreman 服务器的用户名。

如果在任务中未指定该值，则将使用环境变量 FOREMAN_USERNAME 的值。

validate_certs

boolean

是否验证 Foreman 服务器的 TLS 证书。

如果在任务中未指定该值，则将使用环境变量 FOREMAN_VALIDATE_CERTS 的值。

选择

  • false

  • true ← (默认)

value

any

全局参数的值

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 中运行并返回更改状态预测，而无需修改实体

diff_mode

支持: 完全

当处于 diff 模式时，将返回有关已更改的内容（或可能需要在 check_mode 中更改的内容）的详细信息

注意

注意

  • parameter_type 仅对 Foreman >= 1.22 有效

示例

- name: "Create a Global Parameter"
  theforeman.foreman.global_parameter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "TheAnswer"
    value: "42"
    state: present_with_defaults

- name: "Update a Global Parameter"
  theforeman.foreman.global_parameter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "TheAnswer"
    value: "43"
    state: present

- name: "Delete a Global Parameter"
  theforeman.foreman.global_parameter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "TheAnswer"
    state: absent

返回值

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

键

描述

entity

dictionary

受影响的实体的最终状态，按其类型分组。

返回: 成功

global_parameters

list / elements=dictionary

全局参数列表。

返回: 成功

作者

  • Bernhard Hopfenmueller (@Fobhep) ATIX AG

  • Matthias Dellweg (@mdellweg) ATIX AG

  • Manisha Singhal (@manisha15) ATIX AG