Brocade Virtual ADX XML User Manual

53-1003248-01
®
31 July 2014
Brocade Virtual ADX
XML API Programmer’s Guide
Supporting Brocade Virtual ADX version 03.1.00
© 2014 Brocade Communications Systems, Inc. All Rights Reserved.
Notice: This document is for informational purposes only and does not set forth any warranty, expressed or implied, concerning any equipment, equipment feature, or service offered or to be offered by Brocade. Brocade reserves the right to make changes to this document at any time, without notice, and assumes no responsibility for its use. This informational document describes features that may not be currently available. Contact a Brocade sales office for information on feature and product availability. Export of technical data contained in this document may require an export license from the United States government.
The authors and Brocade Communications Systems, Inc. assume no liability or responsibility to any person or entity with respect to the accuracy of this document or any loss, cost, liability, or damages arising from the information contained herein or the computer programs that accompany it.
The product described by this document may contain open source software covered by the GNU General Public License or other open source license agreements. To find out which open source software is included in Brocade products, view the licensing terms applicable to the open source software, and obtain a copy of the programming source code, please visit http:// www.brocade.com/support/oscd.
Brocade Communications Systems, Incorporated
Corporate and Latin American Headquarters Brocade Communications Systems, Inc. 130 Holger Way San Jose, CA 95134 Tel: 1-408-333-8000 Fax: 1-408-333-8101 E-mail: info@brocade.com
European Headquarters Brocade Communications Switzerland Sàrl Centre Swissair Tour B - 4ème étage 29, Route de l'Aéroport Case Postale 105 CH-1215 Genève 15 Switzerland Tel: +41 22 799 5640 Fax: +41 22 799 5641 E-mail: emea-info@brocade.com
Asia-Pacific Headquarters Brocade Communications Systems China HK, Ltd. No. 1 Guanghua Road Chao Yang District Units 2718 and 2818 Beijing 100020, China Tel: +8610 6588 8888 Fax: +8610 6588 9999 E-mail: china-info@brocade.com
Asia-Pacific Headquarters Brocade Communications Systems Co., Ltd. (Shenzhen WFOE) Citic Plaza No. 233 Tian He Road North Unit 1308 – 13th Floor Guangzhou, China Tel: +8620 3891 2000 Fax: +8620 3891 2111 E-mail: china-info@brocade.com
Document History
Title Publication number Summary of changes Date
Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01 New document. July 2014

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
Brocade Virtual ADX XML API Programmer’s Guide iii 53-1003248-01
Chapter 4 Network API Reference
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Network Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Routing Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209
Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .324
Chapter 5 Server Load Balancing API Reference
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .349
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .349
Server Load Balancing - Virtual Servers and Ports . . . . . . . . .349
Server Load Balancing - Real Servers and Ports . . . . . . . . . . .380
Health Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Content Switching (HTTP + TCA + DNS DPI). . . . . . . . . . . . . . .428
Policy-based SLB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .445
Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .452
Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .461
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .531
Chapter 6 Security API Reference
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .559
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .559
Security - Access Control Lists . . . . . . . . . . . . . . . . . . . . . . . . .559
Security - Network Address Translation . . . . . . . . . . . . . . . . . .570
Security - Secure Socket Layer . . . . . . . . . . . . . . . . . . . . . . . . .577
Syn-Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .608
Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .664
firewallPredictorEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .664
accessListActionEnum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .665
firewallGroupIDEnum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .665
firewallWeightEnum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .665
Chapter 7 Global Server Load Balancing API Reference
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .683
Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .683
Site Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .683
Zone Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .688
Policy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .693
Global Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .695
Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .698
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .721
iv Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Appendix A Error Messages
List of Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .731
Appendix B API Examples
Example: Adding and binding a real server and a VIP . . . . . . . . . .813
Perl example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .813
Java Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .819
C# example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .824
Example - Provisioning real and virtual servers . . . . . . . . . . . . . . .834
C# example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .834
Example - Binding a real server port to a virtual server port
and saving to the startup configuration file . . . . . . . . . . . . . . . . . .847
Perl example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .847
Example: Unbinding a real server from a VIP . . . . . . . . . . . . . . . . .849
Perl example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .849
Java example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .853
C# example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .859
Brocade Virtual ADX XML API Programmer’s Guide v 53-1003248-01
vi Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01

Preface

Document conventions

This section describes text formatting conventions and important notice formats that may be used in this document.

Text formatting

The following text formatting conventions may be used in the flow of the text to highlight specific words or phrases.
Format Description
bold text Identifies command names
Identifies keywords
Identifies the names of user-manipulated GUI elements
Identifies text to enter at the GUI or CLI
italic text Provides emphasis
Identifies variables and modifiers
Identifies paths and Internet addresses
Identifies document titles
code
Identifies CLI output
Identifies command syntax examples
Brocade Virtual ADX XML API Programmer’s Guide vii 53-1003248-01

Command syntax conventions

NOTE
ATTENTION
CAUTION
DANGER
Convention Description
bold text Identifies command names, keywords, and command options.
italic text Identifies variables.
[ ]
{ x | y |z }
Syntax components displayed within square brackets are optional.
A choice of required parameters is enclosed in curly braces separated byvertical bars. You must select one.
x | y
< >
A vertical bar separates mutually exclusive elements.
Nonprinting characters, for example, passwords, are enclosed in angle brackets.
...
\
Repeat the previous element. For example, member [member...].
Indicates a “soft” line break in command examples. If a backslash separates two lines of a command input, enter the entire command at the prompt without the backslash.

Notes, cautions, and warnings

The following notices and statements may be used in this document. They are listed below in order of increasing severity of potential hazards.
A note provides a tip, guidance or advice, emphasizes important information, or provides a reference to related information.
An Attention statement indicates a stronger note, for example, to alert you when traffic might be interrupted or the device might reboot.
A Caution statement alerts you to situations that can be potentially hazardous to you or cause damage to hardware, firmware, software, or data.
A Danger statement indicates conditions or situations that can be potentially lethal or extremely hazardous to you. Safety labels are also attached directly to products to warn of these conditions or situations.
viii Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01

Brocade resources

To get up-to-the-minute information, go to http://my.brocade.com to register at no cost for a user ID and password.
Release notes are available at http://my.brocade.com.
White papers, online demonstrations, and data sheets are available through the Brocade website at:
http://www.brocade.com/products-solutions/products/index.page
Select Application Delivery Switches on this page to navigate to the relevant product information.

Contacting Brocade Technical Support

As a Brocade customer, you can contact Brocade Technical Support 24x7 online, by telephone, or by e-mail. Brocade OEM customers contact their OEM/Solutions provider.
For product support information and the latest information on contacting the Technical Assistance Center, go to http://www.brocade.com/services-support/index.html
If you have purchased Brocade product support directly from Brocade, use one of the following methods to contact the Brocade Technical Assistance Center 24x7.
Online Telephone Email
Preferred method of contact for non-urgent issues:
My Cases through
MyBrocade
Software downloads &
licensing tools
Knowledge Base
Required for Sev 1-Critical and Sev 2-High issues:
Continental US:
1-800-752-8061
Europe, Middle East, Africa,
and Asia Pacific: +800-AT FIBREE (+800 28 34 27
33)
support@brocade.com
Please include:
Problem summary
Serial number
Installation details
Environment description
For areas unable to access
toll free number: +1-408-333-6061
Toll-free numbers are
available in many countries.
If you have purchased Brocade product support from a Brocade OEM/Solution Provider, contact your OEM/Solution Provider for all of your product support needs.
OEM/Solution Providers are trained and certified by Brocade to support Brocade® products.
Brocade provides backline support for issues that cannot be resolved by the OEM/Solution
Provider.
Brocade Supplemental Support augments your existing OEM support contract, providing direct
access to Brocade expertise. For more information, contact Brocade or your OEM.
Brocade Virtual ADX XML API Programmer’s Guide ix 53-1003248-01

Document feedback

For questions regarding service levels and response times, contact your OEM/Solution
Provider.
Document feedback
Quality is our first concern at Brocade and we have made every effort to ensure the accuracy and completeness of this document. However, if you find an error or an omission, or you think that a topic needs further development, we want to hear from you. You can provide feedback in two ways:
Through the online feedback form in the HTML documents posted on
http://www.brocade.com.
By sending your feedback to documentation@brocade.com
Provide the publication title, part number, and as much detail as possible, including the topic heading and page number if applicable, as well as your suggestions for improvement.
x Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Chapter

WSDL Programming

In this chapter
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
Enabling a web service on a Brocade Virtual ADX . . . . . . . . . . . . . . . . . . . . . 6

Programmatic interface to Brocade Virtual ADX : XML APIs

XML APIs are a programmatic interface to access Brocade Virtual ADX. It uses the SOAP protocol over HTTP and allows customers an automated management of their Brocade Virtual ADX devices.
1
The fundamental entity in the XML API programming is the WSDL – an XML based text file which specifies the methods exposed by the device, and the ways to access it. Client applications have to be written to access the device using XML API based on the specifications in the WSDL.
Brocade Virtual ADX XML API Programmer’s Guide 1 53-1003248-01

Purpose of the WSDL

1
The following diagram is a pictorial description of the XML API framework.
FIGURE 1 XML API Framework
Purpose of the WSDL
Simple Object Access Protocol
Web Service Definition Language (Application Programming Interface)

XML SOAP interface overview

An XML SOAP interface for Brocade Virtual ADX application delivery controllers gives application administrators a programmatic way to access and manage ADX platforms through published APIs. It allows customers to achieve better orchestration and control over their application delivery infrastructure. Application administrators can create custom scripts using the XML SOAP interface to conduct several configuration tasks, gather system statistics, and simplify day-to-day operational tasks.
2 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Users have access to documented input and output characteristics for each XML SOAP method, the
NOTE
data types, and their values in a platform-independent way. The platform independence is achieved through use of XML (SOAP over HTTP) as the medium for information exchange. One major advantage of the XML-API is significant improvement in latency for accessing information from your ADX devices. The reason for this advantage is that HTTP is optimized for bulk data transfer, unlike SSH or Telnet, which are traditionally used for data access. Latency is measured as the time difference between a request sent to the ADX and a meaningful response becoming available at the client for further action. Such low latency environments are extremely useful in large application delivery deployments, where latency is expected to be as low as possible.

WSDL location

You can obtain the four WSDL files by accessing a Brocade Virtual ADX through the HTTP interface using the following URLs:
http://<device-ip>/wsdl/sys_service.wsdl http://<device-ip>/wsdl/network_service.wsdl http://<device-ip>/wsdl/slb_service.wsdl http://<device-ip>/wsdl/security_service.wsdl http://<device-ip>/wsdl/gslb_service.wsdl
WSDL location
1
The <device-ip> variable in the URL refers to the IP address of the management port on the Brocade Virtual ADX.

Accessing the client API using SOAP

The client application must send an HTTP authentication header before invoking every SOAP request. The username and password in the authentication header must have super user privileges on the Brocade Virtual ADX. The HTTP authentication header must also contain context information along with the username and password.

Creating client-specific APIs from client stubs

Use cases

The following examples provide a framework for developing ADX-specific programs.
Adding and binding a real server and a VIP
1. Add a real server.
2. Add a real server port.
3. Add a virtual server and virtual server port.
Brocade Virtual ADX XML API Programmer’s Guide 3 53-1003248-01
Creating client-specific APIs from client stubs
1
4. Bind the real server to the virtual server.
5. Save the configuration.
Each request is authenticated independently.
Refer to “Example: Adding and binding a real server and a VIP” for examples in Perl, Java, and C#.
Unbinding a real server from a VIP
1. Unbind a previously added real server from the virtual server.
2. Remove the real server and the virtual server.
3. Save the configuration.
Refer to “Example: Unbinding a real server from a VIP” for examples in Perl, Java, and C#.
Provisioning real and virtual servers
1. Add a list of real servers with common parameters.
2. Add a virtual server and real server ports to the VIP.
3. Remove or disable a list of real servers that has a given string in its name, using regular expressions or wild cards if needed.
4. Remove a real server and reuse its IP address for another real server.
Refer to “Example - Provisioning real and virtual servers” for examples in C#.
Monitoring the system
1. List all failed real server ports and real servers.
2. List all failed VIP ports and VIPs.
3. List all unplugged real servers (where the MAC address is unknown in the show server real output).
4. Monitor the status of a given real server port.
5. Monitor the status of a VIP port.
6. Monitor the current connections of a real server.
7. Monitor the current connections of a VIP.
8. Monitor the total current connections of the system.
9. Monitor the CPU and the memory of the system.

Code for simple SOAP clients

The following code examples illustrate how to work with the SOAP protocol.
Perl example
This example shows the output from the script "getChassisInfo.pl" and then shows the contents of the script.
4 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Creating client-specific APIs from client stubs
The following output results from the execution of the "getChassisInfo.pl" script:
C:\>getChassisInfo.pl
Chassis Model : SI-1216-4-PREM Chassis Serial : E2SA02F038
The contents of the “getChassisInfo.pl” script are as follows:
use SOAP::Lite;
my $soap = SOAP::Lite
-> uri('urn:webserviceapi')
-> proxy('http://username:password@10.24.140.172/WS/SYS')
-> ns('urn:webservicesapi','urn');
my $result = $soap->getChassis();
unless ($result->fault) { print "\nChassis Model : " .$result->valueof('//chassisData/identification/model'); print "\nChassis Serial : " .$result->valueof('//chassisData/identification/serialNum') } else { print join ', ', $result->faultcode, $result->faultstring; }
1
import java.io.*; import java.net.*; import java.util.*; import org.apache.soap.*; import org.apache.soap.rpc.*; public class Example1_client {
public static void main (String[] args) throws Exception {
System.out.println("\n\nCalling the SOAP Server to say hello\n\n"); URL url = new URL (args[0]); String name = args[1];
Call call = new Call ( ); call.setTargetObjectURI("urn:Example1"); call.setMethodName("sayHello"); call.setEncodingStyleURI(Constants.NS_URI_SOAP_ENC;); Vector params = new Vector ( ); params.addElement (new Parameter("name", String.class, name, null)); call.setParams (params);
System.out.print("The SOAP Server says: ");
Brocade Virtual ADX XML API Programmer’s Guide 5 53-1003248-01

Enabling a web service on a Brocade Virtual ADX

1
Response resp = call.invoke(url, "");
if (resp.generatedFault ( )) { Fault fault = resp.getFault ( ); System.out.println ("\nOuch, the call failed: "); System.out.println (" Fault Code = " + fault.getFaultCode ( )); System.out.println (" Fault String = " + fault.getFaultString ( )); } else { Parameter result = resp.getReturnValue ( ); System.out.print(result.getValue ( )); System.out.println( ); } } }
Enabling a web service on a Brocade Virtual ADX
Before a Brocade Virtual ADX can acknowledge any SOAP requests, it must have the web-management command configured with at least the soap-service option:
web-managment
Syntax: web-managment [option[ ...]] Options: allow-no-password Allow web server to have no password connection-receive-timeout Web connection receive timeout enable Enable web management frame Allow to disable or enable a frame front-panel Enable front panel hp-top-tools Enable the support of HP TOP Tools http Enable the support of http server list-menu Show web menu as a list page-menu Enable page menu page-size Maximum number of entries in a page refresh Page refresh (polling time) in seconds session-timeout Web session timeout in minutes (value 0 means no timeout) soap-service Enable SOAP Services
6 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Chapter

Using the XML API

In this chapter
API operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
API naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Request and response XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

API operations

You can use the XML API in this guide to perform operations on the various features and functions that are supported on the ADX platform.
Most APIs begin with one of the listed keywords in column 1 of the table below. The keyword indicates the type of operation that can be performed using the API. The arguments to these APIs form the various inputs for the operations. For greater flexibility, each API expects a minimum number of mandatory attributes.
2
The following table contains the basic operations, their descriptions, and examples.
TABLE 1 API operations
Basic API operations
create These APIs are used to create objects such as a real server or a virtual
delete These APIs are used to delete objects such as a real server on the
enable These APIs are used to enable objects after they are created on the
disable These APIs are used to disable objects after they are created and
update These APIs are used to update the configuration of an existing object.
clear These APIs are used to clear an attribute value of an object and set it
set These APIs are used to set one or more specific attributes of an object
get These APIs are used to obtain the configuration and statistics of an
Description Example
createVlan server on the Brocade Virtual ADX platform. All of the create APIs require a few mandatory attributes.
deleteIPSubnetVlans Brocade Virtual ADX platform.
enableGlobalFlowCo Brocade Virtual ADX platform. The objects that need to be enabled are the inputs to these APIs.
enabled on the Brocade Virtual ADX platform. The objects can be disabled without adjusting their current configuration.
If the value of an attribute is not set, it is removed from the configuration of the object.
back to the default value.
to a user-defined value.
object.
ntrol
disableInterfaces
updateIPSubnetVlan
s
clearIPRoute
setInterfaceConfig.
getConfiguration
Brocade Virtual ADX XML API Programmer’s Guide 7 53-1003248-01

API naming conventions

2
TABLE 1 API operations
Basic API operations
Description Example
getAll These APIs are used to obtain the configuration and statistics of more
than one object. The Brocade Virtual ADX device has a maximum number of objects that can be returned on the buffer. The resultant number of objects could be less then the total number of objects available on the Brocade Virtual ADX device. To facilitate the collection of details of all of the objects, these APIs contain "startIndex" and "numRetrieved" inputs. The “startIndex” is an index value with which you can retrieve the information. The "numRetrieved" is the number of entries that you want to retrieve. The response is limited to the number of objects that can be retrieved.
bind These APIs are used to bind one object to another object in the
Brocade Virtual ADX device, for example, binding a real server to a virtual server configured on the Brocade Virtual ADX platform.
unbind These APIs are similar to the bind APIs, and they are used to unbind an
object from another object on the Brocade Virtual ADX platform.
API naming conventions
All of the APIs and enumerations follow the CamelCase naming convention. The API name is formed by multiple words that are joined together as a single word. The APIs begin with a lowercase letter. The first letter of subsequent words is capitalized so that each word that makes up the name can be read easily. Two letter abbreviations are also capitalized if not the first word in the API name, for example, addAcl.
getAllIPSubnetVlans
bindSipPolicyToFilter
unbindSipServers
The names of data structures begin with a capital letter, but all of the other API naming convention rules apply, for example, RealServerMonitoringDetails and AclID.

Request and response XML

Most APIs make a query or a request and expect a response to the query. These requests and responses have a data structure in which they are sent and received respectively. The data structures contain the names of the data required and their respective data types.
8 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Chapter

System API Reference

In this chapter
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Enumerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Overview

The system API described in this chapter allow you to configure CPU-related settings for the Brocade Virtual ADX as needed.

Methods

3

Basic System Management

Description
The following APIs configure basic system management functions on the Brocade Virtual ADX device.
clearReloadConfig
Description Clears all the configuration on the device before reloading.
Return value
Tab le 1 contains the return value of the method.
TABLE 1 Return value
Name Type Description
message string Message
Error messages
List of Error Messages
Brocade Virtual ADX XML API Programmer’s Guide 9 53-1003248-01
3
Methods
getActiveTransitions
Description Retrieves the number of active transitions.
Parameters None
Return value
Tab le 2 contains the return value of the method.
.
TABLE 2 Return value
Name Type Description
active unsignedInt Number of active transitions.
Error messages
List of Error Messages
getARP
Description Retrieves the Address Resolution Protocol (ARP) information.
Parameters
Tab le 3 contains the parameters required for the method.
TABLE 3 Parameters
Name Type Presence Rules Description
ipAddress string Identifies the IP address of the device.
ipMask string Identifies the network mask for the IP address.
port string Identifies the port number.
macAddress string Identifies the MAC address of the device.
macMask string Identifies the mask for the MAC address of the device.
Return value
Tab le 4 contains the return value of the method.
TABLE 4 Return value
Name Type Description
genericInfo ResponseInformation Generic information
arpEntries arpEntry[ ] Returns the ARP cache entries.
Error messages
List of Error Messages
10 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Methods
getAsmState
Description Retrieves the state of the Application Switch Module (ASM) module.
Parameters
Tab le 5 contains the parameters required for the method.
TABLE 5 Parameters
Name Type Presence Rules Description
module unsignedInt Mandatory Specifies the ASM module number.
Return value
Tab le 6 contains the return value of the method.
TABLE 6 Return value
Name Type Description
state AsmState Specifies the ASM state.
3
Error messages
List of Error Messages
getConnectedUsers
Description Retrieves the user connected information.
Return value
Tab le 7 contains the return value of the method.
TABLE 7 Return value
Name Type Description
stats ConnectedUserStats[ ] Specifies who all the connections to the Brocade Virtual ADX
device.
Error messages
List of Error Messages
getCPU
Description Retrieves the CPU information.
Brocade Virtual ADX XML API Programmer’s Guide 11 53-1003248-01
3
Methods
Return value
Tab le 8 contains the return value of the method.
TABLE 8 Return value
Name Type Description
genericInfo ResponseInformation Generic information
modCpuUtil cpuUtil[ ] Returns the available and used memory space in the
management and barrel processors.
Error messages
List of Error Messages
getDNSName
Description Retrieves the Domain Name System (DNS) name.
Return value
Tab le 9 contains the return value of the method.
TABLE 9 Return value
Name Type Description
genericInfo ResponseInformation Generic information
name string Returns the DNS name of the server.
Error messages
List of Error Messages
getFlash
Description Retrieves the flash information.
Return value
Tab le 10 contains the return value of the method.
TABLE 10 Return value
Name Type Description
genericInfo ResponseInformation Generic information
flashData flash Returns the primary, secondary, and boot code version installed on
the flash memory.
Error messages
List of Error Messages
12 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
getHostName
Description Retrieves the hostname.
Return value
Tab le 11 contains the return value of the method.
TABLE 11 Return value
Name Type Description
genericInfo ResponseInformation Generic information
name string Returns the hostname of the device.
Error messages
List of Error Messages
getRAM
Description Retrieves the RAM information.
Methods
3
Return value
Tab le 12 contains the return value of the method.
TABLE 12 Return value
Name Type Description
genericInfo ResponseInformation Generic information
ram memStore Returns the total, used, and available memory space in the system.
Error messages
List of Error Messages
getRunningConfig
Description Retrieves the running configuration.
Return value
Tab le 13 contains the return value of the method.
TABLE 13 Return value
Name Type Description
genericInfo ResponseInformation Generic information
runConfig string Returns the current running configuration of the device.
Error messages
List of Error Messages
Brocade Virtual ADX XML API Programmer’s Guide 13 53-1003248-01
3
Methods
getSIFeatureStatus
Description Retrieves the status of a feature or features on an ADX device.
Parameters
.
TABLE 14 Parameters
Name Type Presence Rules Description
featureList featureEnum[ ] Mandatory Specifies one or more ADX feature names.
Return value
TABLE 15 Return value
Name Type Description
featureList FeatureStatus[ ] Specifies the status of one or more ADX features.
Error messages
List of Error Messages
getStandbyTransitions
Description Retrieves the number of standby transitions.
Parameters None
Return value
Tab le 16 contains the return value of the method.
.
TABLE 16 Return value
Name Type Description
standby unsignedInt Number of standby transitions.
Error messages
List of Error Messages
getStartupConfig
Description Retrieves the system configuration.
14 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Return value
Tab le 17 contains the return value of the method.
TABLE 17 Return value
Name Type Description
config string Identifies the configuration information for the system.
Error messages
List of Error Messages
getSystemClock
Description Retrieves the details of the system clock.
Return value
Tab le 18 contains the return value of the method.
TABLE 18 Return value
Name Type Description
Methods
3
clock SystemClock Specifies the clock detail.
Error messages
List of Error Messages
getSystemIP
Description Retrieves the list of configured IP addresses.
Return value
Tab le 19 contains the return value of the method.
TABLE 19 Return value
Name Type Description
genericInfo ResponseInformation Generic information
ipList networkInterface[ ] Returns the list of IP addresses configured on the device.
Error messages
List of Error Messages
getTechSupportInfo
Description Retrieves the technical support information.
Brocade Virtual ADX XML API Programmer’s Guide 15 53-1003248-01
3
Methods
Parameters
Tab le 20 contains the parameters required for the method.
TABLE 20 Parameters
Name Type Presence Rules Description
fileName string Identifies the file name.
startLineNumber unsignedInt
numLines unsignedInt Identifies the number of lines in a file.
Return value
Tab le 21 contains the return value of the method.
TABLE 21 Return value
Name Type Description
genericInfo ResponseInformation Generic information
technicalInfo string Identifies the technical support information.
Error messages
List of Error Messages
getVersion
Description Retrieves the Virtual ADX version details.
Parameters None
Return value
Tab le 22 contains the return value of the method.
TABLE 22 Return value
Name Type Description
genericInfo ResponseInformation Generic information.
version string ADX version information.
Error messages
List of Error Messages
runCLI
Description Executes a CLI command.
16 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Methods
Parameters
Tab le 23 contains the parameters required for the method.
TABLE 23 Parameters
Name Type Presence Rules Description
cmds string[] Optional Identifies the commands executed through the
CLI.
Return value
Tab le 24 contains the return value of the method.
TABLE 24 Return value
Name Type Description
genericInfo ResponseInformation Generic information
result string Returns the corresponding output of the commands executed
through the CLI.
Error messages
List of Error Messages
3
saveTechSupport
Description Saves the technical support information in a specified format.
Parameters
Tab le 25 contains the parameters required for the method.
TABLE 25 Parameters
Name Type Presence Rules Description
fileFormat techSupportFileFormatEnum Mandatory Specifies the format of the file.
fileName string Mandatory Specifies the name of the file.
Error messages
List of Error Messages
setDefaultModuleThresholdTemperatureConfig
Description Sets the deafult threshold temperature.
Parameters
Tab le 26 contains the parameters required for the method.
TABLE 26 Parameters
Name Type Presence Rules Description
temperatureConfig ModuleThresholdTemperatureConfiguration
Brocade Virtual ADX XML API Programmer’s Guide 17 53-1003248-01
3
Methods
Error messages
List of Error Messages
setModuleThresholdTemperatureConfig
Description Sets the threshold temperature.
Parameters
Tab le 27 contains the parameters required for the method.
TABLE 27 Parameters
Name Type Presence Rules Description
temperatureConfig ModuleThresholdTemperatureConfiguration
Error messages
List of Error Messages
setReloadConfig
Description Sets the reload configuration.
Parameters
Tab le 28 contains the parameters required for the method.
TABLE 28 Parameters
Name Type Presence Rules Description
reloadConfig ReloadConfiguration Mandatory Identifies the configuration of the Brocade
Virtual ADX reload.
Return value
Tab le 29 contains the return value of the method.
TABLE 29 Return value
Name Type Description
message string Message
Error messages
List of Error Messages
writeConfig
Description Saves the system configuration to the startup configuration file.
Error messages
List of Error Messages
18 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Methods
3

System - High Availability

Description
High Availability refers to a system or component that is continuously operational for a long time without failing. The following APIs configure High Availability system functions on the Brocade Virtual ADX.
addHABackupPort
Description Adds a backup port in the hot standby mode.
Parameters
Tab le 30 contains the parameters required for the method.
TABLE 30 Parameters
Name Type Presence Rules Description
backupPort HAbackupPort Optional Identifies the physical Ethernet port which is
used as the backup port. A system reload is required after invoking this API.
Error messages
List of Error Messages
addHARouterPort
Description Adds a router port in the hot standby mode.
Parameters
Tab le 31 contains the parameters required for the method.
TABLE 31 Parameters
Name Type Presence Rules Description
routerPort HARouterPort[ ] Optional Identifies the physical Ethernet port which is
used as the router port. A system reload is required after invoking this API.
Error messages
List of Error Messages
clearBackupNodeConfiguration
Description Clears the configuration of the backup node.
Brocade Virtual ADX XML API Programmer’s Guide 19 53-1003248-01
3
Methods
Parameters
Tab le 32 contains the parameters required for the method.
TABLE 32 Parameters
Name Type Presence Rules Description
attribute haNodeAttributeEnum[ ] Optional Identifies the configuration information for the
backup server.
Error messages
List of Error Messages
createVipGroup
Description Creates the VIP group and add it to VRID configuration.
Parameters
Tab le 33 contains the parameters required for the method.
TABLE 33 Parameters
Name Type Presence Rules Description
config HAVipGroupConfiguration Mandatory Identifies the configuration required for the
VIP group.
Error messages
List of Error Messages
deleteHABackupPort
Description Deletes the backup port and removes the hot standby HA configuration.
Parameters
Tab le 34 contains the parameters required for the method.
TABLE 34 Parameters
Name Type Presence Rules Description
backupPort HAbackupPort Optional Identifies the physical Ethernet port which will be
used as backup port.
Error messages
List of Error Messages
deleteHARouterPort
Description Deletes a router port.
20 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Loading...
+ 848 hidden pages