community.missing_collection.consul_status_module.rst

community.missing_collection.consul_status

Get information from Consul (Status).

Version added: 0.4.0

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

Synopsis

• Get information from Consul (Status).
• https://www.consul.io/api-docs/status

Requirements

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

• requests

Parameters

Parameter	Choices/Defaults	Comments
dc string	Default: ""	datacenter for consul.
get_leader boolean	Choices: no yes	get information about current leader.
get_peers boolean	Choices: no yes	get information about all the peers.
host string	Default: "localhost"	hostname/ip of consul.
port string	Default: "8500"	port number of consul.
scheme string	Choices: http ← https	http scheme for consul.
token string		auth token for consul.

Examples

- name: get current leader information
  consul_status:
    get_leader: true

- name: get current perrs information
  consul_status:
    get_peers: true

Return Values

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

Key	Returned	Description
result str/list	when success.	result from the consul api. Sample: 10.1.10.12:8300

Status

Authors

• Davinder Pal (@116davinder) <[email protected]>