Smartport Macro Configuration Guidelines - Cisco Catalyst 4500 Series Software Configuration Manual

Configuring SmartPort Macros

SmartPort Macro Configuration Guidelines

Follow these guidelines when configuring macros on your switch:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Catalyst 4500 Series Switch, Cisco IOS Software Configuration Guide - Cisco IOS XE 3.9.xE and IOS 15.2(5)Ex
21-6
If a command fails when you apply a macro, either due to a syntax error or to a configuration error,
the macro continues to apply the remaining commands to the interface.
cisco-global needs to be applied at the global configuration mode. We recommend that you apply
this macro before any other interface level macro.
Specific keywords are required when you apply the system-defined macros (cisco-desktop,
cisco-phone, cisco-switch, and cisco-router) on an interface.
When using the cisco-phone macro to apply port security, the port security maximum is 2
(switchport port-security maximum 2).
At most, three keyword-value pairs are allowed per system-defined macro.
When creating a macro, do not use the exit or end commands or change the command mode by using
interface interface-id. This could cause commands that follow exit, end, or interface interface-id
to execute in a different command mode.
When creating a macro, ensure that all CLI commands are in the same configuration mode.
When creating a macro that requires the assignment of unique values, use the parameter value
keywords to designate values specific to the interface. Keyword matching is case sensitive. All
matching occurrences of the keyword are replaced with the corresponding value. Any full match of
a keyword, even if it is part of a larger string, is considered a match and is replaced by the
corresponding value.
Macro names are case sensitive. For example, the commands macro name Sample-Macro and
macro name sample-macro result in two separate macros.
Some macros might contain keywords that require a parameter value. Use the macro global apply
macro-name ? global configuration command or the macro apply macro-name ? interface
configuration command to display a list of any required values in the macro. If you apply a macro
without entering the keyword values, the commands are invalid and are not applied.
When a macro is applied globally to a switch or to a switch interface, all existing configuration on
the interface is retained. it is helpful when applying an incremental configuration.
If you modify a macro definition by adding or deleting commands, the changes are not reflected on
the interface where the original macro was applied. You need to reapply the updated macro on the
interface to apply the new or changed commands.
Use the macro global trace macro-name global configuration command or the macro trace
macro-name interface configuration command to apply and debug a macro to find any syntax or
configuration errors. If a command fails because of a syntax error or a configuration error, the macro
continues to apply the remaining commands.
Some CLI commands are specific to certain interface types. If a macro is applied to an interface that
does not accept the configuration, the macro fails the syntax check or the configuration check, and
the switch returns an error message.
Applying a macro to an interface range is the same as applying a macro to a single interface. When
you use an interface range, the macro is applied sequentially to each interface within the range. If a
macro command fails on one interface, it is still applied to the remaining interfaces.
Chapter 21 Configuring SmartPort Macros