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.

• ansible.posix
• community.general

Although the Ansible project notes, that collections should have no or very little dependencies, we want to make sure the collection works for you out-of-the-box. Currently we only depend on very basic collections, which are most likely already installed in your environment. For version constraints, see galaxy.yml.

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

ansible-doc checkmk.general.$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 find playbooks, demonstrating several aspects of this collection in the folder playbooks/demo/.

Name	Description	Tests
checkmk.general.activation	Activate changes.
checkmk.general.bakery	Bake and sign agents.
checkmk.general.contact_group	Manage contact groups.
checkmk.general.discovery	Discover services on hosts.
checkmk.general.downtime	Manage downtimes.
checkmk.general.folder	Manage folders.
checkmk.general.host_group	Manage host groups.
checkmk.general.host	Manage hosts.
checkmk.general.rule	Manage rules.
checkmk.general.service_group	Manage service groups.
checkmk.general.tag_group	Manage tag groups.
checkmk.general.user	Manage users.

Name	Description	Tests
checkmk.general.agent	Installs Checkmk agents.
checkmk.general.server	Installs Checkmk servers.

We love to see the community build things on top of this collection.
Check out COMMUNITY.md for a listing of interesting projects that build upon this collection in some way.

Please refer to the official Ansible documentation on how to install this collection. The most basic way is this:

ansible-galaxy collection install checkmk.general

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

---
- hosts: all

  collections:
    - checkmk.general

  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

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
    • Distributed Monitoring
    • Notification Rules
    • Time Periods
• Lookup Plugins
  • Version
  • Rules

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

See LICENSE.