User guide

Web Services Specifications Web Services, CLI Scripting and OpenFlow
page 11-2 OmniSwitch AOS Release 7 Switch Management Guide March 2015
Web Services Specifications
The following table lists specifications for Web Services.
Web Services Overview
The Web Services interface provides two levels of granularity, either through direct handling of MIB vari-
ables or using the embedded CLI commands to configure the switch. The Web Services feature provides a
RESTful interface to OmniSwitch configuration.
Representational State Transfer (REST)
REST is a set of guidelines for software architecture of distributed systems. It is an architectural style with
the following characteristics:
REST Characteristics
• Client-Server architecture: all interactions are based on a set of Consumers performing pull-based inter-
actions with a set of Producers.
• Stateless: each request from Consumers to Producers must be self-sufficient and not presume any pre-
agreed upon knowledge on the Producer side. Each request must contain all information necessary for
the Producer to understand and reply to it. If a new resource or API is identified, the Producer needs to
return a unique URL to the Consumer who will then re-use that URL when communicating with the
Producer. This is known as Interconnected Resource Representation: this succession of URLs is how a
Consumer can move from one state to another without the Producer needing to maintain any state
information.
• Cacheable: when similar requests are issued repeatedly to a Producer, existing HTTP caching mecha-
nisms must be capable to cache results the way HTTP caches usually do. Caching can be handled using
the usual mechanisms: unique URL generation and cache lifecycle headers. This reliance on caches,
proxies, etc. follows the natural layer model found in Web models.
Platforms Supported OmniSwitch 10K, 6900
Configuration Methods
• HTTP/HTTPS
• Python API
Response Formats
• Extensible Markup language (XML)
• JavaScript Object Notation (JSON)
Maximum Web Services Ses-
sions
4
Alcatel-Lucent Example Python
Library
consumer.py (Python version 2.X/3.X compatible)
Note: This file is available on the Service & Support Website. It is
being provided as an example application to help with Web Services
familiarization but is not an officially supported part of the Web
Services solution.
Embedded Python /Event based
CLI Scripting
Python 3
Default Script Run Time Limit 60 Seconds.