Skip to main content

Python asyncio client for IP Fabric

Project description

Python Asyncio Client for IP Fabric

This package contains a Python 3.8 asyncio client for use wih the IP Fabric product.

Installation

PyPi installation

pip install aio-ipfabric

Direct installation

pip install git+https://github.com/jeremyschulman/aio-ipfabric@master#egg=aio-ipfabric

Quick Start

import asyncio
from aioipfabric import IPFabricClient

loop = asyncio.get_event_loop()

# create a client using environment variables (see next section)
ipf = IPFabricClient()

# login to IP Fabric system
loop.run_until_complete(ipf.login())

# fetch the complete device inventory
device_list = loop.run_until_complete(ipf.fetch_devices())

Environment Variables

The following environment variable can be used so that you do no need to provide them in your program:

  • IPF_ADDR - IP Fabric server URL, for example "https://my-ipfabric-server.com/"
  • IPF_USERNAME - Login username
  • IPF_PASSWORD - Login password
  • IPF_TOKEN - A refresh token that can be used to obtain an access token

You can use either the login credentials or the refresh token to login.

If you prefer not to use environment variables, the call to IPFabricClient() accepts parameters; refer to the help(IPFabricClient) for details.

Documentation

See the docs directory.

Project details


Download files

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

Source Distribution

aio-ipfabric-0.6.1.tar.gz (15.0 kB view hashes)

Uploaded source

Built Distribution

aio_ipfabric-0.6.1-py3-none-any.whl (30.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page