Skip to main content

Python client and utilities for Batfish Enterprise

Project description

Pybatfish Enterprise

Pybatfish Enterprise is a Python client for Batfish Enterprise.

For the Python client for open-source Batfish, see Pybatfish.

Getting Started

Prerequisites

Pybatfish Enterprise requires a Batfish Enterprise backend to work.

Install Pybatfish Enterprise

We highly recommend that you install Pybatfish Enterprise in a Python 3 virtual environment. Details on how to set one up can be found here. Once your virtual environment is setup and activated, run:

python3 -m pip install pybfe

Using Pybatfish Enterprise

After Pybatfish Enterprise is installed, you can use it in place of Pybatfish in your Ansible plays (which use Batfish Roles).

In your Ansible task that sets up a Batfish service connection, simply add session_type: bfe under parameters, e.g. change your setup task from:

    - name: Setup connection to service
      bf_session:
        host: localhost
        name: local_batfish

to:

    - name: Setup connection to service
      bf_session:
        host: localhost
        name: local_batfish
        parameters:
          session_type: bfe

After this change, Batfish tasks will benefit from Batfish Enterprise features, and allow you to do things like view the results of your Batfish assertions or fact validation on the Enterprise Dashboard.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pybfe, version 2020.2.11.935
Filename, size File type Python version Upload date Hashes
Filename, size pybfe-2020.2.11.935-py2.py3-none-any.whl (127.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page