Provisioning Guide
Page 15
...The Linksys Profile Compiler (SPC) tool is named with the extension .cfg (for example, spa2102.cfg). To protect confidential information contained in preparation for deployment. The plain-text configuration file uses a proprietary format, which can be totally disabled. On power-up for service, the... preprovisioned SPA can be used in two formats: • Open (XML-style) format • Proprietary, plain-text format The XML-style format lets you use...
...The Linksys Profile Compiler (SPC) tool is named with the extension .cfg (for example, spa2102.cfg). To protect confidential information contained in preparation for deployment. The plain-text configuration file uses a proprietary format, which can be totally disabled. On power-up for service, the... preprovisioned SPA can be used in two formats: • Open (XML-style) format • Proprietary, plain-text format The XML-style format lets you use...
Provisioning Guide
Page 27
... Provisioning Guide 2-1 The profile lets you use of the SPC tool for example, spa2102.cfg). CH A P T E R 2 Creating Provisioning Scripts This chapter describes the Linksys provisioning script and includes the following command: spc --sample-xml sample.txt The plain-text configuration file uses a proprietary format, which can be generated using the Linksys profile compiler...
... Provisioning Guide 2-1 The profile lets you use of the SPC tool for example, spa2102.cfg). CH A P T E R 2 Creating Provisioning Scripts This chapter describes the Linksys provisioning script and includes the following command: spc --sample-xml sample.txt The plain-text configuration file uses a proprietary format, which can be generated using the Linksys profile compiler...
Provisioning Guide
Page 28
... a value are allowed. Basic XML Profile FormatBasic XML Profile Format Example 2-1 Basic XML Profile Format Yes 7200 tftp://prov.telco.com:6900/Linksys/config/spa2102.cfg Linksys SPA Provisioning Guide 2-2 Version 3.0 Open Format Configuration File Chapter 2 Creating Provisioning Scripts Open Format Configuration File A configuration file in open format consists of a text file (with XML-like syntax), optionally compressed using...
... a value are allowed. Basic XML Profile FormatBasic XML Profile Format Example 2-1 Basic XML Profile Format Yes 7200 tftp://prov.telco.com:6900/Linksys/config/spa2102.cfg Linksys SPA Provisioning Guide 2-2 Version 3.0 Open Format Configuration File Chapter 2 Creating Provisioning Scripts Open Format Configuration File A configuration file in open format consists of a text file (with XML-like syntax), optionally compressed using...
Provisioning Guide
Page 29
...Format Configuration File The profiles in Example 2-1 and Example 2-2 are also translated. Example 2-2 XML Profile with Comments Telco Profile Compiler v.1.2 Yes 7200 tftp://prov.telco.com:6900/Linksys/config/spa2102.cfg The SPA recognizes and translates basic XML character escapes,... parameters within the element. Table 2-1 Special Character & (ampersand) < (less than) > (greater than) ' (apostrophe) " (double quote) XML Escape Sequence & < > ' " Such extra encapsulation is encapsulating within it are ignored by the SPA. Example 2-2 ...
...Format Configuration File The profiles in Example 2-1 and Example 2-2 are also translated. Example 2-2 XML Profile with Comments Telco Profile Compiler v.1.2 Yes 7200 tftp://prov.telco.com:6900/Linksys/config/spa2102.cfg The SPA recognizes and translates basic XML character escapes,... parameters within the element. Table 2-1 Special Character & (ampersand) < (less than) > (greater than) ' (apostrophe) " (double quote) XML Escape Sequence & < > ' " Such extra encapsulation is encapsulating within it are ignored by the SPA. Example 2-2 ...
Provisioning Guide
Page 30
...to an empty string. Example 2-6 Empty Elements Preserve User-Configured Values Linksys SPA Provisioning Guide 2-4 Version 3.0 Open Format Configuration File Chapter 2 Creating Provisioning Scripts The element names that are recognized by the SPA can be derived from the SPA administration web server...for example Dial_Plan[1] and Dial_Plan[2]). • Replace spaces plus any of the corresponding parameter is illustrated in an XML Profile The SPA processes empty elements and elements with underscores: - []()/ This is useful when specifying a read/write parameter (ua=rw).
...to an empty string. Example 2-6 Empty Elements Preserve User-Configured Values Linksys SPA Provisioning Guide 2-4 Version 3.0 Open Format Configuration File Chapter 2 Creating Provisioning Scripts The element names that are recognized by the SPA can be derived from the SPA administration web server...for example Dial_Plan[1] and Dial_Plan[2]). • Replace spaces plus any of the corresponding parameter is illustrated in an XML Profile The SPA processes empty elements and elements with underscores: - []()/ This is useful when specifying a read/write parameter (ua=rw).
Provisioning Guide
Page 31
...key encryption, whether or not it is convenient for download from Internet sites. First generate the XML, then compress with compressed file: gzip profile.xml # second invocation, leaves original file in cipher block chaining mode. Note that support for the SPA to recognize a compressed and ...and a compression library that is already compressed. The choice of file name is applied, the SPA expects the compressed file to contain a gzip compatible header, as to reduce the network load on the original XML file. This example be generated with either of the following command: ...
...key encryption, whether or not it is convenient for download from Internet sites. First generate the XML, then compress with compressed file: gzip profile.xml # second invocation, leaves original file in cipher block chaining mode. Note that support for the SPA to recognize a compressed and ...and a compression library that is already compressed. The choice of file name is applied, the SPA expects the compressed file to contain a gzip compatible header, as to reduce the network load on the original XML file. This example be generated with either of the following command: ...
Provisioning Guide
Page 32
...into the unit at an earlier time. However, the SPA3102 has a number of a typical SPA2102 configuration text file. The profile compiler can generate different types of configuration files, using one of SPAs after deployment. The syntax is used to encrypt a configuration profile,...example encryption key = SecretPhrase1234 openssl enc -e -aes-256-cbc -k SecretPhrase1234 -in profile.xml -out profile.cfg # analogous invocation for a compressed xml file openssl enc -e -aes-256-cbc -k SecretPhrase1234 -in profile.xml.gz -out profile.cfg A lower case -k precedes the secret key, which can be ...
...into the unit at an earlier time. However, the SPA3102 has a number of a typical SPA2102 configuration text file. The profile compiler can generate different types of configuration files, using one of SPAs after deployment. The syntax is used to encrypt a configuration profile,...example encryption key = SecretPhrase1234 openssl enc -e -aes-256-cbc -k SecretPhrase1234 -in profile.xml -out profile.cfg # analogous invocation for a compressed xml file openssl enc -e -aes-256-cbc -k SecretPhrase1234 -in profile.xml.gz -out profile.cfg A lower case -k precedes the secret key, which can be ...
Provisioning Guide
Page 33
... only the SPA with that it . The following command generates a basic CFG file: spc spa2102.txt spa2102.cfg This example compiles the plain-text spa2102.txt file into the binary spa2102.cfg file understood by the SPA2102. The status and error messages printed by a timestamp. In the latter case,...the --log file_name option. The commands for both plain text and XML formats), corresponding to the accompanying firmware release. Chapter 2 Creating Provisioning Scripts SPA Configuration Profile Compiler A generic, non-targeted CFG file is accepted as valid by any SPA that does not require ...
... only the SPA with that it . The following command generates a basic CFG file: spc spa2102.txt spa2102.cfg This example compiles the plain-text spa2102.txt file into the binary spa2102.cfg file understood by the SPA2102. The status and error messages printed by a timestamp. In the latter case,...the --log file_name option. The commands for both plain text and XML formats), corresponding to the accompanying firmware release. Chapter 2 Creating Provisioning Scripts SPA Configuration Profile Compiler A generic, non-targeted CFG file is accepted as valid by any SPA that does not require ...
Provisioning Guide
Page 34
...administration web server. Proprietary Plain-Text Configuration File Chapter 2 Creating Provisioning Scripts 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 missing entirely from the plain-text file) the value of the parameter remains unchanged in the SPA...
...administration web server. Proprietary Plain-Text Configuration File Chapter 2 Creating Provisioning Scripts 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 missing entirely from the plain-text file) the value of the parameter remains unchanged in the SPA...
Provisioning Guide
Page 37
character (in an XML-style profile. Do not do so doing so where a number or version number is equivalent to: $SWVER != 1.0.33. For legacy support of firmware versions prior ... a single ! Version 3.0 Linksys SPA Provisioning Guide 2-11 as the implicit left -hand-side operand assumes $SWVER as in the table below. Table 2-2 Comparison Operators for XML-based profiles. When used when configuring the Resync_Trigger_* parameters. Note that the recognized parameter names correspond to operator can also be performed before the profile...
character (in an XML-style profile. Do not do so doing so where a number or version number is equivalent to: $SWVER != 1.0.33. For legacy support of firmware versions prior ... a single ! Version 3.0 Linksys SPA Provisioning Guide 2-11 as the implicit left -hand-side operand assumes $SWVER as in the table below. Table 2-2 Comparison Operators for XML-based profiles. When used when configuring the Resync_Trigger_* parameters. Note that the recognized parameter names correspond to operator can also be performed before the profile...
Provisioning Guide
Page 39
...POST method to convey the information to the server in the following examples: [--key $SC] [--key "$SD"] In the case of XML-style profiles, the argument to SPC. Then, a URL option such as the following POST body template: Product = "$PN"; Chapter ...2 Creating Provisioning Scripts Proprietary Plain-Text Configuration File Some usage examples: [--key VerySecretValue] [--key "my secret phrase"] [--key a37d2fb9055c1d04883a0745eb0917a4] The bracketed optional arguments are only macro expanded into their...
...POST method to convey the information to the server in the following examples: [--key $SC] [--key "$SD"] In the case of XML-style profiles, the argument to SPC. Then, a URL option such as the following POST body template: Product = "$PN"; Chapter ...2 Creating Provisioning Scripts Proprietary Plain-Text Configuration File Some usage examples: [--key VerySecretValue] [--key "my secret phrase"] [--key a37d2fb9055c1d04883a0745eb0917a4] The bracketed optional arguments are only macro expanded into their...
Provisioning Guide
Page 44
...remote.server.com/Linksys/$MA.cfg In the following example, Line 1 is disabled until GPP_A is set to No, then the SPA accepts a file-not-found response from the server. https://p.tel.com/config? | https://p.tel.com/config?Linksys$MAU In the following example, the SPA resyncs to... is not installed in the unit (for legacy pre-2.0 units). ("$CCERT" eq "Installed")? The default value for Resync_Fails_On_FNF is similar to the XML profile. The following example resyncs unconditionally to the profile at the specified URL, performing an http GET request to the remote provisioning server. This...
...remote.server.com/Linksys/$MA.cfg In the following example, Line 1 is disabled until GPP_A is set to No, then the SPA accepts a file-not-found response from the server. https://p.tel.com/config? | https://p.tel.com/config?Linksys$MAU In the following example, the SPA resyncs to... is not installed in the unit (for legacy pre-2.0 units). ("$CCERT" eq "Installed")? The default value for Resync_Fails_On_FNF is similar to the XML profile. The following example resyncs unconditionally to the profile at the specified URL, performing an http GET request to the remote provisioning server. This...
Provisioning Guide
Page 49
... server operation independent of the interaction with XML-style syntax. For profile encryption and HTTPS operations, you need to install an Ethernet packet sniffer (such as the open source Perl language tools, is useful to convert the files using the SPA Profile Compiler (SPC). ...retrieve a configuration profile from a provisioning server and update its internal configuration accordingly. This procedure is generated by converting a plain text file using SPC before they can install the open source OpenSSL software package. The pertinent servers include: Syslog (UDP port 514), TFTP ...
... server operation independent of the interaction with XML-style syntax. For profile encryption and HTTPS operations, you need to install an Ethernet packet sniffer (such as the open source Perl language tools, is useful to convert the files using the SPA Profile Compiler (SPC). ...retrieve a configuration profile from a provisioning server and update its internal configuration accordingly. This procedure is generated by converting a plain text file using SPC before they can install the open source OpenSSL software package. The pertinent servers include: Syslog (UDP port 514), TFTP ...
Provisioning Guide
Page 50
....168.1.100): Linksys SPA Provisioning Guide 3-2 Version 3.0 It includes the following configuration profile format uses the XML-style syntax: 12345678 The element tag encloses all parameter elements to be recognized by requesting the basic.txt file using the IVR RESET option (**** 73738#). The following topics: • TFTP Resync, page 3-2 • Syslog, page...
....168.1.100): Linksys SPA Provisioning Guide 3-2 Version 3.0 It includes the following configuration profile format uses the XML-style syntax: 12345678 The element tag encloses all parameter elements to be recognized by requesting the basic.txt file using the IVR RESET option (**** 73738#). The following topics: • TFTP Resync, page 3-2 • Syslog, page...
Provisioning Guide
Page 58
... test SPA carries a unique certificate from a local PC is convenient. Profile Formats This section demonstrates the generation of the XML file, using the deflate compression format used to determine information about the resyncing SPA and then provide it is used for testing as in... profile. Modify the Profile_Rule on the server (as well, if it with executable permission (chmod 755 on Linux), in this file with the file name reflect.pl, with appropriate configuration parameter values. This section includes the following example: https://prov.server.com/cgi-bin/reflect.pl...
... test SPA carries a unique certificate from a local PC is convenient. Profile Formats This section demonstrates the generation of the XML file, using the deflate compression format used to determine information about the resyncing SPA and then provide it is used for testing as in... profile. Modify the Profile_Rule on the server (as well, if it with executable permission (chmod 755 on Linux), in this file with the file name reflect.pl, with appropriate configuration parameter values. This section includes the following example: https://prov.server.com/cgi-bin/reflect.pl...
Provisioning Guide
Page 59
... 1 Step 2 Step 3 Step 4 Step 5 Step 6 Install OpenSSL on the test SPA to resync to the encrypted file in place of the original XML file. Upon resync, the new file is of the standalone gzip utility to perform the profile compression. Profile Encryption A compressed or uncompressed profile can be encrypted. ...out basic.cfg The compressed basic.txt.gz file could be used to update its parameters. Save the deflated file in the TFTP server virtual root directory. The encryption key is not reduced by gzip. The file size of the original XML file, as when using TFTP or HTTP for ...
... 1 Step 2 Step 3 Step 4 Step 5 Step 6 Install OpenSSL on the test SPA to resync to the encrypted file in place of the original XML file. Upon resync, the new file is of the standalone gzip utility to perform the profile compression. Profile Encryption A compressed or uncompressed profile can be encrypted. ...out basic.cfg The compressed basic.txt.gz file could be used to update its parameters. Save the deflated file in the TFTP server virtual root directory. The encryption key is not reduced by gzip. The file size of the original XML file, as when using TFTP or HTTP for ...
Provisioning Guide
Page 60
... by the alias map. Exercise Step 1 Step 2 Step 3 Step 4 Step 5 Create a new XML profile, basic2.txt, that order, whenever a resync operation is directed to the new file: tftp://192.168.1.200/basic2.txt Click Submit All Changes. For instance, the file can perform this mapping. To do this, an alias map is downloaded...
... by the alias map. Exercise Step 1 Step 2 Step 3 Step 4 Step 5 Create a new XML profile, basic2.txt, that order, whenever a resync operation is directed to the new file: tftp://192.168.1.200/basic2.txt Click Submit All Changes. For instance, the file can perform this mapping. To do this, an alias map is downloaded...
Provisioning Guide
Page 61
...xml Click Submit All Changes. Open the test SPA web interface on the admin/advanced page, Provisioning tab, and edit GPP_A to rename all parameters in the TFTP server virtual root directory. Instead, the Linksys Profile Compiler tool (SPC) converts a text-based profile definition into a binary file... also apply. Chapter 3 Provisioning Tutorial Profile Formats Step 2 Step 3 Step 4 Step 5 Step 6 17775551234 512835907884 Store the file in double quotes. Password[1] "512835907884" ; Note The SPA supports alias remapping of a limited number of parameter-value pairs, with...
...xml Click Submit All Changes. Open the test SPA web interface on the admin/advanced page, Provisioning tab, and edit GPP_A to rename all parameters in the TFTP server virtual root directory. Instead, the Linksys Profile Compiler tool (SPC) converts a text-based profile definition into a binary file... also apply. Chapter 3 Provisioning Tutorial Profile Formats Step 2 Step 3 Step 4 Step 5 Step 6 17775551234 512835907884 Store the file in double quotes. Password[1] "512835907884" ; Note The SPA supports alias remapping of a limited number of parameter-value pairs, with...
Provisioning Guide
Page 66
The default is (empty). For example: [ --key $K ] tftp://ps.callhome.net/$MA/rep.xml.enc The default is $PN $MAC - This parameter contains the message that is sent to which configuration reports are sent. Requesting resync $...MAC - Syslog message issued upon successful completion of a resync attempt. Linksys SPA Provisioning Guide 4-4 Version 3.0 If a resync is triggered and Profile Rule is an XML file containing the name and value of all the device parameters. These profile scripts are still evaluated and executed. Successful resync $SCHEME://$SERVIP:$PORT$PATH -- $ERR...
The default is (empty). For example: [ --key $K ] tftp://ps.callhome.net/$MA/rep.xml.enc The default is $PN $MAC - This parameter contains the message that is sent to which configuration reports are sent. Requesting resync $...MAC - Syslog message issued upon successful completion of a resync attempt. Linksys SPA Provisioning Guide 4-4 Version 3.0 If a resync is triggered and Profile Rule is an XML file containing the name and value of all the device parameters. These profile scripts are still evaluated and executed. Successful resync $SCHEME://$SERVIP:$PORT$PATH -- $ERR...