Home

Welcome to the helper-modules wiki!

Note: Your use of this Software is pursuant to the Silver Peak Disclaimer - see the README page for details.

This repository contains sample helper modules, scripts, and client code to help customers learn how to use

1. Silver Peak's Orchestrator REST APIs
2. Orchestrator Notification Service (websocket option)

sp_orchhelper.py

The REST API is a fully featured north- and south-bound API that supports multiple operations on the SD-WAN. To get started, a basic module "sp_orchhelper.py" is provided that supports login/logout capabilities and functions for performing basic GET/POST/PUT/DELETE operations.

To use this class:

• import the OrchHelper class in your own python client code
• instantiate an OrchHelper instance with 3 optional input parameters
• Once the class object is instantiated, call either the login() or mfa_login() functions to intiate an authenticated session to Orchestrator
• From the client code, you can issue any Orchestrator REST API calls (see the Swagger API documentation on your specific Orchestrator instance for details). A sample wrapper function to retrieve the inventory of all appliances is included for learning purposes.
• when completed, issue a logout() request on the class object instance to close out the session.

Releases Supported:

• This base class supports all currently GA releases of Orchestrator

Code Impact Assessment

This module has no direct functions that can change the configuration of an SD-WAN. It provides basic operations to authenticate a user and establish a communication session to the specified Orchestrator

websocket_client.html

Orchestrator Notification Service supports a number of transport options for streaming alarms or audit log events to subscribers. The websocket option requires the subscriber to initiate the websocket connection. The websocket_client.html file contains client stub code for testing websockets in a browser and initiating the websocket session to the target Orchestrator. The README-websocket file contains instructions and details on how to use this code.

websocket_nodeClient.js

Orchestrator Notification Service supports a number of transport options for streaming alarms or audit log events to subscribers. The websocket option requires the subscriber to initiate the websocket connection. The websocket_nodeClient.js file contains node.js client code for initiating a websocket session to the target Orchestrator and issuing various requests over that websocket. The README-websocket file contains instructions and details on how to use this code.

ansible_example.yml

The Orchestrator REST API is a fully featured north- and south-bound API that supports multiple operations on the SD-WAN and with third parties. This file provides Ansible samples for login, logout, get, post, and put operations. Comments in the file outline general usage as applicable. See the Swagger API documentation (In Orchestrator GUI> Support> REST APIs) on your specific Orchestrator instance for API details.