paloaltonetworks.panos.panos_gre_tunnel module – Manage GRE tunnels on PAN-OS devices.

Note

This module is part of the paloaltonetworks.panos collection (version 2.21.2).

To install it, use: ansible-galaxy collection install paloaltonetworks.panos. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: paloaltonetworks.panos.panos_gre_tunnel.

New in paloaltonetworks.panos 1.0.0

Synopsis

• Manage GRE tunnel objects on PAN-OS devices.

Requirements

The below requirements are needed on the host that executes this module.

• pan-python can be obtained from PyPI https://pypi.python.org/pypi/pan-python

• pandevice can be obtained from PyPI https://pypi.python.org/pypi/pandevice

Parameters

Parameter	Comments
api_key string	Deprecated Use provider to specify PAN-OS connectivity instead. The API key to use instead of generating it using username / password.
copy_tos boolean	Copy IP TOS bits from inner packet to GRE packet. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
disabled boolean	Disable the GRE tunnel. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enable_keep_alive boolean	Enable tunnel monitoring. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
gathered_filter string	When state=gathered. An advanced filtering option to filter results returned from PAN-OS. Refer to the guide discussing gathered_filter for more information.
interface string	Interface to terminate the tunnel.
ip_address string	Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured.
keep_alive_hold_timer integer	Keep alive hold timer. Default: :ansible-option-default:`5`
keep_alive_interval integer	Keep alive interval. Default: :ansible-option-default:`10`
keep_alive_retry integer	Keep alive retry time. Default: :ansible-option-default:`3`
local_address_type string	Type of local address. Choices: :ansible-option-choices-entry-default:`"ip"` ← (default) :ansible-option-choices-entry:`"floating-ip"`
local_address_value string	IP address value.
name string	Name of object to create.
password string	Deprecated Use provider to specify PAN-OS connectivity instead. The password to use for authentication. This is ignored if api_key is specified.
peer_address string	Peer IP address.
port integer	Deprecated Use provider to specify PAN-OS connectivity instead. The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
provider dictionary added in paloaltonetworks.panos 1.0.0	A dict object containing connection details.
api_key string	The API key to use instead of generating it using username / password.
ip_address string	The IP address or hostname of the PAN-OS device being configured.
password string	The password to use for authentication. This is ignored if api_key is specified.
port integer	The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
serial_number string	The serial number of a firewall to use for targeted commands. If ip_address is not a Panorama PAN-OS device, then this param is ignored.
username string	The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
state string	The state. Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry:`"replaced"` :ansible-option-choices-entry:`"merged"` :ansible-option-choices-entry:`"deleted"` :ansible-option-choices-entry:`"gathered"`
template string	(Panorama only) The template this operation should target. Mutually exclusive with template_stack.
template_stack string	(Panorama only) The template stack this operation should target. Mutually exclusive with template.
ttl integer	TTL. Default: :ansible-option-default:`64`
tunnel_interface string	To apply GRE tunnels to tunnel interface.
username string	Deprecated Use provider to specify PAN-OS connectivity instead. The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`

Notes

Note

• Minimum PAN-OS version: 9.0

• Panorama is supported.

• Check mode is supported.

• PAN-OS connectivity should be specified using provider or the classic PAN-OS connectivity params (ip_address, username, password, api_key, and port). If both are present, then the classic params are ignored.

• If the PAN-OS to be configured is Panorama, either template or template_stack must be specified.

Examples

- name: Create GRE tunnel
  paloaltonetworks.panos.panos_gre_tunnel:
    provider: '{{ provider }}'
    name: 'myGreTunnel'
    interface: 'ethernet1/5'
    local_address_value: '10.1.1.1/24'
    peer_address: '192.168.1.1'
    tunnel_interface: 'tunnel.7'
    ttl: 42

Authors

• Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)