Documentation

panos_commit - commit firewall’s candidate configuration

New in version 2.3.

Synopsis

  • PanOS module that will commit firewall’s candidate configuration on
  • the device. The new configuration will become active immediately.

Requirements

The below requirements are needed on the host that executes this module.

  • pan-python

Parameters

Parameter Choices/Defaults Comments
interval Default:
0.5
interval for checking commit job
ip_address
required
IP address (or hostname) of PAN-OS device.
password
required
Password for authentication.
sync
    Choices:
  • no
  • yes ←
if commit should be synchronous
timeout
timeout for commit job
username Default:
admin
Username for authentication.

Examples

# Commit candidate config on 192.168.1.1 in sync mode
- panos_commit:
    ip_address: "192.168.1.1"
    username: "admin"
    password: "admin"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
status
string
 success
success status

Sample:
okey dokey


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

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

Hint

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