Cisco SPA2102-AU Provisioning Guide - Page 35

Comments, Macro Expansion

Get Cisco SPA2102-AU PDF manuals and user guides View all Cisco SPA2102-AU manuals
Add to My Manuals
Save this manual to your list of manuals

Page 35 highlights

Chapter 2 Creating Provisioning Scripts Proprietary Plain-Text Configuration File Some_Entry ! ; # user read-write, leaves value unchanged Multiple plain text files can be spliced together to generate the source for the final binary CFG file. This is accomplished using the import directive at the start of a new line followed by one or more spaces and the file name to splice into the stream of parameter-value pairs. File splicing can be nested several files deep. For example, the file base.txt contains the following: Param1 "base value 1" ; Param2 "base value 2" ; The file spa1234.txt contains the following lines: import base.txt Param1 "new value overrides base" ; Param7 "particular value 7" ; When compiled, spa1234.txt becomes: Param1 "base value 1" ; Param2 "base value 2" ; Param1 "new value overrides base" ; Param7 "particular value 7" ; Comments During development and scripting, it is often convenient to temporarily disable a provisioning parameter by entering a # character at the start of the parameter value. This effectively comments-out the remaining text in that parameter. For example, a Profile_Rule with the value "# http://192.168.1.200/sample.cfg" is equivalent to an empty Profile_Rule. The # character comment-mechanism applies to the Profile_Rule*, Upgrade_Rule, and Resync_Trigger_* parameters. Macro Expansion Several provisioning parameters undergo macro expansion internally prior to being evaluated. This preevaluation step provides greater flexibility controlling the resync and upgrade activities of the SPA. The parameter groups which undergo macro expansion before evaluation are as follows: • Resync_Trigger_* • Profile_Rule* • Log_Resync_* • Upgrade_Rule • Log_Upgrade_* Under certain conditions, some general purpose parameters (GPP_*) also undergo macro expansion, as explicitly indicated in the Optional Resync Arguments section. Version 3.0 Linksys SPA Provisioning Guide 2-9

  • 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
2-9
Linksys SPA Provisioning Guide
Version 3.0
Chapter 2
Creating Provisioning Scripts
Proprietary Plain-Text Configuration File
Some_Entry
!
;
# user read-write, leaves value unchanged
Multiple plain text files can be spliced together to generate the source for the final binary CFG file. This
is accomplished using the
import
directive at the start of a new line followed by one or more spaces and
the file name to splice into the stream of parameter-value pairs. File splicing can be nested several files
deep.
For example, the file base.txt contains the following:
Param1 “base value 1” ;
Param2 “base value 2” ;
The file spa1234.txt contains the following lines:
import base.txt
Param1 “new value overrides base” ;
Param7 “particular value 7” ;
When compiled, spa1234.txt becomes:
Param1 “base value 1” ;
Param2 “base value 2” ;
Param1 “new value overrides base” ;
Param7 “particular value 7” ;
Comments
During development and scripting, it is often convenient to temporarily disable a provisioning parameter
by entering a # character at the start of the parameter value. This effectively comments-out the remaining
text in that parameter.
For example, a Profile_Rule with the value
is equivalent to an
empty Profile_Rule. The # character comment-mechanism applies to the Profile_Rule*, Upgrade_Rule,
and Resync_Trigger_* parameters.
Macro Expansion
Several provisioning parameters undergo macro expansion internally prior to being evaluated. This
preevaluation step provides greater flexibility controlling the resync and upgrade activities of the SPA.
The parameter groups which undergo macro expansion before evaluation are as follows:
•
Resync_Trigger_*
•
Profile_Rule*
•
Log_Resync_*
•
Upgrade_Rule
•
Log_Upgrade_*
Under certain conditions, some general purpose parameters (GPP_*) also undergo macro expansion, as
explicitly indicated in the Optional Resync Arguments section.