Documentation

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

Parameters

Parameter Choices/Defaults Comments
interval Default:
0
time waited between checks
ip_address
required
IP address (or hostname) of PAN-OS device.
password
required
Password for authentication.
timeout Default:
0
timeout of API calls
username 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 is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

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

Hint

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