paloaltonetworks.panos.panos_logical_router_vrf_static_route module – Manage logical router static routes

Note

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

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in paloaltonetworks.panos 3.3.0

Synopsis

  • Manage PANOS Logical Routers Static Routes.

Requirements

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

Parameters

Parameter

Comments

admin_dist

string

Administrative distance

api_key

string

Deprecated

Use provider to specify PAN-OS connectivity instead.

The API key to use instead of generating it using username / password.

bfd_profile

string

Name of the BRD profile

commit

boolean

Deprecated

Please use paloaltonetworks.panos.panos_commit_firewall, paloaltonetworks.panos.panos_commit_panorama, paloaltonetworks.panos.panos_commit_push instead.

Commit changes after creating object. If ip_address is a Panorama device, and device_group or template are also set, perform a commit to Panorama and a commit-all to the device group/template.

Choices:

  • false

  • true

destination

string

Destination network

enable_path_monitor

boolean

Enable Path Monitor

Choices:

  • false

  • true

failure_condition

string

Path Monitor failure condition set ‘any’ or ‘all’

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

Next hop interface

ip_address

string

Deprecated

Use provider to specify PAN-OS connectivity instead.

The IP address or hostname of the PAN-OS device being configured.

logical_router

string / required

The parent logical router

metric

integer

Metric

Default: 10

name

string

Static route name

nexthop

string

Next hop IP address or Next VR Name

nexthop_type

string

ip-address, discard, or next-vr

Choices:

  • "ip-address"

  • "discard"

  • "next-lr"

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.

port

integer

Deprecated

Use provider to specify PAN-OS connectivity instead.

The port number to connect to the PAN-OS device on.

Default: 443

preemptive_hold_time

integer

Path Monitor Preemptive Hold Time in minutes

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: 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: "admin"

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

  • "replaced"

  • "merged"

  • "deleted"

  • "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.

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: "admin"

vrf_name

string / required

The parent VRF to insert the route into

Notes

Note

  • Checkmode is supported.

  • Panorama 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 Logical Router
  paloaltonetworks.panos.panos_logical_router_vrf_static_route:
    provider: '{{ provider }}'
    name: lr-1
    commit: true
    destination: 1.1.1.1/32
    nexthop: 192.168.10.1
    nexthop_type: ip-address

Authors

  • Adam Baumeister (@abaumeister)