paloaltonetworks.panos.panos_commit_push module – Push running configuration to managed devices.
Note
This module is part of the paloaltonetworks.panos collection (version 2.17.5).
To install it, use: ansible-galaxy collection install paloaltonetworks.panos
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: paloaltonetworks.panos.panos_commit_push
.
New in paloaltonetworks.panos 2.0.0
Synopsis
Module that will push the running Panorama configuration to managed devices.
The new configuration will become active immediately.
Requirements
The below requirements are needed on the host that executes this module.
pan-os-python
Parameters
Parameter |
Comments |
---|---|
Push the configuration made by a specific administrator. (PAN-OS 10.2+) |
|
A description of the commit. |
|
Push the configuration to specific device serial numbers. |
|
Force template values to override local settings. Choices: |
|
Include device group reference templates. Choices: |
|
The name of the configuration element to push. |
|
A dict object containing connection details. |
|
The API key to use instead of generating it using username / password. |
|
The IP address or hostname of the PAN-OS device being configured. |
|
The password to use for authentication. This is ignored if api_key is specified. |
|
The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443` |
|
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. |
|
The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"` |
|
The type of configuration element to push. Choices: |
|
Wait for the commit to complete. Choices: |
Examples
- name: push device group configs
panos_commit_push:
provider: '{{ credentials }}'
style: 'device group'
name: 'Internet Edge Firewalls'
description: 'Update ECMP routing'
- name: push template configs and force values
panos_commit_push:
provider: '{{ credentials }}'
style: 'template'
name: 'APAC Regional Template'
force_template_values: True
- name: push log collector group configs
panos_commit_push:
provider: '{{ credentials }}'
style: 'log collector group'
name: 'LatAm Collector Group'
- name: push to multiple devices
panos_commit_push:
provider: '{{ credentials }}'
style: 'device group'
name: 'Partner DMZ Firewalls'
devices:
- 0001234567890
- 0987654321000
- 1001001F0F000
- name: push to multiple device groups
panos_commit_push:
provider: '{{ credentials }}'
style: 'device group'
name: '{{ item }}'
sync: False
loop:
- Production Firewalls
- Staging Firewalls
- Development Firewalls
- name: push admin-specific changes to a device group
panos_commit_push:
provider: "{{ credentials }}"
style: 'device group'
name: 'EMEA_Device_Group'
admins:
- 'ansible-admin'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|