Deprecate collection (#624) (#626)

* Deprecate collection * Deprecate content in meta/runtime.yml * Update documentation * alternatives -> alternative (cherry picked from commit f2c3554) Co-authored-by: Mario Lenz <m@riolenz.de>
ansible-collections · Oct 14, 2024 · a5e402a · a5e402a
1 parent 11050e6
commit a5e402a
Show file tree

Hide file tree

Showing 338 changed files with 4,296 additions and 1,227 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # Community Network Collection
 
+:warning: **DEPRECATED: This collection is not not actively maintained anymore.**
+
+For more information why we decided to deprecate the collection, please see [this thread](https://forum.ansible.com/t/8030).
+
 [![Build Status](https://dev.azure.com/ansible/community.network/_apis/build/status/CI?branchName=stable-5)](https://dev.azure.com/ansible/community.network/_build?definitionId=32)
 [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.network)](https://codecov.io/gh/ansible-collections/community.network)
 

diff --git a/meta/runtime.yml b/meta/runtime.yml
diff --git a/plugins/cliconf/aireos.py b/plugins/cliconf/aireos.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: aireos
 short_description: Use aireos cliconf to run command on Cisco WLC platform

diff --git a/plugins/cliconf/apconos.py b/plugins/cliconf/apconos.py
@@ -18,6 +18,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: "David Li (@davidlee-ap)"
 name: apconos
 short_description: Use apconos cliconf to run command on APCON network devices

diff --git a/plugins/cliconf/aruba.py b/plugins/cliconf/aruba.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: aruba
 short_description: Use aruba cliconf to run command on Aruba platform

diff --git a/plugins/cliconf/ce.py b/plugins/cliconf/ce.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: ce
 short_description: Use ce cliconf to run command on HUAWEI CloudEngine platform

diff --git a/plugins/cliconf/cnos.py b/plugins/cliconf/cnos.py
@@ -18,6 +18,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: cnos
 short_description: Use cnos cliconf to run command on Lenovo CNOS platform

diff --git a/plugins/cliconf/edgeos.py b/plugins/cliconf/edgeos.py
@@ -7,6 +7,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: edgeos
 short_description: Use edgeos cliconf to run command on EdgeOS platform

diff --git a/plugins/cliconf/edgeswitch.py b/plugins/cliconf/edgeswitch.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: edgeswitch
 short_description: Use edgeswitch cliconf to run command on EdgeSwitch platform

diff --git a/plugins/cliconf/enos.py b/plugins/cliconf/enos.py
@@ -18,6 +18,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: enos
 short_description: Use enos cliconf to run command on Lenovo ENOS platform

diff --git a/plugins/cliconf/eric_eccli.py b/plugins/cliconf/eric_eccli.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Ericsson IPOS OAM team (!UNKNOWN)
 name: eric_eccli
 short_description: Use eccli cliconf to run command on Ericsson ECCLI platform

diff --git a/plugins/cliconf/exos.py b/plugins/cliconf/exos.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: exos
 short_description: Use exos cliconf to run command on Extreme EXOS platform

diff --git a/plugins/cliconf/icx.py b/plugins/cliconf/icx.py
@@ -6,6 +6,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Ruckus Wireless (@Commscope)
 name: icx
 short_description: Use icx cliconf to run command on Ruckus ICX platform

diff --git a/plugins/cliconf/ironware.py b/plugins/cliconf/ironware.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: ironware
 short_description: Use ironware cliconf to run command on Extreme Ironware platform

diff --git a/plugins/cliconf/netvisor.py b/plugins/cliconf/netvisor.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: netvisor
 short_description: Use netvisor cliconf to run command on Pluribus netvisor platform

diff --git a/plugins/cliconf/nos.py b/plugins/cliconf/nos.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: nos
 short_description: Use nos cliconf to run command on Extreme NOS platform

diff --git a/plugins/cliconf/slxos.py b/plugins/cliconf/slxos.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: slxos
 short_description: Use slxos cliconf to run command on Extreme SLX-OS platform

diff --git a/plugins/cliconf/voss.py b/plugins/cliconf/voss.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Unknown (!UNKNOWN)
 name: voss
 short_description: Use voss cliconf to run command on Extreme VOSS platform

diff --git a/plugins/cliconf/weos4.py b/plugins/cliconf/weos4.py
@@ -5,6 +5,10 @@
 
 DOCUMENTATION = """
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Ernst Oudhof (@ernst-s)
 name: weos4
 short_description: Use weos4 cliconf to run commands on Westermo platform

diff --git a/plugins/httpapi/exos.py b/plugins/httpapi/exos.py
@@ -21,6 +21,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author:
   - "Ujwal Komarla (@ujwalkomarla)"
 name: exos

diff --git a/plugins/httpapi/ftd.py b/plugins/httpapi/ftd.py
@@ -22,6 +22,10 @@
 
 DOCUMENTATION = '''
 ---
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Ansible Networking Team (!UNKNOWN)
 name: ftd
 short_description: HttpApi Plugin for Cisco ASA Firepower device

diff --git a/plugins/lookup/avi.py b/plugins/lookup/avi.py
@@ -5,6 +5,10 @@
 __metaclass__ = type
 
 DOCUMENTATION = '''
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 name: avi
 author: Sandeep Bandi (@sabandi) <sandeepb@avinetworks.com>
 short_description: Look up ``Avi`` objects.

diff --git a/plugins/modules/a10_server.py b/plugins/modules/a10_server.py
@@ -13,6 +13,10 @@
 DOCUMENTATION = '''
 ---
 module: a10_server
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 short_description: Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' server object.
 description:
     - Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv2.

diff --git a/plugins/modules/a10_server_axapi3.py b/plugins/modules/a10_server_axapi3.py
@@ -12,6 +12,10 @@
 DOCUMENTATION = '''
 ---
 module: a10_server_axapi3
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 short_description: Manage A10 Networks AX/SoftAX/Thunder/vThunder devices
 description:
     - Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv3.

diff --git a/plugins/modules/a10_service_group.py b/plugins/modules/a10_service_group.py
@@ -13,6 +13,10 @@
 DOCUMENTATION = '''
 ---
 module: a10_service_group
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 short_description: Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' service groups.
 description:
     - Manage SLB (Server Load Balancing) service-group objects on A10 Networks devices via aXAPIv2.

diff --git a/plugins/modules/a10_virtual_server.py b/plugins/modules/a10_virtual_server.py
@@ -13,6 +13,10 @@
 DOCUMENTATION = '''
 ---
 module: a10_virtual_server
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 short_description: Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' virtual servers.
 description:
     - Manage SLB (Server Load Balancing) virtual server objects on A10 Networks devices via aXAPIv2.

diff --git a/plugins/modules/aireos_command.py b/plugins/modules/aireos_command.py
@@ -10,6 +10,10 @@
 DOCUMENTATION = '''
 ---
 module: aireos_command
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: "James Mighion (@jmighion)"
 short_description: Run commands on remote devices running Cisco WLC
 description:

diff --git a/plugins/modules/aireos_config.py b/plugins/modules/aireos_config.py
@@ -10,6 +10,10 @@
 DOCUMENTATION = '''
 ---
 module: aireos_config
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: "James Mighion (@jmighion)"
 short_description: Manage Cisco WLC configurations
 description:

diff --git a/plugins/modules/apconos_command.py b/plugins/modules/apconos_command.py
@@ -20,6 +20,10 @@
 DOCUMENTATION = '''
 ---
 module: apconos_command
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 version_added: '0.2.0'
 author: "David Lee (@davidlee-ap)"
 short_description: Run arbitrary commands on APCON devices

diff --git a/plugins/modules/aruba_command.py b/plugins/modules/aruba_command.py
@@ -10,6 +10,10 @@
 DOCUMENTATION = '''
 ---
 module: aruba_command
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: "James Mighion (@jmighion)"
 short_description: Run commands on remote devices running Aruba Mobility Controller
 description:

diff --git a/plugins/modules/aruba_config.py b/plugins/modules/aruba_config.py
@@ -10,6 +10,10 @@
 DOCUMENTATION = '''
 ---
 module: aruba_config
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: "James Mighion (@jmighion)"
 short_description: Manage Aruba configuration sections
 description:

diff --git a/plugins/modules/avi_actiongroupconfig.py b/plugins/modules/avi_actiongroupconfig.py
@@ -14,6 +14,10 @@
 DOCUMENTATION = '''
 ---
 module: avi_actiongroupconfig
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
 
 short_description: Module for setup of ActionGroupConfig Avi RESTful Object

diff --git a/plugins/modules/avi_alertconfig.py b/plugins/modules/avi_alertconfig.py
@@ -14,6 +14,10 @@
 DOCUMENTATION = '''
 ---
 module: avi_alertconfig
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
 
 short_description: Module for setup of AlertConfig Avi RESTful Object

diff --git a/plugins/modules/avi_alertemailconfig.py b/plugins/modules/avi_alertemailconfig.py
@@ -14,6 +14,10 @@
 DOCUMENTATION = '''
 ---
 module: avi_alertemailconfig
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
 
 short_description: Module for setup of AlertEmailConfig Avi RESTful Object

diff --git a/plugins/modules/avi_alertscriptconfig.py b/plugins/modules/avi_alertscriptconfig.py
@@ -14,6 +14,10 @@
 DOCUMENTATION = '''
 ---
 module: avi_alertscriptconfig
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
 
 short_description: Module for setup of AlertScriptConfig Avi RESTful Object

diff --git a/plugins/modules/avi_alertsyslogconfig.py b/plugins/modules/avi_alertsyslogconfig.py
@@ -14,6 +14,10 @@
 DOCUMENTATION = '''
 ---
 module: avi_alertsyslogconfig
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
 
 short_description: Module for setup of AlertSyslogConfig Avi RESTful Object

diff --git a/plugins/modules/avi_analyticsprofile.py b/plugins/modules/avi_analyticsprofile.py
@@ -15,6 +15,10 @@
 DOCUMENTATION = '''
 ---
 module: avi_analyticsprofile
+deprecated:
+  removed_in: 6.0.0
+  why: This collection and all content in it is unmaintained and deprecated.
+  alternative: Unknown.
 author: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
 
 short_description: Module for setup of AnalyticsProfile Avi RESTful Object