Brocade Virtual Traffic Manager 17.2 Control API Guide

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.


Brocade Virtual Traffic Manager 17.2 Control API Guide - cover page
Brand
BROCADE
Category
Application program
Document type
Programming Manual
Language
English
Pages
666
File format
PDF
File size
2.4 MB
Published
02 November, 2023
Updated
02 November, 2023
MD5 checksum
0ADC23DEA443A0B552E71C6B364A80D4

About this manual

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.

What's inside

  • Preface and Document Conventions
  • Introduction
  • Code Samples
  • Using Perl SOAP::Lite
  • Sample Control API Applications
  • Troubleshooting
  • Function Reference
  • VirtualServer
  • Pool
  • TrafficIPGroups

Specifications

Product version supported17.2
Document part number53-1005040-01
Document date22 May 2017
API communicationsStandards-conformant SOAP
API architectureSOAP-based

Frequently asked questions

What version of Brocade Virtual Traffic Manager does this Control API Guide support?

It supports Brocade Virtual Traffic Manager version 17.2.

What kind of communications does the Control API use?

The guide describes the API as using standards-conformant SOAP communications on a SOAP-based architecture.

Where do I find debugging and troubleshooting help?

The Troubleshooting chapter covers general debugging techniques, file locations, log files, snooping the SOAP traffic, and debugging with Perl, C#, and Java.

What does the Function Reference document?

It documents Control API methods, structures, and enumerations for objects such as VirtualServer, Pool, TrafficIPGroups, GlobalSettings, and System, and it lists SOAP faults.

Download PDF (2.4 MB)

More BROCADE Manuals


View all BROCADE manuals →