theforeman.foreman.architecture – Manage Architectures
theforeman.foreman.architecture – Manage Architectures
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.architecture
.
New in version 1.0.0: of theforeman.foreman
Synopsis
- Create, update, and delete Architectures
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
name string / required |
Name of architecture | |
operatingsystems list / elements=string |
List of operating systems the entity should be assigned to. 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 | |
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 |
updated_name string |
New architecture name. When this parameter is set, the module will not be idempotent. | |
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 Architecture"
theforeman.foreman.architecture:
name: "i386"
operatingsystems:
- "TestOS1"
- "TestOS2"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
- name: "Update an Architecture"
theforeman.foreman.architecture:
name: "i386"
operatingsystems:
- "TestOS3"
- "TestOS4"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
- name: "Delete an Architecture"
theforeman.foreman.architecture:
name: "i386"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
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.
| ||
architectures list / elements=dictionary |
success |
List of architectures.
| ||
id integer |
success |
Database id of the architecture.
| ||
name string |
success |
Name of the architecture.
| ||
operatinsystem_ids list / elements=integer |
success |
Database ids of associated operatingsystems.
|
Authors
- Manisha Singhal (@Manisha15) ATIX AG
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/theforeman/foreman/architecture_module.html