py-viptela


Namepy-viptela JSON
Version 0.1.3.3 PyPI version JSON
download
home_pagehttps://github.com/aatikturk/py_viptela
SummaryA Python wrapper around Cisco vManage API
upload_time2022-06-24 16:26:44
maintainer
docs_urlNone
authorAdem Atikturk
requires_python>=3
licenseGNU General Public License v2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/aatikturk/py-viptela)

# 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](https://developer.cisco.com/codeexchange/github/repo/CiscoDevNet/python-viptela/)

Also from [github](https://github.com/CiscoDevNet/python-viptela)

There's a separate repo for a postman collection to use with vManage API. That collection included all endpoints and can be found [here](https://github.com/aatikturk/Cisco-SD-WAN-Full-Postman-Collection)

* #### 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 vmanage import Vmanage
>>>from api.admin.user import User
>>>
>>>vmanage = Vmanage(host='198.18.1.10', port=443, username='admin', password='testpassword')
>>>
```

You're ready to make requests using api endpoints. 

Example:  Get all users from the vManage

```
>>>user_api = User(session=vmanage.session, host=vmanage.host, port=vmanage.port)
>>>
>>>users = user_api.findUsers()
>>>
>>>users
[{'userName': 'admin', 'locale': 'en_US', 'group': []},
 {'userName': 'dclouddemo',
  'description': 'Administrator',
  'locale': 'en_US',
  'resGroupName': 'global',
  'group': ['netadmin']}]
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/aatikturk/py_viptela",
    "name": "py-viptela",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "",
    "keywords": "",
    "author": "Adem Atikturk",
    "author_email": "aatikturk@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d3/98/8e4c3017e4d02268491191dd8685d6888c70422f28a927eb17e06f94cbb4/py_viptela-0.1.3.3.tar.gz",
    "platform": null,
    "description": "[![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/aatikturk/py-viptela)\r\n\r\n# py_viptela\r\n### A Python SDK for Cisco SD-WAN vManage API(20.6.2)\r\n\r\nThis 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](https://developer.cisco.com/codeexchange/github/repo/CiscoDevNet/python-viptela/)\r\n\r\nAlso from [github](https://github.com/CiscoDevNet/python-viptela)\r\n\r\nThere's a separate repo for a postman collection to use with vManage API. That collection included all endpoints and can be found [here](https://github.com/aatikturk/Cisco-SD-WAN-Full-Postman-Collection)\r\n\r\n* #### Why another solution?\r\n    It's a great way to learn new things by building things.\r\n\r\n* #### Is it completed or a work-in-progress project?\r\n    This started as a hobby project and still in progress. \r\n   \r\n* #### How can I use this?\r\n    A How-To document will be available after phase-1, which is implementing all the API endpoints, is completed.\r\n\r\n* #### Contributions?\r\n    Highly appreciated and welcome.\r\n    \r\n\r\nAll Endpoints in vManage API are implemented using the vmanage.json file available through vmanage/apidocs page as a reference\r\n\r\n### How to install using pip\r\n\r\n```\r\npip install py-viptela\r\n```\r\n\r\n\r\n### How to Use\r\n\r\n* Clone this repo into your computer.\r\n```\r\ngit clone https://github.com/aatikturk/py-viptela\r\n```\r\n\r\n* Change directory to \"py-viptela\"\r\n```\r\ncd py-viptela\r\n```\r\n\r\n* Import vmanage module and initiate an instance, and import any api module\r\n  Required parameters are as follows:\r\n    host:       Ip address of the vManage\r\n    port:       port to access vmanage\r\n    username:   vManage username\r\n    password:   vManage password\r\n\r\n```\r\n>>>from vmanage import Vmanage\r\n>>>from api.admin.user import User\r\n>>>\r\n>>>vmanage = Vmanage(host='198.18.1.10', port=443, username='admin', password='testpassword')\r\n>>>\r\n```\r\n\r\nYou're ready to make requests using api endpoints. \r\n\r\nExample:  Get all users from the vManage\r\n\r\n```\r\n>>>user_api = User(session=vmanage.session, host=vmanage.host, port=vmanage.port)\r\n>>>\r\n>>>users = user_api.findUsers()\r\n>>>\r\n>>>users\r\n[{'userName': 'admin', 'locale': 'en_US', 'group': []},\r\n {'userName': 'dclouddemo',\r\n  'description': 'Administrator',\r\n  'locale': 'en_US',\r\n  'resGroupName': 'global',\r\n  'group': ['netadmin']}]\r\n```\r\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v2.0",
    "summary": "A Python wrapper around Cisco vManage API",
    "version": "0.1.3.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "4a37c43fda345d7c0b9b049ed393cc65",
                "sha256": "e0c15ea96d166b8b6c28b261be6c785efe12f0d1f93ed52d43811ac5273221ae"
            },
            "downloads": -1,
            "filename": "py_viptela-0.1.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "4a37c43fda345d7c0b9b049ed393cc65",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 89117,
            "upload_time": "2022-06-24T16:26:44",
            "upload_time_iso_8601": "2022-06-24T16:26:44.480884Z",
            "url": "https://files.pythonhosted.org/packages/d3/98/8e4c3017e4d02268491191dd8685d6888c70422f28a927eb17e06f94cbb4/py_viptela-0.1.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-24 16:26:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "aatikturk",
    "github_project": "py_viptela",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "py-viptela"
}
        
Elapsed time: 0.50635s