community.elastic.elastic_index_info (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

Returns info about Elasticsearch indexes.

Requirements

• elasticsearch

Usage examples

Scanned by Steampunk Spotter

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

- name: Get info for myindex
  community.elastic.elastic_index_info:
    name: myindex

Inputs

    
name:
    description:
    - The index name to get information about.
    required: true
    type: str

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

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

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

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

wait_for_active_shards:
    default: '0'
    description:
    - A number controlling to how many active shards to wait for.
    - all to wait for all shards in the cluster to be active, or 0 to not wait.
    type: str