community.general.monit module – Manage the state of a program monitored using Monit

Note

This module is part of the community.general collection (version 12.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.monit.

Synopsis

  • Manage the state of a program monitored using Monit.

Requirements

The below requirements are needed on the host that executes this module.

  • Monit. Support for versions 5.18 and older is deprecated and will be removed in community.general 14.0.0.

Parameters

Parameter

Comments

name

string / required

The name of the monit program/process to manage.

state

string / required

The state of service.

Choices:

  • "present"

  • "started"

  • "stopped"

  • "restarted"

  • "monitored"

  • "unmonitored"

  • "reloaded"

timeout

integer

If there are pending actions for the service monitored by monit, then it checks for up to this many seconds to verify the requested action has been performed. The module sleeps for five seconds between each check.

Default: 300

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Returns details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Manage the state of program httpd to be in started state
  community.general.monit:
    name: httpd
    state: started

Authors

  • Darryl Stoflet (@dstoflet)

  • Simon Kelly (@snopoke)