panos_set - Execute arbitrary commands on a PAN-OS device using XPath and element

New in version 2.7.

Synopsis

• Run an arbitrary ‘xapi’ command taking an XPath (i.e get) or XPath and element (i.e set).
• See https://github.com/kevinsteves/pan-python/blob/master/doc/pan.xapi.rst for details
• Runs a ‘set’ command by default
• This should support _all_ commands that your PAN-OS device accepts vi it’s cli
• cli commands are found as
• Once logged in issue ‘debug cli on’
• Enter configuration mode by issuing ‘configure’
• Enter your set (or other) command, for example ‘set deviceconfig system timezone Australia/Melbourne’
• returns
• “<request cmd=”set” obj=”/config/devices/entry[@name=’localhost.localdomain’]/deviceconfig/system” cookie=XXXX><timezone>Australia/Melbourne</timezone></request>
• The ‘xpath’ is “/config/devices/entry[@name=’localhost.localdomain’]/deviceconfig/system”
• The ‘element’ is “<timezone>Australia/Melbourne</timezone>”

Requirements

The below requirements are needed on the host that executes this module.

• pan-python

Parameters

Parameter	Choices/Defaults	Comments
command	Choices: set ← edit delete get show override	Xapi method name which supports 'xpath' or 'xpath' and 'element'
element		The 'element' for the 'xpath' if required
ip_address required		IP address or host FQDN of the target PAN-OS NVA
password required		Password for the given 'username'
username	Default: admin	User name for a user with admin rights on the PAN-OS NVA
xpath required		The 'xpath' for the commands configurable

Examples

- name: Set timezone on PA NVA
  panos_set:
    ip_address: "192.168.1.1"
    username: "my-random-admin"
    password: "admin1234"
    xpath: "/config/devices/entry/deviceconfig/system"
    element: "<timezone>Australia/Melbourne</timezone>"

- name: Commit configuration
  panos_commit:
    ip_address: "192.168.1.1"
    username: "my-random-admin"
    password: "admin1234"

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

• Jasper Mackenzie

Hint

If you notice any issues in this documentation you can edit this document to improve it.