theforeman.foreman.global_parameter module – Manage Global Parameters

Note

This module is part of the theforeman.foreman collection (version 5.7.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.global_parameter.

New in theforeman.foreman 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

ca_path

path

PEM formatted file that contains a CA certificate to be used for validation.

If the value is not specified in the task, the value of environment variable FOREMAN_CA_PATH will be used instead.

hidden_value

boolean

Whether the value should be hidden in the GUI

Choices:

  • false

  • true

name

string / required

Name of the Global Parameter

parameter_type

string

Type of value

Choices:

  • "string" ← (default)

  • "boolean"

  • "integer"

  • "real"

  • "array"

  • "hash"

  • "yaml"

  • "json"

password

string

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.

state

string

State of the entity

present_with_defaults will ensure the entity exists, but won’t update existing ones

Choices:

  • "present" ← (default)

  • "present_with_defaults"

  • "absent"

updated_name

string

New name of the Global Parameter. When this parameter is set, the module will not be idempotent.

use_gssapi

boolean

Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.

Requires the Python library requests-gssapi to be installed.

If the value is not specified in the task, the value of environment variable FOREMAN_USE_GSSAPI will be used instead.

Choices:

  • false ← (default)

  • true

username

string

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 of the Global Parameter

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

  • The parameter_type only has an effect on Foreman >= 1.22

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

Description

entity

dictionary

Final state of the affected entities grouped by their type.

Returned: success

global_parameters

list / elements=dictionary

List of global parameters.

Returned: success

Authors

  • Bernhard Hopfenmueller (@Fobhep) ATIX AG

  • Matthias Dellweg (@mdellweg) ATIX AG

  • Manisha Singhal (@manisha15) ATIX AG