A Python wrapper around Cisco vManage API
Project description
py_viptela
A Python SDK for Cisco SD-WAN vManage API(20.6.2)
This is a wrapper around Cisco's vManage API. All endpoints in the API are implemented. There's a similar solution provided by Cisco and can be accessed from DevNet website
Also from github
There's a separate repo for a postman collection to use with vManage API. That collection included all endpoints and can be found here
-
Why another solution?
It's a great way to learn new things by building things.
-
Is it completed or a work-in-progress project?
This started as a hobby project and still in progress.
-
How can I use this?
A How-To document will be available after phase-1, which is implementing all the API endpoints, is completed.
-
Contributions?
Highly appreciated and welcome.
All Endpoints in vManage API are implemented using the vmanage.json file available through vmanage/apidocs page as a reference
How to install using pip
pip install py-viptela
How to Use
- Clone this repo into your computer.
git clone https://github.com/aatikturk/py-viptela
- Change directory to "py-viptela"
cd py-viptela
- Import vmanage module and initiate an instance, and import any api module Required parameters are as follows: host: Ip address of the vManage port: port to access vmanage username: vManage username password: vManage password
>>>from py_viptela.vmanage import Vmanage
>>>from py_viptela import api
>>>
>>>vmanage = Vmanage(host='198.18.1.10', port=443, username='admin', password='testpassword')
>>>vmanage.login()
You're ready to make requests using api endpoints.
Example: Get all users from the vManage
>>>
>>>users = api.admin.user.findUsers(vmanage)
>>>
>>>users
[{'userName': 'admin', 'locale': 'en_US', 'group': []},
{'userName': 'dclouddemo',
'description': 'Administrator',
'locale': 'en_US',
'resGroupName': 'global',
'group': ['netadmin']}]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py_viptela-0.2.9.8.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20832a90303831916b4158811ceed9ae6445fc4ab238dc7ba46a999cdb1ac5af |
|
MD5 | 37a6cc8d4cf098dd01ad20af1f8482e7 |
|
BLAKE2b-256 | 26c3b2d3fc51f4c5582063073394baed6630326ea9cbe0137ccd1b6cdbe35efc |