ansible.builtin.consul_session (v2.7.10) — module

Install Ansible via pip

Install with pip install ansible==2.7.10

Description

Allows the addition, modification and deletion of sessions in a consul cluster. These sessions can then be used in conjunction with key value pairs to implement distributed locks. In depth documentation for working with sessions can be found at http://www.consul.io/docs/internals/sessions.html

Requirements

• python >= 2.6
• python-consul
• requests

Usage examples

Scanned by Steampunk Spotter

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

- name: register basic session with consul
  consul_session:
    name: session1

Scanned by Steampunk Spotter

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

- name: register a session with an existing check
  consul_session:
    name: session_with_check
    checks:
      - existing_check_name

Scanned by Steampunk Spotter

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

- name: register a session with lock_delay
  consul_session:
    name: session_with_delay
    delay: 20s

Scanned by Steampunk Spotter

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

- name: retrieve info about session by id
  consul_session:
    id: session_id
    state: info

Scanned by Steampunk Spotter

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

- name: retrieve active sessions
  consul_session:
    state: list

Inputs

    
host:
    default: localhost
    description:
    - The host of the consul agent defaults to localhost.

name:
    description:
    - The name that should be associated with the session. This is opaque to Consul and
      not required.

node:
    description:
    - The name of the node that with which the session will be associated. by default
      this is the name of the agent.

port:
    default: 8500
    description:
    - The port on which the consul agent is running.

delay:
    default: 15
    description:
    - The optional lock delay that can be attached to the session when it is created.
      Locks for invalidated sessions ar blocked from being acquired until this delay has
      expired. Durations are in seconds.

state:
    choices:
    - absent
    - info
    - list
    - node
    - present
    default: present
    description:
    - Whether the session should be present i.e. created if it doesn't exist, or absent,
      removed if present. If created, the ID for the session is returned in the output.
      If absent, the name or ID is required to remove the session. Info for a single session,
      all the sessions for a node or all available sessions can be retrieved by specifying
      info, node or list for the state; for node or info, the node name or session id
      is required as parameter.

checks:
    description:
    - A list of checks that will be used to verify the session health. If all the checks
      fail, the session will be invalidated and any locks associated with the session
      will be release and can be acquired once the associated lock delay has expired.

scheme:
    default: http
    description:
    - The protocol scheme on which the consul agent is running.
    version_added: '2.1'
    version_added_collection: ansible.builtin

behavior:
    choices:
    - delete
    - release
    default: release
    description:
    - The optional behavior that can be attached to the session when it is created. This
      controls the behavior when a session is invalidated.
    version_added: '2.2'
    version_added_collection: ansible.builtin

datacenter:
    description:
    - The name of the datacenter in which the session exists or should be created.

validate_certs:
    default: true
    description:
    - Whether to verify the tls certificate of the consul agent.
    type: bool
    version_added: '2.1'
    version_added_collection: ansible.builtin