theforeman.foreman.operatingsystem 模块 – 操作系统管理

注意

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

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

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

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

theforeman.foreman 1.0.0 中的新增功能

概要 

操作系统管理

别名：foreman_operatingsystem

需求 

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

requests

参数 

参数	注释
architectures 列表 / 元素=字符串	操作系统可安装在其上的架构
description 字符串	操作系统的描述
major 字符串	操作系统的 major 版本
media 列表 / 元素=字符串	安装介质列表
minor 字符串	操作系统的 minor 版本
name 字符串 / 必填	操作系统的名称
os_family 别名：family 字符串	操作系统的发行版系列选项 `"AIX"` `"Altlinux"` `"Archlinux"` `"Coreos"` `"Debian"` `"Fcos"` `"Freebsd"` `"Gentoo"` `"Junos"` `"NXOS"` `"Rancheros"` `"Redhat"` `"Rhcos"` `"Solaris"` `"Suse"` `"VRP"` `"Windows"` `"Xenserver"`
parameters 列表 / 元素=字典	特定于操作系统的宿主参数
name 字符串 / 必填	参数名称
parameter_type 字符串	参数类型选项 `"string"` ← (默认) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value 任意 / 必填	参数的值
password 字符串 / 必填	访问 Foreman 服务器的用户的密码。如果任务中未指定值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
password_hash 字符串	passwd 的哈希算法选项 `"MD5"` `"SHA256"` `"SHA512"` `"Base64"` `"Base64-Windows"`
provisioning_templates 列表 / 元素=字符串	与操作系统关联的配置模板列表。指定要与您的操作系统关联的完整模板名称列表。例如 [“Kickstart default”, “Kickstart default finish”, “Kickstart default iPXE”, “custom”]。指定模板关联后，您可以在 theforeman.foreman.os_default_template 模块中设置默认关联。
ptables 列表 / 元素=字符串	分区表列表
release_name 字符串	操作系统的发行版名称（推荐用于 Debian）
server_url 字符串 / 必填	Foreman 服务器的 URL。如果任务中未指定值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
state 字符串	实体的状态 `present_with_defaults` 将确保实体存在，但不会更新现有实体选项 `"present"` ← (默认) `"present_with_defaults"` `"absent"`
updated_name 字符串	新的操作系统名称。设置此参数后，模块将不是幂等的。
username 字符串 / 必填	访问 Foreman 服务器的用户名。如果任务中未指定值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果任务中未指定值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: "Create an Operating System"
  theforeman.foreman.operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Debian
    release_name: stretch
    family: Debian
    major: 9
    parameters:
      - name: additional-packages
        value: python vim
    state: present

- name: "Ensure existence of an Operating System (provide default values)"
  theforeman.foreman.operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Centos
    family: Redhat
    major: 7
    password_hash: SHA256
    state: present_with_defaults

- name: "Delete an Operating System"
  theforeman.foreman.operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Debian
    family: Debian
    major: 9
    state: absent

返回值 

常见的返回值已在此处文档中说明，以下是此模块独有的字段。

键	描述
实体字典	按其类型分组的受影响实体的最终状态。返回：成功
操作系统列表 / 元素=字典	操作系统列表。返回：成功

作者

Matthias M Dellweg (@mdellweg) ATIX AG
Bernhard Hopfenmüller (@Fobhep) ATIX AG