Checkmk already provides the needed APIs to automate and configure your monitoring. With this project we want to create and share modules and roles for Ansible to both simplify your first steps with automating Checkmk and keep your daily operations smooth and efficient.

This repository is provided as is and we cannot guarantee stability at this point. Additionally, there is no commercial support whatsoever! This is an open source endeavour, which we want to share and progress with the community.

This repository is a successor to ansible-checkmk in a way, that we take the idea of the initial repository and translate it into todays format. We will try to keep you posted as best as we can. Also, keep an eye on this Checkmk forum post for updates.

For documentation on the included modules, run the following command substituting the $MODULE_NAME:

ansible-doc tribe29.checkmk.$MODULE_NAME

For any form of support queries or requests refer to SUPPORT.md.

For information about the structure and organization of this repository have a look at STRUCTURE.md.

You can install the Checkmk collection locally, if you acquired a tarball from the releases page as follows:

ansible-galaxy collection install /path/to/tribe29-checkmk-X.Y.Z.tar.gz

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - source: /path/to/tribe29-checkmk-X.Y.Z.tar.gz
    type: file

You can install the Checkmk collection with the Ansible Galaxy CLI:

ansible-galaxy collection install tribe29.checkmk

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: tribe29.checkmk
    version: X.Y.Z

You can either call modules by their Fully Qualified Collection Namespace (FQCN), such as tribe29.checkmk.activation, or you can call modules by their short name if you list the tribe29.checkmk collection in the playbook's collections keyword:

---
- hosts: all

  collections:
    - tribe29.checkmk

  tasks:
    - name: "Run activation."
      activation:
        server_url: "http://localhost/"
        site: "my_site"
        automation_user: "automation"
        automation_secret: "$SECRET"
        force_foreign_changes: 'true'
        sites:
          - "my_site"

• Checkmk Website
• Checkmk Documentation
• Checkmk Community
• tribe29 - the checkmk company

See CONTRIBUTING.

See CHANGELOG.rst.

This is merely a collection of possible additions to the role. Please do not consider a concrete planning document!

• Modules
  • Monitoring
    • Acknowledgement
  • Setup
    • Agents
    • BI
    • Contact Groups
    • Host Groups
    • Host Tag Groups
    • Passwords
    • Service Groups
    • Time Periods
    • Users
• Lookup Plugins
  • Version

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

See LICENSE.