paloaltonetworks.panos.panos_state_snapshot module – Takes a snapshot of a state of a Firewall device.
Note
This module is part of the paloaltonetworks.panos collection (version 3.1.1).
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_state_snapshot.
New in paloaltonetworks.panos 2.18.0
Synopsis
A wrapper around the PAN-OS Upgrade Assurance package.
The module takes a snapshot of a state of specified areas. It runs the package’s CheckFirewall.run_snapshots() method. Since it’s just a wrapper, the way you would configure snapshot area is exactly the same as if you would run the class directly. Please refer to package’s documentation for syntax and configuration dialect.
Requirements
The below requirements are needed on the host that executes this module.
pan-python can be obtained from PyPI https://pypi.python.org/pypi/pan-python
pandevice can be obtained from PyPI https://pypi.python.org/pypi/pandevice
panos-upgrade-assurance can be obtained from PyPI https://pypi.python.org/pypi/panos-upgrade-assurance
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. |
|
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: |
|
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: |
|
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: |
|
A list of Firewall state areas that we should take a snapshot of. For the details on currently supported list please refer to package documentation. In most of the cases it is enough to specify a snapshot name to run it with default settings. In this case the list element is of type str. If additional configuration is required the element is a single element dict, where key is the state snapshot name and value contains the snapshot’s configuration. For information which snapshot requires additional configuration please refer to package documentation. To capture the actual snapshot data use a register. Default: |
|
Deprecated Use provider to specify PAN-OS connectivity instead. The username to use for authentication. This is ignored if api_key is specified. Default: |
|
The vsys this object belongs to. Default: |
Notes
Note
Panorama is not 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.
Examples
- name: Run snapshot of all areas except for session statistics
panos_state_snapshot:
provider: '{{ device }}'
state_areas:
- '!session_stats'
register: snapshot
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
This is a dict where keys are state areas names just as you specify them in the state_areas property. Values contain the snapshot data. Type and structure differs per state area. Please refer to package documentation for details. Returned: always Sample: |