Using Configuration Templates for AOS-CX Switch Management

Templates in Aruba Central (on-premises) refer to a set of configuration commands that can be used by the administrators for provisioning devices in a group. Configuration templates enable administrators to apply a set of configuration parameters simultaneously to multiple switches in a group and thus automate switch deployments.

  • To minimize configuration errors and troubleshoot device-specific configuration issues, Aruba recommends that the device administrators familiarize themselves with the CLI configuration commands available on AOS-CX switches.
  • The vsf member 1 line must be present in the configuration template for stackable AOS-CX switches running 10.07 or later versions. This is required to apply configuration to the switches. In case, if a template is applied to the switch that does not contain the vsf member 1 line, then the switch will be zeroized.

Creating a Group for Template-Based Configuration

For template-based provisioning, switches must be assigned to a group with template-based configuration method enabled.

For more information, see Creating a Group and Assigning Devices to Groups.

The Import Configuration As Template feature is supported only on AOS-CX switches running firmware version 10.06 or later.

Creating a Configuration Template

To create a configuration template for switches:

  1. In the Network Operations app, set the filter to a template group.

    The dashboard context for the group is displayed.

  2. Under Manage, click Devices > Switches.
  3. Click the Config icon.

    The tabs to configure switches using templates is displayed.

  4. Click the Templates tab. The Templates page is displayed.
  5. Click + to add a new template. The Add Template window is displayed.
  6. In the Basic Info tab, enter a name for the template in the Template Name field.
  7. In the Device Type drop-down, select Aruba CX.
  8. Select the switch model and software version. You can specify any of the following combinations:
    • ALL for both Model and Version—To apply the template to all switch models and all supported switch software versions.
    • ALL for Model and a software version for Version—To apply the template to all switch models running the selected software version.
    • ALL for Version and a switch model for Model—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 Part Number drop-down.
  • The Part Number drop-down is displayed only if you select a switch model in the Model 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 All in the Model drop-down, or if you select a switch model and All in the Part Number drop-down, you can apply a template to both a standalone switch and stack.
  1. Click Next. The Template tab is displayed.
  2. Build a new template by adding the output of the show running-config from the switch CLI in the Template text box. Ensure that the template text adheres to the guidelines listed in the Important Points to Note.
  • You must manually create the template for the AOS-CX switch in a group, along with the password in plaintext format. You can use the output of the show running-config command to create the template. You can also add variables to use the same template for onboarding multiple AOS-CX switches. For more information on variables, see Managing Variable Files.
  • 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 (on-premises) 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 AOS-CX switches, you must configure the password only in plaintext. Also, the format of password must be user admin group administrators password plaintext <string>.
  1. Click Save. After you apply the configuration template, switches reboot and reconnect to Aruba Central (on-premises) 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 and cannot contain the % character. In the template-based configuration, the % character is reserved and is used to denote variables.
  • The following example illustrates the case discrepancies that the users must avoid in the template text:

    ssh server vrf default ssh server vrf mGmt vsf member 1 type jl660ab vlan 1 spanning-tree interface Mgmt no shutdown ip dhcp interface 1/1/1 no shutdown no routing vlan access 1 interface 1/1/2 no shutdown no routing vlan access 1 interface 1/1/3 no shutdown no routing vlan access 1 interface 1/1/4 no shutdown no routing vlan access 1 interface 1/1/5 no shutdown no routing vlan access 1 interface 1/1/6 no shutdown no routing vlan access 1 interface 1/1/7 no shutdown no routing vlan access 1 interface 1/1/8 no shutdown no routing vlan access 1 interface 1/1/9 no shutdown no routing vlan access 1 interface vlan 1 ip dhcp ! ! ! ! ! https-server vrf default https-server vrf MGMT