community.elastic.elastic_snapshot_repository (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 Elasticsearch Snapshot Repositories.

Create and delete repostories.

At present no update functionality.

Requirements

• elasticsearch

Usage examples

Scanned by Steampunk Spotter

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

- name: Add a snapshot repository
  community.elastic.elastic_snapshot_repository:
    name: "my_repository"
    location: "/mnt/my_backup_location"
    state: "present"

Scanned by Steampunk Spotter

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

- name: Delete a snapshot repository
  community.elastic.elastic_snapshot_repository:
    name: "my_repository"
    state: "absent"

Inputs

    
name:
    description:
    - The name of the repository.
    required: true
    type: str

type:
    default: fs
    description:
    - Repository type can include fs, source and url
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The desired state of the user.
    type: str

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

verify:
    default: true
    description:
    - If true, the request verifies the repository is functional on all master and data
      nodes in the cluster.
    - If false, this verification is skipped
    type: bool

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

location:
    description:
    - Location of the shared filesystem used to store and retrieve snapshots.
    - This location must be registered in the path.repo setting on all master and data
      nodes in the cluster.
    type: str

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