theforeman.foreman.foreman (4.0.0) — callback

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==4.0.0

Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 4.0.0

Description

This callback will report facts and task events to Foreman

Requirements

• whitelisting in configuration
• requests (python library)

Inputs

    
url:
    description:
    - URL of the Foreman server.
    env:
    - name: FOREMAN_URL
    - name: FOREMAN_SERVER_URL
    - name: FOREMAN_SERVER
    ini:
    - key: url
      section: callback_foreman
    required: true

dir_store:
    default: ''
    description:
    - 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.
    env:
    - name: FOREMAN_DIR_STORE
    ini:
    - key: dir_store
      section: callback_foreman

proxy_url:
    description:
    - URL of the Foreman Smart Proxy server.
    env:
    - name: FOREMAN_PROXY_URL
    ini:
    - key: proxy_url
      section: callback_foreman

client_key:
    aliases:
    - ssl_key
    default: /etc/foreman/client_key.pem
    description:
    - the corresponding private key
    env:
    - name: FOREMAN_SSL_KEY
    ini:
    - key: ssl_key
      section: callback_foreman
    - key: client_key
      section: callback_foreman

client_cert:
    aliases:
    - ssl_cert
    default: /etc/foreman/client_cert.pem
    description:
    - X509 certificate to authenticate to Foreman if https is used
    env:
    - name: FOREMAN_SSL_CERT
    ini:
    - key: ssl_cert
      section: callback_foreman
    - key: client_cert
      section: callback_foreman

report_type:
    default: foreman
    description:
    - 'endpoint type for reports: foreman or proxy'
    env:
    - name: FOREMAN_REPORT_TYPE
    ini:
    - key: report_type
      section: callback_foreman

verify_certs:
    default: 1
    description:
    - 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.
    env:
    - name: FOREMAN_SSL_VERIFY
    ini:
    - key: verify_certs
      section: callback_foreman

disable_callback:
    default: 0
    description:
    - 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.
    env:
    - name: FOREMAN_CALLBACK_DISABLE