community.missing_collection.consul_coordinate_info_module.rst

community.missing_collection.consul_coordinate_info

Get information from Consul (Coordinate).

Version added: 0.4.0

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

Synopsis

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

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_lan_datacenter boolean	Choices: no yes	This endpoint returns the LAN network coordinates for all nodes in a given datacenter. This will default to the datacenter of the agent being queried.
get_lan_node boolean	Choices: no yes	This endpoint returns the LAN network coordinates for the given node.
get_wan_datacenter boolean	Choices: no yes	This endpoint returns the WAN network coordinates for all Consul servers, organized by datacenter.
host string	Default: "localhost"	hostname/ip of consul.
node string		Specifies the name or ID of the node to query. required when get_lan_node.
port string	Default: "8500"	port number of consul.
scheme string	Choices: http ← https	http scheme for consul.
segment string		Enterprise Specifies the segment to list members for.
token string		auth token for consul.

Examples

- name: get wan datacenter coordinates
  community.missing_collection.consul_coordinate_info:
    get_wan_datacenter: true
    token: "7661077f-3b6b-f763-6330-eedd2c3a442b"

- name: get lan datacenter coordinates
  community.missing_collection.consul_coordinate_info:
    get_lan_datacenter: true
    dc: "dc1"
    token: "7661077f-3b6b-f763-6330-eedd2c3a442b"

- name: get lan node coordinates
  community.missing_collection.consul_coordinate_info:
    get_lan_node: true
    dc: "dc1"
    node: "consul-server1"
    token: "7661077f-3b6b-f763-6330-eedd2c3a442b"

Return Values

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

Key	Returned	Description
result list	when success.	result from the consul api.

Status

Authors

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