expedient.elastic.elastic_user_module.rst

expedient.elastic.elastic_user

elastic user management

Version added: 2.9

Synopsis

• This module creates or deletes users with elastic
• Update state not yet implemented

Requirements

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

• python3

Parameters

Parameter	Choices/Defaults	Comments
elastic_password string		Password for the user Required when creating a new user
elastic_user string / required		The name of the user to create or delete
email string		email address to associate with the user
enabled boolean	Choices: no yes ←	whether to enable the newly created user
full_name string		full name of the user
host string / required		DNS name of the the Elasticsearch instance
metadata dictionary	Default: {}	metadata object to associate with the user can contain any arbitrary key:value pairs
password string / required		Password to use when connecting to Elasticsearch
port integer	Default: 12443	Port number of the Elasticsearch instance
roles list		list of roles to assign to the user Required when creating a new user
state string	Choices: present ← absent	The desired state for the user
username string / required		Username to use when connecting to Elasticsearch
verify_ssl_cert boolean	Choices: no yes ←	Set whether to verify the SSL cert of the Elasticsearch cluster when connecting Should always be True in prod

Status

Authors

• Mike Garuccio (@mgaruccio)