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.
The password used with vault currently must be the same for all files you wish to use together at the same time.
--ask-vault-passask for vault password
--new-vault-id <NEW_VAULT_ID>¶the new vault identity to use for rekey
--new-vault-password-filenew vault password file for rekey
--vault-idthe vault identity to use
--vault-password-filevault password file
--versionshow program’s version number and exit
-h, --helpshow this help message and exit
-v, --verboseverbose mode (-vvv for more, -vvvv to enable connection debugging)
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)
--outputoutput 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)
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)
--outputoutput file name for encrypt or decrypt; use - for stdout
--stdin-name <ENCRYPT_STRING_STDIN_NAME>¶Specify the variable name for stdin
-n, --nameSpecify the variable name
-p, --promptPrompt for the string to encrypt
open and decrypt an existing vaulted file in an editor, that will be encryped again when closed
--encrypt-vault-id <ENCRYPT_VAULT_ID>¶the vault id used to encrypt (required if more than vault-id is provided)
create and open a file in an editor that will be encryped with the provided vault secret when closed
--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
Ansible was originally written by Michael DeHaan.
See the AUTHORS file for a complete list of contributors.