Brocade Virtual ADX XML API Programmer’s Guide (Supporting ADX v03.1.00) - Manual (Page 86)

76 Brocade Virtual ADX XML API Programmer’s Guide
53-1003248-01
Methods
3
Error messages
List of Error Messages
addTemplate
Description
Creates a new template with directly-provided content.
Parameters
Table 191 contains the parameters for this method.
Return values
None.
Error messages
List of Error Messages
overallRe
sult templateResultTypeEnum The overall result of the operation.
result TemplateSummaryFilter [ ] Returns a collection of messages about the template operation
results.
TABLE 191 addTemplate parameters
Parameter Type Presence Rules Description
name string Mandatory Must match the DOS
8.3 filename format. The file name under
which the template
will be stored.
area templateStorageAreaEnum Mandatory "ALL_AREAS" and
"PRE_DEFINED_ARE
A" not allowed. If
"READY_TO_USE_AR
EA" is used, the
template must not
be "raw" (lacking
user input required
to execute) The storage area
where the template
will be stored.
checkForRaw boolean Mandatory If false, bypass the
check for preventing
"raw" templates in
the ready-to-use"
area. The template
content to be
verified to see
whether it is “raw”.
templateContent string Mandatory Maximum size is
expected to be
approx 750k. The XML content of
the template
protected in a
"CDATA" wrapper.
TABLE 190 addInputToTemplateFile return values
Name Type Description