panos_check – check if PAN-OS device is ready for configuration¶
New in version 2.3.
Synopsis¶
Check if PAN-OS device is ready for being configured (no pending jobs).
The check could be done once or multiple times until the device is ready.
Requirements¶
The below requirements are needed on the host that executes this module.
pan-python
pandevice
Parameters¶
Parameter | Choices/Defaults | 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.
|
||
initial_delay
integer
|
Default: 0
|
Length of time (in seconds) to wait before doing any readiness checks.
|
|
interval
integer
|
Default: 0
|
Length of time (in seconds) to wait between checks.
|
|
ip_address
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
|
||
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
|
Default: 443
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The port number to connect to the PAN-OS device on.
|
|
provider
-
added in 2.8 |
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
|
Default: 443
|
The port number to connect to the PAN-OS device on.
|
|
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
|
Default: admin
|
The username to use for authentication. This is ignored if api_key is specified.
|
|
timeout
integer
|
Default: 60
|
Length of time (in seconds) to wait for jobs to finish.
|
|
username
string
|
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.
|
Notes¶
Note
Panorama is supported.
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¶
# Single check.
- name: check if ready
panos_check:
provider: '{{ provider }}'
timeout: 0
# Wait 2 minutes, then check every 5 seconds for 10 minutes.
- name: wait for reboot
panos_check:
provider: '{{ provider }}'
initial_delay: 120
interval: 5
timeout: 600
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community.
Authors¶
Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)