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

Page 88

Advertising
background image

78

Brocade Virtual ADX XML API Programmer’s Guide

53-1003248-01

Methods

3

Return values
None.

Error messages

List of Error Messages

executeTemplateFile

Description
Executes a named template file with optional inputs.

Parameters

Table 194

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 194

executeTemplateFile 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.

inputs

TemplateSummaryFilter

[ ]

Optional

Only "variableName"
and "defaultValue"
fields are used.

Optional input
values to use in the
execution of the
template.

purgeConfig

boolean

TABLE 193

executeTemplateContent parameters (Continued)

Parameter

Type

Presence

Rules

Description

Advertising