Brocade Virtual ADX XML API Programmer’s Guide (Supporting ADX v03.1.00) - Manual (Page 3)

Brocade Virtual ADX XML API Programmer’s Guide iii
53-1003248-01
Contents
Preface
Document conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Text formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Command syntax conventions . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Notes, cautions, and warnings . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Brocade resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Contacting Brocade Technical Support . . . . . . . . . . . . . . . . . . . . . . . . ix
Document feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Chapter 1 WSDL Programming
Programmatic interface to Brocade Virtual ADX : XML APIs. . . . . . . . 1
Purpose of the WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
XML SOAP interface overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
WSDL location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Accessing the client API using SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Creating client-specific APIs from client stubs . . . . . . . . . . . . . . . . . . 3
Use cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Code for simple SOAP clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Enabling a web service on a Brocade Virtual ADX . . . . . . . . . . . . . . . 6
Chapter 2 Using the XML API
API operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
API naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Request and response XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Chapter 3 System API Reference
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Basic System Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
System - High Availability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Device Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Role Based Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Config Template basic operations . . . . . . . . . . . . . . . . . . . . . . .75
Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141