beautypg.com

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

Page 90

background image

80

Brocade Virtual ADX XML API Programmer’s Guide

53-1003248-01

Methods

3

Return value

Table 196

contains the return values for this method.

Error messages

List of Error Messages

getTemplate

Description
Retrieves a template.

Parameters

Table 197

contains the parameters for this method.

numRetrieved unsignedInt

Optional

Specifies the
number of templates
to be retrieved.
When both
startIndex and
numRetrieved
parameters are not
present, then all
possible templates
will be returned.

filter

TemplateSummaryFilter

Optional

Filter criteria.

TABLE 196

getAllTemplateSummary return values

Name

Type

Description

genericInfo

ResponseInformation

Generic Information.
The genericInfo consists of the totalCount - the total number of
entries in the returned result.

templateList

TemplateSummary

[ ]

Retrieves a list of Template Summaries.

TABLE 197

getTemplate parameters

Parameter

Type

Presence

Rules

Description

name

string

Mandatory

Must match the
DOS 8.3 filename
format.

The file name of the
template.

area

templateStorageAreaEnum

Mandatory

"ALL_AREAS" is not
allowed.

The storage area
where the template
is found.

TABLE 195

getAllTemplateSummary parameters (Continued)

Parameter

Type

Presence

Rules

Description