community.general.panos_op (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

This module will allow user to pass and execute any supported OP command on the PANW device.

Requirements

• pan-python can be obtained from PyPI U(https://pypi.org/project/pan-python/)
• pandevice can be obtained from PyPI U(https://pypi.org/project/pandevice/)

Usage examples

Scanned by Steampunk Spotter

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

- name: show list of all interfaces
  panos_op:
    ip_address: '{{ ip_address }}'
    username: '{{ username }}'
    password: '{{ password }}'
    cmd: 'show interfaces all'

Scanned by Steampunk Spotter

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

- name: show system info
  panos_op:
    ip_address: '{{ ip_address }}'
    username: '{{ username }}'
    password: '{{ password }}'
    cmd: 'show system info'

Inputs

    
cmd:
    description:
    - The OP command to be performed.
    required: true

api_key:
    description:
    - API key that can be used instead of I(username)/I(password) credentials.

password:
    description:
    - Password credentials to use for authentication.
    required: true

username:
    default: admin
    description:
    - Username credentials to use for authentication.
    required: false

ip_address:
    description:
    - IP address (or hostname) of PAN-OS device or Panorama management console being configured.
    required: true

Outputs

stdout:
  description: output of the given OP command as JSON formatted string
  returned: success
  sample: '{system: {app-release-date: 2017/05/01  15:09:12}}'
  type: str
stdout_xml:
  description: output of the given OP command as JSON formatted string
  returned: success
  sample: <response status=success><result><system><hostname>fw2</hostname>
  type: str