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

Creating Provisioning Scripts, Macro Expansion, Variables on the argument of

Page 45 highlights

Creating Provisioning Scripts Proprietary Plain-Text Configuration File 2 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 91. 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 If a macro name is not recognized, it remains unexpanded. For example, the name STRANGE is not recognized as a valid macro name, while MAU is recognized as a valid macro name. The administrator enters: spa$STRANGE$MAU.cfg The resulting macro expansion for a device with MAC address 000E08012345 is: spa$STRANGE000E08012345.cfg Macro expansion is not applied recursively. For example, $$MAU" expands into $MAU" (the $$ is expanded), and does not result in the MAC addres. The special purpose parameters (GPP_SA through GPP_SD), whose contents are mapped to the macro expressions $SA through $SD, are only macro expanded as the argument of the --key option in a resync URL. Also, the macro expression can qualify the expansion so that only a substring of the macro variable is used instead of its full value, such as a portion of the MAC address. The syntax for substring macro expansion is $(NAME:p) and $(NAME:p:q), where p and q are non-negative integers. The resulting expansion results in the macro variable substring starting at character offset p, and of length q (or till end-of-string if q is not specified). Refer to the following examples. The administrator enters: $(MAU:4) The resulting macro expansion for a device with MAC address 000E08012345 is: 08012345 The administrator enters: $(MAU:8:2) The resulting macro expansion for a device with MAC address 000E08012345 is: 23 Cisco Small Business IP Telephony Devices Provisioning Guide 43

  • 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
43
2
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 91
.
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
If a macro name is not recognized, it remains unexpanded. For example, the name
STRANGE is not recognized as a valid macro name, while MAU is recognized as a
valid macro name.
The administrator enters:
spa$STRANGE$MAU.cfg
The resulting macro expansion for a device with MAC address 000E08012345
is:
spa$STRANGE000E08012345.cfg
Macro expansion is not applied recursively. For example, $$MAU” expands into
$MAU” (the $$ is expanded), and does not result in the MAC addres.
The special purpose parameters (GPP_SA through GPP_SD), whose contents are
mapped to the macro expressions $SA through $SD, are only macro expanded as
the argument of the
--key
option in a resync URL.
Also, the macro expression can qualify the expansion so that only a substring of
the macro variable is used instead of its full value, such as a portion of the MAC
address.
The syntax for substring macro expansion is $(NAME:p) and $(NAME:p:q), where p
and q are non-negative integers. The resulting expansion results in the macro
variable substring starting at character offset p, and of length q (or till end-of-string
if q is not specified). Refer to the following examples.
The administrator enters:
$(MAU:4)
The resulting macro expansion for a device with MAC address 000E08012345
is:
08012345
The administrator enters:
$(MAU:8:2)
The resulting macro expansion for a device with MAC address 000E08012345
is:
23