Checkmk Ansible Collection

Checkmk already provides the needed application programming interfaces (APIs) to automate and configure your monitoring. With this project we want to augment the experience and provide easy to use modules and roles for Ansible to both simplify your first steps with automating Checkmk and keep your daily operations smooth and efficient.

:dragon_face: Here be dragons!

This collection is provided as is, we can and will not guarantee that it works as intended, nor can we be accountable for any damage or misconfiguration done by it. Study the contents thoroughly before using it. There is no commercial support whatsoever.

This is an Open Source endeavour, on which we collaborate with the community. All fixes and support are provided by individuals in their spare time. Keep that in mind, when using the collection and interacting with this repository and the community.

:wrench: Installing this collection

Refer to INSTALL.md for detailed installation instructions.

:construction_worker: Using this collection

Refer to USAGE.md for detailed instructions on how to use this collection.

:electric_plug: Dependencies

• ansible.posix
• ansible.utils
• ansible.windows
• 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.

:bulb: Getting help

For documentation on the included modules, head over to the Galaxy, or 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.

:toolbox: Included content

You can find playbooks, demonstrating the content of this collection in the folder playbooks/demo/.

:inbox_tray: Inventory plugins

Name	Description	Tests
checkmk.general.checkmk	Dynamic Inventory Source for Checkmk.

:mag: Lookup plugins

Click on the lookup plugin name below, to get detailed documentation about it. For more in-depth documentation, see this README.

Name	Description	Tests
checkmk.general.activation	Look up the status of a single activation.
checkmk.general.activations	Look up all activations.
checkmk.general.bakery	Look up the status of the agent bakery.
checkmk.general.folder	Look up folder attributes.
checkmk.general.folders	Look up all folders.
checkmk.general.host	Look up host attributes.
checkmk.general.hosts	Look up all hosts.
checkmk.general.ldap_connection	Look up LDAP connection attributes.
checkmk.general.ldap_connections	Look up all LDAP connections.
checkmk.general.role	Look up role attributes.
checkmk.general.roles	Look up all roles.
checkmk.general.rule	Look up rule attributes.
checkmk.general.rules	Look up all rules.
checkmk.general.ruleset	Look up ruleset attributes.
checkmk.general.rulesets	Look up all rulesets.
checkmk.general.site	Look up site attributes.
checkmk.general.sites	Look up all sites.
checkmk.general.version	Look up version and edition information.

:battery: Modules

Click on the module name below, to get detailed documentation about it.

Name	Description	Tests
checkmk.general.activation	Activate changes.
checkmk.general.aux_tag	Manage auxiliary tags.
checkmk.general.bakery	Bake and sign agents.
checkmk.general.contact_group	Manage contact groups.
checkmk.general.dcd	Manage Dynamic Host Management (DCD).
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.ldap	Manage LDAP connections.
checkmk.general.notification	Manage notification rules.
checkmk.general.password	Manage passwords.
checkmk.general.role	Manage roles and permissions.
checkmk.general.rule	Manage rules.
checkmk.general.service_group	Manage service groups.
checkmk.general.site	Manage sites.
checkmk.general.tag_group	Manage tag groups.
checkmk.general.timeperiod	Manage time periods.
checkmk.general.user	Manage users.

:computer: Roles

Click on the role name below, to get documentation about the role.

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

:heavy_plus_sign: Additional content

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.

:green_heart: Getting involved

See CONTRIBUTING.

:mega: Release notes

See CHANGELOG.rst.

:books: Versioning

This collection uses Semantic Versioning for releases. From the official homepage:

Given a version number MAJOR.MINOR.PATCH, increment the:

  MAJOR version when you make incompatible API changes
  MINOR version when you add functionality in a backward compatible manner
  PATCH version when you make backward compatible bug fixes

:truck: Roadmap

This is merely a collection of possible additions to the collection. Do not consider it a concrete planning document!

• Modules
  • Monitoring
    • Acknowledgement
    • Business Intelligence
    • Event Console
  • Setup
    • Agents
    • Business Intelligence
    • Event Console
    • Notification Rules
• OMD Module

:information_source: More information about Ansible

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

:information_source: More information about Checkmk

• Checkmk Website
• Checkmk User Guide
• Checkmk Forum

:scroll: Licensing

See LICENSE.