paloaltonetworks.panos.panos_commit_panorama (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 commit the candidate configuration on a Panorama instance.

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: commit candidate configs on panorama
  paloaltonetworks.panos.panos_commit_panorama:
    provider: '{{ credentials }}'

Scanned by Steampunk Spotter

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

- name: commit changes by specified admins on panorama
  paloaltonetworks.panos.panos_commit_panorama:
    provider: '{{ credentials }}'
    admins: ['netops', 'secops', 'cloudops']
    description: 'Saturday change window'

Scanned by Steampunk Spotter

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

- name: commit specific device group changes on panorama
  paloaltonetworks.panos.panos_commit_panorama:
    provider: '{{ credentials }}'
    device_groups: ['production', 'development', 'testing']

Scanned by Steampunk Spotter

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

- name: commit log collector group changes on panorama
  paloaltonetworks.panos.panos_commit_panorama:
    provider: '{{ credentials }}'
    log_collector_groups: ['us-west-loggers', 'apac-loggers', 'latam-loggers']
    description: 'Log collector changes'

Inputs

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

force:
    default: false
    description:
    - Force the commit.
    type: bool

admins:
    description:
    - Commit only the changes made by specified list of administrators.
    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

templates:
    description:
    - Commit changes made to these templates.
    elements: str
    type: list

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

device_groups:
    description:
    - Commit changes made to these device groups.
    elements: str
    type: list

log_collectors:
    description:
    - Commit changes made to these log collectors.
    elements: str
    type: list

template_stacks:
    description:
    - Commit changes made to these template stacks.
    elements: str
    type: list

wildfire_clusters:
    description:
    - Commit changes made to these WildFire clusters.
    elements: str
    type: list

wildfire_appliances:
    description:
    - Commit changes made to these WildFire appliances.
    elements: str
    type: list

log_collector_groups:
    description:
    - Commit changes made to these log collector groups.
    elements: str
    type: list

exclude_shared_objects:
    default: false
    description:
    - Exclude shared object configuration changes.
    type: bool

exclude_device_and_network:
    default: false
    description:
    - Exclude network and device configuration changes.
    type: bool

Outputs

details:
  description: Commit job completion messages.
  returned: on success
  sample: Configuration committed successfully
  type: str
jobid:
  description: The ID of the PAN-OS commit job.
  returned: always
  sample: 49152
  type: int