community.general.consul_acl_bootstrap module – Bootstrap ACLs in Consul
Note
This module is part of the community.general collection (version 9.5.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.consul_acl_bootstrap
.
New in community.general 8.3.0
Synopsis
Allows bootstrapping of ACLs in a Consul cluster, see https://developer.hashicorp.com/consul/api-docs/acl#bootstrap-acls for details.
Parameters
Parameter |
Comments |
---|---|
The secret to be used as secret ID for the initial token. Needs to be an UUID. |
|
The CA bundle to use for https connections |
|
Host of the consul agent, defaults to Default: |
|
The port on which the consul agent is running. Default: |
|
The protocol scheme on which the consul agent is running. Defaults to Default: |
|
Whether the token should be present or absent. Choices:
|
|
Whether to verify the TLS certificate of the consul agent. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Bootstrap the ACL system
community.general.consul_acl_bootstrap:
bootstrap_secret: 22eaeed1-bdbd-4651-724e-42ae6c43e387
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The bootstrap result as returned by the consul HTTP API. Note: If Returned: changed Sample: |