C H A P T E R 2 Creating Provisioning Scripts; Open Format Configuration File - Linksys SPA2102-AU Provisioning Manual

Open Format Configuration File

Open Format Configuration File
A configuration file in open, XML-style format can be sent from the provisioning server to the SPA
during a resync operation without compiling them into a binary object.
The SPA can accept configuration formats generated by standard tools. This eases development of
back-end provisioning server software to generate SPA configuration profiles from existing databases.
The SPA configuration profile open format consists of a text file (with XML-like syntax), optionally
compressed using the gzip deflate algorithm (RFC1951), and further optionally encrypted using 256-bit
AES symmetric key encryption.
The XML profile syntax consists of an XML-style hierarchy of elements, with element attributes and
values. Opening element tags need to be properly matched by corresponding closing element tags.
Empty element tags are allowed. Element tags are case sensitive. Comments are allowed, using standard
XML syntax. Leading and trailing white space is removed from the parameter value. New lines within
a value are converted to spaces.
The SPA recognizes elements with proper SPA parameter names, when encapsulated in the special
<flat-profile> element. In addition, the SPA also recognizes arbitrary, configurable aliases for a limited
number of parameter names. The <flat-profile> element itself can in turn be encapsulated within other
arbitrary elements.
Unrecognized element names are ignored by the SPA. Any parameters not specified by a profile are left
unchanged in the SPA. If the XML file contains multiple occurrences of the same parameter tag, the last
such occurrence overrides any earlier ones. To avoid inadvertently overriding configuration values for
a parameter, it is recommended that at most one instance of a parameter be specified in any one profile.
Element attributes are allowed. Their value must be enclosed by double quotes. All such attributes are
ignored by the SPA, except for the user-access attribute: ua.
The user-access attribute defines access to the administration web server for a specific parameter by the
User account. Access by the Admin account is unaffected by this attribute.
The ua attribute, if present, must have one of the following values:
•
•
•
If the user-access attribute (ua) is not specified in an element tag, the factory default user access is
applied for the corresponding parameter.
An XML header of the form <? . . . ?> is allowed, but is ignored by the SPA.
As an example, the following profile would be accepted by the SPA. It supplies the values of three
provisioning parameters.
Basic XML Profile FormatBasic XML Profile Format
Example 2-1
<flat-profile>
<Resync_On_Reset> Yes
</Resync_On_Reset>
<Resync_Periodic> 7200
</Resync_Periodic>
<Profile_Rule>
Linksys SPA Provisioning Guide
2-2
na—no access
ro—read-only
rw—read/write
Basic XML Profile Format
tftp://prov.telco.com:6900/Linksys/config/spa2102.cfg
Chapter 2 Creating Provisioning Scripts
Version 3.0