Updataed documnetations

Signed-off-by: Shiva Shankar Vaddepally <shivashankar.vaddepally@cloud.com>

Author: shivashankar-vaddepally

examples/bgpRouter.yaml

@@ -7,11 +7,6 @@
       delegate_to: localhost
       netscaler.adc.bgpRouter:
         state: present
-        nsip: 10.102.201.219
-        nitro_user: nsroot
-        nitro_pass: nspentest
-        validate_certs: no
-        nitro_protocol: http
         localAS: 10
         afParams.addressFamily: "ipv4"
         afParams.redistribute.protocol: "kernel"

meta/runtime.yml

@@ -697,19 +697,7 @@ action_groups:
     - route
     - route6
     - routerdynamicrouting
-    - "accessList"
-    - "bfdInterface"
-    - "bgpPrefix"
-    - "bgpRouter"
-    - "ipRoute"
-    - "ospfDatabase"
-    - "ospfInterface"
-    - "ospfNeighbor"
-    - "ospfRouter"
-    - "ospf6Database"
-    - "ospf6Interface"
-    - "ospf6Neighbor"
-    - "ospf6Router"
+    - bgpRouter
     - rsskeytype
     - save_config
     - server

plugins/modules/bgpRouter.py

@@ -15,8 +15,155 @@
     "status": ["preview"],
     "supported_by": "community",
 }
-DOCUMENTATION = ""
-EXAMPLES = ""
+DOCUMENTATION = r"""
+--- 
+module: bgpRouter
+short_description: Manage BGP Router configuration on Citrix ADC (NetScaler) devices
+description: This module allows for the management of BGP Router configurations on Citrix ADC (NetScaler) devices.
+version_added: 2.10.0
+author:
+  - Shiva Shankar Vaddepally (@shivashankar-vaddepally)
+options:
+  state:
+  choices:
+    - present
+    - absent
+    default: present
+      - The state of the resource being configured by the module on the NetScaler
+        ADC node.
+      - When C(present), the resource will be added/updated configured according to
+        the module's parameters.
+      - When C(absent), the resource will be deleted from the NetScaler ADC node.
+    type: str
+  afParams.addressFamily:
+    type: str
+    choices: ["ipv4", "ipv6"]
+    description:
+      - Address family for this BGP AF parameter.
+
+  afParams.redistribute.protocol:
+    type: str
+    choices: ["kernel", "connected", "static", "rip", "ospf", "isis", "intranet"]
+    description:
+      - The protocol from which routes need to be redistributed.
+
+  afParams.redistribute.routeMap:
+    type: str
+    description:
+      - Route map reference.
+
+  localAS:
+    type: int
+    description:
+      - Local Autonomous System number.
+
+  routerId:
+    type: str
+    description:
+      - Router ID in IP address format.
+
+  neighbor.ASOriginationInterval:
+    type: int
+    description:
+      - Minimum interval between sending AS-origination routing updates.
+
+  neighbor.address:
+    type: str
+    description:
+      - Address of the neighboring router.
+
+  neighbor.advertisementInterval:
+    type: int
+    description:
+      - Minimum interval between sending BGP routing updates.
+
+  neighbor.afParams.activate:
+    type: bool
+    description:
+      - Enable the Address Family for the neighbor.
+
+  neighbor.afParams.addressFamily:
+    type: str
+    choices: ["ipv4", "ipv6"]
+    description:
+      - Address family identifier
+
+  neighbor.afParams.routeMap.direction:
+    type: str
+    choices: ["in", "out"]
+    description:
+      - Apply the route-map to incoming routes or outgoing routes.
+
+  neighbor.afParams.routeMap.name:
+    type: str
+    description:
+      - Name of the route map.
+
+  neighbor.connectTimer:
+    type: int
+    description:
+      - Time interval (in seconds) for the ConnectRetry timer.
+
+  neighbor.holdTimerConfig:
+    type: int
+    description:
+      - Hold timer value for the neighbor in seconds.
+
+  neighbor.keepaliveTimerConfig:
+    type: int
+    description:
+      - Keepalive timer value for the neighbor in seconds.
+
+  neighbor.md5Password:
+    type: str
+    description:
+      - MD5 password used for neighbor authentication.
+    no_log: true
+
+  neighbor.multihopBfd:
+    type: bool
+    description:
+      - Enable BFD for multihop BGP sessions.
+
+  neighbor.remoteAS:
+    type: int
+    description:
+      - Remote AS number for the neighbor.
+
+  neighbor.singlehopBfd:
+    type: bool
+    description:
+      - Enable BFD on this neighbor
+
+  neighbor.updateSource:
+    type: str
+    description:
+      - Source of routing updates.
+"""
+EXAMPLES = r"""
+---
+- name: BGP routing 
+  hosts: localhost
+  gather_facts: no
+  tasks:
+    - name: Configure BGP routing
+      delegate_to: localhost
+      netscaler.adc.bgpRouter:
+        state: present
+        localAS: 10
+        afParams.addressFamily: "ipv4"
+        afParams.redistribute.protocol: "kernel"
+        routerId: "10.102.201.219"
+        neighbor.ASOriginationInterval: 15
+        neighbor.address: "2.2.12.30"
+        neighbor.advertisementInterval: 30
+        neighbor.afParams.addressFamily: "ipv4"
+        neighbor.holdTimerConfig: 90
+        neighbor.keepaliveTimerConfig: 30
+        neighbor.multihopBfd: "False"
+        neighbor.remoteAS: 100
+        neighbor.singlehopBfd: "False"
+"""
 RETURN = r"""
 ---
 changed:

tests/sanity/ignore-2.15.txt

@@ -947,4 +947,5 @@ plugins/modules/nslaslicense.py validate-modules:missing-gplv3-license # We use
 plugins/modules/sslechconfig.py validate-modules:missing-gplv3-license # We use MIT license
 plugins/modules/sslhpkekey.py validate-modules:missing-gplv3-license # We use MIT license
 plugins/modules/sslprofile_sslechconfig_binding.py validate-modules:missing-gplv3-license # We use MIT license
-plugins/modules/authenticationprotecteduseraction.py validate-modules:missing-gplv3-license # We use MIT license
+plugins/modules/authenticationprotecteduseraction.py validate-modules:missing-gplv3-license # We use MIT license
+plugins/modules/bgpRouter.py validate-modules:missing-gplv3-license # We use MIT license

tests/sanity/ignore-2.16.txt

@@ -947,4 +947,5 @@ plugins/modules/nslaslicense.py validate-modules:missing-gplv3-license # We use
 plugins/modules/sslechconfig.py validate-modules:missing-gplv3-license # We use MIT license
 plugins/modules/sslhpkekey.py validate-modules:missing-gplv3-license # We use MIT license
 plugins/modules/sslprofile_sslechconfig_binding.py validate-modules:missing-gplv3-license # We use MIT license
-plugins/modules/authenticationprotecteduseraction.py validate-modules:missing-gplv3-license # We use MIT license
+plugins/modules/authenticationprotecteduseraction.py validate-modules:missing-gplv3-license # We use MIT license
+plugins/modules/bgpRouter.py validate-modules:missing-gplv3-license # We use MIT license

tests/sanity/ignore-2.17.txt

@@ -947,4 +947,5 @@ plugins/modules/nslaslicense.py validate-modules:missing-gplv3-license # We use
 plugins/modules/sslechconfig.py validate-modules:missing-gplv3-license # We use MIT license
 plugins/modules/sslhpkekey.py validate-modules:missing-gplv3-license # We use MIT license
 plugins/modules/sslprofile_sslechconfig_binding.py validate-modules:missing-gplv3-license # We use MIT license
-plugins/modules/authenticationprotecteduseraction.py validate-modules:missing-gplv3-license # We use MIT license
+plugins/modules/authenticationprotecteduseraction.py validate-modules:missing-gplv3-license # We use MIT license
+plugins/modules/bgpRouter.py validate-modules:missing-gplv3-license # We use MIT license