feat(panos_virtual_router_facts): Module is deprecated

PaloAltoNetworks · Aug 1, 2022 · 01306b5 · 01306b5
1 parent ea71428
commit 01306b5
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 0 deletions.
diff --git a/plugins/modules/panos_virtual_router_facts.py b/plugins/modules/panos_virtual_router_facts.py
@@ -27,6 +27,10 @@
     - Retrieves information on virtual routers from a firewall or Panorama.
 author: "Garfield Lee Freeman (@shinmog)"
 version_added: '1.0.0'
+deprecated:
+    alternative: Use M(panos_virtual_router) with I(state=gathered)
+    removed_in: '3.0.0'
+    why: Updating module design to network resource modules.
 requirements:
     - pan-python
     - pandevice
@@ -134,6 +138,12 @@ def main():
         required_one_of=helper.required_one_of,
     )
 
+    module.deprecate(
+        "Deprecated; use panos_virtual_router with state=gathered",
+        version="3.0.0",
+        collection_name="paloaltonetworks.panos",
+    )
+
     # Verify imports, build pandevice object tree.
     parent = helper.get_pandevice_parent(module)
 

diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt
@@ -123,6 +123,8 @@ plugins/modules/panos_tunnel.py validate-modules:missing-gplv3-license
 plugins/modules/panos_type_cmd.py validate-modules:missing-gplv3-license
 plugins/modules/panos_userid.py validate-modules:missing-gplv3-license
 plugins/modules/panos_virtual_router.py validate-modules:missing-gplv3-license
+plugins/modules/panos_virtual_router_facts.py validate-modules:deprecation-mismatch
+plugins/modules/panos_virtual_router_facts.py validate-modules:invalid-documentation
 plugins/modules/panos_virtual_router_facts.py validate-modules:missing-gplv3-license
 plugins/modules/panos_virtual_wire.py validate-modules:missing-gplv3-license
 plugins/modules/panos_vlan.py validate-modules:missing-gplv3-license

diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt
@@ -123,6 +123,8 @@ plugins/modules/panos_tunnel.py validate-modules:missing-gplv3-license
 plugins/modules/panos_type_cmd.py validate-modules:missing-gplv3-license
 plugins/modules/panos_userid.py validate-modules:missing-gplv3-license
 plugins/modules/panos_virtual_router.py validate-modules:missing-gplv3-license
+plugins/modules/panos_virtual_router_facts.py validate-modules:deprecation-mismatch
+plugins/modules/panos_virtual_router_facts.py validate-modules:invalid-documentation
 plugins/modules/panos_virtual_router_facts.py validate-modules:missing-gplv3-license
 plugins/modules/panos_virtual_wire.py validate-modules:missing-gplv3-license
 plugins/modules/panos_vlan.py validate-modules:missing-gplv3-license

diff --git a/tests/sanity/ignore-2.12.txt b/tests/sanity/ignore-2.12.txt
@@ -123,6 +123,8 @@ plugins/modules/panos_tunnel.py validate-modules:missing-gplv3-license
 plugins/modules/panos_type_cmd.py validate-modules:missing-gplv3-license
 plugins/modules/panos_userid.py validate-modules:missing-gplv3-license
 plugins/modules/panos_virtual_router.py validate-modules:missing-gplv3-license
+plugins/modules/panos_virtual_router_facts.py validate-modules:deprecation-mismatch
+plugins/modules/panos_virtual_router_facts.py validate-modules:invalid-documentation
 plugins/modules/panos_virtual_router_facts.py validate-modules:missing-gplv3-license
 plugins/modules/panos_virtual_wire.py validate-modules:missing-gplv3-license
 plugins/modules/panos_vlan.py validate-modules:missing-gplv3-license

diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt
@@ -124,6 +124,8 @@ plugins/modules/panos_type_cmd.py validate-modules:missing-gplv3-license
 plugins/modules/panos_userid.py validate-modules:missing-gplv3-license
 plugins/modules/panos_virtual_router.py validate-modules:missing-gplv3-license
 plugins/modules/panos_virtual_router_facts.py validate-modules:missing-gplv3-license
+plugins/modules/panos_virtual_router_facts.py validate-modules:deprecation-mismatch
+plugins/modules/panos_virtual_router_facts.py validate-modules:invalid-documentation
 plugins/modules/panos_virtual_wire.py validate-modules:missing-gplv3-license
 plugins/modules/panos_vlan.py validate-modules:missing-gplv3-license
 plugins/modules/panos_vlan_interface.py validate-modules:missing-gplv3-license