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

Page 432

Advertising
background image

422

Brocade Virtual ADX XML API Programmer’s Guide

53-1003248-01

Methods

5

Parameters

Table 202

contains the parameters required for the method.

Return values

Table 203

contains the return values of the method.

Error messages

List of Error Messages

getBooleanHealthCheck

Description
Retrieves the boolean health check.

Parameters

Table 204

contains the parameters required for the method.

Return values

Table 205

contains the return values of the method.

Error messages

List of Error Messages

TABLE 202

Parameters

Name

Type

Presence

Rules

Description

startIndex

unsignedInt

Optional

Any positive
integer value
between 1-1024

Identifies the start index for
retrieving the port profile
information.

numRetrieved

unsignedInt

Optional

Any positive
integer value
between 1-1024

Identifies the number of port
profiles to be retrieved. Maximum
value allowed is 16.

portProfileFilter

PortProfileSummaryFilter

Optional

Specifies the filter criteria.

TABLE 203

Return values

Name

Type

Description

genericInfo

ResponseInformation

Identifies the generic information about all port profiles.

profileList

PortProfilesSummary

[]

Identifies the port profile summary.

TABLE 204

Parameters

Name

Type

Presence

Rules

Description

elementName

string

Optional

Identifies the name of the boolean health check to be retrieved.

TABLE 205

Return values

Name

Type

Description

genericInfo

ResponseInformation

Identifies the generic information about Boolean Health Check.

element

BooleanHealthCheck

Identifies the boolean health check details.

Advertising