foreman_setting – Manage Foreman Settings

Synopsis

  • Manage Foreman Setting 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 Setting
password
string / required
Password of the user accessing the Foreman server
server_url
string / required
URL of the Foreman server
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 to set the Setting to
if missing, reset to default

Examples

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

- name: "Reset a Setting"
  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 Returned Description
foreman_setting
dictionary
success
Created / Updated state of the setting


Status

Authors

  • Matthias M Dellweg (@mdellweg) ATIX AG

Hint

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