Documentation

panos_check – check if PAN-OS device is ready for configuration

New in version 2.3.

DEPRECATED

Removed in Ansible:
 version: 2.12
Why:Consolidating code base.
Alternative:Use https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks instead.

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

Parameters

Parameter Choices/Defaults Comments
interval
-
Default:
0
time waited between checks
ip_address
string / required
IP address (or hostname) of PAN-OS device.
password
string / required
Password for authentication.
timeout
-
Default:
0
timeout of API calls
username
string
Default:
"admin"
Username for authentication.

Examples

# single check on 192.168.1.1 with credentials admin/admin
- name: check if ready
  panos_check:
    ip_address: "192.168.1.1"
    password: "admin"

# check for 10 times, every 30 seconds, if device 192.168.1.1
# is ready, using credentials admin/admin
- name: wait for reboot
  panos_check:
    ip_address: "192.168.1.1"
    password: "admin"
  register: result
  until: result is not failed
  retries: 10
  delay: 30

Status

  • This module will be removed in version 2.12. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)

Hint

If you notice any issues in this documentation you can edit this document to improve it.