paloaltonetworks.panos.panos_virtual_router_facts module – Retrieves virtual router information

Note

This module is part of the paloaltonetworks.panos collection (version 2.13.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_virtual_router_facts.

New in paloaltonetworks.panos 1.0.0

DEPRECATED

Removed in:

version 3.0.0

Why:

Updating module design to network resource modules.

Alternative:

Use paloaltonetworks.panos.panos_virtual_router with state=gathered

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

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

string

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

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

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: :ansible-option-default:`"admin"`

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

Description

spec

complex

The spec of the specified virtual router.

Returned: When name is specified.

ad_ebgp

integer

Admin distance for this protocol.

Returned: success

ad_ibgp

integer

Admin distance for this protocol.

Returned: success

ad_ospf_ext

integer

Admin distance for this protocol.

Returned: success

ad_ospf_int

integer

Admin distance for this protocol.

Returned: success

ad_ospfv3_ext

integer

Admin distance for this protocol.

Returned: success

ad_ospfv3_int

integer

Admin distance for this protocol.

Returned: success

ad_rip

integer

Admin distance for this protocol.

Returned: success

ad_static

integer

Admin distance for this protocol.

Returned: success

ad_static_ipv6

integer

Admin distance for this protocol.

Returned: success

interface

list / elements=string

List of interfaces

Returned: success

name

string

Virtual router name.

Returned: success

vrlist

list / elements=string

List of virtual router specs.

Returned: When name is not specified.

Status

  • This module will be removed in version 3.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Garfield Lee Freeman (@shinmog)