pybfe 2019.11.1.823

Python client and utilities for Batfish Enterprise

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.