panos_gre_tunnel – Create GRE tunnels on PAN-OS devices

New in version 2.9.

Synopsis

  • NOTE: The modules in this role are deprecated in favour of the modules in the collection https://paloaltonetworks.github.io/pan-os-ansible

  • Create GRE tunnel objects on PAN-OS devices.

Requirements

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

Parameters

Parameter Choices/Defaults 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
    Choices:
  • no
  • yes
Copy IP TOS bits from inner packet to GRE packet.
disabled
boolean
    Choices:
  • no
  • yes
Disable the GRE tunnel.
enable_keep_alive
boolean
    Choices:
  • no
  • yes
Enable tunnel monitoring.
interface
-
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
Default:
5
Keep alive hold timer.
keep_alive_interval
integer
Default:
10
Keep alive interval.
keep_alive_retry
integer
Default:
3
Keep alive retry time.
local_address_type
-
    Choices:
  • ip ←
  • floating-ip
Type of local address.
local_address_value
-
IP address value.
name
- / required
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
-
Peer IP address.
port
integer
Default:
443
Deprecated
Use provider to specify PAN-OS connectivity instead.
The port number to connect to the PAN-OS device on.
provider
-
added in 2.8
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
Default:
443
The port number to connect to the PAN-OS device on.
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
Default:
"admin"
The username to use for authentication. This is ignored if api_key is specified.
state
string
    Choices:
  • present ←
  • absent
The state.
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
Default:
64
TTL.
tunnel_interface
-
To apply GRE tunnels to tunnel interface.
username
string
Default:
"admin"
Deprecated
Use provider to specify PAN-OS connectivity instead.
The username to use for authentication. This is ignored if api_key is specified.

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
  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

Status

Authors

  • Garfield Lee Freeman (@shinmog)