Depreciate aos (#36029)

* Deprecate Apstra's aos_* modules These modules don't work with AOS 2.1 or higher. They will be replaced non-upstreamed modules * Correct list
2024-09-14 20:13:21 +02:00 · 2018-02-16 18:26:07 +00:00 · 2018-02-16 18:26:07 +00:00 · f77a390131
commit f77a390131
parent 3eff279dd7
14 changed files with 62 additions and 12 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -60,6 +60,7 @@ See [Porting Guide](http://docs.ansible.com/ansible/devel/porting_guides/porting
 * ec2_ami_find has been deprecated, use ec2_ami_facts.
 * panos_security_policy: Use panos_security_rule - the old module uses deprecated API calls
 * vsphere_guest is deprecated in Ansible 2.5 and will be removed in Ansible-2.9. Use vmware_guest module instead.
+* Apstra's ``aos_*`` modules are deprecated. See new modules at [ansible-apstra](https://www.ansible.com/ansible-apstra)

 See [Porting Guide](https://docs.ansible.com/ansible/devel/porting_guides/porting_guide_2.5.html) for more information

--- a/docs/docsite/rst/porting_guides/porting_guide_2.5.rst
+++ b/docs/docsite/rst/porting_guides/porting_guide_2.5.rst
@ -137,6 +137,7 @@ Deprecation notices

 The following modules will be removed in Ansible 2.9. Please update update your playbooks accordingly.

+* Apstra's ``aos_*`` modules are deprecated as they do not work with AOS 2.1 or higher. See new modules at `https://github.com/apstra <https://github.com/apstra>`_.
 * :ref:`nxos_ip_interface <nxos_ip_interface>` use :ref:`nxos_l3_interface <nxos_l3_interface>` instead.
 * :ref:`nxos_portchannel <nxos_portchannel>` use :ref:`nxos_linkagg <nxos_linkagg>` instead.
 * :ref:`nxos_switchport <nxos_switchport>` use :ref:`nxos_l2_interface <nxos_l2_interface>` instead.
--- a/lib/ansible/modules/network/aos/_aos_asn_pool.py
+++ b/lib/ansible/modules/network/aos/_aos_asn_pool.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_asn_pool
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage AOS ASN Pool
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Apstra AOS ASN Pool module let you manage your ASN Pool easily. You can create
    and delete ASN Pool by Name, ID or by using a JSON File. This module
--- a/lib/ansible/modules/network/aos/_aos_blueprint.py
+++ b/lib/ansible/modules/network/aos/_aos_blueprint.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_blueprint
 author: jeremy@apstra.com (@jeremyschulman)
 version_added: "2.3"
 short_description: Manage AOS blueprint instance
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
    - Apstra AOS Blueprint module let you manage your Blueprint easily. You can create
      create and delete Blueprint by Name or ID. You can also use it to retrieve
--- a/lib/ansible/modules/network/aos/_aos_blueprint_param.py
+++ b/lib/ansible/modules/network/aos/_aos_blueprint_param.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_blueprint_param
 author: jeremy@apstra.com (@jeremyschulman)
 version_added: "2.3"
 short_description: Manage AOS blueprint parameter values
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
 - Apstra AOS Blueprint Parameter module let you manage your Blueprint Parameter easily.
   You can create access, define and delete Blueprint Parameter. The list of
--- a/lib/ansible/modules/network/aos/_aos_blueprint_virtnet.py
+++ b/lib/ansible/modules/network/aos/_aos_blueprint_virtnet.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_blueprint_virtnet
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage AOS blueprint parameter values
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
 - Apstra AOS Blueprint Virtual Network module let you manage your Virtual Network easily.
   You can create access, define and delete Virtual Network by name or by using a JSON / Yaml file.
--- a/lib/ansible/modules/network/aos/_aos_device.py
+++ b/lib/ansible/modules/network/aos/_aos_device.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_device
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage Devices on AOS Server
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Apstra AOS Device module let you manage your devices in AOS easily. You can
    approve devices and define in which state the device should be. Currently
--- a/lib/ansible/modules/network/aos/_aos_external_router.py
+++ b/lib/ansible/modules/network/aos/_aos_external_router.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_external_router
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage AOS External Router
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Apstra AOS External Router module let you manage your External Router easily. You can create
    create and delete External Router by Name, ID or by using a JSON File. This module
--- a/lib/ansible/modules/network/aos/_aos_ip_pool.py
+++ b/lib/ansible/modules/network/aos/_aos_ip_pool.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_ip_pool
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage AOS IP Pool
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Apstra AOS Ip Pool module let you manage your IP Pool easily. You can create
    create and delete IP Pool by Name, ID or by using a JSON File. This module
--- a/lib/ansible/modules/network/aos/_aos_logical_device.py
+++ b/lib/ansible/modules/network/aos/_aos_logical_device.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_logical_device
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage AOS Logical Device
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Apstra AOS Logical Device module let you manage your Logical Devices easily.
    You can create create and delete Logical Device by Name, ID or by using a JSON File.
--- a/lib/ansible/modules/network/aos/_aos_logical_device_map.py
+++ b/lib/ansible/modules/network/aos/_aos_logical_device_map.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_logical_device_map
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage AOS Logical Device Map
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Apstra AOS Logical Device Map module let you manage your Logical Device Map easily. You can create
    create and delete Logical Device Map by Name, ID or by using a JSON File. This module
--- a/lib/ansible/modules/network/aos/_aos_login.py
+++ b/lib/ansible/modules/network/aos/_aos_login.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_login
 author: jeremy@apstra.com (@jeremyschulman)
 version_added: "2.3"
 short_description: Login to AOS server for session token
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Obtain the AOS server session token by providing the required
    username and password credentials.  Upon successful authentication,
--- a/lib/ansible/modules/network/aos/_aos_rack_type.py
+++ b/lib/ansible/modules/network/aos/_aos_rack_type.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_rack_type
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage AOS Rack Type
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Apstra AOS Rack Type module let you manage your Rack Type easily.
    You can create create and delete Rack Type by Name, ID or by using a JSON File.
--- a/lib/ansible/modules/network/aos/_aos_template.py
+++ b/lib/ansible/modules/network/aos/_aos_template.py
@ -19,7 +19,7 @@
 #

 ANSIBLE_METADATA = {'metadata_version': '1.1',
-                    'status': ['preview'],
+                    'status': ['deprecated'],
                    'supported_by': 'community'}


@ -29,6 +29,10 @@ module: aos_template
 author: Damien Garros (@dgarros)
 version_added: "2.3"
 short_description: Manage AOS Template
+deprecated:
+    removed_in: "2.9"
+    why: This module does not support AOS 2.1 or later
+    alternative: See new modules at U(https://www.ansible.com/ansible-apstra).
 description:
  - Apstra AOS Template module let you manage your Template easily. You can create
    create and delete Template by Name, ID or by using a JSON File. This module