theforeman.foreman.image 模块 – 管理镜像

注意

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

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

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

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

theforeman.foreman 1.0.0 中的新增功能

概要

  • 创建、更新和删除镜像

别名：foreman_image

要求

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

  • requests

参数

参数

注释

architecture

字符串 / 必需

镜像的架构

compute_resource

字符串 / 必需

镜像分配到的计算资源

image_password

字符串

用于登录操作系统的密码

image_username

字符串 / 必需

用于登录操作系统的用户名

name

字符串 / 必需

镜像名称

operatingsystem

字符串 / 必需

操作系统通过其标题查找，标题组成如下：“<name> <major>.<minor>”。

只要只有一个该名称的操作系统，您可以省略版本部分。

password

字符串 / 必需

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

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

server_url

字符串 / 必需

Foreman 服务器的 URL。

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

state

字符串

实体的状态

选择

  • "present" ←（默认）

  • "absent"

user_data

布尔值

镜像支持 user_data

选择

  • false

  • true

username

字符串 / 必需

访问 Foreman 服务器的用户名。

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

uuid

别名：image_uuid

字符串 / 必需

操作系统镜像的 UUID 或 Marketplace URN

validate_certs

布尔值

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

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

选择

  • false

  • true ←（默认）

属性

属性

支持

描述

check_mode

支持：完全

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

diff_mode

支持：完全

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

示例

- name: create Image for EC2
  theforeman.foreman.image:
     name: CentOS
     image_uuid: "ami-0ff760d16d9497662"
     image_username: "centos"
     operatingsystem: "CentOS 7"
     compute_resource: "AWS"
     architecture: "x86_64"

返回值

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

键

描述

实体

字典

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

已返回：成功

images

列表 / elements=dictionary

镜像列表。

已返回：成功

作者

  • Mark Hlawatschek (@hlawatschek) ATIX AG