panos_virtual_router_facts – Retrieves virtual router information

New in version 2.8.

Synopsis

  • Retrieves information on virtual routers from a firewall or Panorama.

Requirements

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

  • pan-python

  • pandevice

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.
ip_address
string
Deprecated
Use provider to specify PAN-OS connectivity instead.

The IP address or hostname of the PAN-OS device being configured.
name
-
Name of the virtual router.
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
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.
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
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

  • Panorama is supported.

  • Check mode is not 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

# Get information on a specific virtual router
- name: Get vr3 info
  panos_virtual_router_facts:
    provider: '{{ provider }}'
    name: 'vr3'
  register: ans

# Get the config of all virtual routers
- name: Get all virtual routers
  panos_virtual_router_facts:
    provider: '{{ provider }}'
  register: vrlist

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
spec
complex
When name is specified.
The spec of the specified virtual router.

  ad_ebgp
integer
Admin distance for this protocol.

  ad_ibgp
integer
Admin distance for this protocol.

  ad_ospf_ext
integer
Admin distance for this protocol.

  ad_ospf_int
integer
Admin distance for this protocol.

  ad_ospfv3_ext
integer
Admin distance for this protocol.

  ad_ospfv3_int
integer
Admin distance for this protocol.

  ad_rip
integer
Admin distance for this protocol.

  ad_static
integer
Admin distance for this protocol.

  ad_static_ipv6
integer
Admin distance for this protocol.

  interface
list
List of interfaces

  name
-
Virtual router name.

vrlist
list
When name is not specified.
List of virtual router specs.



Status

Authors

  • Garfield Lee Freeman (@shinmog)