community.elastic.elastic_cluster_settings (1.1.2) — module

Install collection

Install with ansible-galaxy collection install community.elastic:==1.1.2

Add to requirements.yml

  collections:
    - name: community.elastic
      version: 1.1.2

Description

Manage Elastic Search Cluster Settings

Requirements

• elasticsearch

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update a setting
  community.elastic.elastic_cluster:
    settings:
      - "indices.recovery.max_bytes_per_sec": "50mb"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Reset a bunch of settings to their default value
  community.elastic.elastic_cluster_settings:
    settings:
      action.auto_create_index: null
      action.destructive_requires_name: null
      cluster.auto_shrink_voting_configuration: null
      cluster.indices.close.enable: null

Inputs

    
cafile:
    description:
    - Path to ca file
    type: str

timeout:
    default: 30
    description:
    - Response timeout in seconds.
    type: int

settings:
    description:
    - The Elastic search settings to update.
    - Supply as a dict key/values.
    required: true
    type: dict

login_port:
    default: 9200
    description:
    - The Elastic server port to login to.
    required: false
    type: int

login_user:
    description:
    - The Elastic user to login with.
    - Required when I(login_password) is specified.
    required: false
    type: str

persistent:
    default: true
    description:
    - Whether to make a setting update persistent or transient.
    - If security is enabled you need the manage cluster privilege.
    type: bool

auth_method:
    choices:
    - ''
    - http_auth
    default: ''
    description:
    - Authentication Method.
    type: str

auth_scheme:
    choices:
    - http
    - https
    default: http
    description:
    - Authentication scheme.
    type: str

login_hosts:
    default: localhost
    description:
    - The Elastic hosts to connect to.
    elements: str
    required: false
    type: list

login_password:
    description:
    - The password used to authenticate with.
    - Required when I(login_user) is specified.
    required: false
    type: str

connection_options:
    default: []
    description:
    - Additional connection options for Elasticsearch
    elements: dict
    type: list