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

Page 596

Advertising
background image

586

Brocade Virtual ADX XML API Programmer’s Guide

53-1003248-01

Methods

6

Parameters

Table 78

contains the parameters required for the method.

Return values

Table 79

contains the return values of the method.

Error messages

List of Error Messages

getAllSslKeyPairFileSummary

Description
Retrieves the summary information of all the SSL key pair files.

Parameters

Table 80

contains the parameters required for the method.

TABLE 78

Parameters

Name

Type

Presence

Rules

Description

startIndex

unsignedInt

Optional

Sets the start index for retrieving the key pair file
names. When both startIndex and numRetrieved
parameters are not present, all the key pair names
are returned.

numRetrieved

unsignedInt

Optional

Specifies the number of key pair file names to
retrieve. Maximum value allowed is 4096.
When both the startIndex and numRetrieved
parameters are not present, all the key pair names
are returned.

TABLE 79

Return values

Name

Type

Description

genericInfo

ResponseInformation

Generic response information.

filenameList

SslKeyName

[]

Array of key pair file names.

TABLE 80

Parameters

Name

Type

Presence

Rules

Description

startIndex

unsignedInt

Optional

Sets the starting index for labeling the
number of SSL keys in an ordered list.
When both the startIndex and
numRetrieved parameters are not present,
then a possible number of SSL key
summaries is returned.

numRetrieved

unsignedInt

Optional

Specifies the number of SSL key
summaries to be retrieved. Maximum
value allowed is 128.
When both the startIndex and
numRetrieved parameters are not present,
then a possible number of SSL key
summaries is returned.

filter

SslKeyPairFileSummaryFilter

Optional

Filter criteria.

Advertising