summaryrefslogtreecommitdiffstats
path: root/src/ansiblelint/rules/deprecated_module.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:06:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:06:49 +0000
commit2fe34b6444502079dc0b84365ce82dbc92de308e (patch)
tree8fedcab52bbbc3db6c5aa909a88a7a7b81685018 /src/ansiblelint/rules/deprecated_module.md
parentInitial commit. (diff)
downloadansible-lint-2fe34b6444502079dc0b84365ce82dbc92de308e.tar.xz
ansible-lint-2fe34b6444502079dc0b84365ce82dbc92de308e.zip
Adding upstream version 6.17.2.upstream/6.17.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/ansiblelint/rules/deprecated_module.md')
-rw-r--r--src/ansiblelint/rules/deprecated_module.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/ansiblelint/rules/deprecated_module.md b/src/ansiblelint/rules/deprecated_module.md
new file mode 100644
index 0000000..c05d641
--- /dev/null
+++ b/src/ansiblelint/rules/deprecated_module.md
@@ -0,0 +1,32 @@
+# deprecated-module
+
+This rule identifies deprecated modules in playbooks.
+You should avoid using deprecated modules because they are not maintained, which can pose a security risk.
+Additionally when a module is deprecated it is available temporarily with a plan for future removal.
+
+Refer to the [Ansible module index](https://docs.ansible.com/ansible/latest/collections/index_module.html) for information about replacements and removal dates for deprecated modules.
+
+## Problematic Code
+
+```yaml
+---
+- name: Example playbook
+ hosts: localhost
+ tasks:
+ - name: Configure VLAN ID
+ ansible.netcommon.net_vlan: # <- Uses a deprecated module.
+ vlan_id: 20
+```
+
+## Correct Code
+
+```yaml
+---
+- name: Example playbook
+ hosts: localhost
+ tasks:
+ - name: Configure VLAN ID
+ dellemc.enterprise_sonic.sonic_vlans: # <- Uses a platform specific module.
+ config:
+ - vlan_id: 20
+```