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

Page 195

Advertising
background image

Brocade Virtual ADX XML API Programmer’s Guide

185

53-1003248-01

Methods

4

Parameters

Table 456

contains the parameters required for the method.

Return values

Table 457

contains the return values of the method.

Error messages

List of Error Messages

getAllIPForwardCache

Description
Retrieves all of the IP forward cache information.

Parameters

Table 458

contains the parameters required by the method.

TABLE 456

Parameters

Name

Type

Presence

Rules

Description

startIndex

unsignedInt

Optional

When both the
startIndex and
numRetrieved are
absent, then only the
available IP summary
information is
retrieved.

The start index used to retrieve
the summary of IP addresses
configured in the interfaces.

numRetrieved unsignedInt

Optional

When both the
startIndex and
numRetrieved are
absent, then only the
available IP summary
information is
retrieved.

The number of IP summaries to
be retrieved. Maximum value
allowed is 20.

filter

InterfaceSummaryFilter

Optional

The filter criteria.

TABLE 457

Return values

Name

Type

Description

genericInfo

ResponseInformation Identifies the generic information about all of the interface IP addresses.

summaryList

InterfaceSummary

[]

The summary of interface addresses.

TABLE 458

Parameters

Name

Type

Presence

Rules

Description

startIndex

unsignedInt Optional

Identifies the starting index.

numRetrieved

unsignedInt Optional

Identifies the number of sessions to be retrieved. The
maximum value allowed is 10.

filterInfo

IPFilter

Optional

Specifies the filter criteria.

Advertising