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 |
---|---|
Deprecated Use provider to specify PAN-OS connectivity instead. The API key to use instead of generating it using username / password. |
|
Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured. |
|
Name of the virtual router. |
|
Deprecated Use provider to specify PAN-OS connectivity instead. The password to use for authentication. This is ignored if api_key is specified. |
|
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` |
|
A dict object containing connection details. |
|
The API key to use instead of generating it using username / password. |
|
The IP address or hostname of the PAN-OS device being configured. |
|
The password to use for authentication. This is ignored if api_key is specified. |
|
The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443` |
|
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. |
|
The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"` |
|
(Panorama only) The template this operation should target. Mutually exclusive with template_stack. |
|
(Panorama only) The template stack this operation should target. Mutually exclusive with template. |
|
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 |
---|---|
The spec of the specified virtual router. Returned: When name is specified. |
|
Admin distance for this protocol. Returned: success |
|
Admin distance for this protocol. Returned: success |
|
Admin distance for this protocol. Returned: success |
|
Admin distance for this protocol. Returned: success |
|
Admin distance for this protocol. Returned: success |
|
Admin distance for this protocol. Returned: success |
|
Admin distance for this protocol. Returned: success |
|
Admin distance for this protocol. Returned: success |
|
Admin distance for this protocol. Returned: success |
|
List of interfaces Returned: success |
|
Virtual router name. Returned: success |
|
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.