Proprietary Plain-Text Configuration File; Source Text Syntax - Linksys SPA2102-AU Provisioning Manual

Proprietary Plain-Text Configuration File

spc –-sample-profile plain.txt
# sample config.xml to be fed directly to an SPA running 2.0.6 or above:
spc --sample-xml config.xml
Proprietary Plain-Text Configuration File
The plain-text format is an alternative to the open format and is the only format recognized by firmware
releases prior to 2.0.6.

Source Text Syntax

The syntax of the plain-text file accepted by SPC is a series of parameter-value pairs, with the value
enclosed in double quotes. Each parameter-value pair is followed by a semicolon (for example,
parameter_name "parameter_value";). If no quoted value is specified for a parameter (or if a parameter
specification is missing entirely from the plain-text file) the value of the parameter remains unchanged
in the SPA.
The syntax also controls the User account access to the parameter in the administration web server. An
optional exclamation point or question mark, immediately following the parameter name, indicates the
parameter should be read-write or user read-only for the User account.
If neither mark is present, the parameter is made inaccessible to the user from the web server pages. Note
that this syntax has no effect on the Admin account access to the parameter. If the parameter
specification is missing entirely from the plain-text file, the User account access to the parameter
remains unchanged in the SPA.
If the plain-text file contains multiple occurrences of the same parameter-value specification, the last
occurrence overrides any earlier ones. To avoid accidentally overwriting configuration values, it is
recommended that no more than one specification for each parameter be included in one profile.
Parameter names in the plain-text file must match the corresponding names appearing in the SPA web
interface, with the following modifications:
•
•
•
The following illustrates the format for each parameter-value pair:
Parameter_name [ '?' | '!' ] ["quoted_parameter_value_string"] ';'
Boolean parameter values are asserted by any one of the values {Yes | yes | Enable | enable | 1}. They
are deasserted by any one of the values {No | no | Disable | disable | 0}.
The following are examples of plain-text file entries:
# These parameter names are for illustration only
Feature_Enable
Another_Parameter
Hidden_Parameter
Linksys SPA Provisioning Guide
2-8
Spaces between words are replaced by underscores, for example Multi_Word_Parameter
Parameters with a numeric identifier use a bracketed index syntax to identify the line, extension, or
user (for example, Line_Enable[1] and Line_Enable[2]).
Comments are delimited by a # character up to the end-of-line. Blank lines can be used for
readability.
! "Enable" ;
? "3600"
"abc123" ;
# user read-write, but force the value to Enable
; # user read-only
# user not-accessible
Chapter 2 Creating Provisioning Scripts
Version 3.0