theforeman.foreman.setting module – Manage Settings

Note

This module is part of the theforeman.foreman collection (version 4.2.0).

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 theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: theforeman.foreman.setting.

New in theforeman.foreman 1.0.0

Synopsis

  • Manage Settings

Aliases: foreman_setting

Requirements

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

  • requests

Parameters

Parameter

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 FOREMAN_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 FOREMAN_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 FOREMAN_USERNAME will be used instead.

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 FOREMAN_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

value

any

value to set the Setting to

if missing, reset to default

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying the entity

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Notes

Note

  • To obtain a list of possible settings for your installation, use the theforeman.foreman.setting_info module or the hammer settings list command and look for the name attribute.

  • The web interface by default shows the full_name attribute, which can’t be used with this module.

Examples

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

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

Return Values

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

Key

Description

entity

dictionary

Final state of the affected entities grouped by their type.

Returned: success

settings

list / elements=dictionary

List of settings.

Returned: success

foreman_setting

dictionary

Created / Updated state of the setting (deprecated)

Returned: success

Authors

  • Matthias M Dellweg (@mdellweg) ATIX AG