Programmer's Guide (Supporting ADX v03.1.00) Manual

366 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Methods
5
Parameters
Table 43 contains the parameters required for the method.
Return values
Table 44 contains the return values of the method.
Error messages
List of Error Messages
getAllVirtualServerPortsSummary
Description
Retrieves all virtual server port summary information.
Parameters
Table 45 contains the parameters required for the method.
TABLE 43 Parameters
Name Type Presence Rules Description
realServerPort ServerPort Mandatory Identifies the real server ports
whose bindings are to be
obtained.
startIndex unsignedInt Optional Sets the starting index used to
label the number of virtual server
ports in an ordered list.
numRetrieved unsignedInt Optional The number of elements
expected in the result by the
request. Maximum value allowed
is 8.
filter VirtualServerPortSummaryFilter Optional The filtering criteria that must be
applied to the result.
TABLE 44 Return values
Name Type Description
genericInfo ResponseInformation Generic information
ports VirtualServerPortSummary[] Returns the name or number list of all
the configured virtual server ports and
the summary of configuration
information.
TABLE 45 Parameters
Name Type Presence Rules Description
virtualServer Server Mandatory Identifies the virtual server from
which the ports list is obtained.
startIndex unsignedInt Optional Sets the starting index used to label
the number of virtual server ports in
an ordered list.