beautypg.com

Getallmatchlists – Brocade Virtual ADX XML API Programmer’s Guide (Supporting ADX v03.1.00) User Manual

Page 430

background image

420

Brocade Virtual ADX XML API Programmer’s Guide

53-1003248-01

Methods

5

Parameters

Table 196

contains the parameters required for the method.

Return values

Table 197

contains the return values of the method.

Error messages

List of Error Messages

getAllMatchLists

Description
Retrieves the summary of all the match lists.

Parameters

Table 198

contains the parameters required for the method.

TABLE 196

Parameters

Name

Type

Presence

Rules

Description

startIndex

unsignedInt

Optional

Any positive
integer value
between 1-
1024

Sets the start index
for retrieving the
element health
checks summary.

numRetrieved

unsignedInt

Optional

Any positive
integer value
between 1-
1024

Specifies the
number of element
health checks to be
retrieved. Maximum
value allowed is 16.

elmentHealthCheckFilter

ElementHealthCheckFilter

Optional

Specifies the Filter
Criteria.

TABLE 197

Return values

Name

Type

Description

genericInfo

ResponseInformation

Identifies the generic information about all Element Health
Checks.

elementList

ElementHealthChecksSummary

[]

Identifies the element health checks summary .

TABLE 198

Parameters

Name

Type

Presence

Rules

Description

startIndex

unsignedInt

Optional

Any positive integer value
between 1-1024

Identifies the starting index for
retrieving the match lists
summary.

numRetrieved

unsignedInt

Optional

Any positive integer value
between 1-1024

Identifies the number of match
lists to be retrieved. Maximum
value allowed is 16.

matchListFilter

MatchListSum
maryFilter

Optional

Specifies the filter criteria.