Deprecate net_* modules (#60818)

* Deprecate net_ modules

* Move modules to finish deprecation

* Add missing `why`, move net_static_route

* Add changelogs and porting guide

changelogs/fragments/deprecate_net_modules.yaml

@@ -0,0 +1,5 @@
+deprecated_features:
+- Deprecated ``net_interface``, ``net_linkagg``, ``net_lldp_interface``, ``net_l2_interface``, ``net_vlan``,
+  ``net_l3_interface``, ``net_vrf``, ``net_lldp``, ``net_banner``, ``net_logging``, ``net_system``, ``net_user``,
+  and ``net_static_route``.
+  Please use either the equivalent network role or the platform-specific resource module.

docs/docsite/rst/porting_guides/porting_guide_2.9.rst

@@ -84,6 +84,32 @@ The following modules will be removed in Ansible 2.13. Please update update your
 
 * nginx_status_facts use :ref:`nginx_status_info <nginx_status_info_module>` instead.
 
+* net_banner use the platform-specific [netos]_banner modules instead.
+
+* net_interface use the new platform-specific [netos]_interfaces modules instead.
+
+* net_l2_interface use the new platform-specific [netos]_l2_interfaces modules instead.
+
+* net_l3_interface use the new platform-specific [netos]_l3_interfaces modules instead.
+
+* net_linkagg use the new platform-specific [netos]_lag modules instead.
+
+* net_lldp use the new platform-specific [netos]_lldp_global modules instead.
+
+* net_lldp_interface use the new platform-specific [netos]_lldp_interfaces modules instead.
+
+* net_logging use the platform-specific [netos]_logging modules instead.
+
+* net_static_route use the platform-specific [netos]_static_route modules instead.
+
+* net_system use the platform-specific [netos]_system modules instead.
+
+* net_user use the platform-specific [netos]_user modules instead.
+
+* net_vlan use the new platform-specific [netos]_vlans modules instead.
+
+* net_vrf use the platform-specific [netos]_vrf modules instead.
+
 * nxos_interface use :ref:`nxos_interfaces <nxos_interfaces_module>` instead.
 
 * nxos_linkagg use :ref:`nxos_lag_interfaces <nxos_lag_interfaces_module>` instead.

lib/ansible/modules/network/interface/_net_interface.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -22,6 +22,10 @@ short_description: Manage Interface on network devices
 description:
   - This module provides declarative management of Interfaces
     on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_interfaces" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   name:

lib/ansible/modules/network/interface/_net_linkagg.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -22,6 +22,10 @@ short_description: Manage link aggregation groups on network devices
 description:
   - This module provides declarative management of link aggregation groups
     on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_lag_interfaces" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   name:

lib/ansible/modules/network/interface/_net_lldp_interface.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 DOCUMENTATION = """
@@ -21,6 +21,10 @@ short_description: Manage LLDP interfaces configuration on network devices
 description:
   - This module provides declarative management of LLDP interfaces
     configuration on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_lldp_interfaces" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   name:

lib/ansible/modules/network/layer2/_net_l2_interface.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 DOCUMENTATION = """
@@ -21,6 +21,10 @@ short_description: Manage Layer-2 interface on network devices
 description:
   - This module provides declarative management of Layer-2 interface
     on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_l2_interfaces" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   name:

lib/ansible/modules/network/layer2/_net_vlan.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -22,6 +22,10 @@ short_description: Manage VLANs on network devices
 description:
   - This module provides declarative management of VLANs
     on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_vlans" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   name:

lib/ansible/modules/network/layer3/_net_l3_interface.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -22,6 +22,10 @@ short_description: Manage L3 interfaces on network devices
 description:
   - This module provides declarative management of L3 interfaces
     on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_l3_interfaces" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   name:

lib/ansible/modules/network/layer3/_net_vrf.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -22,6 +22,10 @@ short_description: Manage VRFs on network devices
 description:
   - This module provides declarative management of VRFs
     on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_vrf" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   name:

lib/ansible/modules/network/protocol/_net_lldp.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -22,6 +22,10 @@ short_description: Manage LLDP service configuration on network devices
 description:
   - This module provides declarative management of LLDP service configuration
     on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_lldp_global" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   state:

lib/ansible/modules/network/routing/_net_static_route.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -22,6 +22,10 @@ short_description: Manage static IP routes on network appliances (routers, switc
 description:
   - This module provides declarative management of static
     IP routes on network appliances (routers, switches et. al.).
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_static_route" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 
 options:

lib/ansible/modules/network/system/_net_banner.py

@@ -7,7 +7,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -21,6 +21,10 @@ description:
   - This will configure both login and motd banners on network devices.
     It allows playbooks to add or remove
     banner text from the active running configuration.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_banner" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   banner:

lib/ansible/modules/network/system/_net_logging.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -22,6 +22,10 @@ short_description: Manage logging on network devices
 description:
   - This module provides declarative management of logging
     on network devices.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_logging" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   dest:

lib/ansible/modules/network/system/_net_system.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 
@@ -24,6 +24,10 @@ description:
     on network devices.  It provides an option to configure host system
     parameters or remove those parameters from the device active
     configuration.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_system" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   hostname:

lib/ansible/modules/network/system/_net_user.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                     'supported_by': 'network'}
 
 DOCUMENTATION = """
@@ -24,6 +24,10 @@ description:
     either individual usernames or the aggregate of usernames in the
     current running config. It also supports purging usernames from the
     configuration that are not explicitly defined.
+deprecated:
+    removed_in: "2.13"
+    alternative: Use platform-specific "[netos]_user" module
+    why: Updated modules released with more functionality
 extends_documentation_fragment: network_agnostic
 options:
   aggregate: