This manual introduces concepts, functions, syntax and examples for Brocade Virtual Traffic Manager control API. This document describes how to use the API to control Brocade Virtual Traffic Manager. The API provides control of Brocade Virtual Traffic Manager, including configuration, monitoring and troubleshooting.
This Control API Guide from Brocade describes how to program against the Brocade Virtual Traffic Manager 17.2 using its SOAP-based Control API. It opens with document conventions and an introduction to the API's standards-conformant SOAP communications, architecture, and security considerations, followed by code samples for listing running virtual servers and for fault handling in Perl, C#, Java, Python, and PHP 5.
The rest of the guide covers using Perl SOAP::Lite, sample applications such as blocking traffic from an IP address, adding a node to a pool, and reconfiguring a site based on traffic load, and troubleshooting techniques including log files, snooping SOAP traffic, WSDL interface problems, and language-specific debugging. A large function reference documents methods, structures, enumerations, and SOAP faults for VirtualServer, Pool, TrafficIPGroups, catalog, global settings, system, and other objects.
| Product version supported | 17.2 |
|---|---|
| Document part number | 53-1005040-01 |
| Document date | 22 May 2017 |
| API communications | Standards-conformant SOAP |
| API architecture | SOAP-based |
It supports Brocade Virtual Traffic Manager version 17.2.
The guide describes the API as using standards-conformant SOAP communications on a SOAP-based architecture.
The Troubleshooting chapter covers general debugging techniques, file locations, log files, snooping the SOAP traffic, and debugging with Perl, C#, and Java.
It documents Control API methods, structures, and enumerations for objects such as VirtualServer, Pool, TrafficIPGroups, GlobalSettings, and System, and it lists SOAP faults.