theforeman.foreman.global_parameter – Manage Global Parameters¶
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.global_parameter
.
New in version 1.0.0: of theforeman.foreman
Parameters¶
Examples¶
- name: "Create a Global Parameter"
theforeman.foreman.global_parameter:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "TheAnswer"
value: "42"
state: present_with_defaults
- name: "Update a Global Parameter"
theforeman.foreman.global_parameter:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "TheAnswer"
value: "43"
state: present
- name: "Delete a Global Parameter"
theforeman.foreman.global_parameter:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "TheAnswer"
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.
|
|
global_parameters
list
/ elements=dictionary
|
success |
List of global parameters.
|
Authors¶
Bernhard Hopfenmueller (@Fobhep) ATIX AG
Matthias Dellweg (@mdellweg) ATIX AG
Manisha Singhal (@manisha15) ATIX AG