theforeman.foreman.os_default_template – Manage Default Template Associations To Operating Systems
theforeman.foreman.os_default_template – Manage Default Template Associations To Operating Systems
Note
This plugin is part of the theforeman.foreman collection (version 1.5.1).
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 | Choices/Defaults | Comments |
---|---|---|
operatingsystem string / required |
Operating systems are looked up by their title which is composed as " .". 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 | |
provisioning_template string |
name of provisioning template | |
server_url string / required |
URL of the Foreman server. If the value is not specified in the task, the value of environment variable | |
state string |
|
State of the entity
|
template_kind string / required |
|
name of the template kind |
username string / required |
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable | |
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 |
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 | Returned | Description | |
---|---|---|---|
entity dictionary |
success |
Final state of the affected entities grouped by their type.
| |
os_default_templates list / elements=dictionary |
success |
List of operatingsystem default templates.
|
Authors
- Matthias M Dellweg (@mdellweg) ATIX AG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/os_default_template_module.html