Group Level CLI Configuration

Users can pre-define CLI configuration for one or more switch models. When switches join this switch group, the CLI configuration gets applied to the startup-config and the switches are rebooted for the configuration to take effect.
  • Group CLI Configuration is applicable only when a switch joins controller for the first time.
  • After selecting the Group CLI configuration option, the existing GUI options at the switch group level are disabled, including common settings, model family based configurations, the Copy configuration to, and Get configuration from functions.
  • If the Group CLI configuration is selected, only those switches joining the switch group after that point will inherit the configuration.
  • Switch-level UI configuration options and routing must be read-only. However, ports and LAG settings can still be configured from the ports table.
  • You cannot return to GUI mode to define the Switch group configuration unless the switch group is deleted and re-created.
Parent topic: Configuring the Switches

Enabling the Group CLI Configuration

An administrator can create a new template or modify an existing Group CLI configuration for the switch group before enabling the template.
  1. On the menu, click Network > Wired > Switches to display the Switches window.
  2. Select a Domain or Switch Group and in the Details section, click the Configuration tab.
  3. In the Group CLI Configuration section, switch ON Enable Group CLI Config to display the Confirming Group CLI Configuration Setup dialog box.

    Confirming Group CLI Configuration Setup

  4. Click OK to display the Group CLI Configuration dialog box.
  5. In the Choose Model, select one or more ICX models to create a new Group CLI Configuration template and click Next to display the CLI Configuration tab. You can also select an existing ICX model and click Next to modify the Group CLI configuration.
    Note: The RUCKUS ICX devices that have already been selected in the Group CLI Configuration will not be available.
  6. Enter the name of the Group CLI Configuration in the Name field. Insert the command lines in the space provided. Users can choose the CLI commands under the 'Examples' pane to build configuration. Alternatively, CLI commands can be typed directly or copied from a notepad and pasted into the 'CLI Configuration' box.

    Note: It is recommended that users get familiarized with FastIorn commands and their ordering to avoid any issues with applying the configuration.

    Inserting Command Lines in the CLI Configuration Interface

    Support for Space and Dollar Sign in Variable Type as String

    The example template provides a structured format for entering CLI commands in the CLI Configuration interface. It shows how to replace placeholders (enclosed in < >) with actual values to create valid configurations.

    Example Template

    Selecting IP Address as Variable Type

    Details of fields with IP address as variable type

    Example showing values with IP address as variable type

  7. Variables assist in applying unique configuration to the switches. For example, IP address can be defined as a variable so that each switch gets assigned a unique IP address . In the Edit Variable field, enter the Name, Type, Value 1, Value 2 and Value 3 of the variables, where Value1 denotes the “Starting IP Address”, Value 2 denotes the “Ending IP Address”, and Value 3 is the “Netmask".
    Note: The Edit Variable field is optional.

    By default, the Overwrite existing configuration on the Switches option is not selected and only the factory-default switches (no start-up config) will inherit the group level configuration. If this option is selected, the controller will replace the existing configuration of the new joined switch with the configuration defined for the group.

  8. After reviewing the Group CLI Configuration, click OK.
  9. A confirmation dialog box is displayed, click OK.
  10. The switch group is now Group CLI Configuration enabled and is available for provisioning.

    Provisioning the Group CLI Configuration Setup

  11. After the configuration is setup, any factory default switch joining the group will have the configuration applied and will be rebooted for the changes to take effect.
  12. Select a Domain or Switch Group and select the Switch.

    Discovering a New switch

CLI Templates

CLI templates enable users to make incremental configuration changes on the fly to the selected switches. CLI templates are not tied to any switch or switch group. Once defined, they can be applied to any selected switch(es) or Switch Groups.

Note: Only an administrator with Full Access permission can update CLI configurations. The validity of CLI commands and their ordering rests solely with the administrator.
Note: For more information about admin permissions, refer to RUCKUS SmartZone (LT-GA) Controller Administration Guide.

Using CLI templates

  1. On the menu, click Network > Wired > Switches to display the Switches window.
  2. Select a Domain > Switch Group or Switch Group and in the Details section, click the Configuration tab.
  3. Click CLI template icon to display the CLI Templates dialog box. You can select an existing CLI template with an existing common variables or create a new CLI template with a new common varibles.
    Note: To edit existing common variables or add common variables. Click Edit icon, modify the common variables or add common variables and then click Save. For more information, see Step 4 b Edit Variable.

    CLI Template

  4. Complete the following steps to create a new CLI template.
    1. Click Create icon to display the CLI Templates dialog box.

      CLI Templates Dialog Box

    2. Complete the following fields:
      • Name: Enter the name of the CLI template.
      • Command Lines: Insert or edit the command lines in the space provided. Users can choose the CLI commands under the 'Examples' pane to build configuration. Alternatively, CLI commands can be typed directly or copied from a notepad and pasted into the 'CLI Configuration' box.
        Note: It is recommended that users get familiarized with FastIron commands and their ordering to avoid any issues with applying the configuration.
      • Edit Variable: Click Add and select the String or Range or IP Address variable to add the String or Range or IP Address variable to the table. Variables helps to apply unique configuration to the switches. For example, IP address can be defined as a variable so that each switch gets assigned a unique IP address. In the Edit Variable field, enter the Name, Type, Value 1, Value 2, and Value 3 for IP address variables, where Value1 denotes the “Starting IP Address”, Value 2 denotes the “Ending IP Address”, and Value 3 is the “Netmask". Click icon to add a new variables setting to the Common Variables.
        Note: The Edit Variable field is optional.

        Adding Common Variables

        Adding Common Variables
    3. Select Reboot Switches after applying config checkbox if you want the switch to reload after the configuration update. If you do not select this option, the switch will not reload after the configuration update.
    4. Click Save & Next.
    5. Select the target switches checkbox and click Next to display the Review dialog box.

      Selecting Switches

      Note: Configuration will be applied only to the switches that are online. Users need to re-apply configuration for switches that are offline at a later time when they come back online.
    6. Review the CLI template.

      Reviewing the CLI Template

      Reviewing Template
    7. Select Apply now or Schedule Later to save the created template and apply to the selected switches. If you select the Schedule Later then select the Date and Time to apply the configuration.

      Schedule Later Dialog Box

    8. Click OK to display the CLI Template Set Successfully message.
    9. Click OK.
  5. Select a Domain > Switch Group or Switch Group and in the Details section, click the Configuration tab.
  6. In the Configuration History tab, select the Switch to display the Configuration Details. Make sure that the CLI template is successfully added to the switch.