cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Deprecating panos modules; pointing to Galaxy role (#52355)

Browse source 
* Deprecating panos modules; pointing to Galaxy role

* Updating porting guide; deprecating panos_set

* Changing 2.11 to 2.12
This commit is contained in:
Garfield Lee Freeman 2019-02-22 11:41:40 -08:00 committed by Nathaniel Case
parent 4e6ca4b21b
commit fb97204291
23 changed files with 197 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/docsite/rst/porting_guides/porting_guide_2.8.rst
View file

@ -144,6 +144,7 @@ The following modules will be removed in Ansible 2.12. Please update your playbo
* ``github_hooks`` use :ref:`github_webhook <github_webhook_module>` and :ref:`github_webhook_facts <github_webhook_facts_module>` instead.
* ``digital_ocean`` use :ref `digital_ocean_droplet <digital_ocean_droplet_module>` instead.
* ``gce`` use :ref `gce_compute_instance <gce_compute_instance_module>` instead.
* ``panos`` use `Ansible Galaxy role <https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks>`_ instead.
Noteworthy module changes
@ -199,6 +200,10 @@ Noteworthy module changes
* ``vmware_vm_facts`` used to return dict of dict with virtual machine's facts. Ansible 2.8 and onwards will return list of dict with virtual machine's facts.
Please see module ``vmware_vm_facts`` documentation for example.
* The ``panos`` modules have been deprecated in favor of using the Palo Alto Networks `Ansible Galaxy role
<https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks>`_. Contributions to the role can be made
`here <https://github.com/PaloAltoNetworks/ansible-pan>`_.
Plugins
=======

6
lib/ansible/modules/network/panos/panos_admin.py → lib/ansible/modules/network/panos/_panos_admin.py
View file

@ -20,7 +20,7 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -35,6 +35,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
admin_username:
description:

6
lib/ansible/modules/network/panos/panos_admpwd.py → lib/ansible/modules/network/panos/_panos_admpwd.py
View file

@ -30,6 +30,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- paramiko
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
ip_address:
description:
@ -74,7 +78,7 @@ status:
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

6
lib/ansible/modules/network/panos/panos_cert_gen_ssh.py → lib/ansible/modules/network/panos/_panos_cert_gen_ssh.py
View file

@ -30,6 +30,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- paramiko
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is not supported.
options:
@ -79,7 +83,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

10
lib/ansible/modules/network/panos/panos_check.py → lib/ansible/modules/network/panos/_panos_check.py
View file

@ -30,17 +30,21 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
timeout:
description:
- timeout of API calls
required: false
default: "0"
default: 0
interval:
description:
- time waited between checks
required: false
default: "0"
default: 0
extends_documentation_fragment: panos
'''
@ -68,7 +72,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

6
lib/ansible/modules/network/panos/panos_commit.py → lib/ansible/modules/network/panos/_panos_commit.py
View file

@ -34,6 +34,10 @@ author:
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
ip_address:
description:
@ -119,7 +123,7 @@ panos_commit:
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

6
lib/ansible/modules/network/panos/panos_dag.py → lib/ansible/modules/network/panos/_panos_dag.py
View file

@ -29,6 +29,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
dag_name:
description:
@ -60,7 +64,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

6
lib/ansible/modules/network/panos/panos_dag_tags.py → lib/ansible/modules/network/panos/_panos_dag_tags.py
View file

@ -21,7 +21,7 @@
# limitations under the License.
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
DOCUMENTATION = '''
@ -35,6 +35,10 @@ version_added: "2.5"
requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
- pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is not supported.
- Panorama is not supported.

6
lib/ansible/modules/network/panos/panos_import.py → lib/ansible/modules/network/panos/_panos_import.py
View file

@ -34,6 +34,10 @@ requirements:
- pan-python
- requests
- requests_toolbelt
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
category:
description:
@ -71,7 +75,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

6
lib/ansible/modules/network/panos/panos_interface.py → lib/ansible/modules/network/panos/_panos_interface.py
View file

@ -20,7 +20,7 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -34,6 +34,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is not supported.
options:

6
lib/ansible/modules/network/panos/panos_lic.py → lib/ansible/modules/network/panos/_panos_lic.py
View file

@ -31,6 +31,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
auth_code:
description:
@ -70,7 +74,7 @@ serialnumber:
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

6
lib/ansible/modules/network/panos/panos_loadcfg.py → lib/ansible/modules/network/panos/_panos_loadcfg.py
View file

@ -29,6 +29,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
file:
description:
@ -62,7 +66,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

11
lib/ansible/modules/network/panos/panos_match_rule.py → lib/ansible/modules/network/panos/_panos_match_rule.py
View file

@ -21,7 +21,7 @@
# limitations under the License.
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
DOCUMENTATION = '''
@ -35,6 +35,10 @@ version_added: "2.5"
requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
- pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is not supported.
- Panorama NOT is supported.
@ -57,7 +61,10 @@ options:
rule_type:
description:
- Type of rule. Valid types are I(security) or I(nat).
default: "security"
required: true
choices:
- security
- nat
source_zone:
description:
- The source zone.

6
lib/ansible/modules/network/panos/panos_mgtconfig.py → lib/ansible/modules/network/panos/_panos_mgtconfig.py
View file

@ -29,6 +29,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
dns_server_primary:
description:
@ -66,7 +70,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

34
lib/ansible/modules/network/panos/panos_nat_rule.py → lib/ansible/modules/network/panos/_panos_nat_rule.py
View file

@ -19,6 +19,10 @@ version_added: "2.4"
requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
- pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is not supported.
- Panorama is supported.
@ -41,10 +45,22 @@ options:
operation:
description:
- The action to be taken. Supported values are I(add)/I(update)/I(find)/I(delete).
required: true
choices:
- add
- update
- delete
- find
devicegroup:
description:
- If Panorama, the device group to put this rule in.
rule_name:
description:
- name of the SNAT rule
required: true
description:
description:
- The description
source_zone:
description:
- list of source zones
@ -68,10 +84,17 @@ options:
snat_type:
description:
- type of source translation
choices:
- static-ip
- dynamic-ip-and-port
- dynamic-ip
snat_address_type:
description:
- type of source translation. Supported values are I(translated-address)/I(translated-address).
default: 'translated-address'
default: 'interface-address'
choices:
- interface-address
- translated-address
snat_static_address:
description:
- Source NAT translated address. Used with Static-IP translation.
@ -95,6 +118,13 @@ options:
dnat_port:
description:
- dnat translated port
tag_name:
description:
- Tag for the NAT rule.
to_interface:
description:
- Destination interface.
default: 'any'
commit:
description:
- Commit configuration if changed.
@ -126,7 +156,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
# import pydevd

36
lib/ansible/modules/network/panos/panos_object.py → lib/ansible/modules/network/panos/_panos_object.py
View file

@ -21,7 +21,7 @@
# limitations under the License.
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
DOCUMENTATION = '''
@ -36,6 +36,10 @@ version_added: "2.4"
requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
- pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is not supported.
- Panorama is supported.
@ -59,6 +63,11 @@ options:
description:
- The operation to be performed. Supported values are I(add)/I(delete)/I(find).
required: true
choices:
- add
- update
- delete
- find
addressobject:
description:
- The name of the address object.
@ -68,6 +77,11 @@ options:
address_type:
description:
- The type of address object definition. Valid types are I(ip-netmask) and I(ip-range).
default: 'ip-netmask'
choices:
- ip-netmask
- ip-range
- fqdn
addressgroup:
description:
- A static group of address objects or dynamic address group.
@ -89,6 +103,9 @@ options:
protocol:
description:
- The IP protocol to be used in a service object definition. Valid values are I(tcp) or I(udp).
choices:
- tcp
- udp
servicegroup:
description:
- A group of service objects.
@ -105,6 +122,23 @@ options:
description: >
- The color of the tag object. Valid values are I(red, green, blue, yellow, copper, orange, purple, gray,
light green, cyan, light gray, blue gray, lime, black, gold, and brown).
choices:
- red
- green
- blue
- yellow
- copper
- orange
- purple
- gray
- light green
- cyan
- light gray
- blue gray
- lime
- black
- gold
- brown
devicegroup:
description: >
- The name of the Panorama device group. The group must exist on Panorama. If device group is not defined it

6
lib/ansible/modules/network/panos/panos_op.py → lib/ansible/modules/network/panos/_panos_op.py
View file

@ -20,7 +20,7 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
DOCUMENTATION = '''
@ -33,6 +33,10 @@ version_added: "2.5"
requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
- pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is NOT supported.
- Panorama is NOT supported.

6
lib/ansible/modules/network/panos/panos_pg.py → lib/ansible/modules/network/panos/_panos_pg.py
View file

@ -29,6 +29,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
pg_name:
description:
@ -80,7 +84,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

9
lib/ansible/modules/network/panos/panos_query_rules.py → lib/ansible/modules/network/panos/_panos_query_rules.py
View file

@ -21,7 +21,7 @@
# limitations under the License.
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
DOCUMENTATION = '''
@ -38,6 +38,10 @@ requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
- pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)
- xmltodict can be obtains from PyPI U(https://pypi.org/project/xmltodict/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is not supported.
- Panorama is supported.
@ -81,6 +85,9 @@ options:
protocol:
description:
- The protocol used to be queried. Must be either I(tcp) or I(udp).
choices:
- tcp
- udp
tag_name:
description:
- Name of the rule tag to be queried.

6
lib/ansible/modules/network/panos/panos_restart.py → lib/ansible/modules/network/panos/_panos_restart.py
View file

@ -29,6 +29,10 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
version_added: "2.3"
requirements:
- pan-python
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
extends_documentation_fragment: panos
'''
@ -48,7 +52,7 @@ status:
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}

14
lib/ansible/modules/network/panos/panos_sag.py → lib/ansible/modules/network/panos/_panos_sag.py
View file

@ -31,6 +31,10 @@ requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
- pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)
- xmltodict can be obtained from PyPI U(https://pypi.org/project/xmltodict/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
options:
api_key:
description:
@ -39,10 +43,10 @@ options:
description:
- name of the dynamic address group
required: true
static_match_filter:
sag_match_filter:
description:
- Static filter user by the address group
required: true
type: list
devicegroup:
description: >
- The name of the Panorama device group. The group must exist on Panorama. If device group is not defined
@ -62,6 +66,10 @@ options:
description:
- The operation to perform Supported values are I(add)/I(list)/I(delete).
required: true
choices:
- add
- list
- delete
extends_documentation_fragment: panos
'''
@ -81,7 +89,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
from ansible.module_utils.basic import AnsibleModule

16
lib/ansible/modules/network/panos/panos_security_rule.py → lib/ansible/modules/network/panos/_panos_security_rule.py
View file

@ -8,7 +8,7 @@ __metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -26,6 +26,10 @@ requirements:
- pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
- pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)
- xmltodict can be obtained from PyPI U(https://pypi.org/project/xmltodict/)
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
notes:
- Checkmode is not supported.
- Panorama is supported.
@ -49,6 +53,16 @@ options:
description:
- The action to be taken. Supported values are I(add)/I(update)/I(find)/I(delete).
default: 'add'
choices:
- add
- update
- delete
- find
category:
description:
- The category.
type: list
default: ['any']
rule_name:
description:
- Name of the security rule.

6
lib/ansible/modules/network/panos/panos_set.py → lib/ansible/modules/network/panos/_panos_set.py
View file

@ -41,6 +41,10 @@ description:
- The 'element' is "<timezone>Australia/Melbourne</timezone>"
author: "Jasper Mackenzie (@spmp)"
version_added: "2.7"
deprecated:
alternative: Use U(https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks) instead.
removed_in: "2.12"
why: Consolidating code base.
requirements:
- pan-python
options:
@ -99,7 +103,7 @@ RETURN = '''
'''
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
from ansible.module_utils.basic import AnsibleModule