diff options
| author | Brian Coca <bcoca@users.noreply.github.com> | 2019-02-25 15:58:51 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-02-25 15:58:51 -0500 |
| commit | 40a053ce7813445f4ffefff1e90327b5a0a8d32d (patch) | |
| tree | 0e099be9422ff1de81f9db68873ceae7b30203de | |
| parent | 30b3ce0f81f6e74ff12fc5ad3c4e24f02386ce14 (diff) | |
| download | ansible-40a053ce7813445f4ffefff1e90327b5a0a8d32d.tar.gz | |
better error for bad module options (#52726)
also document clearly inline vaults don't work on 'options'
fixes #52707
| -rw-r--r-- | changelogs/fragments/better_json_option_error.yml | 2 | ||||
| -rw-r--r-- | docs/docsite/rst/user_guide/playbooks_vault.rst | 2 | ||||
| -rw-r--r-- | lib/ansible/executor/module_common.py | 5 |
3 files changed, 8 insertions, 1 deletions
diff --git a/changelogs/fragments/better_json_option_error.yml b/changelogs/fragments/better_json_option_error.yml new file mode 100644 index 0000000000..6306f59b40 --- /dev/null +++ b/changelogs/fragments/better_json_option_error.yml @@ -0,0 +1,2 @@ +bugfixes: + - handle option json errors more gracefully, also document options are not vaultable. diff --git a/docs/docsite/rst/user_guide/playbooks_vault.rst b/docs/docsite/rst/user_guide/playbooks_vault.rst index bd26ff7afb..3aae832780 100644 --- a/docs/docsite/rst/user_guide/playbooks_vault.rst +++ b/docs/docsite/rst/user_guide/playbooks_vault.rst @@ -126,6 +126,8 @@ To create a vaulted variable, use the :ref:`ansible-vault encrypt_string <ansibl This vaulted variable will be decrypted with the supplied vault secret and used as a normal variable. The ``ansible-vault`` command line supports stdin and stdout for encrypting data on the fly, which can be used from your favorite editor to create these vaulted variables; you just have to be sure to add the ``!vault`` tag so both Ansible and YAML are aware of the need to decrypt. The ``|`` is also required, as vault encryption results in a multi-line string. +.. note:: + Inline vaults ONLY work on variables, you cannot use directly on a task's options. .. _encrypt_string: diff --git a/lib/ansible/executor/module_common.py b/lib/ansible/executor/module_common.py index d3a9c9fee8..b6c369efa0 100644 --- a/lib/ansible/executor/module_common.py +++ b/lib/ansible/executor/module_common.py @@ -687,7 +687,10 @@ def _find_module_utils(module_name, b_module_data, module_path, module_args, tas if module_substyle == 'python': params = dict(ANSIBLE_MODULE_ARGS=module_args,) - python_repred_params = repr(json.dumps(params)) + try: + python_repred_params = repr(json.dumps(params)) + except TypeError as e: + raise AnsibleError("Unable to pass options to module, they must be JSON serializable: %s" % to_native(e)) try: compression_method = getattr(zipfile, module_compression) |