redhat.satellite.global_parameter module – Manage Global Parameters
Note
This module is part of the redhat.satellite collection (version 3.11.0).
To install it, use: ansible-galaxy collection install redhat.satellite
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: redhat.satellite.global_parameter
.
New in redhat.satellite 1.0.0
Synopsis
Manage Global Parameter Entities
Aliases: foreman_global_parameter
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
Whether the value should be hidden in the GUI Choices:
|
|
Name of the Global Parameter |
|
Type of value Choices:
|
|
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:
|
|
New name of the Global Parameter. When this parameter is set, the module will not be idempotent. |
|
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:
|
|
Value of the Global Parameter |
Attributes
Notes
Note
The parameter_type only has an effect on Foreman >= 1.22
Examples
- name: "Create a Global Parameter"
redhat.satellite.global_parameter:
username: "admin"
password: "changeme"
server_url: "https://satellite.example.com"
name: "TheAnswer"
value: "42"
state: present_with_defaults
- name: "Update a Global Parameter"
redhat.satellite.global_parameter:
username: "admin"
password: "changeme"
server_url: "https://satellite.example.com"
name: "TheAnswer"
value: "43"
state: present
- name: "Delete a Global Parameter"
redhat.satellite.global_parameter:
username: "admin"
password: "changeme"
server_url: "https://satellite.example.com"
name: "TheAnswer"
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 global parameters. Returned: success |