encryption/decryption utility for Ansible data files
ansible-vault [create|decrypt|edit|encrypt|encrypt_string|rekey|view] [options] [vaultfile.yml]
can encrypt any structured data file used by Ansible. This can include group_vars/ or host_vars/ inventory variables, variables loaded by include_vars or vars_files, or variable files passed on the ansible-playbook command line with -e @file.yml or -e @file.json. Role variables and defaults are also included!
Because Ansible tasks, handlers, and other objects are data, these can also be encrypted with vault. If you’d like to not expose what variables you are using, you can keep an individual task file entirely encrypted.
--ask-vault-pass
¶ask for vault password
--new-vault-id
<NEW_VAULT_ID>
¶the new vault identity to use for rekey
--new-vault-password-file
¶new vault password file for rekey
--output
¶output file name for encrypt or decrypt; use - for stdout
--vault-id
¶the vault identity to use
--vault-password-file
¶vault password file
--version
¶show program’s version number, config file location, configured module search path, module location, executable location and exit
-h
,
--help
¶show this help message and exit
-v
,
--verbose
¶verbose mode (-vvv for more, -vvvv to enable connection debugging)
encrypt the supplied string using the provided vault secret
--encrypt-vault-id
<ENCRYPT_VAULT_ID>
¶the vault id used to encrypt (required if more than vault-id is provided)
--output
¶output file name for encrypt or decrypt; use - for stdout
--stdin-name
<ENCRYPT_STRING_STDIN_NAME>
¶Specify the variable name for stdin
-n
,
--name
¶Specify the variable name
-p
,
--prompt
¶Prompt for the string to encrypt
open and decrypt an existing vaulted file in an editor, that will be encrypted again when closed
--encrypt-vault-id
<ENCRYPT_VAULT_ID>
¶the vault id used to encrypt (required if more than vault-id is provided)
encrypt the supplied file using the provided vault secret
--encrypt-vault-id
<ENCRYPT_VAULT_ID>
¶the vault id used to encrypt (required if more than vault-id is provided)
--output
¶output file name for encrypt or decrypt; use - for stdout
re-encrypt a vaulted file with a new secret, the previous secret is required
--encrypt-vault-id
<ENCRYPT_VAULT_ID>
¶the vault id used to encrypt (required if more than vault-id is provided)
The following environment variables may be specified.
ANSIBLE_CONFIG
– Override the default ansible config file
Many more are available for most options in ansible.cfg
/etc/ansible/ansible.cfg
– Config file, used if present
~/.ansible.cfg
– User config file, overrides the default config if present