theforeman.foreman.image module – Manage Images

Note

This module is part of the theforeman.foreman collection (version 5.2.0-dev).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: theforeman.foreman.image.

New in theforeman.foreman 1.0.0

Synopsis

  • Create, update, and delete Images

Aliases: foreman_image

Requirements

The below requirements are needed on the host that executes this module.

  • requests

Parameters

Parameter

Comments

architecture

string / required

architecture of the image

compute_resource

string / required

Compute resource the image is assigned to

image_password

string

Password that is used to login into the operating system

image_username

string / required

Username that is used to login into the operating system

name

string / required

Image name

operatingsystem

string / required

Operating systems are looked up by their title which is composed as “<name> <major>.<minor>”.

You can omit the version part as long as you only have one operating system by that name.

password

string / required

Password of the user accessing the Foreman server.

If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.

server_url

string / required

URL of the Foreman server.

If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.

state

string

State of the entity

Choices:

  • "present" ← (default)

  • "absent"

user_data

boolean

Image supports user_data

Choices:

  • false

  • true

username

string / required

Username accessing the Foreman server.

If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.

uuid

aliases: image_uuid

string / required

UUID or Marketplace URN of the operatingsystem image

validate_certs

boolean

Whether or not to verify the TLS certificates of the Foreman server.

If the value is not specified in the task, the value of environment variable FOREMAN_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying the entity

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- 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"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

entity

dictionary

Final state of the affected entities grouped by their type.

Returned: success

images

list / elements=dictionary

List of images.

Returned: success

Authors

  • Mark Hlawatschek (@hlawatschek) ATIX AG