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

Brocade Virtual ADX XML API Programmer’s Guide 7
53-1003248-01
Chapter
2
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.
The following table contains the basic operations, their descriptions, and examples.
TABLE 1 API operations
Basic API
operations Description Example
create These APIs are used to create objects such as a real server or a virtual
server on the Brocade Virtual ADX platform. All of the create APIs
require a few mandatory attributes. createVlan
delete These APIs are used to delete objects such as a real server on the
Brocade Virtual ADX platform. deleteIPSubnetVlans
enable These APIs are used to enable objects after they are created on the
Brocade Virtual ADX platform. The objects that need to be enabled are
the inputs to these APIs. enableGlobalFlowCo
ntrol
disable These APIs are used to disable objects after they are created and
enabled on the Brocade Virtual ADX platform. The objects can be
disabled without adjusting their current configuration. disableInterfaces
update These APIs are used to update the configuration of an existing object.
If the value of an attribute is not set, it is removed from the
configuration of the object. updateIPSubnetVlan
s
clear These APIs are used to clear an attribute value of an object and set it
back to the default value. clearIPRoute
set These APIs are used to set one or more specific attributes of an object
to a user-defined value. setInterfaceConfig.
get These APIs are used to obtain the configuration and statistics of an
object. getConfiguration