foreman_global_parameter – Manage Foreman Global Parameters

Synopsis

  • Manage Foreman Global Parameter Entities

Requirements

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

  • apypie

Parameters

Parameter Choices/Defaults Comments
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
server_url
string / required
URL of the Foreman server
state
string
    Choices:
  • present ←
  • present_with_defaults
  • absent
State of the entity in Foreman
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
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether or not to verify the TLS certificates of the Foreman server

aliases: verify_ssl
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"
  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"
  foreman_global_parameter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "TheAnswer"
    value: "43"
    state: present

- name: "Delete a Global Parameter"
  foreman_global_parameter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "TheAnswer"
    state: absent

Status

Authors

  • Bernhard Hopfenmueller (@Fobhep) ATIX AG

  • Matthias Dellweg (@mdellweg) ATIX AG

  • Manisha Singhal (@manisha15) ATIX AG

Hint

If you notice any issues in this documentation, you can edit this document to improve it.