Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bigevilbeard/sdwan_api

SDWAN API Example w/ Golang
https://github.com/bigevilbeard/sdwan_api

Last synced: about 1 month ago
JSON representation

SDWAN API Example w/ Golang

Awesome Lists containing this project

README 

        
[![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/bigevilbeard/sdwan_api)

# SD-WAN API Example w/ Golang



## Introduction



The Cisco SD-WAN software provides a REST API, which is a programmatic interface for controlling, configuring, and monitoring the Cisco SD-WAN devices in an overlay network. You access the REST API through the vManage web server.



A REST API is a web service that adheres to the REST, or Representational State Transfer, architecture. The REST architecture uses a stateless, client–server, cacheable communications protocol. The Cisco SD-WAN vManage NMS web server uses HTTP and its secure counterpart, HTTPS, as the communications protocol. REST applications communicate over HTTP or HTTPS using standard HTTP methods to make calls between network devices. These standard HTTP methods include:



- GET—Retrieve or read information.

- PUT—Update an object.

- POST—Create an object.

- DELETE—Remove an object.



REST is a simpler alternative to mechanisms such as remote procedure calls (RPCs) and web services such as Simple Object Access Protocol (SOAP) and Web Service Definition Language (WSDL). The REST architecture has not been formally defined by any standards body.



For more information about REST, see this [Wikipedia](https://en.wikipedia.org/wiki/Representational_state_transfer) page.



## Resource Data

The Cisco SD-WAN REST API uses the JavaScript Object Notation (JSON) data model to represent the data associated with a resource. JSON has three types of data:



- Scalar—Data types with a single value. Scalar types include numbers, strings, and booleans.

- Array—Ordered lists of values of an arbitrary type.

- Object—Unordered set of key:value pairs (also referred to as attributes), where the `key` is a string and the `value` can have an arbitrary type.



For more information about JSON, see the JSON Data [Interchange Standard](http://json.org/).



## Install go(lang)

With [homebrew](http://mxcl.github.io/homebrew/):



```

sudo brew install go

```

Or with [apt](http://packages.qa.debian.org/a/apt.html)-get:



```

sudo apt-get install golang

```

Or [Install Golang](https://golang.org/doc/install) manually or [compile](https://golang.org/doc/install/source) it yourself.



## 'GET' this code



All of the code and examples for this example can be cloned and accessed with the following command:



```

git clone https://github.com/bigevilbeard/sdwan_api

```



The code is built to be used on the Cisco DevNet always on [SD-WAN Sandbox](https://devnetsandbox.cisco.com/RM/Diagram/Index/4fb544ad-c88c-4227-8b09-5d35aa26a63b?diagramType=Topology). To use this code in another environment, update the `baseURL` / `Username/Password` in the code.



## The Code



When I built this code, I broke it down into sections and steps. Below is how I did this. Each example is a checkpoint, and the code following this is the next step. This helped me build this code.



- `example.api.cookie` - When you use a program or script to transfer data from a vManage web server or perform operations on the server, you must first establish an HTTPS session to the server. To do this, you send a call to login to the server with the following parameters:



- URL to send the request to — Use `https://{vmanage-ip-address/j_security_check`, which performs the login operation and security checks on the vManage web server at the specified IP address.

- Request method — Specify a `POST` request.

- The data contains the username and password in the format `j_username=username` & `j_password=password`.



Note: Disable security check for HTTPS(SSL) for certificates have been implemented. See:[import "crypto/tls"](https://golang.org/pkg/crypto/tls/) as this is sandbox.



I added the HTTP Response Status Codes. When making HTTP requests with Go, it is almost always necessary to check the status code of the response that is returned. Generally, if the status code is between 200 and 299, you can treat it as successful. But if anything except a 200-299 status, we often need to fix something.



- `example.api.func` - This breaks the `example.api.cookie` into two functions. The `main()` function will now utilize all the functions creating a `cookiejar` to store cookies required while logging into the URL/vManage.



- `example.api.output` adds an additional `Get` request for `https://{vmanage-ip-address/dataservice/device` this display all Cisco SDWAN devices in the overlay network that are connected to the vManage NMS. The output is



- `example.api.final` - Printing the final output into a more human readable format and removing unwanted information. The [import "encoding/json"](https://golang.org/pkg/encoding/json/) has been used. The use of [interface](https://golang.org/pkg/fmt/) makes the code more flexible and scalable, and it's a way to achieve [polymorphism](https://en.wikipedia.org/wiki/Polymorphism_%28computer_science%29) in Go. Instead of requiring a particular type, interfaces allow to you specify only that some behaviour is needed.



## About me



Network Automation Developer Advocate for Cisco DevNet.

I'm like Hugh Hefner... minus the mansion, the exotic cars, the girls, the magazine and the money. So basically, I have a robe.



Find me here: [LinkedIn](https://www.linkedin.com/in/stuarteclark/) / [Twitter](https://twitter.com/bigevilbeard)