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

Page 89

Advertising
background image

Brocade Virtual ADX XML API Programmer’s Guide

79

53-1003248-01

Methods

3

Return values
None.

Error messages

List of Error Messages

getAllTemplateSummary

Description
Returns a summary of all templates in one or all storage areas.

Parameters

Table 195

contains the parameters for this method.

saveRunningConfig

boolean

Optional

If true, the resulting
running
configuration is
saved after the
template execution
is completed, but
only if no errors have
occurred.

Save the running
configuration to the
startup configuration
on the Brocade
Virtual ADX.

reloadAfter

boolean

Optional

If true, the ADX is
restarted after the
template execution
is completed, but
only if no errors have
occurred.

Reload the device
after successful
execution.

TABLE 195

getAllTemplateSummary parameters

Parameter

Type

Presence

Rules

Description

area

templateStorageAreaEnum

Mandatory

"ALL_AREAS" returns
templates from all
areas, otherwise
templates from one
selected area are
returned.

The storage area(s)
from which to query.

startIndex

unsignedInt

Optional

Sets the start index
for retrieving the
templates. When
both startIndex and
numRetrieved
parameters are not
present, then all the
possible templates
will be returned.

TABLE 194

executeTemplateFile parameters (Continued)

Parameter

Type

Presence

Rules

Description

Advertising