community.missing_collection.alertmanager_info_module.rst

community.missing_collection.alertmanager_info

Get information from Alertmanager.

Version added: 0.3.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Get information from Alertmanager.
• https://alertmanager.io/docs/alertmanager/latest/management_api/

Requirements

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

• requests

Parameters

Parameter	Choices/Defaults	Comments
command string	Choices: healthy ← ready	management command to run.
host string	Default: "localhost"	hostname/ip of alertmanager.
port string	Default: "9090"	port number of alertmanager.
scheme string	Choices: http ← https	http scheme for alertmanager.

Examples

- name: get health of alertmanager
  community.missing_collection.alertmanager_info:
    scheme: 'http'
    host: 'localhost'
    port: '9093'
    command: 'healthy'

- name: get ready of alertmanager
  community.missing_collection.alertmanager_info:
    scheme: 'http'
    host: 'localhost'
    port: '9093'
    command: 'ready'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
result string	when success.	result of the api request. Sample: OK

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>