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

Page 92

Advertising
background image

82

Brocade Virtual ADX XML API Programmer’s Guide

53-1003248-01

Methods

3

getTemplateValidationStatus

Description
Retrieves the template validation operation status and list of errors or warnings, if any.

Parameters
None.

Return values

Table 200

contains the return values for this method.

Error messages

List of Error Messages

getTemplateVariables

Description
Gets the variables from a template.

Parameters

Table 201

contains the parameters for this method.

Return value

Table 202

contains the return values for this method.

TABLE 200

Return values

Name

Type

Description

status

templateOperationStatusEnum

overallResult

templateResultTypeEnum

The overall result of the operation.

Result

TemplateOperationResult

[ ]

Returns a collection of messages about the validation
results.

TABLE 201

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 202

Return values

Name

Type

Description

variables

TemplateSummaryFilter

[ ]

Retrieves all the variables from within the template.

variableGroup

TemplateVariableGroup

[ ]

Retrieves all the variable groups from within the
template.

Advertising