Cisco 11503 Administration Guide - Page 274

Using the echo Command, Using Commented Lines

Page 274 highlights

Using the echo Command Chapter 8 Using the CSS Scripting Language Using the echo Command When you play a script, the default behavior of the script is to display each command and its output. Use the echo command to control what appears on the screen during script execution. Because the goal of most scripts is to present clear, useful output, it is good practice to disable the echo command by using the no echo command. The no echo command tells the script engine not to print the commands being processed or their output to the terminal. Once you disable the echo command, you must use the echo command explicitly to print text to the screen. Echo is enabled automatically upon script termination. For a further explanation of the echo and no echo commands, see "Using the "! no echo" Comment" later in this chapter. Note All of the examples and their outputs shown in the remainder of this chapter assume that the echo command is disabled, unless otherwise stated. Using Commented Lines To write scripts that other users can understand and maintain, it is important to document your script with comments. Comments are particularly important when other users begin using and/or modifying your scripts. To make this process easier for you, you can add commented lines to your scripts. You denote comments with the exclamation mark (!) as the first character in any line of a script. For example, enter: ! I want a comment here so that I can tell you that I will ! execute a show variables command show variables This example begins with a comment for the user to read (note the exclamation mark). Any characters are allowed after a comment symbol, but the entire line must be a comment. In the third line, the script will execute a show variables command because it does not start with an exclamation mark. Cisco Content Services Switch Administration Guide 8-6 OL-5647-02

  • 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
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364
  • 365
  • 366
  • 367
  • 368
  • 369
  • 370
  • 371
  • 372
  • 373
  • 374
  • 375
  • 376
  • 377
  • 378
  • 379
  • 380
  • 381
  • 382
  • 383
  • 384
  • 385
  • 386
  • 387
  • 388
  • 389
  • 390
  • 391
  • 392

Chapter 8
Using the CSS Scripting Language
Using the echo Command
8-6
Cisco Content Services Switch Administration Guide
OL-5647-02
Using the echo Command
When you play a script, the default behavior of the script is to display each
command and its output. Use the
echo
command to control what appears on the
screen during script execution. Because the goal of most scripts is to present clear,
useful output, it is good practice to disable the
echo
command by using the
no
echo
command. The
no echo
command tells the script engine not to print the
commands being processed or their output to the terminal. Once you disable the
echo
command, you must use the
echo
command explicitly to print text to the
screen.
Echo is enabled automatically upon script termination. For a further explanation
of the
echo
and
no echo
commands,
see
“Using the “! no echo” Comment”
later
in this chapter.
Note
All of the examples and their outputs shown in the remainder of this chapter
assume that the
echo
command is disabled, unless otherwise stated.
Using Commented Lines
To write scripts that other users can understand and maintain, it is important to
document your script with comments. Comments are particularly important when
other users begin using and/or modifying your scripts. To make this process easier
for you, you can add commented lines to your scripts. You denote comments with
the exclamation mark (!) as the first character in any line of a script.
For example, enter:
! I want a comment here so that I can tell you that I will
! execute a show variables command
show variables
This example begins with a comment for the user to read (note the exclamation
mark). Any characters are allowed after a comment symbol, but the entire line
must be a comment. In the third line, the script will execute a
show variables
command because it does not start with an exclamation mark.