paloaltonetworks.panos.panos_readiness_checks module – Runs readiness checks (boolean in nature) against a Firewall device.
Note
This module is part of the paloaltonetworks.panos collection (version 2.19.1).
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_readiness_checks.
New in paloaltonetworks.panos 2.18.0
Synopsis
A wrapper around the PAN-OS Upgrade Assurance package.
The module is meant to run readiness checks available in the package’s CheckFirewall.run_readiness_checks() method. Since it’s just a wrapper, the way you would configure a check 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.org/project/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. |
|
A list of checks that should be run against a device. For the details on currently supported checks please refer to package’s documentation. In most of the cases it is enough to specify a check 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 one element dict, where key is the check name and value contains the check’s configuration. For information which check requires additional configuration please refer to package documentation. Default: :ansible-option-default:`["all"]` |
|
When set to true will make the module fail when at least one of the checks did not pass. Choices: |
|
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"` |
|
When set to true will skip the en_US.UTF-8 locales on the checks. Use with caution only when you actually use different, English based locales but you do not have en_US.UTF-8 installed. Choices: |
|
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"` |
|
The vsys this object belongs to. Default: :ansible-option-default:`"vsys1"` |
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 all management plane checks using NOT notation
panos_readiness_checks:
provider: '{{ device }}'
checks:
- '!ha'
- '!session_exist'
- '!arp_entry_exist'
- '!ip_sec_tunnel_status'
- name: Check if a specified session exists in vsys2, fail if it does not
panos_readiness_checks:
provider: '{{ device }}'
vsys: vsys2
force_fail: true
checks:
- session_exist:
source: '34.23.15.1'
destination: '10.1.0.4'
dest_port: '80'
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 checks names just as you specify them in the checks property. Each value is also a dict. WHen force_fail has the default value of false this dict contains results for all checks that were specified in checks property. When force_fail is set to true it contains only checks that failed. Returned: always |
|
A free text describing the check result. Prefixed with a keyword: SUCCESS, FAIL, ERROR, SKIPPED. Meaningful only for failed tests as the ones succeeded are self explanatory. Returned: always |
|
A result of a check. Returned: always |