theforeman.foreman.image module – Manage Images
Note
This module is part of the theforeman.foreman collection (version 3.7.0).
You might already have this collection installed if you are using the ansible
package.
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
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
architecture of the image |
|
Compute resource the image is assigned to |
|
Password that is used to login into the operating system |
|
Username that is used to login into the operating system |
|
Image name |
|
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 of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity Choices:
|
|
Image supports user_data Choices:
|
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
UUID or Marketplace URN of the operatingsystem image |
|
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 Choices:
|
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 |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of images. Returned: success |