supporing bgprouter

Signed-off-by: Shiva Shankar Vaddepally <[email protected]>

Author: Shiva Shankar Vaddepally

examples/bgprouter.yaml

@@ -7,30 +7,26 @@
       delegate_to: localhost
       netscaler.adc.bgprouter:
         state: present
-        localAS: 100
-        routerId: 2.2.2.2
+
+        localAS: 122
+        routerId: "2.2.2.2"
         afParams:
-          - addressFamily: ipv4
+          - addressFamily: "ipv4"
             redistribute:
-              - protocol: static
-                routeMap: test
-          - addressFamily: ipv6
+              - protocol: "static"
+                routeMap: "test"
+          - addressFamily: "ipv6"
         neighbor:
-          - address: 44.1.1.33
+          - address: "44.1.1.33"
             remoteAS: 300
-            ASOriginationInterval: 15
-            advertisementInterval: 30
-            updateSource: vlan101
-            holdTimer: 90
-            keepaliveTimer: 30
-            state: Connect
+            ASOriginationInterval: 11
+            advertisementInterval: 34
+            updateSource: "vlan101"
             singlehopBfd: false
             multihopBfd: false
             afParams:
-              - addressFamily: ipv4
-                activate: true
+              - addressFamily: "ipv4"
                 routeMap:
-                  - name: test
-                    direction: out
-              - addressFamily: ipv6
-                activate: false
+                  - name: "test"
+                    direction: "out"
+              - addressFamily: "ipv6"

examples/ospf6interface.yaml

@@ -6,7 +6,8 @@
       delegate_to: localhost
       netscaler.adc.ospf6interface:
         state: present
-        name: vlan0
+
+        name: "vlan10"
         areaId: 0
         tagId: "22"
         instanceId: 0

examples/ospf6router.yaml

@@ -6,8 +6,15 @@
     - name: Configure ospf6router
       delegate_to: localhost
       netscaler.adc.ospf6router:
-        state: present
+        state: unset
+
         tagId: 11
-        routerId: 1.1.1.1
         afParams:
           - addressFamily: ipv6
+            redistribute:
+              - protocol: static
+                metric: 111
+
+# before running this playbook, please make sure that to run 
+# enable ns feature osp6
+# set ns param ipv6dynamicrouting ENABLED

examples/ospfinterface.yaml

@@ -7,14 +7,15 @@
       delegate_to: localhost
       netscaler.adc.ospfinterface:
         state: present
+
         name: vlan100
         helloInterval: 10
         deadInterval: 40
         cost: 10
         priority: 1
         mtu: 1500
         networkType: broadcast
-        authType: null
+        authType: "null"
         retransmitInterval: 5
         transmitDelay: 1
         bfd: false

examples/ospfrouter.yaml

@@ -1,18 +1,20 @@
 ---
-- name: Sample routeMap playbook
+- name: Sample ospfrouter playbook
   hosts: localhost
   gather_facts: false
   tasks:
-    - name: Configure routeMap
+    - name: Configure ospfrouter
       delegate_to: localhost
       netscaler.adc.ospfrouter:
         state: present
-        nsip: 10.106.210.21
-        nitro_user: nsroot
-        nitro_pass: notnsroot
-        validate_certs: false
-        nitro_protocol: http
-        tagId: "11"
+
+        processId: 1
         routerId: "1.1.1.1"
-        afParams:
-          - addressFamily: "ipv6"
+        passiveInterface:
+          - vlan22
+        redistribute:
+          - protocol: connected
+        networks:
+          - ipaddress: "33.1.2.5"
+            netmask: 25
+            area: 1

examples/routemap.yaml

@@ -7,9 +7,10 @@
       delegate_to: localhost
       netscaler.adc.routemap:
         state: present
+
         name: test
         rules:
           - action: permit
             sequence: 10
-            setMetric: 300
+            setMetric: 105
             matchAsPath: "300"

plugins/module_utils/module_executor.py

@@ -305,34 +305,30 @@ def _add_nitro_attributes_aliases(self, payload):
 
     @trace
     def _filter_resource_module_params(self):
+        def filter_values(value):
+            if isinstance(value, dict):
+                cleaned_dict = {}
+                for k, v in value.items():
+                    cleaned_v = filter_values(v)
+                    if cleaned_v is not None:
+                        cleaned_dict[k] = cleaned_v
+                return cleaned_dict if cleaned_dict else None
+            elif isinstance(value, list):
+                cleaned_list = []
+                for item in value:
+                    cleaned_item = filter_values(item)
+                    if cleaned_item is not None:
+                        cleaned_list.append(cleaned_item)
+                return cleaned_list if cleaned_list else None
+            else:
+                return value if value is not None else None
+
         log("DEBUG: self.module.params: %s" % self.module.params)
         for k, v in self.module.params.items():
-            if (not k.endswith("_binding")) and (
-                k
-                in NITRO_RESOURCE_MAP[self.resource_name]["readwrite_arguments"].keys()
-            ):
-                # self.module.params is a dict of key:value pairs. If an attribute is not
-                # defined in the playbook, it's value will be None. So, filter out those attributes.
-                # Also, filter out attributes ending with `_binding` as they are handled separately
-                if v is not None:
-                    if isinstance(v, list):
-                        filtered_list = []
-                        for listitem in v:
-                            if isinstance(listitem, dict):
-                                filtered_dict = {
-                                    key: value
-                                    for key, value in listitem.items()
-                                    if value is not None
-                                }
-                                if filtered_dict:
-                                    filtered_list.append(filtered_dict)
-                            else:
-                                if listitem is not None:
-                                    filtered_list.append(listitem)
-                        if filtered_list:
-                            self.resource_module_params[k] = filtered_list
-                    else:
-                        self.resource_module_params[k] = v
+            if not k.endswith("_binding") and k in NITRO_RESOURCE_MAP[self.resource_name]["readwrite_arguments"]:
+                cleaned_value = filter_values(v)
+                if cleaned_value is not None:
+                    self.resource_module_params[k] = cleaned_value
 
         if self.resource_name in NITRO_ATTRIBUTES_ALIASES:
             self.resource_module_params = self._add_nitro_attributes_aliases(

plugins/module_utils/nitro_resource_map.py

@@ -16647,7 +16647,8 @@
                                 "choices": ["ipv4", "ipv6"],
                             },
                             "routeMap": {
-                                "type": "dict",
+                                "type": "list",
+                                "elements": "dict",
                                 "options": {
                                     "direction": {
                                         "no_log": False,
@@ -16666,6 +16667,7 @@
                     "multihopBfd": {"no_log": False, "type": "bool"},
                     "remoteAS": {"no_log": False, "type": "int"},
                     "singlehopBfd": {"no_log": False, "type": "bool"},
+                    "state": {"no_log": False, "type": "str"},
                     "updateSource": {"no_log": False, "type": "str"},
                 },
             },
@@ -46870,7 +46872,19 @@
                 "transmitDelay",
             ],
         },
-        "add_payload_keys": [],
+        "add_payload_keys": [
+            "areaId",
+                "cost",
+                "deadInterval",
+                "helloInterval",
+                "instanceId",
+                "name",
+                "networkType",
+                "priority",
+                "retransmitInterval",
+                "tagId",
+                "transmitDelay",
+        ],
         "bindings": [],
         "bindprimary_key": "",
         "delete_arg_keys": [],
@@ -46921,7 +46935,7 @@
                 "no_log": False,
                 "type": "int",
             },
-            "tagId": {"no_log": False, "type": "int"},
+            "tagId": {"no_log": False, "type": "str"},
             "transmitDelay": {
                 "no_log": False,
                 "type": "int",
@@ -46997,7 +47011,6 @@
         "update_payload_keys": [
             "afParams",
             "passiveInterface",
-            "routerId",
             "tagId",
         ],
     },
@@ -47025,11 +47038,18 @@
             ],
         },
         "add_payload_keys": [
-            "networks",
-            "passiveInterface",
-            "processId",
-            "redistribute",
-            "routerId",
+            "authKey",
+            "authType",
+            "bfd",
+            "cost",
+            "deadInterval",
+            "helloInterval",
+            "mtu",
+            "name",
+            "networkType",
+            "priority",
+            "retransmitInterval",
+            "transmitDelay"
         ],
         "bindings": [],
         "bindprimary_key": "",
@@ -47054,7 +47074,11 @@
             "helloInterval": {"no_log": False, "type": "int"},
             "mtu": {"no_log": False, "type": "int"},
             "name": {"no_log": False, "type": "str"},
-            "networkType": {"no_log": False, "type": "str"},
+            "networkType": {
+                "no_log": False,
+                "type": "str",
+                "choices": ["broadcast", "non-broadcast", "point-to-multipoint", "point-to-point"],
+            },
             "priority": {"no_log": False, "type": "int"},
             "retransmitInterval": {"no_log": False, "type": "int"},
             "transmitDelay": {"no_log": False, "type": "int"},
@@ -47111,7 +47135,8 @@
         "primary_key_composite": [],
         "readwrite_arguments": {
             "networks": {
-                "type": "dict",
+                "type": "list",
+                "elements": "dict",
                 "options": {
                     "area": {"no_log": False, "type": "int"},
                     "ipaddress": {"no_log": False, "type": "str"},
@@ -47121,7 +47146,8 @@
             "passiveInterface": {"no_log": False, "type": "list", "elements": "str"},
             "processId": {"no_log": False, "type": "int"},
             "redistribute": {
-                "type": "dict",
+                "type": "list",
+                "elements": "dict",
                 "options": {
                     "metric": {"no_log": False, "type": "int"},
                     "metricType": {"no_log": False, "type": "int"},
@@ -50490,7 +50516,7 @@
             },
         },
         "singleton": False,
-        "update_payload_keys": ["rules"],
+        "update_payload_keys": ["name", "rules"],
     },
     "routerdynamicrouting": {
         "_supported_operations": [