theforeman.foreman.organization 模块 – 管理组织

注意

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

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

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

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

theforeman.foreman 1.0.0 中的新增功能

概要

  • 管理组织

别名：foreman_organization

需求

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

  • requests

参数

参数

注释

description

字符串

组织的描述

ignore_types

别名：select_all_types

列表 / 元素=字符串

在 theforeman.foreman 3.8.0 中添加

将自动关联的资源类型列表

label

字符串

组织的标签

name

字符串 / 必需

组织的名称

parameters

列表 / 元素=字典

实体域特定的主机参数

name

字符串 / 必需

参数的名称

parameter_type

字符串

参数的类型

选择

  • "string" ← (默认)

  • "boolean"

  • "integer"

  • "real"

  • "array"

  • "hash"

  • "yaml"

  • "json"

value

任意 / 必需

参数的值

password

字符串 / 必需

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

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

server_url

字符串 / 必需

Foreman 服务器的 URL。

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

state

字符串

实体的状态

选择

  • "present" ← (默认)

  • "absent"

username

字符串 / 必需

访问 Foreman 服务器的用户名。

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

validate_certs

布尔值

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

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

选择

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 下运行，并在不修改实体的情况下返回更改状态预测

diff_mode

支持：完全支持

在差异模式下，将返回有关已更改内容（或在 check_mode 中可能需要更改的内容）的详细信息

示例

- name: "Create CI Organization"
  theforeman.foreman.organization:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My Cool New Organization"
    state: present

返回值

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

键

描述

entity

字典

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

返回：成功

organizations

列表 / 元素=字典

组织列表。

返回：成功

作者

  • Eric D Helms (@ehelms)

  • Matthias M Dellweg (@mdellweg) ATIX AG