community.general.panos_commit (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

PanOS module that will commit firewall's candidate configuration on

the device. The new configuration will become active immediately.

Requirements

• pan-python

Usage examples

Scanned by Steampunk Spotter

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

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

Inputs

    
sync:
    default: 'yes'
    description:
    - if commit should be synchronous
    type: bool

timeout:
    description:
    - timeout for commit job

interval:
    default: 0.5
    description:
    - interval for checking commit job

password:
    description:
    - Password for authentication. If the value is not specified in the task, the value
      of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
    required: true

username:
    default: admin
    description:
    - Username for authentication. If the value is not specified in the task, the value
      of environment variable C(ANSIBLE_NET_USERNAME) will be used instead if defined.
      C(admin) will be used if nothing above is defined.

ip_address:
    description:
    - IP address (or hostname) of PAN-OS device.
    required: true

commit_vsys:
    description:
    - Commit changes for specified VSYS
    type: list

description:
    description:
    - Commit description/comment
    type: str

commit_changes_by:
    description:
    - Commit changes made by specified admin
    type: list

Outputs

panos_commit:
  contains:
    job_id:
      description: Palo Alto job ID for the commit operation. Only returned if commit
        job is launched on device.
      returned: always
      sample: '139'
      type: str
    status_code:
      description: Palo Alto API status code. Null if commit is successful.
      returned: always
      sample: 19
      type: str
    status_detail:
      description: Palo Alto API detailed status message.
      returned: always
      sample: Configuration committed successfully
      type: str
    status_text:
      description: Palo Alto API status text.
      returned: always
      sample: success
      type: str
  description: Information about commit job.
  returned: always
  type: complex
  version_added: 2.8
  version_added_collection: community.general