redhat.satellite.setting – Manage Settings

Note

This plugin is part of the redhat.satellite collection (version 2.1.0).

To install it use: ansible-galaxy collection install redhat.satellite.

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

New in version 1.0.0: of redhat.satellite

Synopsis

  • Manage Settings

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults Comments
name
string / required
Name of the Setting
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.
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 to set the Setting to
if missing, reset to default

Examples

- name: "Set a Setting"
  redhat.satellite.setting:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "http_proxy"
    value: "http://localhost:8088"

- name: "Reset a Setting"
  redhat.satellite.setting:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "http_proxy"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
foreman_setting
dictionary
success
Created / Updated state of the setting


Authors

  • Matthias M Dellweg (@mdellweg) ATIX AG