Cluster Builder

Cluster Builder shows a network map of the cluster command switch, cluster member switches, and all switches that are candidates for joining the cluster. Cluster Builder periodically polls the command switch for updates and redisplays the network map when devices are removed or added. An advisory is displayed while the network map is under construction. You can extend or restrict the network map and change the polling interval by selecting Cluster > User Settings (see the User Settings help file for details).

With this window, you can:

Using Pop-up Menus

To use a pop-up menu on the Cluster Builder window, right-click on a device or link on the network map to display the menu. Then, slide the mouse to highlight a menu selection, and release the mouse button to activate the selection.

Using Drop-down Menus

To use the drop-down menus in the menu bar on the Cluster Builder window, click a link or device on the network map to select it (selected switches are displayed in  a red rectangle, and selected links are labeled with the word Selected); then, click on a menu and select an item from it. Whenever a menu selection is invalid for a selected device or link, the selection is disabled (grayed out).

Adding a Device to the Cluster

A cluster can include a maximum of 16 switches: one command switch and 15 member switches. You can add devices to a cluster after you assign an IP address to the command switch and connect it to other devices running clustering software. If the command switch feature is not enabled on the command switch, you must enable it before building the cluster (you can enable it by using the Visual Switch Manager for the switch).

To add a device to the cluster:

  1. Click on a candidate (device with a blue label) to select it.
    The device is highlighted by a red rectangle.
  2. From the Cluster menu, select Add to Cluster.
    Note: Once the maximum allowed devices are added to the cluster, the Add to Cluster menu option is disabled (grayed out) on all candidates until a cluster member is removed.
  3. Enter the password, if prompted, then click OK.
    If the switch was configured with a password, the software prompts you for it before adding the switch to the cluster. If the switch has no password, the software automatically adds the device to the cluster.
    Note: When a switch is removed from a cluster, its member information is not removed from the configuration file. So if this switch previously belonged to the cluster, Cluster Builder might not prompt for a password when you add it.
  4. From the Options menu, select Save Configuration to save your changes to nonvolatile memory.
    Note: Catalyst 1900 and 2820 switches automatically save configuration changes to nonvolatile memory. Allow approximately one minute for changes to be saved to nonvolatile memory before resetting or turning off the switch.

Note: You can also do this procedure by using the Add to Cluster item on the switch pop-up menu.

When the device is added, its label turns green.

Removing a Device from the Cluster

To remove a device from the cluster:

Note: If you remove a member that has downstream members connected to it and the software does not have enough information to draw these members on the map, the downstream members are displayed as orphan devices in the upper left area of Cluster Builder. These orphan devices are cluster members that you can configure. 

  1. Click on a cluster member (device with a green label) to select it.
    The device is highlighted by a red rectangle.
  2. From the Cluster menu, select Remove from Cluster.
    When the device is removed, its label turns blue.
  3. From the Options menu, select Save Configuration to save your changes to nonvolatile memory.
    Note: Catalyst 1900 and 2820 switches automatically save configuration changes to nonvolatile memory. Allow approximately one minute for changes to be saved to nonvolatile memory before resetting or turning off the switch.

Note: You can also do this procedure by using the Remove from Cluster item on the switch pop-up menu.

Changing User Settings

User settings control the polling interval that updates the Cluster Builder window, the graphing and reporting functions, and the screens that display when you launch the Cluster Management Suite. You can change these settings (Cluster > User Settings) and save them on the command switch so they remain in effect when you launch the application later.

Displaying Cluster Manager

From Cluster Builder, you can access Cluster Manager, which shows a graphic of a switch cluster (the command switch and member switches) in a wiring closet view. By default, the command switch is located at the top of the cluster and is the only cluster member with an IP address displayed. From Cluster Manager, you can perform tasks on the port, device, and cluster level.

To display Cluster Manager, select Goto Cluster Manager from the Cluster menu. For more information, select Help>Contents on the Cluster Manager page.

By default, Cluster builder is displayed when you launch the Cluster Management Suite, but you can change this default by selecting Cluster > User Settings (for details, see the User Settings help file).

Displaying Cluster View

In Cluster View, the network map displays the cluster as a double-switch icon, candidates, and edge devices directly connected to the cluster. From this view, you can display link and device performance graphs, and access other views. You can alternate between the Cluster Builder and Cluster View windows.

To display Cluster View, select Toggle Views from the Views menu. (Click here for detailed information on Cluster View.)

Displaying Host Names or Addresses and Port Connections

By default, Cluster Builder displays the host name on the label of each device. To display address and port connection information instead of host names, select Toggle Labels from the Views menu.

When you toggle to addresses and port connection information, Cluster Builder displays IP addresses if they are assigned; otherwise, it displays the MAC addresses. If the network map contains an unknown device, no port numbers are displayed for the device. When a link on the network map represents a port group, Cluster Builder displays the ID of the first port that responds to the information request. To display detailed information about these ports, display a link report (see Displaying Link Graphs and Link Reports).

Some links on the network map represent multiple connections between the same two switches. To generate a report on an individual link left-click on the link and select a link ID from the pop-up menu; then right-click on the link and choose Link Report from the pop-up menu.

Launching VSM or the Device Web Page

To display the web page for the command switch, double-click on the command switch icon. You can display the web page for any other device by any of these methods:

Displaying Switch Bandwidth Graphs

The Bandwidth Graph displays an estimate of the traffic flowing through a switch that you select on the network map.

Note: Switch bandwidth graphs are not available on Catalyst 1900 and 2820 switches.

To display a switch bandwidth graph:

  1. Click on a cluster member (a device with a green label) to select it.
    The switch is highlighted by a red rectangle.
  2. Select Bandwidth Graph from the Device menu.
    For more information, click Help on the Bandwidth Graph window.
    Note: To change the polling interval for refreshing graph data, select Cluster > User Settings (for details, see the User Settings help file).

Hiding and Displaying Candidates

By default, Cluster Builder displays the command switch, cluster members, and cluster candidates.

To hide candidates connected to a cluster member:

  1. Click on the cluster member to select it.
    The member is highlighted by a red rectangle.
  2. From the Device menu, click Show/Hide Candidates.
    Candidates connected to the member are removed from the map.

To display candidates connected to a cluster member:

  1. Click on the cluster member to select it.
    The member is highlighted by a red rectangle.
  2. From the Device menu, select Show/Hide Candidates.
    Any candidates connected to the selected member are displayed on the map.

Refreshing the Switch State

If the state of a switch changes from down to up, Cluster Builder displays the device in yellow to notify you of the state change. To acknowledge this notification and display the up state:

  1. Click on the yellow device icon.
  2. Select Refresh State from the Device menu.
    The color of the device changes from yellow to green.

Configuring a Host Name

If you did not assign a host name to the command switch prior to launching Cluster Builder, it is assigned a default host name of "Switch." Any unnamed members are assigned the name "Switch-" and a number that indicates the order in which the device was added (such as Switch-1). If the command or member switch has an assigned host name, the name is retained and displayed on the page when you launch Cluster Builder.

Note: You cannot change the host name of a candidate device.

To change a host name:

  1. Click on a cluster member or command switch to select it.
    The device is highlighted by a red rectangle.
  2. Select Host Name Configuration from the Device menu.
    The modification dialog is displayed.
  3. In the Enter Host Name field, enter a unique name for the device.
    Note: On a command switch, the maximum length of the host name is 28 characters; on member switches, the maximum length is 31 characters. Do not use "-N" (where N is a number) as the last characters in host names for any switch.
  4. Click OK to close the dialog.
    The map is redisplayed with the new name shown for the device.
  5. Select Save Configuration from the Options menu to record your changes to nonvolatile memory.
    Note: Catalyst 1900 and 2820 switches automatically save configuration changes to nonvolatile memory. Allow approximately one minute for changes to be saved to non-volatile memory before resetting or turning off the switch.

Displaying Link Graphs and Link Reports

A Link Graph shows the total bytes transmitted and received on the link, total packets transmitted and received on the link, and total errors received on a link selected on the network map. To display a link graph, one end of the link must connect to a 2900 or 3500 XL port.

Note: You cannot graph links between Catalyst 1900 and 2820 switches, or between candidate switches.

To display a link graph, right-click on a link to display its pop-up menu; then select Link Graph from the menu. Or use this procedure:

  1. Click on a link to select it.
    The word "Selected" is displayed in red on the link.
  2. From the Link menu, select Link Graph to display the graph.
    For more information, click Help on the graph window.
    Note: You can change the graph polling interval by selecting User Settings from the Cluster menu. For more information, click Help on the User Settings page.

A Link Report displays port connection information for cluster members on each end of a selected link. If one of the link is connected to a Catalyst 1900 or 2820 switch, a candidate switch, or an unknown device, the report contains only member information.

Note: You cannot generate link reports between Catalyst 1900 and 2820 switches.

To display a link report, right-click on a link to display its pop-up menu; then select Link Report from the menu. Or use this procedure: 

  1. Click on a link to select it.
    The word "Selected" is displayed in red on the link.
  2. From the Link menu, select Link Report to display the report. For more information, click Help on the report window.

Arranging and Saving the Device Layout

Before arranging and saving the layout, make sure that all devices you want to manage are added to the cluster (either Cluster Builder discovered them or you added them manually).

To arrange and save the device layout:

  1. Click and hold the left mouse button on a cluster member and drag it to a new location on the network map.
  2. Select Save Layout from the Options menu.
    An advisory is displayed while the new layout is under construction. When you relaunch Cluster Builder, it displays the saved version of the layout unless the topology has changed. If the topology has changed, you must arrange the devices again and select Save Layout.

Saving a Configuration

Saving a configuration records any changes that you make using the Cluster Builder window to nonvolatile memory. Your changes remain in effect for subsequent sessions. To save your changes to nonvolatile memory, select Save Configuration from the Options menu.