community.general.consul_acl_bootstrap (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Allows bootstrapping of ACLs in a Consul cluster, see U(https://developer.hashicorp.com/consul/api-docs/acl#bootstrap-acls) for details.

Usage examples

Scanned by Steampunk Spotter

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

- name: Bootstrap the ACL system
  community.general.consul_acl_bootstrap:
    bootstrap_secret: 22eaeed1-bdbd-4651-724e-42ae6c43e387

Inputs

    
host:
    default: localhost
    description:
    - Host of the consul agent, defaults to V(localhost).
    type: str

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

state:
    choices:
    - present
    - bootstrapped
    default: present
    description:
    - Whether the token should be present or absent.
    type: str

scheme:
    default: http
    description:
    - The protocol scheme on which the consul agent is running. Defaults to V(http) and
      can be set to V(https) for secure connections.
    type: str

ca_path:
    description:
    - The CA bundle to use for https connections
    type: str

validate_certs:
    default: true
    description:
    - Whether to verify the TLS certificate of the consul agent.
    type: bool

bootstrap_secret:
    description:
    - The secret to be used as secret ID for the initial token.
    - Needs to be an UUID.
    type: str

Outputs

result:
  description:
  - The bootstrap result as returned by the consul HTTP API.
  - B(Note:) If O(bootstrap_secret) has been specified the C(SecretID) and C(ID) will
    not contain the secret but C(VALUE_SPECIFIED_IN_NO_LOG_PARAMETER). If you pass
    O(bootstrap_secret), make sure your playbook/role does not depend on this return
    value!
  returned: changed
  sample:
    AccessorID: 834a5881-10a9-a45b-f63c-490e28743557
    CreateIndex: 25
    CreateTime: '2024-01-21T20:26:27.114612038+01:00'
    Description: Bootstrap Token (Global Management)
    Hash: X2AgaFhnQGRhSSF/h0m6qpX1wj/HJWbyXcxkEM/5GrY=
    ID: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
    Local: false
    ModifyIndex: 25
    Policies:
    - ID: 00000000-0000-0000-0000-000000000001
      Name: global-management
    SecretID: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
  type: dict