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']}]

Release files for py-viptela 0.2.9.8.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-viptela 0.2.9.8.5
File	Size	Uploaded
py_viptela-0.2.9.8.5.tar.gz	84.0 kB	Jan 22, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for py-viptela 0.2.9.8.5
File	Interpreter	ABI	Platform	Reset
py_viptela-0.2.9.8.5-py3-none-any.whl 192.8 kB Jan 22, 2023	Python 3	none	any	Details

Total release size: 276.8 kB

Release files / py_viptela-0.2.9.8.5.tar.gz

Download URL	py_viptela-0.2.9.8.5.tar.gz
Size	84.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`9931a4653b0cf6b88588cfe14a4aa4dd2a811979aa83dcee58881a952f72aaa3`
BLAKE2b-256 checksum How to use checksums	`09042a2e863b3014600ed5c322484a85e8a576cb7183025fb2c65f58ed97c77c`
Upload date	Jan 22, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.1`

Release files / py_viptela-0.2.9.8.5-py3-none-any.whl

Download URL	py_viptela-0.2.9.8.5-py3-none-any.whl
Size	192.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0d689bf9ce4ad553c1e96fe912bbe87e4f653c50538a904a34c4482e75bcf9d0`
BLAKE2b-256 checksum How to use checksums	`897a82d3a44e7193a9cceba09580cac02539b15e5cca2ece482883a3a0a4f4a1`
Upload date	Jan 22, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.1`