Update params to version 4.0.0

cisco-en-programmability · Dec 2, 2021 · 61e98d5 · 61e98d5
1 parent ec4a675
commit 61e98d5
Show file tree

Hide file tree

Showing 15 changed files with 51 additions and 0 deletions.
diff --git a/plugins/modules/network_device.py b/plugins/modules/network_device.py
@@ -16,6 +16,7 @@
 author: Rafael Campos (@racampos)
 options:
   cleanConfig:
+    version_added: "4.0.0"
     description: CleanConfig query parameter.
     type: bool
   cliTransport:

diff --git a/plugins/modules/reserve_ip_subpool.py b/plugins/modules/reserve_ip_subpool.py
@@ -27,6 +27,7 @@
     elements: str
     type: list
   ipv4GateWay:
+    version_added: "4.0.0"
     description: Gateway ip address details, example 175.175.0.1.
     type: str
   ipv4GlobalPool:

diff --git a/plugins/modules/sda_device_info.py b/plugins/modules/sda_device_info.py
@@ -19,6 +19,7 @@
     description: Additional headers.
     type: dict
   deviceManagementIpAddress:
+    version_added: "4.0.0"
     description:
     - DeviceManagementIpAddress query parameter.
     type: str

diff --git a/plugins/modules/sda_fabric_authentication_profile.py b/plugins/modules/sda_fabric_authentication_profile.py
@@ -16,19 +16,23 @@
 author: Rafael Campos (@racampos)
 options:
   authenticateTemplateName:
+    version_added: "4.0.0"
     description: Authenticate Template Name. Allowed values are 'No Authentication ',
       'Open Authentication', 'Closed Authentication', 'Low Impact'.
     type: str
   authenticationOrder:
+    version_added: "4.0.0"
     description: Authentication Order. Allowed values are 'dot1x ', 'mac'.
     type: str
   dot1xToMabFallbackTimeout:
+    version_added: "4.0.0"
     description: In a network that includes both devices that support and devices that
       do not support IEEE 802.1X, MAB can be deployed as a fallback, or complementary,
       mechanism to IEEE 802.1X. If the network does not have any IEEE 802.1X-capable
       devices, MAB can be deployed as a standalone authentication mechanism (e.g. 3-120).
     type: str
   numberOfHosts:
+    version_added: "4.0.0"
     description: Number of hosts specifies the number of data hosts that can be connected
       to a port. With Single selected, you can have only one data client on the port.
       With Unlimited selected, you can have multiple data clients and one voice client
@@ -39,6 +43,7 @@
       Global/USA/San Jose.
     type: str
   wakeOnLan:
+    version_added: "4.0.0"
     description: The IEEE 802.1X Wake on LAN (WoL) Support feature allows dormant systems
       to be powered up when the switch receives a specific Ethernet frame. You can use
       this feature in cases when hosts on power save and needs to receive a magic packet

diff --git a/plugins/modules/sda_fabric_authentication_profile_info.py b/plugins/modules/sda_fabric_authentication_profile_info.py
@@ -23,6 +23,7 @@
     - SiteNameHierarchy query parameter.
     type: str
   authenticateTemplateName:
+    version_added: "4.0.0"
     description:
     - AuthenticateTemplateName query parameter.
     type: str

diff --git a/plugins/modules/sda_fabric_border_device.py b/plugins/modules/sda_fabric_border_device.py
@@ -16,48 +16,62 @@
 author: Rafael Campos (@racampos)
 options:
   borderSessionType:
+    version_added: "4.0.0"
     description: Border Session Type.
     type: str
   connectedToInternet:
+    version_added: "4.0.0"
     description: Connected to Internet.
     type: bool
   deviceManagementIpAddress:
+    version_added: "4.0.0"
     description: Management Ip Address of the Device which is provisioned successfully.
     type: str
   externalAutonomouSystemNumber:
+    version_added: "4.0.0"
     description: External Autonomous System Number will be used to automate IP routing
       between Border Node and remote peer (e.g.,1-65535).
     type: str
   externalConnectivityIpPoolName:
+    version_added: "4.0.0"
     description: IP pool to use to automate IP routing between the border node and remote
       peer.
     type: str
   externalConnectivitySettings:
+    version_added: "4.0.0"
     description: External Connectivity Settings information of L3 Handoff.
     type: dict
   externalDomainRoutingProtocolName:
+    version_added: "4.0.0"
     description: External Domain Routing Protocol Name. (Example BGP).
     type: str
   interfaceName:
+    version_added: "4.0.0"
     description: Interface Name.
     type: str
   internalAutonomouSystemNumber:
+    version_added: "4.0.0"
     description: Internal Autonomouns System Number used by border node to communicate
       with remote peer (e.g.,1-65535).
     type: str
   l3Handoff:
+    version_added: "4.0.0"
     description: L3 Handoff information.
     type: dict
   siteNameHierarchy:
+    version_added: "4.0.0"
     description: Site Name Hierarchy for device location(site should be fabric site).
     type: str
   virtualNetwork:
+    version_added: "4.0.0"
     description: Virtual Network information of L3 Hand off.
     type: dict
   virtualNetworkName:
+    version_added: "4.0.0"
     description: Virtual Network Name assigned to site.
     type: str
   vlanId:
+    version_added: "4.0.0"
     description: Vlan Id (e.g.,2-4096 except for reserved VLANs (1002-1005, 2046, 4095)).
     type: str
 requirements:

diff --git a/plugins/modules/sda_fabric_border_device_info.py b/plugins/modules/sda_fabric_border_device_info.py
@@ -19,6 +19,7 @@
     description: Additional headers.
     type: dict
   deviceManagementIpAddress:
+    version_added: "4.0.0"
     description:
     - DeviceManagementIpAddress query parameter.
     type: str

diff --git a/plugins/modules/sda_fabric_control_plane_device.py b/plugins/modules/sda_fabric_control_plane_device.py
@@ -16,9 +16,11 @@
 author: Rafael Campos (@racampos)
 options:
   deviceManagementIpAddress:
+    version_added: "4.0.0"
     description: DeviceManagementIpAddress query parameter.
     type: str
   siteNameHierarchy:
+    version_added: "4.0.0"
     description: Site Name Hierarchy of provisioned Device(site should be fabric site).
     type: str
 requirements:

diff --git a/plugins/modules/sda_fabric_control_plane_device_info.py b/plugins/modules/sda_fabric_control_plane_device_info.py
@@ -19,6 +19,7 @@
     description: Additional headers.
     type: dict
   deviceManagementIpAddress:
+    version_added: "4.0.0"
     description:
     - DeviceManagementIpAddress query parameter.
     type: str

diff --git a/plugins/modules/sda_fabric_edge_device.py b/plugins/modules/sda_fabric_edge_device.py
@@ -19,6 +19,7 @@
     description: Management Ip Address of the Device which is provisioned successfully.
     type: str
   siteNameHierarchy:
+    version_added: "4.0.0"
     description: Site Name Hierarchy of provisioned Device.
     type: str
 requirements:

diff --git a/plugins/modules/sda_fabric_site.py b/plugins/modules/sda_fabric_site.py
@@ -16,6 +16,7 @@
 author: Rafael Campos (@racampos)
 options:
   fabricName:
+    version_added: "4.0.0"
     description: Fabric Name (should be existing fabric name).
     type: str
   siteNameHierarchy:

diff --git a/plugins/modules/sda_port_assignment_for_access_point.py b/plugins/modules/sda_port_assignment_for_access_point.py
@@ -16,21 +16,26 @@
 author: Rafael Campos (@racampos)
 options:
   authenticateTemplateName:
+    version_added: "4.0.0"
     description: Authenticate TemplateName associated to siteNameHierarchy.
     type: str
   dataIpAddressPoolName:
+    version_added: "4.0.0"
     description: Ip Pool Name, that is assigned to INFRA_VN.
     type: str
   deviceManagementIpAddress:
+    version_added: "4.0.0"
     description: Management Ip Address of the edge device.
     type: str
   interfaceDescription:
+    version_added: "4.0.0"
     description: Details or note of interface assignment.
     type: str
   interfaceName:
     description: Interface Name of the edge device.
     type: str
   siteNameHierarchy:
+    version_added: "4.0.0"
     description: Site Name Hierarchy should be a valid fabric site name hierarchy. E.g
       Global/USA/San Jose.
     type: str

diff --git a/plugins/modules/sda_port_assignment_for_user_device.py b/plugins/modules/sda_port_assignment_for_user_device.py
@@ -16,33 +16,39 @@
 author: Rafael Campos (@racampos)
 options:
   authenticateTemplateName:
+    version_added: "4.0.0"
     description: Authenticate TemplateName associated to siteNameHierarchy. Allowed
       values are 'Open Authentication', 'Closed Authentication', 'Low Impact', 'No Authentication',
       ''.
     type: str
   dataIpAddressPoolName:
+    version_added: "4.0.0"
     description: Ip Pool Name, that is assigned to virtual network with traffic type
       as DATA(can't be empty if voiceIpAddressPoolName is empty).
     type: str
   deviceManagementIpAddress:
     description: DeviceManagementIpAddress query parameter.
     type: str
   interfaceDescription:
+    version_added: "4.0.0"
     description: Details or note of interface assignment.
     type: str
   interfaceName:
     description: InterfaceName query parameter.
     type: str
   scalableGroupName:
+    version_added: "4.0.0"
     description: Valid name of a scalable group associated with virtual network(Scalable
       groups are only supported on No Auth profile because the other profiles assign
       SGTs from ISE).
     type: str
   siteNameHierarchy:
+    version_added: "4.0.0"
     description: Site Name Hierarchy should be a valid fabric site name hierarchy. E.g
       Global/USA/San Jose.
     type: str
   voiceIpAddressPoolName:
+    version_added: "4.0.0"
     description: Ip Pool Name, that is assigned to virtual network with traffic type
       as VOICE(can't be empty if dataIpAddressPoolName is emty).
     type: str

diff --git a/plugins/modules/sda_virtual_network_ip_pool.py b/plugins/modules/sda_virtual_network_ip_pool.py
@@ -16,37 +16,47 @@
 author: Rafael Campos (@racampos)
 options:
   authenticationPolicyName:
+    version_added: "4.0.0"
     description: Deprecated, same as vlanName, please use vlanName.
     type: str
   ipPoolName:
+    version_added: "4.0.0"
     description: IpPoolName query parameter.
     type: str
   isL2FloodingEnabled:
+    version_added: "4.0.0"
     description: Layer2 flooding enablement flag.
     type: bool
   isThisCriticalPool:
+    version_added: "4.0.0"
     description: Critical pool enablement flag where depending on the pool type (data
       or voice), a corresponding Critical Vlan gets assigned to the Critical Pool.
     type: bool
   isWirelessPool:
+    version_added: "4.0.0"
     description: Wireless Pool enablement flag.
     type: str
   poolType:
+    version_added: "4.0.0"
     description: Pool Type (needed when assigning segment to INFRA_VN) (Example AP.).
     type: str
   scalableGroupName:
+    version_added: "4.0.0"
     description: Scalable Group, that is associated to Virtual Network.
     type: str
   siteNameHierarchy:
+    version_added: "4.0.0"
     description: Full path of sda fabric siteNameHierarchy.
     type: str
   trafficType:
+    version_added: "4.0.0"
     description: Traffic type.
     type: str
   virtualNetworkName:
     description: VirtualNetworkName query parameter.
     type: str
   vlanName:
+    version_added: "4.0.0"
     description: Vlan name for this segment, represent the segment name, if empty, vlanName
       would be auto generated by API.
     type: str

diff --git a/plugins/modules/site_health_info.py b/plugins/modules/site_health_info.py
@@ -23,6 +23,7 @@
     - Timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required.
     type: str
   siteType:
+    version_added: "4.0.0"
     description:
     - SiteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA.
     type: str