https://github.com/ciscodevnet/uniq
A Python API client library for Cisco's Application Policy Infrastructure Controller Enterprise Module (APIC-EM) Northbound APIs.
https://github.com/ciscodevnet/uniq
apic-em iwan pnp python python-3 rest rest-api uniq
Last synced: 6 months ago
JSON representation
A Python API client library for Cisco's Application Policy Infrastructure Controller Enterprise Module (APIC-EM) Northbound APIs.
- Host: GitHub
- URL: https://github.com/ciscodevnet/uniq
- Owner: CiscoDevNet
- License: apache-2.0
- Created: 2016-05-25T20:46:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-14T20:08:13.000Z (over 8 years ago)
- Last Synced: 2025-04-14T22:03:43.497Z (6 months ago)
- Topics: apic-em, iwan, pnp, python, python-3, rest, rest-api, uniq
- Language: Python
- Homepage:
- Size: 731 KB
- Stars: 45
- Watchers: 26
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/uniq)
uniq is a Python API client library for Cisco's Application Policy Infrastructure Controller Enterprise Module (APIC-EM) Northbound APIs.
# Description
The APIC-EM Northbound Interface is the only API that you will need to control your network programmatically. The API is function rich and provides you with an easy-to-use, programmatic control of your network elements, interfaces, and hosts.
The APIC-EM API provides you with the ability to think about your network at a higher policy level rather than how to implement that policy. When you use the APIC-EM API, your applications will make network policy decisions, which will then be implemented by the APIC-EM Controller through its Southbound Interfaces. Thus you tell the network what you want (i.e., the policy) and the controller figures out how to implement that policy for you.
The APIC-EM API is REST based and thus you will discover and control your network using HTTP protocol with HTTP verbs (i.e., GET, POST, PUT, and DELETE) with JSON syntax.
This package provides a handle to this rich API library in an easy to consume fashion.
# Getting Started
### Install
To install uniq, simply
``` bash
pip install uniq
```
### Use
Import the package and make an API call.
``` python
from uniq.apis.nb.client_manager import NbClientManager
client = NbClientManager(
server="1.1.1.1",
username="username",
password="password",
connect=True)
# NorthBound API call to get all users
user_list_result = client.user.getUsers()
# Serialize the model object to a python dictionary
users = client.serialize(user_list_result)
print(users)
```
### Running Tests
The tests are located in the [tests](tests/) directory.
After installing the package, they can be run by executing the below command:
```
python setup.py test
```
### Sample Scripts
For sample scripts check out the [sample_scripts](sample_scripts/) directory.
# Python
This project has been tested and working on Python 3.0+