redhat.satellite.global_parameter – Manage Global Parameters

Note

This plugin is part of the redhat.satellite collection (version 3.0.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 redhat.satellite.

To use it in a playbook, specify: redhat.satellite.global_parameter.

New in version 1.0.0: of redhat.satellite

Synopsis

  • Manage Global Parameter Entities

Requirements

The below requirements are needed on the host that executes this module.

  • requests

Parameters

Parameter Choices/Defaults Comments
hidden_value
boolean
    Choices:
  • no
  • yes
Whether the value should be hidden in the GUI
name
string / required
Name of the Global Parameter
parameter_type
string
    Choices:
  • string ←
  • boolean
  • integer
  • real
  • array
  • hash
  • yaml
  • json
Type of value
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 SATELLITE_PASSWORD will be used instead.
server_url
string / required
URL of the Foreman server.
If the value is not specified in the task, the value of environment variable SATELLITE_SERVER_URL will be used instead.
state
string
    Choices:
  • present ←
  • present_with_defaults
  • absent
State of the entity
present_with_defaults will ensure the entity exists, but won't update existing ones
updated_name
string
New name of the Global Parameter. 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 SATELLITE_USERNAME will be used instead.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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 SATELLITE_VALIDATE_CERTS will be used instead.
value
raw
Value of the Global Parameter

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 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