redhat.satellite.foreman – Sends events to Foreman

Note

This plugin is part of the redhat.satellite collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. 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 redhat.satellite.

To use it in a playbook, specify: redhat.satellite.foreman.

Synopsis

• This callback will report facts and task events to Foreman

Requirements

The below requirements are needed on the local controller node that executes this callback.

• whitelisting in configuration

• requests (python library)

Parameters

Parameter	Choices/Defaults	Configuration	Comments
client_cert string	Default: "/etc/foreman/client_cert.pem"	ini entries: [callback_foreman] ssl_cert = /etc/foreman/client_cert.pem [callback_foreman] client_cert = /etc/foreman/client_cert.pem env:FOREMAN_SSL_CERT	X509 certificate to authenticate to Foreman if https is used aliases: ssl_cert
client_key string	Default: "/etc/foreman/client_key.pem"	ini entries: [callback_foreman] ssl_key = /etc/foreman/client_key.pem [callback_foreman] client_key = /etc/foreman/client_key.pem env:FOREMAN_SSL_KEY	the corresponding private key aliases: ssl_key
dir_store string	Default: ""	ini entries: [callback_foreman] dir_store = env:FOREMAN_DIR_STORE	When set, callback does not perform HTTP calls but stores results in a given directory. For each report, new file in the form of SEQ_NO-hostname.json is created. For each facts, new file in the form of SEQ_NO-hostname.json is created. The value must be a valid directory. This is meant for debugging and testing purposes. When set to blank (default) this functionality is turned off.
disable_callback string	Default: 0	env:FOREMAN_CALLBACK_DISABLE	Toggle to make the callback plugin disable itself even if it is loaded. It can be set to '1' to prevent the plugin from being used even if it gets loaded.
proxy_url string		ini entries: [callback_foreman] proxy_url = None env:FOREMAN_PROXY_URL	URL of the Foreman Smart Proxy server.
report_type string	Default: "foreman"	ini entries: [callback_foreman] report_type = foreman env:FOREMAN_REPORT_TYPE	endpoint type for reports: foreman or proxy
url string / required		ini entries: [callback_foreman] url = None env:FOREMAN_URL env:FOREMAN_SERVER_URL env:FOREMAN_SERVER	URL of the Foreman server.
verify_certs string	Default: 1	ini entries: [callback_foreman] verify_certs = 1 env:FOREMAN_SSL_VERIFY	Toggle to decide whether to verify the Foreman certificate. It can be set to '1' to verify SSL certificates using the installed CAs or to a path pointing to a CA bundle. Set to '0' to disable certificate checking.