Cisco SPA901-UK Provisioning Guide - Page 41

Comments, Macro Expansion, Creating Provisioning Scripts, Variables

Page 41 highlights

Creating Provisioning Scripts Proprietary Plain-Text Configuration File 2 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 commentmechanism 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 IP Telephony device. 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. During macro expansion, expressions of the form $NAME and $(NAME) are replaced by the contents of the named variables. These variables include general purpose parameters, several product identifiers, certain event timers, and provisioning state values. For a complete list, see the "Macro Expansion Variables" section on page 89. In the following example, the expression $(MAU) is used to insert the MAC address 000E08012345. The administrator enters: spa$(MAU)config.cfg The resulting macro expansion for a device with MAC address 000E08012345 is: spa000E08012345config.cfg 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

Creating Provisioning Scripts
Proprietary Plain-Text Configuration File
Cisco Small Business IP Telephony Devices Provisioning Guide
40
2
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
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 IP Telephony device.
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.
During macro expansion, expressions of the form $NAME and $(NAME) are
replaced by the contents of the named variables. These variables include general
purpose parameters, several product identifiers, certain event timers, and
provisioning state values. For a complete list, see the
“Macro Expansion
Variables” section on page 89
.
In the following example, the expression $(MAU) is used to insert the MAC address
000E08012345.
The administrator enters:
spa$(MAU)config.cfg
The resulting macro expansion for a device with MAC address
000E08012345 is:
spa000E08012345config.cfg