paloaltonetworks.panos.panos_commit_push (2.19.1) — module

Install collection

Install with ansible-galaxy collection install paloaltonetworks.panos:==2.19.1

Add to requirements.yml

  collections:
    - name: paloaltonetworks.panos
      version: 2.19.1

Description

Module that will push the running Panorama configuration to managed devices.

The new configuration will become active immediately.

Requirements

• pan-os-python

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: push device group configs
  paloaltonetworks.panos.panos_commit_push:
    provider: '{{ credentials }}'
    style: 'device group'
    name: 'Internet Edge Firewalls'
    description: 'Update ECMP routing'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: push template configs and force values
  paloaltonetworks.panos.panos_commit_push:
    provider: '{{ credentials }}'
    style: 'template'
    name: 'APAC Regional Template'
    force_template_values: true

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: push log collector group configs
  paloaltonetworks.panos.panos_commit_push:
    provider: '{{ credentials }}'
    style: 'log collector group'
    name: 'LatAm Collector Group'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: push to multiple devices
  paloaltonetworks.panos.panos_commit_push:
    provider: '{{ credentials }}'
    style: 'device group'
    name: 'Partner DMZ Firewalls'
    devices:
      - 0001234567890
      - 0987654321000
      - 1001001F0F000

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: push to multiple device groups
  paloaltonetworks.panos.panos_commit_push:
    provider: '{{ credentials }}'
    style: 'device group'
    name: '{{ item }}'
    sync: false
  loop:
    - Production Firewalls
    - Staging Firewalls
    - Development Firewalls

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: push admin-specific changes to a device group
  paloaltonetworks.panos.panos_commit_push:
    provider: "{{ credentials }}"
    style: 'device group'
    name: 'EMEA_Device_Group'
    admins:
      - 'ansible-admin'

Inputs

    
name:
    description:
    - The name of the configuration element to push.
    type: str

sync:
    default: true
    description:
    - Wait for the commit to complete.
    type: bool

style:
    choices:
    - device group
    - template
    - template stack
    - log collector group
    - wildfire appliance
    - wildfire cluster
    description:
    - The type of configuration element to push.
    required: true
    type: str

admins:
    description:
    - Push the configuration made by a specific administrator. (PAN-OS 10.2+)
    elements: str
    type: list

devices:
    description:
    - Push the configuration to specific device serial numbers.
    elements: str
    type: list

provider:
    description:
    - A dict object containing connection details.
    required: true
    suboptions:
      api_key:
        description:
        - The API key to use instead of generating it using I(username) / I(password).
        type: str
      ip_address:
        description:
        - The IP address or hostname of the PAN-OS device being configured.
        required: true
        type: str
      password:
        description:
        - The password to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
      port:
        default: 443
        description:
        - The port number to connect to the PAN-OS device on.
        type: int
      serial_number:
        description:
        - The serial number of a firewall to use for targeted commands. If I(ip_address)
          is not a Panorama PAN-OS device, then this param is ignored.
        type: str
      username:
        default: admin
        description:
        - The username to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
    type: dict
    version_added: 1.0.0
    version_added_collection: paloaltonetworks.panos

description:
    description:
    - A description of the commit.
    type: str

include_template:
    default: false
    description:
    - Include device group reference templates.
    type: bool

force_template_values:
    default: false
    description:
    - Force template values to override local settings.
    type: bool

Outputs

jobid:
  description: The ID of the PAN-OS commit job.
  returned: always
  sample: 49152
  type: int