theforeman.foreman.os_default_template module – Manage Default Template Associations To Operating Systems
Note
This module is part of the theforeman.foreman collection (version 3.4.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
.
To use it in a playbook, specify: theforeman.foreman.os_default_template
.
New in version 1.0.0: of theforeman.foreman
Synopsis
Manage OSDefaultTemplate Entities
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
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 |
|
name of provisioning template |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity
Choices:
|
|
name of the template kind Choices:
|
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
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 an Association"
theforeman.foreman.os_default_template:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
operatingsystem: "CoolOS"
template_kind: "finish"
provisioning_template: "CoolOS finish"
state: present
- name: "Delete an Association"
theforeman.foreman.os_default_template:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
operatingsystem: "CoolOS"
template_kind: "finish"
state: absent
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 operatingsystem default templates. Returned: success |