Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 740 Bytes

README.md

File metadata and controls

31 lines (20 loc) · 740 Bytes

AIO Netbox

An asyncio netbox library that conforms to any running netbox via it's OpenAPI spec

Installation

AIONetbox is distributed as a library intended to be included in other asyncio python projects. It has been developed on python 3.6+ though 3.8 is recommended.

pip install aionetbox

Usage

from aionetbox import AIONetbox

netbox = AIONetbox.from_openapi(
    url='http://localhost:8000',
    api_key='0123abcd'
)

sites = await netbox.dcim.dcim_sites_list()
my_site = await netbox.dcim.dcim_sites_read(id=2)

custom_field_sort = await netbox.dcim.dcim_regions_list(cf_sf_id='identifier')

Each module and method map to the swagger definition for netbox (/api/docs)