diff options
| author | Jordan Borean <jborean93@gmail.com> | 2020-01-10 09:13:13 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-10 09:13:13 +1000 |
| commit | 595ab62ab8f95db25373bc5f70e52c6680f790ec (patch) | |
| tree | 1d639bf0e62f3d44d42cd36ec11ffad9a292c63c /docs/docsite | |
| parent | 92677d43b603245d78b17092541bdf3f4529dd97 (diff) | |
| download | ansible-595ab62ab8f95db25373bc5f70e52c6680f790ec.tar.gz | |
Ansible.Basic - Added deprecated_aliases (#66323)
Diffstat (limited to 'docs/docsite')
| -rw-r--r-- | docs/docsite/rst/dev_guide/developing_modules_general_windows.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst b/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst index 39235d3299..8ac00d3bf4 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_general_windows.rst @@ -215,6 +215,7 @@ options set: - ``aliases``: A list of aliases for the module option - ``choices``: A list of valid values for the module option, if ``type=list`` then each list value is validated against the choices and not the list itself - ``default``: The default value for the module option if not set +- ``deprecated_aliases``: A list of hashtables that define aliases that are deprecated and the versions they will be removed in. Each entry must contain the keys ``name`` and ``version`` - ``elements``: When ``type=list``, this sets the type of each list value, the values are the same as ``type`` - ``no_log``: Will sanitise the input value before being returned in the ``module_invocation`` return value - ``removed_in_version``: States when a deprecated module option is to be removed, a warning is displayed to the end user if set |