Commands For Clustering Access Control System

1.7 Commands for Cluster Configurations

1.7.1 clear cluster nodes

Command: clear cluster nodes [nodes-sn <candidate-sn-list> | mac-address <mac-addr>] Function: Clear the nodes in the candidate list found by the commander switch.
Parameters:

  • <candidate-sn-list>: sn of candidate switches. Valid values are from 1 to 256. More than one candidate can be specified.
  • <mac-addr>: mac address of the switches (including all candidates, members and other switches).

Command mode: Admin Mode
Default: No parameter means to clear information from all switches.
Usage guide: After executing this command, the information of this node will be deleted from the chain list saved on the commander switch. In 30 seconds, the commander will recreate a cluster topology and re-add this node. After being read, the candidate ID of the switch may change. The command can only be executed on commander switches.
Example: Clear all candidate switch lists found by the commander switch.

active500EM#clear cluster nodes

1.7.2 cluster auto-add

Command: cluster auto-add
???????????????????no cluster auto-add
Function: When this command is executed in the commander switch, the newly discovered candidate switches will be added to the cluster as a member switch automatically. The no command disables this function.
Parameters: None.
Command mode: Global Mode
Default: This function is disabled. This means that the candidate switches are not automatically added to the cluster.
Usage guide: After enabling this command on a commander switch, candidate switches will be automatically added as members.
Example: Enable auto adding in the commander switch.

active500EM(config)#cluster auto-add

1.7.3 cluster commander

Command: cluster commander [<cluster-name>] ???????????????????no cluster commander
Function: Set the switch as a commander switch and create a cluster.
Parameter:

  • <cluster-name>: the cluster?s name. The length of this field can be no longer than 32 characters.

Command mode: Global Mode
Default: No commander switch; cluster-name is null.
Usage guide: This command sets the role of a switch as the commander switch and creates a cluster which can only be executed on non commander switches. The cluster-name cannot be changed after the switch becomes a commander. The ?no cluster commander? command should be executed first. The no operation of this command will cancel the commander configuration of the switch.
Example: Set the current switch as the commander switch and name the cluster ?switch?.

active500EM(config)#cluster commander switch

1.7.4 cluster ip-pool

Command: cluster ip-pool <commander-ip>
???????????????????no cluster ip-pool
Function: Configure the private IP address pool for member switches of the cluster.
Parameter?

  • <commander-ip>: cluster IP address pool for allocating internal IP addresses of the cluster. commander-ip is the head address of the address pool. The valid format is 10.x.x.x, in dotted-decimal notation. The address pool should be big enough to hold 128 members which requires the last byte of addresses to be less than 126?254 ? 128 = 126). The IP address pool should never be changed if the commander is configured. The change can only be done after the ?no cluster commander? command has been executed.

Command mode: Global Mode
Default: Address pool is 10.254.254.1.
Usage guide: When candidate switches become cluster members, the commander switch allocates a private IP address to each member for the communication within the cluster for management and maintenance of cluster members. This command can only be used on non-commander switches. Once the cluster is established, users cannot modify the IP address pool. The no command will restore the address pool back to the default value, which is 10.254.254.1.
Example: Set the private IP address pool used by cluster member devices as 10.254.254.10.

active500EM(config)#cluster ip-pool 10.254.254.10

1.7.5 cluster keepalive interval

Command: cluster keepalive interval <second>
???????????????????no cluster keepalive interval
Function: Configure the interval of keepalive messages within the cluster.
Parameter:

  • <second>: keepalive interval. Valid values are in seconds with a range from 3 to 30.

Command mode: Global Configuration Mode
Default: 30 seconds.
Usage guide: After executing this command on a commander switch, the value of the parameter will be distributed to all member switches via the TCP connections between the commander and members. After executing this command on a non commander switch, the configuration value will be saved but not used until the switch becomes a commander. The keepalive interval is the the interval distributed by its commander. The commander will send DP messages within the cluster once during each keepalive interval. Members will respond to the received DP messages with DR messages. The no operation of this command will restore the keepalive interval in the cluster to the default value.
Example: Set the keepalive interval in the cluster to 10 seconds.

active500EM(config)#cluster keepalive interval 10

1.7.6 cluster keepalive loss-count

Command: cluster keepalive loss-count <loss-count>
???????????????????no cluster keepalive loss-count
Function: Configure the max number of lost keepalive messages in a cluster.
Parameter:

  • <loss-count>: tolerable max number of lost messages. The range is from 1 to 10.

Command mode: Global Configuration Mode
Default: 3.
Usage guide: After executing this command on a commander switch, the value of the parameter will be distributed to all member switches via the TCP connections between the commander and members. After executing this command on a non-commander switch, the configuration value will be saved but not used until the switch becomes a commander. The loss-count value is the one distributed by the commander. The commander calculates the loss-count after sending each DP message. The commander adds 1 to the loss-count of each switch, and clears that switch, after receiving a DR message. When a loss-count reaches the configured value (3 by default), the commander will delete the switch from its candidate chain list. If the time that a member fails to receive DP messages from the commander reaches loss-count, it will change its status to candidate. The no operation of this command will restore the max number of lost keepalive messages in the cluster back to the default value of 3.
Example: Set the tolerable max number of lost keepalive messages in the cluster to 5.

active500EM(config)#cluster keepalive loss-count 5

1.7.7 cluster member

Command: cluster member {nodes-sn <candidate-sn-list> | mac-address <mac-addr> [id <member-id>]}
???????????????????no cluster member {id <member-id> | mac-address <mac-addr>}
Function: On a commander switch, manually add candidate switches into the cluster. The no command deletes the specified member switch and no longer identifies it as a candidate.
Parameters:

  • nodes-sn <candidate-sn-list> ?all cluster member switches as recorded in a chain list, each with a node sn which can be viewed by the ?show cluster candidates? command. One or more candidates can be added as member at one time. The valid range is 1-256.
  • <mac-addr>? CPU Mac of candidate switches.
  • <member-id>? member id can be specified to a candidate as it becomes a member. The range is from 1 to 128, increasing from 1.
  • nodes-sn: automatically generated sn which may change after the candidate becomes a member. Members added will be treated like those added in mac-addr mode with all config files in mac-addr mode.

Command mode: Global Mode
Default: None.
Usage guide: After executing this command, the switch will add those candidate switches identified in <nodes-sn> or <mac-address>. One or more candidates are allowed at one time, linked with ?-? or ?;?. A switch can only be member or commander of one cluster. If this command is used on a non commander switch an error will occur. The no operation of this command will delete the specified member switch and identify it as a candidate.
Example: In the commander switch, add the candidate switch which has the sequence number of 1. In the commander switch, add the switch with the mac address of 11-22-33-44-55-66 to member, and the member-id of 5.

active500EM(config)#cluster member nodes-sn 1
active500EM(config)#cluster member mac-address 11-22-33-44-55-66 id 5

1.7.8 cluster member auto-to-user

Command: cluster member auto-to-user
Function: All members will be deleted when configuring no cluster auto-add. Users need to change members to manually added ones to keep them.
Parameters: None.
Command mode: Global Mode.
Default: None.
Usage guide: Execute this command on a switch to change automatically added members to manually added ones.
Example: Change automatically added members to manually added ones.

active500EM(config)#cluster member auto-to-user

1.7.9 cluster reset member

Command: cluster reset member [id <member-id> | mac-address <mac-addr>] Function: In the commander switch, this command can be used to reset the member switch.
Parameter:

  • member-id: Valid values are from 1 to 128. Use hyphen ?-? or semicolon ?;? to specify more than one member. If no value is provided, all member switches will be rebooted.

Command mode: Admin Mode
Default: Boot all member switches.
Usage guide: In the commander switch, users can use this command to reset a member switch. If this command is executed on a non-commander switch, an error will be displayed.
Example: In the commander switch, reset the member switch to 1.

active500EM#cluster reset member id 1

1.7.10 cluster run

Command: cluster run [key <WORD>] [vid <VID>]
???????????????????no cluster run
Function: Enable the cluster function. The no command disables the cluster function.
Parameters:

  • <WORD>?all keys in one cluster should be the same. The value should no longer than 16 characters.
  • <VID>?vlan id of the cluster. The valid range is 1 to 4094.

Command mode: Global Mode
Default: Cluster function is disabled. key: NULL() vid?1.
Usage guide: This command enables the cluster function. The cluster function must be enabled before implementing any other cluster commands. The ?no cluster run? command disables the cluster function. Users should allocate an exclusive vlan for the cluster?such as vlan100).
Note? routing protocols should be disabled on the layer 3 interface where the cluster vlan is located to avoid broadcasting the private route of the cluster.
Example: Disable the cluster function in the local switch.

active500EM(config)#no cluster run

1.7.11 cluster update member

Command: cluster update member <member-id> <src-url> <dst-filename> [ascii | binary] Function: Remotely upgrade member switches from the commander switch.
Parameters:

  • <member-id>? The valid range is from 1 to 128. Use a hyphen ?-? or semicolon ??? to specify more than one member.
  • <src-url>? location of source files to be copied.
  • <dst-filename>? specified filename for saving the file in the flash of the switch.
  • ascii: the file transmission follows ASCII standard.
  • binary: the file transmission follows binary standard. This is the default mode.
  • When src-url is a FTP address, its form will be: ftp://<username>:<password>@<ipadress>/<filename>.
    • <username>: FTP username.
    • <password>: FTP password.
    • <ipadress>: IP address of the FTP server.
    • <filename>: name of the file to be downloaded via FTP.
  • When src-url is a TFTP address, its form will be: tftp://<ipadress>/<filename>.
    • <ipadress>: IP address of the TFTP server.
    • <filename>: name of the file to be downloaded.
  • Special keywords used in the source or destination address filename:
    • startup-config: start-up configuration file
    • nos.img: system file

Command mode: Admin Mode
Usage guide: The commander distributes the remote upgrade command to members via the TCP connections and the members perform a remote upgrade and reboot. If this command is used on a non-commander switch, an error will be displayed. If more than one member is to be upgraded, these member switches should have the same IMG files. Otherwise, there will be a failure during re-booting.
Example: Remotely upgrade a member switch from the commander switch, with member ID 1, source file location ftp://switch:switch@192.168.1.1/nos.img, and destination filename nos.img.

active500EM#cluster update member 1 ftp://switch:switch@192.168.1.1/nos.img nos.img

1.7.12 debug cluster

Command: debug cluster {statemachine | application | tcp}
???????????????????no debug cluster {statemachine | application | tcp}
Function: Enable application debugging of the cluster. The no command disables this command.
Parameters:

  • statemachine: display debugging information when the switch status changes.
  • application: display debugging information when users configure the switch after logging on via SNMP, WEB.
  • tcp: TCP connection between the commander and the member.

Command mode: Admin Mode
Default: None.
Usage guide: Enable application debugging of the cluster.
Example: Enable debugging status on the switch.

active500EM#debug cluster statemachine

1.7.13 debug cluster packets

Command: debug cluster packets {DP | DR | CP} {receive | send}
???????????????????no debug cluster packets {DP | DR | CP} {receive | send}
Function: Enable debugging. The no command disables debugging.
Parameters:

  • DP: discovery messages.
  • DR: responsive messages.
  • CP: command messages.
  • receive: receive messages.
  • send: send messages.

Command mode: Admin Mode
Default: None.
Usage guide: Enable debugging of cluster messages. After enabling classification, all DP, DR and CP messages sent or received in the cluster will be displayed.
Example: Enable debugging of received DP messages.

active500EM#debug cluster packets DP receive

1.7.14 show cluster

Command: show cluster
Function: Display cluster information of the switch.
Parameters: None.
Command mode: Admin and Configuration Mode
Default: None.
Usage guide: None.
Example: Execute this command on different switches.
?-in a commander???????-

active500EM#show cluster
  Status: Enabled
  Cluster VLAN: 1
  Role:                 commander
  IP pool:              10.254.254.1
  Cluster name:         MIS-zebra
  Keepalive interval:   30
  Keepalive loss-count: 3
  Auto add:             Disabled
  Number of Members:    0
  Number of Candidates: 3

?-in a member ????????-

active500EM#show cluster
  Status: Enabled
  Cluster VLAN: 1
  Role:   Member
  Commander Ip Address: 10.254.254.1
  Internal Ip Address:  10.254.254.2
  Commamder Mac Address: 00-12-cf-39-1d-90

?- a candidate ????????-

active500EM#show cluster
  Status: Enabled
  Cluster VLAN: 1
  Role:   Candidate

?- disabled ?????????-

active500EM#show cluster
  Status: Disabled

1.7.15 show cluster members

Command: show cluster members [id <member-id> | mac-address <mac-addr>] Function: Display cluster member information. This command only applies to commander switches.
Parameters:

  • <member-id>: member id of the switch.
  • <mac-addr>: CPU MAC addresses of member switches.

Command mode: Admin and Configuration Mode
Default: No parameters displays information of all member switches.
Usage guide: Executing this command on a commander switch will display the configuration information of all cluster member switches.
Example: Execute this command on a commander switch to display the configuration information of all, and specified, cluster member switches.

active500EM#show cluster members
Member From : User config(U); Auto member (A)
ID From Status     Mac               Hostname     Description   Internal IP
--- - ------------ ----------------- ------------ ------------- ---------------
xxx x xxxxxxxxxx12 xx-xx-xx-xx-xx-xx xxxxxxxxxx12 xxxxxxxxxx12  xxx.xxx.xxx.xxx
  1 U Inactive     00-01-02-03-04-05 MIS-zebra    DCRS-6804     10.254.254.2
  2 A Active       00-01-02-03-04-05 MIS-bison    DCRS-6804     10.254.254.3
  3 U Active       00-01-02-03-04-05 SRD-jaguar   DCRS-9808     10.254.254.4
  4 A Inactive     00-01-02-03-04-05 HRD-puma     DCRS-5950-28T 10.254.254.5
active500EM#show cluster members id 1
Cluster Members:
ID:          1
Member status: Inactive member  (user-config)
IP Address:    10.254.254.2
MAC Address:   00-01-02-03-04-06
Description:   DCRS-9808
Hostname:      DSW102

1.7.16 show cluster candidates

Command: show cluster candidates [nodes-sn <candidate-sn-list> | mac-address <mac-addr>] Function: Display the information of the candidate member switches for the command switch.
Parameters:

  • <candidate-sn-list>?Specify candidate number in candidate list. The valid range is from 1 to 256. More than one switch can be specified.
  • <mac-addr>? MAC address of the candidate switch.

Command mode: Admin and Configuration Mode
Default: No parameters means that all member switch information is displayed.
Usage guide: Executing this command on the switch will display the information of the candidate member switches.
Example: Display configuration information of all cluster candidate switches.

active500EM#show cluster candidates
  --------------------------------------------------------
  Cluster Candidates:
  SN       Mac            Description                 Hostname
  --- -----------------   ------------------------   ------------------------
  xxx xx-xx-xx-xx-xx-xx   xxxxxxxxxxxxxxxxxxxxxx24    xxxxxxxxxxxxxxxxxxxxxx24
    1 00-01-02-03-04-06   ES3528M
    2 01-01-02-03-04-05   ES3528M                     MIS-zebra

1.7.17 show cluster topology

Command: show cluster topology [root-sn <starting-node-sn> | nodes-sn <node-sn-list> | mac-address <mac-addr>] Function: Display cluster topology information. This command only applies to commander switches.
Parameters:

  • <starting-node-sn>?the starting node of the topology.
  • <node-sn-list>?the switch node sn.
  • <mac-addr>?the CPU MAC address of the switch.
  • No parameters: display all topology information.

Command mode: Admin and Configuration Mode
Default: None.
Usage guide: Executing this command on the commander switch will display the topology information with the starting node specified.
Example: Execute this command on the commander switch to display the topology information.

active500EM#show cluster topology
Role: commander(CM);Member(M);Candidate(CA);Other commander(OC);Other member(OM)
LV SN Description  Hostname    Role  MAC-ADDRESS     Upstream     Upstream     leaf
                                                     local-port   remote-port  node
- --- ------------ ------------ -- ----------------- ------------ ------------ ----
x xxx xxxxxxxxxx12 xxxxxxxxxx12 xx xx-xx-xx-xx-xx-xx xxxxxxxxxx12 xxxxxxxxxx12 x
1   1 ES4626H      LAB-SWITCH-1 CM 01-02-03-04-05-01 -root-       -root-       -
    2 ES4626H      LAB-SWITCH-2 M  01-02-03-04-05-02 eth 1/0/1    eth 1/0/2    N
    3 ES4626H      LAB-SWITCH-3 CA 01-02-03-04-05-03 eth 1/0/1    eth 1/0/3    Y
    4 ES4626H      LAB-SWITCH-4 CA 01-02-03-04-05-04 eth 1/0/1    eth 1/0/4    Y
------------------------------------------------------------------------------------
2   2 ES4626H      LAB-SWITCH-2 M  01-02-03-04-05-02 eth 1/0/1    eth 1/0/2    -
    5 ES3528M      LAB-SWITCH-1 OC 01-02-03-04-05-13 eth 1/0/1    eth 1/0/2    Y
    6 ES3528M      LAB-SWITCH-1 OM 01-02-03-04-05-14 eth 1/0/1    eth 1/0/3    Y
------------------------------------------------------------------------------------
active500EM#show cluster topology root-sn 2
Role: commander(CM);Member(M);Candidate(CA);Other commander(OC);Other member(OM)
   SN Description  Hostname    Role  MAC-ADDRESS     Upstream     Upstream     leaf
                                                     local-port   remote-port  node
- --- ------------ ------------ -- ----------------- ------------ ------------ ----
*   2 ES4626H      LAB-SWITCH-2 M  01-02-03-04-05-02 eth 1/0/1    eth 1/0/2    -
    5 ES3528M      LAB-SWITCH-1 OC 01-02-03-04-05-13 eth 1/0/1    eth 1/0/2    Y
    6 ES3528M      LAB-SWITCH-1 OM 01-02-03-04-05-14 eth 1/0/1    eth 1/0/3    Y
------------------------------------------------------------------------------------
active500EM#show cluster topology nodes-sn 2
Topology role: Member
Member status: Active member (user-config)
SN: 2
MAC Address: 01-02-03-04-05-02
Description: ES4626H
Hostname: LAB-SWITCH-2
Upstream local-port: eth 1/0/1
Upstream node: 01-02-03-04-05-0
Upstream remote-port: eth 1/0/2
Upstream speed: 100full
active500EM#show cluster topology mac-address 01-02-03-04-05-02
Topology role: Member
Member status: Active member (user-config)
SN: 2
MAC Address: 01-02-03-04-05-02
Description: ES4626H
Hostname: LAB-SWITCH-2
Upstream local-port: eth 1/0/1
Upstream node: 01-02-03-04-05-01
Upstream remote-port: eth 1/0/2
Upstream speed: 100full

1.7.18 rcommand commander

Command: rcommand commander
Function: In the member switch, use this command to configure the commander switch.
Parameters: None.
Command mode: Admin Mode
Default: None.
Usage guide: This command is used to configure the commander switch remotely. Users must telnet to the commander switch after passing authentication. The command ?exit? is used to quit the configuration interface of the commander switch. This command can only be executed on member switches.
Example: In the member switch, enter the configuration interface of the commander switch.

active500EM#rcommand commander

1.7.19 rcommand member

Command: rcommand member <mem-id>
Function: In the commander switch, this command is used to remotely manage the member switches in the cluster.
Parameter:

  • <mem-id>: id allocated by the commander to each member. The valid range is from 1 to 128.

Command mode: Admin Mode
Default: None.
Usage guide: After executing this command, users will remotely login to a member switch and enter Admin Mode. Use exit to quit the configuration interface on the member switch. Telnet authentication will be omitted on member switches because an internal private IP is used. This command can only be executed on commander switches.
Example: In the commander switch, enter the configuration interface of the member switch with member-id 1.

active500EM#rcommand member 1


Return to Controller Wired CLI Table of Contents