Cisco Small Business 300 1.1 Series Administration Manual page 50

Macro Commands
78-20269-01 Command Line Interface Reference Guide
Use the following guidelines to create a macro:
•
Use the macro name command to assign a name to the macro.
•
Enter one macro command per line.
•
Use the @ character to end the macro.
•
Use the # character at the beginning of a line to enter comment text within
the macro. In addition, # is used to identify certain preprocessor commands
that can only be used within a macro. There are two possible preprocessor
commands:
-
#macro key description - Each macro can be configured with up to 3
keyword and description pairs. When a macro is displayed from the GUI,
its keywords and descriptions are displayed (if they exist).
The syntax for this preprocessor command is as follows:
- #macro key description: $
keyword2
- #$
keyword3
- #$
Parameters:
- keyword - A keyword must be prefixed with '$'
- description-string - description of the keyword
-
#macro keywords - This preprocessor command accepts up to 3
keywords. The command creates a CLI help string with the keywords for
the macro. The help string will be displayed if help on the macro is
requested from the macro apply/trace and macro global apply trace
commands. The GUI also uses the keywords specified in the command
as the parameter names for the macro. See Example 2 and 3 below for a
description of how this command is used in the CLI.
The syntax for this preprocessor command is as follows:
- #macro keywords: $
Parameter:
- keyword-name - User-defined name of the keyword (parameter)
prefixed with '$'
It is important to consider the scope of any user-defined macro. Because of the
potential hazards of applying unintended configurations, do not change
keyword1
description_string
:
description_string
:
keyword-name1
description_string
:
keyword-name2
$
3
51