community.missing_collection.zookeeper_info_module.rst

community.missing_collection.zookeeper_info

Get Information about Zookeeper Instance.

Version added: 0.2.0

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

Synopsis

• Get Information about Zookeeper Instance using Admin Server Rest API.

Requirements

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

• requests

Parameters

Parameter	Choices/Defaults	Comments
command string		zookeeper admin server command to fetch metrics. {'example': 'stats'}
url string / required		url of zookeeper admin server. {'example': 'http://localhost:8080'}

Examples

- name: fetch list of zookeeper commands
  community.missing_collection.zookeeper_info:
    url: http://localhost:8080

- name: fetch stats of zookeeper
  community.missing_collection.zookeeper_info:
    url: http://localhost:8080
    command: stats

Return Values

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

Key	Returned	Description
commands string	when no args and success.	list of zookeeper admin server commands.
output dictionary	when command is defined and success.	output of given zookeeper admin server command.

Status

Authors

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