community.missing_collection.prometheus_module.rst

community.missing_collection.prometheus

Management of the Prometheus.

Version added: 0.3.0

• Synopsis
• Requirements
• Parameters
• Examples
• Status

Synopsis

• Management of the Prometheus.
• https://prometheus.io/docs/prometheus/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: reload quit	management command to run.
host string	Default: "localhost"	hostname/ip of prometheus.
password string	Default: ""	password for prometheus user. dont define user & password if prometheus have authentication.
port string	Default: "9090"	port number of prometheus.
scheme string	Choices: http ← https	http scheme for prometheus.
user string	Default: ""	prometheus username. dont define user & password if prometheus have authentication.

Examples

- name: reload prometheus config
  community.missing_collection.prometheus_info:
    scheme: 'http'
    host: 'localhost'
    port: '9090'
    command: 'reload'

- name: quit/shutdown prometheus
  community.missing_collection.prometheus_info:
    scheme: 'http'
    host: 'localhost'
    port: '9090'
    command: 'quit'

Status

Authors

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