mongodb_monitoring -- Manages the free monitoring feature.

Synopsis

Manages the free monitoring feature.

Optionally return the monitoring url.

Requirements

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

Parameters

state (optional, str, started)
Manage the free monitoring feature.
return_url (optional, bool, False)
When true return the monitoring url if available.
login_user (False, str, None)

The MongoDB user to login with.

Required when login_password is specified.

login_password (False, str, None)

The password used to authenticate with.

Required when login_user is specified.

login_database (False, str, admin)
The database where login credentials are stored.
login_host (False, str, localhost)
The host running MongoDB instance to login to.
login_port (False, int, 27017)
The MongoDB server port to login to.
strict_compatibility (optional, bool, True)
Enforce strict requirements for pymongo and MongoDB software versions
ssl (False, bool, False)
Whether to use an SSL connection when connecting to the database.
ssl_cert_reqs (False, str, CERT_REQUIRED)
Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided.
ssl_ca_certs (False, str, None)
The ssl_ca_certs option takes a path to a CA file.
ssl_crlfile (False, str, None)
The ssl_crlfile option takes a path to a CRL file.
ssl_certfile (False, str, None)
Present a client certificate using the ssl_certfile option.
ssl_keyfile (False, str, None)
Private key for the client certificate.
ssl_pem_passphrase (False, str, None)
Passphrase to decrypt encrypted private keys.
auth_mechanism (False, str, None)
Authentication type.
connection_options (False, list, None)

Additional connection options.

Supply as a list of dicts or strings containing key value pairs seperated with '='.

Notes

Note

Examples

- name: Enable monitoring
  community.mongodb.mongodb_monitoring:
    state: "started"

- name: Disable monitoring
  community.mongodb.mongodb_monitoring:
    state: "stopped"

- name: Enable monitoring and return the monitoring url
  community.mongodb_monitoring:
    state: "started"
    return_url: "yes"

Return Values

changed (success, bool, )
Whether the monitoring status changed.
msg (success, str, )
A short description of what happened.
failed (failed, bool, )
If something went wrong
url (When requested and available., str, )
The MongoDB instance Monitoring url.

Status

Authors

  • Rhys Campbell (@rhysmeister)