Overview

note

Most of the methods require the device is licensed.

The panos_upgrade_assurance package consists of several modules. Most of them (including methods they provide) can be used separately. This makes those modules highly flexible up to the point where one can interact with the XML API directly.

But for general use cases, the wrapper methods are provided.

This package consists of the following modules:

• firewall_proxy, includes:

  • FirewallProxy class

    A low level class. Acts as a proxy between the pan-os-python Firewall and the CheckFirewall classes. Its main purpose is to provide a wrapper for running XML API commands, handling basic communication errors, etc.

• check_firewall, includes

  • CheckFirewall class

    A high level class. Its main purpose is to provide an interface to run readiness checks and state snapshots. It wraps around the FirewallProxy class methods and provides results in a unified way.

• snapshot_compare, includes

  • SnapshotCompare class

    This class provides:

    • mechanism to calculate differences between two snapshots made with the CheckFirewall class,
    • mechanism to generate a report based on calculated differences.

• utils, includes data classes and helper methods:

  • ConfigParser class to validate configuration passed to different methods, used throughout the package, it has it's own, documented dialect
  • CheckType and SnapType classes to map commonly used names to variables
  • CheckResults data class that represents internal check results
  • and some more.