Linksys SPA921 Cisco Small Business IP Telephony Devices Provisioning Guide - Page 42

Proprietary Plain-Text Configuration File, Source Text Syntax

Page 42 highlights

Creating Provisioning Scripts Proprietary Plain-Text Configuration File 2 Proprietary Plain-Text Configuration File The plain-text configuration file uses a proprietary format, which can be encrypted to prevent unauthorized use of confidential information. By convention, the profile is named with the extension .cfg (for example, spa962.cfg). The SPC tool is used to compile the plain-text file into an encrypted CFG 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 IP Telephony Device. 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 IP Telephony Device. 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 a profile includes no more than one specification for each parameter. The element names derive from the field names in the administration web pages for the device, with the following modifications: • Element names may not include spaces or special characters. To derive the element name from the field name, subsitute an underscore for spaces and the following special characters: [ ] ( ) / For example, the Resync On Reset field is represented by the following element: Cisco Small Business IP Telephony Devices Provisioning Guide 40

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116

Creating Provisioning Scripts
Proprietary Plain-Text Configuration File
Cisco Small Business IP Telephony Devices Provisioning Guide
40
2
Proprietary Plain-Text Configuration File
The plain-text configuration file uses a proprietary format, which can be encrypted
to prevent unauthorized use of confidential information. By convention, the profile
is named with the extension .cfg (for example, spa962.cfg). The SPC tool is used to
compile the plain-text file into an encrypted CFG 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 IP Telephony Device.
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
IP Telephony Device.
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 a profile includes no
more than one specification for each parameter.
The element names derive from the field names in the administration web pages
for the device, with the following modifications:
Element names may not include spaces or special characters. To derive the
element name from the field name, subsitute an underscore for spaces and
the following special characters:
[ ] ( ) /
For example, the Resync On Reset field is represented by the following
element:
<Resync_On_Reset>