Using Configuration Templates for Switch Management
Templates in Aruba Central refer to a set of configuration commands that can be used for provisioning devices. Using templates, you can simultaneously apply CLI-based configuration parameters to multiple devices in a template group.
For template-based provisioning, switches must be assigned to a template group.
Creating a Template Group
Unlike UI groups, template groups have minimal UI options and use the CLI commands to provision a device. Template groups allow you to automate switch deployments. However, to minimize configuration errors and troubleshoot device-specific configuration issues, Aruba recommends that you familiarize with the CLI configuration options available on Aruba Switch and Aruba CX switches.
To manage devices using configuration templates, you can create a template group and assign devices.
For more information, see Creating a Group and Assigning Devices to Groups.
|
|
Aruba CX switches can only be configured using configuration templates. You cannot move a Aruba CX switch from a template group to a UI group in Aruba Central. If attempted, a warning is displayed that the Aruba CX switch cannot be moved to a UI group, because UI group is not supported on Aruba CX switches. When you onboard a factory default Aruba CX switch, the switch is listed under in the > page, because UI group is not available for Aruba CX switches. When you pre-provision a Aruba CX switch, the switch is listed under in the > page, because UI group is not available for Aruba CX switches. For Aruba CX switches, the feature is not supported. |
Creating a Configuration Template
To create a configuration template for switches:
1. In the app, set the filter to a template group.
The dashboard context for the group is displayed.
2. Under , click > .
3. Click the Config icon.
The tabs to configure switches using templates is displayed.
4. Click the tab. The Templates page is displayed.
5. Click to add a new template. The window is displayed.
6. In the tab, enter a name for the template in the field.
7. In the drop-down, select or .
8. Select the switch model and software version. You can specify any of the following combinations:
for both and —To apply the template to all switch models and all supported switch software versions.
for and a software version for —To apply the template to all switch models running the selected software version.
for and a switch model for —To apply the template to a switch model and all software versions supported by the selected switch model.
A switch model and a software version—To apply the template to a specific switch model and the software version. The template created for a switch model and a software version takes precedence over the template that is created for all platforms and versions.
9. Select the manufacturing part number of the switch in the drop-down.
|
|
The drop-down is displayed only if you select a switch model in the drop-down. If you select a specific switch model and part number, you can apply the template to a standalone switch and not to a stack. If you select in the drop-down, or if you select a switch model and in the drop-down, you can apply a template to both a standalone switch and stack. |
10. Click . The Template tab is displayed.
11. Build a new template or import configuration information from a switch that is already provisioned in the template group.
To build a new template, add the switch command information in the text box. Ensure that the template text adheres to the guidelines listed in the Important Points to Note.
To import configuration text from a switch that is already provisioned in the template group:
a. Click .
b. From the search box, select the switch from which you want to import the configuration. The imported configuration is displayed in the text box.
c. If required, modify the configuration parameters. Ensure that the template text adheres to the guidelines listed in the Important Points to Note.
|
|
Importing configuration from an existing device in the template group allows you to quickly create a basic template. However, before applying the template to other switches in the group, ensure that the template text is variabilized as per your deployment requirements. For more information on variable definitions, see Downloading Sample Variables File. All switch templates must include a password command to set a password for the device. The template cannot be saved without adding a password command. If the configuration that is pushed from Aruba Central to the device does not contain a password command, the configuration push is aborted for the device and a log is added to the audit trail. For example, if you add the password command in a condition block and the condition evaluates to false, the configuration that is pushed will not contain the password command. For more information, see Managing Password in Configuration Templates. For Aruba CX switches, you must configure the password only in plaintext. Also, the format of password must be user manager group <string> password plaintext <string> or user manager password plaintext <string>. For more information about using password commands, see the Configuring Username and Password Security chapter in the HPE ArubaOS-Switch Access Security Guide. |
d. To view the variables present in the imported configuration template, click . The Variables in Template column is displayed.
For more information on variables, see Downloading Sample Variables File.
e. To download the variables as a CSVComma-Separated Values. A file format that stores tabular data in the plain text format separated by commas. or plain text file, click the download icon and select one of the following options:
12. Click . After you apply the configuration template, switches reboot and reconnect to Aruba Central with the new configuration.
Important Points to Note
Note the following points when adding configuration text to a template:
The CLI syntax in the switch template must be accurate. Aruba recommends that you validate the configuration syntax on the switch before adding it to the template text.
Ensure that the command text indentation matches the indentation in the running configuration.
The commands in the template are case-sensitive.
The following example illustrates the case discrepancies that the users must avoid in templates and variable definitions.
trunk E1-E4 trk1 trunk
interface Trk1
dhcp-snooping trust
exit
trunk E1-E4 trk1 trunk
switch-interconnect trk1
trunk E5-E6 trk2 trunk
vlan 5
name "VLAN5"
untagged Trk2
tagged Trk1
isolate-list Trk1
ip igmp forcedfastleave Trk1
ip igmp blocked Trk1
ip igmp forward Trk1
forbid Trk1
loop-protect Trk2
trunk E1-E4 trk1 trunk
trunk E4-E5 trk2 trunk
spanning-tree Trk1 priority 4
spanning-tree Trk2 admin-edge-port
trunk A2-A4 trk1 trunk
igmp fastlearn Trk1
trunk E4-E5 trk2 trunk
ip source-binding 2 4.5.6.7 b05ada-96a4a0 Trk2
[no] ip source-binding trap OutOfResources
snmp-server mib hpSwitchAuthMIB ..
snmp-server mib hpicfMACsec unsecured-access ..
[no] lldp config <P-PORT-LIST> dot1TlvEnable ..
[no] lldp config <P-PORT-LIST> medTlvEnable ..
no lldp config <P-PORT-LIST> medPortLocation..
[no] lldp config <P-PORT-LIST> dot3TlvEnable ..
[no] lldp config <P-PORT-LIST> basicTlvEnable ..
[no] lldp config <P-PORT-LIST> ipAddrEnable <lldp-ip>
trunk-load-balance L4-based
trunk-load-balance L3-based
Downloading Sample Variables File
Best Practices
Aruba recommends you to follow the below steps to use configuration templates in managing switches:
1. Configure the switch.
2. Add the switch to Aruba Central.
3. Create the template, You can use option to import an existing template created for switches.
4. Modify the template based on the user requirement. For example, addition or removal of variables.
5. Save the edited template.
