theforeman.foreman.image – Manage Images

Note

This plugin is part of the theforeman.foreman collection (version 1.5.0).

To install it use: ansible-galaxy collection install theforeman.foreman.

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

New in version 1.0.0: of theforeman.foreman

Synopsis

  • Create, update, and delete Images

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults 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
    Choices:
  • present ←
  • absent
State of the entity
user_data
boolean
    Choices:
  • no
  • yes
Image supports user_data
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
string / required
UUID or Marketplace URN of the operatingsystem image

aliases: image_uuid
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.

Examples

- name: create Image for EC2
  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 Returned Description
entity
dictionary
success
Final state of the affected entities grouped by their type.
 
images
list / elements=dictionary
success
List of images.


Authors

  • Mark Hlawatschek (@hlawatschek) ATIX AG