community.network.panos_commit – commit firewall’s candidate configuration

From Get docs
Ansible/docs/2.10/collections/community/network/panos commit module


community.network.panos_commit – commit firewall’s candidate configuration

Note

This plugin is part of the community.network collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.panos_commit.


DEPRECATED

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

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

commit_changes_by

list / elements=string

Commit changes made by specified admin

commit_vsys

list / elements=string

Commit changes for specified VSYS

description

string

Commit description/comment

interval

string

Default:

0.5

interval for checking commit job

ip_address

string / required

IP address (or hostname) of PAN-OS device.

password

string / required

Password for authentication. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

sync

boolean

  • no
  • yes

if commit should be synchronous

timeout

string

timeout for commit job

username

string

Default:

"admin"

Username for authentication. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead if defined. admin will be used if nothing above is defined.



Examples

- name: Commit candidate config on 192.168.1.1 in sync mode
  community.network.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

panos_commit

complex

always

Information about commit job.


job_id

string

always

Palo Alto job ID for the commit operation. Only returned if commit job is launched on device.


Sample:

139

status_code

string

always

Palo Alto API status code. Null if commit is successful.


Sample:

19

status_detail

string

always

Palo Alto API detailed status message.


Sample:

Configuration committed successfully

status_text

string

always

Palo Alto API status text.


Sample:

success




Status

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

Authors

  • Luigi Mori (@jtschichold)
  • Ivan Bojer (@ivanbojer)
  • Tomi Raittinen (@traittinen)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/panos_commit_module.html