`vyos.vyos` is no longer deprecated! 🎉 (#348)

* Remove deprecation notice for vyos.vyos

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Add changelog

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* fix review comments

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* chore: auto fixes from pre-commit.com hooks

---------

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

1 files changed, 127 insertions, 133 deletions

diff --git a/docs/vyos.vyos.vyos_snmp_server_module.rst b/docs/vyos.vyos.vyos_snmp_server_module.rst
index dfef282a..325f4138 100644
--- a/docs/vyos.vyos.vyos_snmp_server_module.rst
+++ b/docs/vyos.vyos.vyos_snmp_server_module.rst
@@ -1235,30 +1235,29 @@ Examples
     # vyos@vyos:~$ show configuration commands | grep snmp
     # vyos@vyos:~$
 
-      - name: Merge provided configuration with device configuration
-        vyos.vyos.vyos_snmp_server:
-          config:
-            communities:
-              - name: "switches"
-                authorization_type: "rw"
-              - name: "bridges"
-                clients: ["1.1.1.1", "12.1.1.10"]
-            contact: "admin2@ex.com"
-            listen_addresses:
-              - address: "20.1.1.1"
-              - address: "100.1.2.1"
-                port: 33
-            snmp_v3:
-              users:
-                - user: admin_user
-                  authentication:
-                    plaintext_key: "abc1234567"
-                    type: "sha"
-                  privacy:
-                    plaintext_key: "abc1234567"
-                    type: "aes"
-
-          state: merged
+    - name: Merge provided configuration with device configuration
+      vyos.vyos.vyos_snmp_server:
+        config:
+          communities:
+            - name: "switches"
+              authorization_type: "rw"
+            - name: "bridges"
+              clients: ["1.1.1.1", "12.1.1.10"]
+          contact: "admin2@ex.com"
+          listen_addresses:
+            - address: "20.1.1.1"
+            - address: "100.1.2.1"
+              port: 33
+          snmp_v3:
+            users:
+              - user: admin_user
+                authentication:
+                  plaintext_key: "abc1234567"
+                  type: "sha"
+                privacy:
+                  plaintext_key: "abc1234567"
+                  type: "aes"
+        state: merged
 
     # After State:
 
@@ -1333,9 +1332,10 @@ Examples
     #     ],
     #
 
-    # using Replaced:
+    # Using replaced
 
     # Before State
+    # -------------
     # vyos@vyos:~$ show configuration commands | grep snmp
     # set service snmp community bridges client '1.1.1.1'
     # set service snmp community bridges client '12.1.1.10'
@@ -1347,43 +1347,42 @@ Examples
     # set service snmp v3 user admin_user auth type 'sha'
     # set service snmp v3 user admin_user privacy plaintext-key 'abc1234567'
     # set service snmp v3 user admin_user privacy type 'aes'
-    # vyos@vyos:~$
 
-      - name: Replace
-        vyos.vyos.vyos_snmp_server:
-          config:
-            communities:
-              - name: "bridges"
-                networks: ["1.1.1.0/24", "12.1.1.0/24"]
-            location: "RDU, NC"
-            listen_addresses:
-              - address: "100.1.2.1"
-                port: 33
-            snmp_v3:
-              groups:
-                - group: "default"
-                  view: "default"
-              users:
-                - user: admin_user
-                  authentication:
-                    plaintext_key: "abc1234567"
-                    type: "sha"
-                  privacy:
-                    plaintext_key: "abc1234567"
-                    type: "aes"
-                  group: "default"
-                - user: guest_user2
-                  authentication:
-                    plaintext_key: "opq1234567"
-                    type: "sha"
-                  privacy:
-                    plaintext_key: "opq1234567"
-                    type: "aes"
-              views:
-                - view: "default"
-                  oid: 1
-
-          state: replaced
+    - name: Replace SNMP Server configuration
+      vyos.vyos.vyos_snmp_server:
+        config:
+          communities:
+            - name: "bridges"
+              networks: ["1.1.1.0/24", "12.1.1.0/24"]
+          location: "RDU, NC"
+          listen_addresses:
+            - address: "100.1.2.1"
+              port: 33
+          snmp_v3:
+            groups:
+              - group: "default"
+                view: "default"
+            users:
+              - user: admin_user
+                authentication:
+                  plaintext_key: "abc1234567"
+                  type: "sha"
+                privacy:
+                  plaintext_key: "abc1234567"
+                  type: "aes"
+                group: "default"
+              - user: guest_user2
+                authentication:
+                  plaintext_key: "opq1234567"
+                  type: "sha"
+                privacy:
+                  plaintext_key: "opq1234567"
+                  type: "aes"
+            views:
+              - view: "default"
+                oid: 1
+
+        state: replaced
 
     # After State:
     # vyos@vyos:~$ show configuration commands | grep snmp
@@ -1539,43 +1538,41 @@ Examples
     # set service snmp v3 user admin_user auth type 'sha'
     # set service snmp v3 user admin_user privacy plaintext-key 'abc1234567'
     # set service snmp v3 user admin_user privacy type 'aes'
-    # vyos@vyos:~$
 
-      - name: Override config
-        vyos.vyos.vyos_snmp_server:
-          config:
-            communities:
-              - name: "bridges"
-                networks: ["1.1.1.0/24", "12.1.1.0/24"]
-            location: "RDU, NC"
-            listen_addresses:
-              - address: "100.1.2.1"
-                port: 33
-            snmp_v3:
-              groups:
-                - group: "default"
-                  view: "default"
-              users:
-                - user: admin_user
-                  authentication:
-                    plaintext_key: "abc1234567"
-                    type: "sha"
-                  privacy:
-                    plaintext_key: "abc1234567"
-                    type: "aes"
-                  group: "default"
-                - user: guest_user2
-                  authentication:
-                    plaintext_key: "opq1234567"
-                    type: "sha"
-                  privacy:
-                    plaintext_key: "opq1234567"
-                    type: "aes"
-              views:
-                - view: "default"
-                  oid: 1
-
-          state: overridden
+    - name: Override SNMP server config
+      vyos.vyos.vyos_snmp_server:
+        config:
+          communities:
+            - name: "bridges"
+              networks: ["1.1.1.0/24", "12.1.1.0/24"]
+          location: "RDU, NC"
+          listen_addresses:
+            - address: "100.1.2.1"
+              port: 33
+          snmp_v3:
+            groups:
+              - group: "default"
+                view: "default"
+            users:
+              - user: admin_user
+                authentication:
+                  plaintext_key: "abc1234567"
+                  type: "sha"
+                privacy:
+                  plaintext_key: "abc1234567"
+                  type: "aes"
+                group: "default"
+              - user: guest_user2
+                authentication:
+                  plaintext_key: "opq1234567"
+                  type: "sha"
+                privacy:
+                  plaintext_key: "opq1234567"
+                  type: "aes"
+            views:
+              - view: "default"
+                oid: 1
+        state: overridden
 
     # After State:
     # vyos@vyos:~$ show configuration commands | grep snmp
@@ -1738,11 +1735,10 @@ Examples
     # set service snmp v3 user guest_user2 privacy plaintext-key 'opq1234567'
     # set service snmp v3 user guest_user2 privacy type 'aes'
     # set service snmp v3 view default oid 1
-    # vyos@vyos:~$
 
-      - name: Delete Config
-        vyos.vyos.vyos_snmp_server:
-          state: deleted
+    - name: Delete Config
+      vyos.vyos.vyos_snmp_server:
+        state: deleted
 
     # After State:
     # vyos@vyos:~$ show configuration commands | grep snmp
@@ -1816,30 +1812,29 @@ Examples
     #     ],
 
     # Using rendered:
-      - name: Render provided configuration
-        vyos.vyos.vyos_snmp_server:
-          config:
-            communities:
-              - name: "switches"
-                authorization_type: "rw"
-              - name: "bridges"
-                clients: ["1.1.1.1", "12.1.1.10"]
-            contact: "admin2@ex.com"
-            listen_addresses:
-              - address: "20.1.1.1"
-              - address: "100.1.2.1"
-                port: 33
-            snmp_v3:
-              users:
-                - user: admin_user
-                  authentication:
-                    plaintext_key: "abc1234567"
-                    type: "sha"
-                  privacy:
-                    plaintext_key: "abc1234567"
-                    type: "aes"
-
-          state: rendered
+    - name: Render provided configuration
+      vyos.vyos.vyos_snmp_server:
+        config:
+          communities:
+            - name: "switches"
+              authorization_type: "rw"
+            - name: "bridges"
+              clients: ["1.1.1.1", "12.1.1.10"]
+          contact: "admin2@ex.com"
+          listen_addresses:
+            - address: "20.1.1.1"
+            - address: "100.1.2.1"
+              port: 33
+          snmp_v3:
+            users:
+              - user: admin_user
+                authentication:
+                  plaintext_key: "abc1234567"
+                  type: "sha"
+                privacy:
+                  plaintext_key: "abc1234567"
+                  type: "aes"
+        state: rendered
 
     # Module Execution:
     #  "rendered": [
@@ -1870,11 +1865,10 @@ Examples
     # set service snmp v3 user admin_user auth type 'sha'
     # set service snmp v3 user admin_user privacy plaintext-key 'abc1234567'
     # set service snmp v3 user admin_user privacy type 'aes'
-    # vyos@vyos:~$
 
-      - name: gather configs
-        vyos.vyos.vyos_snmp_server:
-          state: gathered
+    - name: Gather SNMP server config
+      vyos.vyos.vyos_snmp_server:
+        state: gathered
 
     # Module Execution:
     #   "gathered": {
@@ -1941,10 +1935,10 @@ Examples
     # set service snmp v3 user vyos privacy type 'aes'
     # set service snmp v3 view default oid 1
 
-      - name: parse configs
-        vyos.vyos.vyos_snmp_server:
-          running_config: "{{ lookup('file', './_parsed_snmp.cfg') }}"
-          state: parsed
+    - name: Parse SNMP server config
+      vyos.vyos.vyos_snmp_server:
+        running_config: "{{ lookup('file', './_parsed_snmp.cfg') }}"
+        state: parsed
 
     # Module Execution:
     # "parsed": {