ansible.builtin.vault (v2.16.5) — filter

Install Ansible via pip

Install with pip install ansible-core==2.16.5

Description

Put your information into an encrypted Ansible Vault.

Inputs

    
salt:
    description:
    - Encryption salt, will be random if not provided.
    - While providing one makes the resulting encrypted string reproducible, it can lower
      the security of the vault.
    type: string

_input:
    description: Data to vault.
    required: true
    type: string

secret:
    description: Vault secret, the key that lets you open the vault.
    required: true
    type: string

vault_id:
    default: filter_default
    description: Secret identifier, used internally to try to best match a secret when
      multiple are provided.
    type: string

wrap_object:
    default: false
    description:
    - This toggle can force the return of an C(AnsibleVaultEncryptedUnicode) string object,
      when V(False), you get a simple string.
    - Mostly useful when combining with the C(to_yaml) filter to output the 'inline vault'
      format.
    type: bool

Outputs

_value:
  description: The vault string that contains the secret data (or C(AnsibleVaultEncryptedUnicode)
    string object).
  type: string