README.txt

pan-python is a Python package for Palo Alto Networks' Next-Generation
Firewalls and WildFire cloud.  It provides:

  - a Python and command line interface to the PAN-OS and Panorama XML API
  - a command line program for managing PAN-OS XML configurations
  - a Python and command line interface to the WildFire API

Python versions 2.7, 3.2, 3.3 and 3.4 are supported with a single code
base.  There are no external modules required to use pan-python.

The pan package contains the following modules:

    pan.xapi:   pan.xapi.PanXapi class
    pan.commit: pan.commit.PanCommit class (internal)
    pan.rc:     pan.rc.PanRc class (internal)
    pan.config: pan.config.PanConfig class (internal)
    pan.wfapi:  pan.wfapi.PanWFapi class

bin/panxapi.py is a command line program for accessing the XML API and
uses the pan.xapi and pan.commit modules.

bin/panconf.py is a command line program program for managing PAN-OS
XML configurations and uses the pan.config module.

bin/panwfapi.py is a command line program for accessing the WildFire
API and uses the pan.wfapi module.

Documentation:

  Rendered reStructuredText from GitHub:

    https://github.com/kevinsteves/pan-python/blob/master/doc/panxapi.rst
    https://github.com/kevinsteves/pan-python/blob/master/doc/panconf.rst
    https://github.com/kevinsteves/pan-python/blob/master/doc/pan.xapi.rst
    https://github.com/kevinsteves/pan-python/blob/master/doc/panwfapi.rst
    https://github.com/kevinsteves/pan-python/blob/master/doc/pan.wfapi.rst
    https://github.com/kevinsteves/pan-python/blob/master/doc/panrc.rst

  HTML from source distribution:

    doc/panxapi.html
    doc/panconf.html
    doc/pan.xapi.html
    doc/panwfapi.html
    doc/pan.wfapi.html
    doc/panrc.html

Install:

  You can install the package or just run the programs from within the
  package source directory:

    $ tar xzf pan-python-1.0.0.tar.gz
    $ cd pan-python-1.0.0

    $ cd bin
    $ ./panxapi.py

  or:

    $ sudo ./setup.py install
    $ panxapi.py

Remote Git Repository:

  https://github.com/kevinsteves/pan-python

Author:

  Kevin Steves <kevin.steves@pobox.com>