hashivault_identity_group_alias – Hashicorp Vault group alias manage module

New in version 4.3.0.

Synopsis

• Module to manage identity group aliases in Hashicorp Vault.

Requirements

The below requirements are needed on the host that executes this module.

• hvac>=0.10.1

• ansible>=2.0.0

• requests

Parameters

Parameter	Choices/Defaults	Comments
alias_id -		ID of the group alias. If set, updates the corresponding group alias.
authtype -	Choices: token userpass github ldap approle Default: "token or environment variable `VAULT_AUTHTYPE`"	authentication type
aws_header -	Default: "to environment variable `VAULT_AWS_HEADER`"	X-Vault-AWS-IAM-Server-ID Header value to prevent replay attacks.
ca_cert -	Default: "to environment variable `VAULT_CACERT`"	Path to a PEM-encoded CA cert file to use to verify the Vault server TLS certificate
ca_path -	Default: "to environment variable `VAULT_CAPATH`"	Path to a directory of PEM-encoded CA cert files to verify the Vault server TLS certificate. If ca_cert is specified, its value will take precedence
canonical_id -		Group ID to which this alias belongs to.
client_cert -	Default: "to environment variable `VAULT_CLIENT_CERT`"	Path to a PEM-encoded client certificate for TLS authentication to the Vault server
client_key -	Default: "to environment variable `VAULT_CLIENT_KEY`"	Path to an unencrypted PEM-encoded private key matching the client certificate
group_name -		Group name to which this alias belongs to.
login_mount_point -	Default: "value of authtype or environment varialbe `VAULT_LOGIN_MOUNT_POINT`"	authentication mount point
mount_accessor -		Accessor of the mount to which the alias should belong to.
name -		Name of the alias. Name should be the identifier of the client in the authentication source.
namespace -	Default: "to environment variable VAULT_NAMESPACE"	namespace for vault
password -	Default: "to environment variable `VAULT_PASSWORD`"	password to login to vault.
state -		whether crete/update or delete the group alias
token -	Default: "to environment variable `VAULT_TOKEN`"	token for vault
url -	Default: "to environment variable `VAULT_ADDR`"	url for vault
username -	Default: "to environment variable `VAULT_USER`"	username to login to vault.
verify -	Default: "to environment variable `VAULT_SKIP_VERIFY`"	If set, do not verify presented TLS certificate before communicating with Vault server. Setting this variable is not recommended except during testing

Examples

---
- hosts: localhost
  tasks:
    - hashivault_identity_group_alias:
      name: 'bob'
      group_name: 'bob'

Status

• This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]

• This module is maintained by the Ansible Community. [community]

Authors

• UNKNOWN

Hint

If you notice any issues in this documentation, you can edit this document to improve it.