tribe29.checkmk.activation (0.23.0) — module

Install collection

Install with ansible-galaxy collection install tribe29.checkmk:==0.23.0

Add to requirements.yml

  collections:
    - name: tribe29.checkmk
      version: 0.23.0

Description

Activate changes within Checkmk.

This module only needs to be run once and not for every host. Use C(run_once).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Activate changes on all sites."
  tribe29.checkmk.activation:
      server_url: "http://localhost/"
      site: "my_site"
      automation_user: "automation"
      automation_secret: "$SECRET"
  run_once: 'true'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Activate changes on a specific site."
  tribe29.checkmk.activation:
      server_url: "http://localhost/"
      site: "my_site"
      automation_user: "automation"
      automation_secret: "$SECRET"
      sites:
        - "my_site"
  run_once: 'true'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Activate changes including foreign changes."
  tribe29.checkmk.activation:
      server_url: "http://localhost/"
      site: "my_site"
      automation_user: "automation"
      automation_secret: "$SECRET"
      force_foreign_changes: 'true'
  run_once: 'true'

Inputs

    
site:
    description: The site you want to connect to.
    required: true
    type: str

sites:
    default: []
    description: The sites that should be activated. Omitting this option activates all
      sites.
    type: raw

server_url:
    description: The base url of your Checkmk server.
    required: true
    type: str

validate_certs:
    default: true
    description: Whether to validate the SSL certificate of the Checkmk server.
    type: bool

automation_user:
    description: The automation user you want to use. It has to be an 'Automation' user,
      not a normal one.
    required: true
    type: str

automation_secret:
    description: The secret to authenticate your automation user.
    required: true
    type: str

force_foreign_changes:
    default: false
    description: Wheather to active foreign changes.
    type: bool

Outputs

http_code:
  description: The HTTP code the Checkmk API returns.
  returned: always
  sample: '200'
  type: int
message:
  description: The output message that the module generates.
  returned: always
  sample: Changes activated.
  type: str