paloaltonetworks.panos.panos_facts module – Collects facts from PAN-OS devices
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_facts.
New in paloaltonetworks.panos 1.0.0
Synopsis
Collects fact information from Palo Alto Networks firewalls and Panorama.
Requirements
The below requirements are needed on the host that executes this module.
pan-python
Parameters
Parameter |
Comments |
|---|---|
Deprecated Use provider to specify PAN-OS connectivity instead. The API key to use instead of generating it using username / password. |
|
Scopes what information is gathered from the device. Possible values for this argument include all, system, session, interfaces, ha, routing, vr, vsys and config. You can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. Panorama only supports the system, ha, and config subsets. |
|
Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured. |
|
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"` |
|
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
Checkmode 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.
Examples
# Gather facts
- name: Get facts
panos_facts:
provider: '{{ provider }}'
gather_subset: ['config']
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Device confiration in XML format. Returned: When |
|
Specifies whether full commit is required to apply changes. Returned: When |
|
Specifies whether HA is enabled or not. Returned: When |
|
Specifies the HA mode on local node. Returned: When |
|
Specifies the HA state on local node. Returned: When |
|
Hostname of the local node. Returned: When |
|
Network interface information. Returned: When |
|
Interface description/comment. Returned: success |
|
List of interface IP addresses in CIDR format. Returned: success |
|
List of interface IPv6 addresses in CIDR format. Returned: success |
|
Current kb/s throughput. Returned: When |
|
Device model of the local node. Returned: When |
|
Specifies whether multivsys mode is enabled on local node. Returned: When |
|
Current packets/s throughput. Returned: When |
|
Routing Table information. Returned: When |
|
Age of the route entry in the routing table. Returned: success |
|
IP prefix of the destination. Returned: success |
|
Flags for the route entry in the routing table. Returned: success |
|
Egress interface the router will use to reach the next hop. Returned: success |
|
Metric for the route. Returned: success |
|
Address of the device at the next hop toward the destination network. Returned: success |
|
Unicast or multicast route table. Returned: success |
|
Virtual router the route belongs to. Returned: success |
|
Serial number of the local node. Returned: When |
|
Maximum number of sessions on local node. Returned: When |
|
Current number of active sessions on local node Returned: When |
|
Specifies if commit is required to apply changes. Returned: When |
|
Uptime of the local node. Returned: When |
|
PanOS version of the local node. Returned: When |
|
Virtual Router information. Returned: When |
|
List interfaces in the VR. Returned: success |
|
Name of the virtual router. Returned: success |
|
Virtual System information. Returned: When |
|
Number of active sessions on VSYS. Returned: success |
|
VSYS description/name. Returned: success |
|
VSYS ID. Returned: success |
|
List of interfaces attached to the VSYS. Returned: success |
|
List of virtual routers attached to the VSYS. Returned: success |
|
Number of configured maximum sessions on VSYS. 0 for unlimited. Returned: success |
|
List of security zones attached to the VSYS. Returned: success |