Skip to main content

published

Run in Cisco Cloud IDE

vDocs

Business Ready Documents for Cisco SD-WAN vManage

Current API Coverage

ARP Interfaces

BFD Sessions

BFD Sessions from Device

BFD Summary

CEdge Interfaces

Control Connection

Control Local Property

Control WAN Interface

Device Counters

Device Status

Fabric Devices

Hardware Environment

Hardware Inventory

Interfaces

OMP Peers

System

System Status

Template Feature Types

Template Features

Template Policy List

vEdge Devices

Installation

$ python3 -m venv sdwan
$ source sdwan/bin/activate
(sdwan) $ pip install vdocs

Usage - Help

(sdwan) $ vdocs --help

vDocs Help

Usage - In-line

(sdwan) $ vdocs --url <url to vManage> --username <vManage username> --password <vManage password>

Usage - Interactive

(sdwan) $ vdocs
vManage URL: <URL to vManage>
vManage Username: <vManage Username>
vManage Password: <vManage Password>

Usage - Environment Variables

(sdwan) $ export URL=<URL to vManage>
(sdwan) $ export USERNAME=<vManage Username>
(sdwan) $ export PASSWORD=<vManage Password>

Excel Viewer - CSV Files

Markdown Preview - Markdown Files

Markmap - Mindmap Files

Open in Default Browser - HTML Files

Always On Sandbox

This code works with the always on sandbox!

https://devnetsandbox.cisco.com/RM/Diagram/Index/a4ab71bc-f7a0-4d63-bedb-05a051818569?diagramType=Topology

export URL=https://sandbox-sdwan-2.cisco.com
export USERNAME=devnetuser
export PASSWORD='RG!_Yw919_83'

(venv)$ pip install vdocs
(venv)$ mkdir vdocs_output
(venv)$ cd vdocs_output
(venv)/vdocs_output$ vdocs
(venv)/vdocs_output$ code . 
(Launches VS Code and you can view the output with the recommended VS Code extensions)

Contact

Please contact John Capobianco if you need any assistance

Metadata

Release files for vdocs 0.1.8

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

Source distribution (sdist)

Source distribution for vdocs 0.1.8
File Size Uploaded Provenance Actions
vdocs-0.1.8.tar.gz 37.1 kB Without provenance Details for vdocs-0.1.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vdocs 0.1.8
File Interpreter ABI Platform Actions
vdocs-0.1.8-py3-none-any.whl Python 3 none any Details for vdocs-0.1.8-py3-none-any.whl

Total release size: 92.8 kB

Release files / vdocs-0.1.8.tar.gz

Download URL vdocs-0.1.8.tar.gz
Size 37.1 kB
Tags Source
SHA-256 checksum
How to use checksums
25140cad36eb491d51ce8da7d193a5718b98e5b5e6c74d1707282aa86afd417d
BLAKE2b-256 checksum
How to use checksums
c40a91e4899cba768e7baf0b88986fed30bf3869cbe0fbfe1029948e74abdb02
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.2 CPython/3.10.4 Linux/5.10.102.1-microsoft-standard-WSL2

Release files / vdocs-0.1.8-py3-none-any.whl

Download URL vdocs-0.1.8-py3-none-any.whl
Size 55.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e1c455493bfd8513682d533d58f70f262a86d00e0c9096c464aeee1ff08020d9
BLAKE2b-256 checksum
How to use checksums
13ffaf8b0862bb042cf53708b4a4b65032fed8fbe5fccc95246e13a84e5b4149
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.2 CPython/3.10.4 Linux/5.10.102.1-microsoft-standard-WSL2

Security for vdocs 0.1.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page