theforeman / theforeman.foreman / 4.0.0 / module / global_parameter Manage Global Parameters | "added in version" 1.0.0 of theforeman.foreman" Authors: Bernhard Hopfenmueller (@Fobhep) ATIX AG, Matthias Dellweg (@mdellweg) ATIX AG, Manisha Singhal (@manisha15) ATIX AGtheforeman.foreman.global_parameter (4.0.0) — module
Install with ansible-galaxy collection install theforeman.foreman:==4.0.0
collections: - name: theforeman.foreman version: 4.0.0
Manage Global Parameter Entities
- 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
name: description: - Name of the Global Parameter required: true type: str state: choices: - present - present_with_defaults - absent default: present description: - State of the entity - C(present_with_defaults) will ensure the entity exists, but won't update existing ones type: str value: description: - Value of the Global Parameter required: false type: raw password: description: - Password of the user accessing the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_PASSWORD) will be used instead. required: true type: str username: description: - Username accessing the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_USERNAME) will be used instead. required: true type: str server_url: description: - URL of the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_SERVER_URL) will be used instead. required: true type: str hidden_value: description: - Whether the value should be hidden in the GUI required: false type: bool updated_name: description: - New name of the Global Parameter. When this parameter is set, the module will not be idempotent. type: str parameter_type: choices: - string - boolean - integer - real - array - hash - yaml - json default: string description: - Type of value type: str validate_certs: default: true description: - 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 C(FOREMAN_VALIDATE_CERTS) will be used instead. type: bool
entity: contains: global_parameters: description: List of global parameters. elements: dict type: list description: Final state of the affected entities grouped by their type. returned: success type: dict