CHAPTER 1 COMMANDS FOR BASIC SWITCH CONFIGURATION ..........................1-42
1.1COMMANDS FOR BASIC CONFIGURATION ............................................................................................ 1-42
1.1.1 Authe nti cat ion lin e ................................................................................................................................. 1-42
1.1.4 clock set ................................................................................................................................................ 1-44
1.1.9 end ........................................................................................................................................................ 1-46
1.1.12 help ..................................................................................................................................................... 1-47
1.1.14 ip host ................................................................................................................................................. 1-48
1.1.16 ip http server ....................................................................................................................................... 1-49
1.1.17 language ............................................................................................................................................. 1-50
1.1.21 service passw ord-encryption ............................................................................................................... 1-51
1.1.22 service terminal-length ........................................................................................................................ 1-52
1.1.25 set default ........................................................................................................................................... 1-53
1.1.27 show clock .......................................................................................................................................... 1-54
1.1.28 show temperature ............................................................................................................................... 1-54
1.1.29 show tech-support ............................................................................................................................... 1-54
1.1.30 show version ....................................................................................................................................... 1-55
1.1.32 web language ...................................................................................................................................... 1-56
1.2.3 authentication line login ........................................................................................................................ 1-57
1.2.4 authentication security ip ........................................................................................................................ 1-58
1.2.5 authentication security ip v 6 .................................................................................................................... 1-59
1.2.17 show ssh-server .................................................................................................................................. 1-64
1.2.18 show ssh-user ..................................................................................................................................... 1-64
1.2.19 show telnet login ................................................................................................................................. 1-65
1.3COMMANDS FOR CONFIGURING SWITCH IP ......................................................................................... 1-65
1.3.3 ip address ............................................................................................................................................. 1-66
1.4.4 show snmp ............................................................................................................................................ 1-69
1.4.5 show snmp engineid ............................................................................................................................. 1-71
1.4.6 show snmp group .................................................................................................................................. 1-72
1.4.7 show snmp mib ..................................................................................................................................... 1-72
1.4.8 show snmp status ................................................................................................................................. 1-73
1.4.9 show snmp user .................................................................................................................................... 1-74
1.4.10 show snmp view .................................................................................................................................. 1-74
1.4.11 snmp-server community ...................................................................................................................... 1-75
1.4.15 snmp-server group .............................................................................................................................. 1-78
1.4.20 snmp-server user ................................................................................................................................ 1-81
1.5COMMANDS FOR SWITCH UPGRADE ................................................................................................... 1-81
1.5.6 ip ftp ...................................................................................................................................................... 1-85
1.5.7 show ftp ................................................................................................................................................. 1-86
1.5.8 show tftp ................................................................................................................................................ 1-86
CHAPTER 2 FILE SYSTEM COMMANDS .....................................................................2-89
2.1 CD .................................................................................................................................................... 2-89
DIR .................................................................................................................................................... 2-90
2.5
FORM AT ............................................................................................................................................ 2-91
MOUNT .............................................................................................................................................. 2-92
4.1.4 flow control ........................................................................................................................................... 4-111
4.1.8 name ................................................................................................................................................... 4-113
4.1.12 show interface ................................................................................................................................... 4-116
11.1.9 name ................................................................................................................................................. 11-23
11.1.11 private-vlan association ................................................................................................................... 11-25
11.1.12 show dot1q-tunnel ........................................................................................................................... 11-26
11.1.13 show garp ........................................................................................................................................ 11-26
11.1.14 show gvrp ........................................................................................................................................ 11-26
11.1.15 show vlan ........................................................................................................................................ 11-27
11.1.16 show vlan-translation ....................................................................................................................... 11-28
11.1.27 vlan-translation miss drop ............................................................................................................... 11-37
11.2.6 show dynamic-vlan prefer ................................................................................................................. 11-42
11.2.7 show mac-vlan .................................................................................................................................. 11-42
11.2.8 show mac-vlan interface .................................................................................................................... 11-43
11.2.9 show protocol-vlan ............................................................................................................................ 11-43
11.2.10 show subnet-vlan ............................................................................................................................ 11-44
11.2.11 show subnet-vlan interface .............................................................................................................. 11-44
11.3COMMANDS FOR VOICE VLANCONFIGURATION ............................................................................. 11-47
11.3.1 show voice-vlan ................................................................................................................................. 11-47
12.1.3 show mac-address-table ................................................................................................................... 12-51
12.2COMMANDS FOR MAC ADDRESS BINDING CONFIGURATION .............................................................. 12-52
12.2.2 show port-security ............................................................................................................................. 12-52
12.2.3 show port-security address ............................................................................................................... 12-53
12.2.4 show port-security interface .............................................................................................................. 12-54
13.1.4 name ................................................................................................................................................. 13-61
13.1.9 spanning-tree lin k-ty pe p2p ............................................................................................................... 13-64
13.1.21 spanning-tree format ....................................................................................................................... 13-73
13.2COMMANDS FOR MONITOR AND DEBUG .......................................................................................... 13-76
13.2.1 show spanning-tree ........................................................................................................................... 13-76
13.2.2 show spanning-tr ee mst config ......................................................................................................... 13-79
13.2.3 show mst-pending ............................................................................................................................. 13-79
CHAPTER 14 COMMANDS FOR QOS AND PBR ......................................................14-82
14.1 CLASS ........................................................................................................................................... 14-82
SET ............................................................................................................................................. 14-94
CHAPTER 15 COMMANDS FOR IPV6 PBR ............................................................. 15-104
15.1 CLASS ......................................................................................................................................... 15-104
SET ............................................................................................................................................. 15-106
17.2.9 ip address ......................................................................................................................................... 17-11
17.2.29 show ip traffic .................................................................................................................................. 17-22
17.2.30 show ipv6 interface ......................................................................................................................... 17-24
17.2.31 show ipv6 route ............................................................................................................................... 17-26
17.2.32 show ipv6 neighbors ....................................................................................................................... 17-27
17.2.33 show ipv6 traffic .............................................................................................................................. 17-29
17.2.34 show ipv6 enable ............................................................................................................................ 17-30
17.2.35 show ipv6 redirect ........................................................................................................................... 17-31
17.2.36 show ipv6 tunnel ............................................................................................................................. 17-31
17.4.2 ip urpf enable .................................................................................................................................... 17-37
17.4.3 show urpf rule ipv4 num .................................................................................................................... 17-38
17.4.4 show urpf rule ipv6 num .................................................................................................................... 17-38
17.4.5 show urpf rule ipv4 ............................................................................................................................ 17-38
17.4.6 show urpf rule ipv6 ............................................................................................................................ 17-39
17.4.7 show urpf .......................................................................................................................................... 17-39
17.5.5 ip proxy-arp ....................................................................................................................................... 17-42
17.5.7 show arp ........................................................................................................................................... 17-43
17.5.8 show arp traffic .................................................................................................................................. 17-45
CHAPTER 18 COMMANDS FOR ARP SCANNING PREVENTION ..............................18-1
CHAPTER 20 COMMAND FOR ARP GUARD ............................................................20-13
20.1 ARP-GUARD IP ............................................................................................................................... 20-13
CHAPTER 21 COMMAND FOR ARP LOCAL PROXY ................................................21-14
21.1 IP LOCAL PROXY-ARP ..................................................................................................................... 21-14
CHAPTER 22 COMMANDS FOR GRATUITOUS ARP CONFIGURA TION .................22-15
22.1 IP GRATUITOUS-ARP ....................................................................................................................... 22-15
22.2
SHOW IP GRATUITOUS-ARP ............................................................................................................. 22-15
CHAPTER 23 COMMANDS FOR ND SNOOPING ......................................................23-17
24.1.2 clear ip dhcp binding ......................................................................................................................... 24-26
24.1.3 clear ip dhcp conflict ......................................................................................................................... 24-27
24.1.4 clear ip dhcp server statisti cs ............................................................................................................ 24-27
24.1.7 debug ip dhcp server ........................................................................................................................ 24-29
24.1.13 ip dhcp conflict logging .................................................................................................................... 24-32
24.1.14 ip dhcp excluded-address ............................................................................................................... 24-33
24.1.15 ip dhcp pool ..................................................................................................................................... 24-33
24.1.16 ip dhcp conflict ping-detection enable ............................................................................................. 24-34
24.1.17 ip dhcp ping packets ....................................................................................................................... 24-34
24.1.18 ip dhcp ping timeout ........................................................................................................................ 24-35
24.1.25 service dhcp .................................................................................................................................... 24-39
24.1.26 show ip dhcp binding ...................................................................................................................... 24-40
24.1.27 show ip dhcp conflict ....................................................................................................................... 24-41
24.1.28 show ip dhcp server statist ic s ......................................................................................................... 24-41
24.2COMMANDS FOR DHCPREL AY CONFIGURATION ............................................................................ 24-44
24.2.1 ip forward-protocol udp bootps .......................................................................................................... 24-44
24.2.2 ip helper-address .............................................................................................................................. 24-44
CHAPTER 25 COMMANDS FOR DHCPV6 .................................................................25-45
SET AGGREGATOR ..................................................................................................................... 29-104
29.16
SET AS-PATH .............................................................................................................................. 29-105
29.17
SET ATOMIC -AGGREGATE ........................................................................................................... 29-105
29.18
SET COMM-LIST ......................................................................................................................... 29-106
29.19
SET COMMUNITY ........................................................................................................................ 29-106
29.20
SET EXTCOMMUNITY ................................................................................................................... 29-107
29.21
SET IP NEXT-HOP ........................................................................................................................ 29-107
29.22
SET LOCAL-PREFERENCE ........................................................................................................... 29-108
29.23
SET METRIC ............................................................................................................................... 29-108
29.24
SET METRIC-TYPE ...................................................................................................................... 29-109
29.25
SET ORIGIN ................................................................................................................................ 29-109
29.26
SET ORIGINATOR-ID .................................................................................................................... 29-110
29.27
SET TAG .................................................................................................................................... 29-110
29.28
SET VPNV4 NEXT-HOP ................................................................................................................ 29-111
29.29
SET WEIGHT ............................................................................................................................... 29-111
29.30
SHOW IP PREFIX-LIST <LIST-NAME> ............................................................................................ 29-112
29.31
SHOW IP PREFIX-LIST<DETAIL|SUMMARY> ................................................................................... 29-113
29.32
SHOW ROUTE-MAP ..................................................................................................................... 29-114
29.33
SHOW ROUTER-ID ...................................................................................................................... 29-115
CHAPTER 30 COMMANDS FOR STATIC ROUTE .................................................... 30-116
30.1 IP ROUTE ..................................................................................................................................... 30-116
30.2
SHOW IP ROUTE ........................................................................................................................... 30-117
30.3
SHOW IP ROUTE VRF ..................................................................................................................... 30-119
30.4
IP ROUTE VRF .............................................................................................................................. 30-119
CHAPTER 31 COMMANDS FOR RIP ........................................................................ 31-120
38.1PUBLIC COMMANDS FOR MULTICAST ................................................................................................ 38-1
38.1.1 show ip mroute .................................................................................................................................... 38-1
38.2COMMANDS FOR PIM-DM ................................................................................................................ 38-2
38.2.1 debug pim timer sat ............................................................................................................................ 38-2
38.2.3 ip mroute ............................................................................................................................................. 38-3
38.2.4 ip pim bsr-border ................................................................................................................................. 38-3
38.2.5 ip pim dense-mode ............................................................................................................................. 38-4
38.2.6 ip pim dr-priority .................................................................................................................................. 38-4
38.2.7 ip pim exclude-genid ........................................................................................................................... 38-4
38.2.8 ip pim hello-holdtime ........................................................................................................................... 38-5
38.2.9 ip pim hello-interval ............................................................................................................................. 38-5
38.2.10 ip pim multica st -routing ..................................................................................................................... 38-6
38.2.11 ip pim neighbor-filter .......................................................................................................................... 38-6
38.2.12 ip pim scope-border .......................................................................................................................... 38-7
38.2.13 ip pim state-refresh origination-interval ............................................................................................. 38-7
38.2.14 show ip pim interface ........................................................................................................................ 38-7
38.2.15 show ip pim mroute dense-mode ...................................................................................................... 38-8
38.2.16 show ip pim neighbor ...................................................................................................................... 38-10
38.2.17 show ip pim nexthop ....................................................................................................................... 38-11
38.3COMMANDS FOR PIM-SM .............................................................................................................. 38-12
38.3.1 clear ip pim bsr rp-set ........................................................................................................................ 38-12
38.3.10 ip mroute ......................................................................................................................................... 38-16
38.3.11 ip pim accept-register ...................................................................................................................... 38-16
38.3.12 ip pim bsr-border ............................................................................................................................. 38-17
38.3.13 ip pim bsr-candidate ........................................................................................................................ 38-17
38.3.14 ip pim cisco -register-checksum ....................................................................................................... 38-18
38.3.15 ip pim dr-priority .............................................................................................................................. 38-18
38.3.16 ip pim exclude-genid ....................................................................................................................... 38-18
38.3.17 ip pim hello-holdtime ....................................................................................................................... 38-19
38.3.18 ip pim hello-interval ......................................................................................................................... 38-19
38.3.19 ip pim ignore-rp-set-priority ............................................................................................................. 38-20
38.3.20 ip pim jp-timer ................................................................................................................................. 38-20
38.3.21 ip pim multica st -routing ................................................................................................................... 38-21
38.3.22 ip pim neighbor-filter ....................................................................................................................... 38-21
38.3.23 ip pim register-rate-limit ................................................................................................................... 38-22
38.3.24 ip pim register-rp-reachability .......................................................................................................... 38-22
38.3.25 ip pim register-source ...................................................................................................................... 38-22
38.3.26 ip pim register-suppression ............................................................................................................. 38-23
38.3.27 ip pim rp-address ............................................................................................................................ 38-23
38.3.28 ip pim rp-candidate ......................................................................................................................... 38-23
38.3.29 ip pim rp-register-kat ....................................................................................................................... 38-24
38.3.30 ip pim scope-border ........................................................................................................................ 38-24
38.3.31 ip pim sparse-mode ......................................................................................................................... 38-25
38.3.32 show ip pim bsr-router ..................................................................................................................... 38-25
38.3.33 show ip pim interface ...................................................................................................................... 38-26
38.3.34 show ip pim mroute sparse-mode ................................................................................................... 38-27
38.3.35 show ip pim neighbor ...................................................................................................................... 38-28
38.3.36 show ip pim nexthop ....................................................................................................................... 38-29
38.3.37 show ip pim rp-hash ........................................................................................................................ 38-31
38.3.38 show ip pim rp mapping .................................................................................................................. 38-31
38.4COMMANDS FOR MSDPCONFIGURATION ....................................................................................... 38-32
38.4.6 clear msdp stat ist ic s .......................................................................................................................... 38-34
38.4.12 debug msdp keepal iv e .................................................................................................................... 38-36
38.4.29 show msdp global ........................................................................................................................... 38-43
38.4.30 show msdp local-sa-cache .............................................................................................................. 38-44
38.4.31 show msdp peer .............................................................................................................................. 38-45
38.4.32 show msdp sa-cache ...................................................................................................................... 38-46
38.4.33 show msdp sa-cache summary ....................................................................................................... 38-47
38.4.34 show msdp statistics ....................................................................................................................... 38-49
38.4.35 show msdp summary ...................................................................................................................... 38-50
38.7.2 ip dvmrp enable ................................................................................................................................ 38-58
38.7.3 ip dvmrp metric ................................................................................................................................. 38-59
38.7.4 ip dvmrp multicast-routing ................................................................................................................. 38-59
38.7.5 ip dvmrp output-report-delay ............................................................................................................. 38-59
38.7.6 ip dvmrp reject-non-pruners .............................................................................................................. 38-60
38.7.7 ip dvmrp tunnel ................................................................................................................................. 38-60
38.7.8 show ip dvmrp ................................................................................................................................... 38-61
38.7.9 show ip dvmrp interface .................................................................................................................... 38-61
38.7.10 show ip dvmrp neighbor .................................................................................................................. 38-62
38.7.11 show ip dvmrp prune ....................................................................................................................... 38-63
38.7.12 show ip dvmrp route ........................................................................................................................ 38-64
38.8COMMANDS FOR DCSCM .............................................................................................................. 38-65
38.8.3 ip multicast destination-control access-group ................................................................................... 38-66
38.8.4 ip multicast destination-control access-group (sip) ........................................................................... 38-67
38.8.5 ip multicast destination-control access-group (vmac) ....................................................................... 38-67
38.8.6 ip multicast policy .............................................................................................................................. 38-68
38.8.7 ip multicast sou rc e -control ................................................................................................................ 38-68
38.8.8 ip multicast source-control access-group .......................................................................................... 38-69
38.8.10 show ip multicast destination-control ............................................................................................... 38-70
38.8.11 show ip multicast destination-control access-list ............................................................................. 38-70
38.8.12 show ip multicast policy ................................................................................................................... 38-71
38.8.13 show ip multicast source-control ..................................................................................................... 38-71
38.8.14 show ip multicast source-control acc ess-list ................................................................................... 38-71
38.9COMMANDS FOR IGMP .................................................................................................................. 38-72
38.9.1 clear ip igmp group ........................................................................................................................... 38-72
38.9.4 ip igmp access-group ........................................................................................................................ 38-73
38.9.5 ip igmp immediate-leave ................................................................................................................... 38-73
38.9.6 ip igmp join-group ............................................................................................................................. 38-74
1-28
XGS3 Command Guide
38.9.7 ip igmp last-member-query-interval ................................................................................................... 38-74
38.9.8 ip igmp limit ....................................................................................................................................... 38-74
38.9.9 ip igmp query-interval ........................................................................................................................ 38-75
38.9.10 ip igmp query-max-response-time ................................................................................................... 38-75
38.9.11 ip igmp query-timeout ...................................................................................................................... 38-76
38.9.12 ip igmp robust-variable .................................................................................................................... 38-76
38.9.13 ip igmp static-group ......................................................................................................................... 38-77
38.9.14 ip igmp version ................................................................................................................................ 38-77
38.9.15 show ip igmp groups ....................................................................................................................... 38-77
38.9.16 show ip igmp interface .................................................................................................................... 38-80
38.10COMMANDS FOR IGMPSNOOPING ............................................................................................... 38-80
38.10.1 clear ip igmp snooping vlan ............................................................................................................. 38-80
38.10.2 clear ip igmp snooping vlan <1-4094> mrouter-port ........................................................................ 38-80
38.10.3 debug igmp snooping all/p ac ket/ ev ent /t imer / mf c ............................................................................ 38-81
38.10.4 ip igmp snooping ............................................................................................................................. 38-81
38.10.5 ip igmp snooping vlan ..................................................................................................................... 38-81
38.10.6 ip igmp snooping vlan immedi ate-leave .......................................................................................... 38-82
38.10.7 ip igmp snooping vlan l2-general-querier ........................................................................................ 38-82
38.10.8 ip igmp snooping vlan l2-general-querier-source ............................................................................ 38-82
38.10.9 ip igmp snooping vlan l2-general-querier-version ........................................................................... 38-83
38.10.10 ip igmp snooping vlan limit ............................................................................................................ 38-83
38.10.11 ip igmp snooping vlan mrouter-port interface ................................................................................ 38-84
38.10.12 ip igmp snooping vlan mrpt ........................................................................................................... 38-84
38.10.13 ip igmp snooping vlan query-interval ............................................................................................. 38-84
38.10.14 ip igmp snooping vlan query-mrsp ................................................................................................ 38-85
38.10.15 ip igmp snooping vlan query-robustness ....................................................................................... 38-85
38.10.16 ip igmp snooping vlan report source-address ............................................................................... 38-85
38.10.17 ip igmp snooping vlan static-group ................................................................................................ 38-86
38.10.18 ip igmp snooping vlan suppression-query-time ............................................................................. 38-86
38.10.19 show ip igmp snooping .................................................................................................................. 38-87
38.11COMMANDS FOR IGMPPROXY ..................................................................................................... 38-89
38.11.1 clear ip igmp proxy group ................................................................................................................ 38-89
38.11.2 debug igmp proxy all ....................................................................................................................... 38-89
38.11.7 ip igmp proxy ................................................................................................................................... 38-91
38.11.8 ip igmp proxy aggregate .................................................................................................................. 38-91
1-29
XGS3 Command Guide
38.11.9 ip igmp proxy downstream .............................................................................................................. 38-91
38.11.10 ip igmp proxy limit .......................................................................................................................... 38-92
38.11.11 ip igmp proxy multicast-source ...................................................................................................... 38-92
38.11.12 ip igmp proxy unsolicited-report interval ........................................................................................ 38-92
38.11.13 ip igmp proxy unsolicited-report robustness .................................................................................. 38-93
38.11.14 ip igmp proxy upstream ................................................................................................................. 38-93
38.11.15 ip multicas t ssm ............................................................................................................................. 38-93
38.11.16 ip pim bsr-border ........................................................................................................................... 38-94
38.11.17 show debugging igmp proxy .......................................................................................................... 38-94
38.11.18 show ip igmp proxy ........................................................................................................................ 38-95
38.11.19 show ip igmp proxy mroute ........................................................................................................... 38-96
38.11.20 show ip igmp proxy upstream groups ............................................................................................ 38-97
39.7.14 ipv6 mld version .............................................................................................................................. 39-50
39.7.15 show ipv6 mld groups ..................................................................................................................... 39-51
39.7.16 show ipv6 mld interface ................................................................................................................... 39-51
39.7.17 show ipv6 mld join-group ................................................................................................................ 39-52
1-32
XGS3 Command Guide
39.8COMMANDS FOR MLDSNOOPING CONFIGURATION ......................................................................... 39-52
CHAPTER 44 COMMANDS FOR AM CONFIGURATION .............................................44-1
44.1 AM ENABLE ..................................................................................................................................... 44-1
44.2
AM PORT ......................................................................................................................................... 44-1
44.3
AM IP-POOL ..................................................................................................................................... 44-1
44.4
AM MAC-IP-POOL ............................................................................................................................. 44-2
44.5
NO AM ALL ....................................................................................................................................... 44-2
44.6
SHOW AM ........................................................................................................................................ 44-2
CHAPTER 45 COMMANDS FOR SECURITY FEATURE ..............................................45-1
CHAPTER 63 COMMANDS FOR RELO AD SWITCH AFTER SPECIFIED TIME .........63-1
63.1 RELOAD AFTER ................................................................................................................................ 63-1
authentication line {console | sty | web} login {local | radius | tacos}
No authentication line {console | sty | web} login
Function:
Configure VTY (login with Telnet and SSH), Web and Console, so as to select the priority of the authentication mode
for the login user. The no form command restores the default authenticati on mode .
Default:
No configuration is enabled for the console login method by default. Local authentication is enabled for the VTY and
Web login method by default.
Command Mode:
Global Mode.
Usage Guide:
The authentication method for Console, VTY and Web login can be configured respectively. And authentication
method can be any one or combination of Local, RADIUS or TACCACS. When login method is configuration in
combination, the preference goes from left to right. If the users have passed the authentication method,
authentication method of lower preferences will be ignored. To be mentioned, if the user receives correspond
protocol’s answer whether refuse or incept, it will not attempt the next authentication method (Exception: if the local
authentication method failed, it will attempt the next authentication method); it will attempt the next authentication
method if it receives nothing. And AAA function RADIUS server should be configured before the RADIUS
configuration method can be used. And TACACS server should be configured before the TACACS configuration
method can be used.
The authentication line console login command is exclusive with the login command. The authentication line console login command configures the switch to use the Console login method. And the login command makes the
Console login to use the passwords configured by the password command for authentication.
If local authentication is configured while no local users are configured, users will be able to login the switch via the
Console method.
Example:
To configure the Telnet and ssh login method to use RADIUS authentication method.
Switch(config)# authenticat ion line vty login lo cal radi us
Configure the first and second img files used in the next boot of the main control boardcard.
Parameters: .
primary means to configure the first IMG file, backup means to configure the second IMG file, <img-file-url> is the full
path of the booting IMG file, the format of which is as follows:
1. The file path comprises of two parts: device prefix used as the root directory (flash:/) and the file name. No
space is allowed in each part or between two parts.
2. The suffix of all file names should be .img.
3. The length of the full file path should be no longer than 128 characters, while the file name no longer than 80
characters.
Command Mode:
Admin Mode.
Default:
The factory original configuration only specifies the first booting IMG file, the nos.img file in the FLASH, without the
second one.
Example:
1. Set flash:/nos.img as the second booting IMG file used in the next booting of the syste m.
Switch#boot img fla sh:/nos. img backup
2. Set flash:/5.4.128.0_nos.img as the first booting IMG file used in the next booting of the system.
Switch#boot img flash:/5.4.128.0_nos.img primary
1.1.3 boot startup-config
Command:
boot startup-config { NULL | <file-url> }
1-43
XGS3 Command Guide
Function:
Configure the CGF file used in the next booting of the main control boardcard.
Parameters:
The NULL keyword means to use the factory original configuration as the next booting configuration. Setting the he
CGF file used in the next booting as NULL equals to implementing “set default” and “write”. <file-url> is the ful l path
of CGF file used in the next booting.
1. The file path compri se s of two parts: device prefix used as th e root dir e ctory ( fl ash :/) an d th e fil e name. No space
is allowed in each part or between two parts.
2. The suffix of all file names should be .cfg.
3. The length of the full file path should be no longer than 128 characters, while the file name no longer than 80
characters.
Command Mode:
Admin Mode.
Default Settings:
None.
Example:
1. Set flash:/ startup.cfg as the booting CFG file used in the next booting of the system.
Switch# boot startup-configflash:/ startup.cfg
2. Set flash:/ test-trunk.cfg as the booting CFG file used in the next booting of the system.
Switch#boot startup-config flash:/ test-trunk.cfg
1.1.4 clock set
Command:
clock set <HH:MM:SS> <YYYY.MM.DD>
Function:
Set system date and time.
Parameter:
<HH:MM:SS>is the current time, and the valid scope for HH is 0 to 23, MM and SS 0 to 59; <YYYY.MM.DD> is the
current year, month and date, and the valid scope for YYYY is 1970~2038, MON meaning month, and DD between 1
to 31.
Command mode:
Admin Mode.
Default:
upon first time start-up, it is defaulted to 2001.1.1 0: 0: 0.
Usage guide:
The switch can not continue timing with power off, hence the current date and time must be first set at environments
where exact time is required.
Example:
To set the switch current date and time to 2002.8.1 23: 0: 0:
Switch#clock set 23:0:0 2002.8.1
1-44
XGS3 Command Guide
1.1.5 config
Command:
config [terminal]
Function:
Enter Global Mode from Admin Mode.
Parameter:
[terminal] indicates terminal configuration.
Command mode:
Admin Mode
Example:
Switch#config
1.1.6 debug ssh-server
Command:
debug ssh-server
no debug ssh-server
Function:
Display SSH server debugging information; the “no debug ssh-server” command stops displaying SSH server
debugging information.
Default:
This function is disabled by default.
Command mode:
Admin Mode.
Example:
Switch#debug ssh-server
1.1.7 enable
Command:
enable
disable
Function:
Enter Admin Mode from User Mode.
Command mode:
User Mode/ Admin Mode.
Usage Guide:
To prevent unauthorized access of non-admin user, user authentication is required (i.e. Admin user password is
required) when entering Admin Mode from User Mode. If the correct Admin user password is entered, Admin Mode
access is granted; if 3 consecutive entry of Admin user password are all wrong, it remains in the User Mode. Set the
Admin user password under Global Mode with “enable password” command.
Example:
Switch>enable
1-45
XGS3 Command Guide
Switch#
1.1.8 enable password
Command:
enable passw ord [8] <password>
no enable password
Function:
Configure the password used for enter Admin Mode from the User Mode,
The “no enable password” command deletes this password.
Parameter:
password is the configured code. Encryption will be performed by entering 8.
Command mode:
Global Mode
Default:
This password is empty by system default
Usage Guide:
Configure this password to prevent unauthorized entering Admin Mode. It is recommended to set the password at
the initial switch configuration. Also, it is recommended to exit Admin Mode with “exit” command when the
administrator needs to leave the terminal for a long time.
Example:
Set the Admin user password to “admin”.
Switch(config)#enable p as sw or d 8 admin
1.1.9 end
Command:
end
Function:
Quit current mode and return to Admin mode when not at User Mode/ Admin Mode.
Command mode:
Except User Mode/ Admin Mode
Example:
Quit VLAN mode and return to Admin mode.
Switch(config-vlan1)#end
Switch#
1.1.10 exec-timeout
Command:
exec-timeout <minutes> [<seconds>]
no exec-timeout
Function:
1-46
XGS3 Command Guide
Configure the timeout of exiting admin mode. The “no exec-timeout” command restores the default value.
Parameters:
<minute> is the time value shown in minute and ranges between 0~35791.<seconds> is the time value shown in
seconds and ranges between 0~2147483.
Command mode:
Global mode
Default:
Default timeout is 10 minutes.
Usage guide:
To secure the sw itch , as well to prevent malic iou s a ctio ns f ro m un authorized user , the time will be count from the last
configuration the admin had m ade, an d the sy st em w ill exit the admin mode at due time. It is required to enter admin
code and password to enter the admin mode again. The timeout timer will be disabled when the timeout is set to 0.
Example:
Set the admin mode timeout value to 6 minutes
Switch(config)#exec-timeout 6
Set the admin mode timeout value to 5 minutes, 30 seconds
Switch(config)#exec-timeout 5 30
1.1.11 exit
Command:
exit
Function:
Quit current mode and return to it’s previous mode.
Command mode:
All Modes
Usage Guide:
This command is to quit current mode and return to it’s previous mode.
Example:
Quit global mode to it’s previous mode
Switch#exit
Switch#
1.1.12 help
Command:
help
Function:
Output brief description of the command interpreter help system.
Command mode:
All configuration modes.
Usage Guide:
An instant online help provided by the switch. Help command displays information about the whole help system,
1-47
including complete help and partial help. The user can type in ? any time to get online help.
Example:
switch(config)#help
PLANETOS CLI provides advanced help feature. When you need help,
anytime at the command line please press '?'.
If nothing matches, the help list will be empty and you must backup
until entering a '?' shows the available options.
Two styles of help are provided:
1. Full help is available when you are ready to enter acommand argument (e.g. 'show ?')
and describes each possible
argument.
2. Partial help is provided when an abbreviated argument is entered
and you want to know what arguments match the input
(e.g. 'show ve?'.)
XGS3 Command Guide
1.1.13 hostname
Command:
hostname <hostname>
no hostname
Function:
Set the prompt in the switch command line interface. The no operation cancels the configuration.
Parameter:
<hostname> is the string for the prompt, up to 30 characters are allowed.
Command mode:
Global Mode
Default:
The default prompt is relatived with the switch.
Usage Guide:
With this command, the user can set the CLI prompt of the switch according to their own requirements.
Example:
Set the prompt to “Test”.
Switch(config)#hostname Test
Test(config)#
1.1.14 ip host
Command:
ip host <hostname> <ip_addr>
no ip host {<hostname>|all}
Function:
Set the mapping relationship between the host and IP address; the “no ip host” parameter of this command will
1-48
XGS3 Command Guide
delete the mapping.
Parameter:
<hostname> is the host name, up to 15 characters are allowed; <ip_addr> is the corresponding IP address for the
host name, takes a dot decimal format; all is all of the host name.
Command mode:
Global Mode
Usage Guide:
Set the association between host and IP address, which can be used in commands like “ping <host>“.
Example:
Set IP address of a host with the hostname of “beijing” to 200.121.1.1.
Switch(config)#ip host beijing 200.121.1.1
Command related:
telnet, ping, traceroute
1.1.15 ipv6 host
Command:
ipv6 host <hostname> <ipv6_addr>
no ipv6 host {<hostname>|all}
Function:
Configure the mapping relationship between the IPv6 address and the host; the “no ipv6 host <hostname>”
command deletes this mapping relationship.
Parameter:
<hostname> is the name of the host, containing max 15 ch aracters;<ipv6_addr> is the IPv6 address corr e spo ndi ng
to the host name.<all> is all the h ost addres s.
Command Mode:
Global Mode
Usage Guide:
Configure a fixed corresponding relationship between the host and the IPv6 address, applicable in commands such
as “traceroute6 <host>”, etc.
Example:
Set the IPv6 address of the host named beijing to 2001:1:2:3::1
Switch(config)#ipv6 host beijing 2001:1:2:3::1
Command related:
ping6,traceroute6
1.1.16 ip http server
Command:
ip http server
no ip http server
Function:
Enable Web configuration; the “no ip http server” command disables Web configuration
Command mode:
Global mode
1-49
XGS3 Command Guide
Usage guide:
Web configuation is for supplying a interface configured with HTTP for the user, which is straight and visual, esay to
understand.
Example:
Enable Web Server function and enable Web configurations.
Switch(config)#ip http server
1.1.17 language
Command:
language {chinese | english}
Function:
Set the language for displaying the help information.
Parameter:
chinese for Chinese display; english for English display.
Command mode:
Admin and Config Mode.
Default:
The default setting is English display.
Usage Guide:
Switch provides help information in two languages, the user can select the language according to their preference.
After the system restart, the help information display will revert to English.
1.1.18 login
Command:
login
no login
Function:
login enable password authentication, no login command cancels the login configuration.
Command mode:
Global mode
Default:
No login by default
Usage guide:
By using this command, users have to enter the password set by password command to enter normal user mode
with console; no login cancels this restriction.
Example:
Enable password
Switch(config)#login
1.1.19 password
Command:
password [8] <password>
1-50
XGS3 Command Guide
no password
Function:
Configure the pas sw or d us ed f or ent er n or ma l u ser mo de on the console. The “no password” command delete s this
password.
Parameter:
password is the configured code. Encryption will be performed by entering 8.
Command mode:
Global mode
Default:
This password is empty by system default
Usage guide:
When both this password and login command are configured, users have to enter the password set by password
command to enter normal user mode on console.
Example:
Switch(config)#password 8 test
Switch(config)#login
1.1.20 reload
Command:
reload
Function:
Warm reset the switch.
Command mode:
Admin Mode.
Usage Guide:
The user can use this command to restart the switch without power off.
1.1.21 service password-encryption
Command:
service password-encryption
no service password-encryption
Function:
Encrypt system password. T he “no serv ice password-encryption” command cancels the encryption.
Command mode:
Global Mode
Default:
No service password-encryption by system default
Usage guide:
The current unencrypted passwords as well as the coming passwords configured by password, enable password
and username command will be encrypted by executed this command. no service password-encryption cancels this
function however encrypted passwords remain unchanged.
Example:
Encrypt system passwords
Switch(config)#service password-encryption
1-51
XGS3 Command Guide
1.1.22 service terminal-length
Command:
service terminal-length <0-512>
no service terminal-length
Function:
Configure the columns of characters displayed in each screen on terminal (vty). The “no service terminal-length”
command cancels the screen shifting operation.
Parameter:
Columns of characters displayed on each screen of vty, ranging between 0-512.
Command mode:
Global Mode
Usage guide:
Configure the columns of characters displayed on each screen of the terminal. The columns of characters displayed
on each screen on the telent.ssh client and the Console will be following this configuration.
Example:
Set the number of vty threads to 20.
Switch(config)#service terminal-length 20
1.1.23 sysContact
Command:
sysContact <LINE>
no sysContact
Function:
Set the factory contact mode, the “no sysContact” command reset the switch to factory settings.
Parameter:
<LINE> is the prompt character string, range from 0 to 255 characters.
Command mode:
Global Mode
Default:
Thefactory settings.
Usage guide:
The user can set the factory contact mode bases the fact instance.
Example:
Set the factory contact mode to test.
Switch(config)#sysContact test
1.1.24 sysLocation
Command:
sysLocation <LINE>
no sysLocation
Function:
1-52
XGS3 Command Guide
Set the factory address, the “no sysLocation” command reset the switch to factory settings.
Parameter:
<LINE> is the prompt character string, range from 0 to 255 characters.
Command mode:
Global Mode
Default:
Thefactory settings.
Usage guide:
The user can set the factory address bases the fact instance.
Example:
Set the factory address to test.
Switch(config)#sysLocation test
1.1.25 set default
Command:
set default
Function:
Reset the switch to factory settings.
Command mode:
Admin Mode.
Usage Guide:
Reset the switch to factory settings. That is to say, all configurations made by the user to the switch will disappear.
When the switch is restarted, the prompt will be the same as when the switch was powered on for the first time.
Note:
After the command, “write” command must be executed to save the operation. The switch will reset to factory
settings after restart.
Example:
Switch#set default
Are you sure? [Y/N] = y
Switch#write
Switch#reload
1.1.26 setup
Command:
setup
Function:
Enter the Setup Mode of the switch.
Command mode:
Admin Mode.
Usage Guide:
Switch provides a Setup Mode, in which the user can configure IP addresses, etc.
1-53
1.1.27 show clock
Command:
show clock
Function:
Display the curre nt syst e m cl o ck.
Command mode:
Admin and Configuration Mode.
Usage Guide:
If the system clock is inaccurate, user can adjust the time by examining the system date and clock.
Example:
Switch#show clock
Current time is TUE AUG 22 11:00:01 2002
Command related:
clock set
XGS3 Command Guide
1.1.28 show temperature
Command:
show temperature
Function:
Display the current temputerature of the switch CPU.
Command mode:
All mode.
Usage Guide:
This command is used to monitor the temperature of the switch CPU.
Example:
Display the current temperature of the switch CPU.
Switch(Config)#show temperature
Temperature: 47.0625 ℃
1.1.29 show tech-support
Command:
show tech-support
Function:
Display the operational information and the task status of the switch. The technique specialist use this command to
diagnose whether the switch operate normally.
Command mode:
Admin and Configuration Mode.
Usage Guide:
This command is used to collect the relative information when the switch operation is malfunctioned.
Example:
1-54
XGS3 Command Guide
Switch#show tech-support
1.1.30 show version
Command:
show version
Function:
Display the version information of the switch.
Command mode:
Admin and Configuration Mode.
Usage Guide:
this command is used to show the v er si on in form ation of the switch, including the hardware version an d the sof t w ar e
version information.
Example:
Switch#show version.
1.1.31 username
Command:
username <username> [privilege <privilege>] [password <0|7> <password>]
no username <username>
Function:
Configure local login username and password along with its privilege level.
Parameter:
<username> is the name of the user. <privilege> is t he maximum privilege level of the commands that the user is
able to execute, its value is limited between 1 and 15, and 1 by default. <password> is the pass wor d for the us e r. If
input option 7 on password setting, the p as sw ord is encry pte d; if input option 0, the password is not processed.
Command Mode:
Global Mode.
Usage Guide:
There are two available choices for the preferences of the registered commands in the switch. They are 1 and 15.
Preference of 1 is for the commands of the normal user configuration mode. Preference of 15 is for the commands
registered in modes other than the normal user configuration modes. 16 local users at most can be configured
through this command, and the maximum length of the password should be no less than 32.
Notice:
The user can log in user and priority after the command configures, before issuing the command authentication line
console login local, it should be made sure that at one user has be configured as preference level of 15, in order to
login the switch and make configuration change s in pr ivileg ed mod e and gl obal m ode. If ther e are no conf igure d loca l
users with preference level of 15, while only Local authentication is configured for the Console login method, the
switch can be login without any authentication. When using the HTTP method to login the switch, only users with
preference level of 15 can login the switch, users with preference level other than 15 will be denied.
Example:
Configure an administrator account named admin, with the preference level as 15. And configure two normal
accounts with its preference level as 1. Then enable local authentication method.
Above all the configurations, only the admin user is able to login the switch in privileged mode through Telnet or
1-55
XGS3 Command Guide
Console login method, user1 a nd user 2 ca n only log in the switch in normal user mode through the telnet and console
login method. For HTTP login method, only the admin user can pass the authentication configuration, user1 and
user2 will be denied.
Switch(config)# authenticat ion line con so le logi n local
1.1.32 web language
Command:
web language {chinese | english}
Function:
Set the language for displaying the HTTP Server information.
Parameter:
chinese for Chinese display; english for English display.
Command mode:
Admin Mode
Default:
The default setting is English display.
Usage Guide:
The user can select the language according to their preference.
1.1.33 write
Command:
write
Function:
Save the currently configured p aram eters to the Flash memory.
Command mode:
Admin Mode.
Usage Guide:
After a set of configuration with desired functions, the setting should be saved to the Flash memory, so that the
system can revert to the saved configuration automatically in the case of accidentally powered off or power failure.
This is the equivalent to the copy running-config startup-config command.
1.2 Commands for Telnet
1.2.1 authentication ip access-class
Command:
authentication ip access-class {<num-std>|<name>}
no authentication ip access-class
Function:
1-56
XGS3 Command Guide
Binding standard IP ACL protocol tologin with Telnet/SSH/Web; the no form command w ill can cel the binding ACL.
Parameters:
<num-std> is the access-clas s numb er for st andar d numer ic ACL, ranging between 1-99; <name> is the access-class
name for standard ACL, the character string length is ranging between 1-32.
Default:
The binding ACL to Telnet/SSH/Web function is closed by default.
Command Mode:
Global Mode.
Example:
Binding standard IP ACL protocol to access-class 1.
Switch(config)#authenti cat ion i p acce ss-class 1
1.2.2 authentication ipv6 access-class
Command:
authentication ipv6 access-class {<num-std>|<name>}
no authentication ipv6 access-class
Function:
Binding standard IPv6 ACL protocol tologin with Telnet/SSH/Web; the no form command will cancel the binding ACL.
Parameters:
<num-std> is the access-class number for standard numeric ACL, ranging between 500-599; <name> is the
access-class name for standard ACL, the character string length is ranging between 1-32.
Default:
The binding ACL to Telnet/SSH/Web function is closed by default.
Command Mode:
Global Mode.
Example:
Binding standard IP ACL protocol to access-class 500.
Switch(config)#authenti cat ion i pv 6 acces s-class 500
1.2.3
authentication line login
Command:
authentication line {console | vty | web} login {local | radius | tacacs}
no authentication line {console | vty | web} login
Function:
Configure VTY (login with Telnet and SSH), Web and Console, so as to select the priority of the authentication mode
for the login user. The no form command restores the default authentication mode.
Default:
No configuration is enabled for the console login method by default. Local authentication is enabled for the VTY and
Web login method by default.
Command Mode:
Global Mode.
1-57
XGS3 Command Guide
Usage Guide:
The authentication method for Console, VTY and Web login can be configured respectively. And authentication
method can be any one or combination of Local, RADIUS or TACACS. When login method is configuration in
combination, the preference goes from left to right. If the users have passed the authentication method,
authentication method of lower preferences will be ignored. To be mentioned, if the user receives correspond
protocol’s answer whether refuse or incept, it will not attempt the next authentication method (Excepti on: if th e loc al
authentication method failed, it will attempt the next authentication method); it will attempt the next authentication
method if it receives nothing. And AAA function RADIUS server should be configured before the RADIUS
configuration method can be used. And TACACS server should be configured before the TACACS configuration
method can be used.
The authentication line console login command is exclusive with the “login” command. The authentication line console login command c onfigures the sw itch to us e the Console login method. And the login command makes the
Console login to use the passwords configured by the password command for authentication.
If local authentication is configured while no local users are configured, users will be able to login the switch via the
Console method.
Example:
Configure the remote login authentication mode to radius.
authentication securityip <ip
no authentication securityip <ip-addr>
Function:
To configure the trusted IP address for Telnet and HTTP login method. The no form of this command will remove the
trusted IP address configuration.
Parameters:
<ip-addr> is the trusted IP address of the client in dotted decimal format which can login the switch.
Default:
No trusted IP address is configured by default.
Command Mode:
Global Mode.
Usage Guide:
IP address of the client which can login the switch is not restricted before the trusted IP address is not configured.
After the trusted IP addr es s is configured, only client s with trusted IP addr e ss es are able to login the switch. U p to 32
trusted IP addresses can be configured in the switch.
Example:
To configure 192.168.1.21 as the trusted IP address.
Switch(config)# authenticat ion sec urity ip 192.168.1.21
1-58
XGS3 Command Guide
1.2.5 authentication securityipv6
Command:
authentication securityipv6 <ipv6-addr>
no authentication securityipv6 <ipv6-addr>
Function:
To configure the trusted IPv6 address for Telnet and HTTP login method. The no form of this command will remove
the specified configuration.
Parameters:
<ipv6-addr> is the trusted IPv6 address which can login the switch.
Default:
No trusted IPv6 addresses are configured by default.
Command Mode:
Global Mode.
Usage Guide:
IPv6 address of the client which can login the switch is not restricted before the trusted IPv6 address is not
configured. After the trusted IPv6 address is configu red, only clients w ith tr us ted IP v 6 addr e sse s ar e ab le to login the
switch. Up to 32 trusted IPv6 addresses can be configured in the switch.
Example:
Configure the secure IPv6 address is 2001:da8:123:1::1.
Switch(config)# authenticat ion sec urity ipv 6 2001:da8:123:1::1
1.2.6 terminal length
Command:
terminal length <0-512>
terminal no length
Function:
Set columns of characters displayed in each screen on terminal; the “terminal no length” cancels the screen
switching operation and display content once in all.
Parameter:
Columns of characters displayed in each screen, ranging between 0-512 (0 refers to non-stop display).
Command mode:
Admin Mode.
Default:
Default columns is 25.
Usage guide:
Set columns of characters displayed in each screen on terminal, so that the-More-message will be shown when
displayed information exceeds the screen. Press any key to show information in next screen. 25 columns by default.
Example:
Configure treads in each display to 20.
Switch#terminal length 20
1-59
XGS3 Command Guide
1.2.7 terminal monitor
Command:
terminal monitor
terminal no monitor
Function:
Copy debugging messages to current display terminal; the “terminal no monitor” command restores to the default
value.
Command mode:
Admin Mode.
Usage guide:
Configures whether the current debugging messages is displayed on this terminal. If this command is configured on
telnet or SSH clients, debug messages will be sent to that client. The debug message is displayed on console by
default.
<ip-addr> is the IP address of the remote host, shown in dotted decimal notation; <ipv6-addr> is the IPv6 address
of the remo te host ; <hostname> is the name of the remote host, containing max 30 characters; <port> is the port
number, ranging between 0~65535.
Command Mode:
Admin Mode.
Usage Guide:
This command is used when the switch is applied as Telnet client, for logging on remote host to configure. When a
switch is applied as a Telnet client, it can only establish one TCP connection with the remote host. To connect to
another remote host, the current TCP connection must be disconnected with a hotkey “CTRL+ \”. To telnet a host
name, mapping relationship between the host name and the IP/IPv6 address should be previously configured. For
required commands please refer to ip host and ipv6 host. In case a host corresponds to both an IPv4 and an IPv6
addresses, the IPv6 should be preferred when telneting this host name.
Example:
The switch Telnets to a remote host whose IP address is 20.1.1.1.
Switch#telnet 20.1.1.1 23
Connecting Host 20.1.1.1 Port 23
Service port is 23
Connected to 20.1.1.1
login:123
password:***
XGS3>
1-60
XGS3 Command Guide
1.2.9 telnet server enable
Command:
telnet server enable
no telnet server enable
Function:
Enable the Telnet server function in the sw itch: the “ no tel net serv er enable” command disa bles the Telnet function in
the switch.
Default:
Telnet server function is enab l ed by default .
Command mode:
Global Mode
Usage Guide:
This command is available in Console only. The administrator can use this command to enable or disable the Telnet
client to login to the switch.
Configure the max connection number supported by the Telnet service of the switch.
Parameters:
<max-connection-number>: the max connection number supported by the Telnet service, ranging from 5 to 16. The
default option will restore the default configuration.
Default:
The system default value of the max connection number is 5.
Command Mode:
Global Mode
Usage Guide:
None.
Example:
Set the max connection number supported by the Telnet service as 10.
Configure the number of times for retrying SSH authentication; the “no ssh-server authentication-retries”
command restores the default number of times for retrying SSH authentication.
Parameter:
authentication-retries > is the number of times for retrying authentication; valid range is 1 to 10.
Command mode:
Global Mode
Default:
The number of times for retrying SSH authentication is 3 by default.
Example:
Set the number of times for retrying SSH authentication to 5.
modulus is the modulus which is used to compute the host key; valid range is 768 to 2048. The default value is
1024.
Command mode:
Global Mode
Default:
The system uses the key generated when the ssh-server is started at the first time.
1-62
XGS3 Command Guide
Usage Guide:
This command is used to generate the new host key. When SSH client logs on the server, the new host key is used
for authentication. After the new host key is generated and “write” command is used to save the configuration, the
system uses this key for authentication all the time. Because it takes quite a long time to compute the new key and
some clients are not compatible with the key generated by the modulus 2048, it is recommended to use the key
which is generated by the default modulus 1024.
Configure the max connection number supported by the SSH service of the switch.
Parameters:
<max-connection-number>: the max connection number supported by the SSH service, ranging from 5 to 16. The
default option will restore the defaul t configuration.
Default:
The system default value of the max connection number is 5.
Command Mode:
Global Mode
Usage Guide:
None.
Example:
Set the max connection number supported by the SSH service as 10.
Switch(config)#ssh-server max-connection 10
1.2.15 ssh-server timeout
Command:
ssh-server timeout <timeout>
no ssh-server timeout
Function:
Configure timeout value for SSH authentication; the “no ssh-server timeout” command restores the default timeout
value for SSH authentication.
Parameter:
<timeout> is timeout value; valid range is 10 to 600 seconds.
Command mode:
Global Mode
Default:
SSH authentication timeout is 180 seconds by default.
Example:
Set SSH authentication timeout to 240 seconds.
1-63
XGS3 Command Guide
Switch(config)#ssh-server timeout 240
1.2.16 ssh-user
Command:
ssh-user <username> password {0 | 7} <password>
no ssh-user <username>
Function:
Configure the username and password of SSH client software for logging on the switch; the “no ssh-user
<user-name>“ command deletes the username.
Parameter:
<username> is SSH client username. It can’t exceed 16 characters; <password> is SSH client password. It can’t
exceed 32 characters; 0 | 7 stand for unencrypted password and encrypted password.
Command mode:
Global Mode
Default:
There are no SSH username and password by default.
Usage Guide:
This command is used to configure the authorized SSH client. Any unauthorized SSH clients can’t log on and
configure the switch.
Example:
Set a SSH client which has “switch” as username and “switch” as password.
Switch(config)#ssh-user switch password 0 switch
1.2.17 show ssh-server
Command:
show ssh-server
Function:
Display SSH state and users which log on currently.
Command mode:
Admin Mode.
Example:
Switch#show ssh-server
ssh server is enabled
ssh-server timeout 180s
ssh-server authentication-retries 3
ssh-server max-connection number 6
ssh-server login user number 2
1.2.18 show ssh-user
Command:
show ssh-user
1-64
XGS3 Command Guide
Function:
Display the configured SSH usernames.
Command Mode:
Admin Mode.
Example:
Switch#show ssh-user
test
Relative Command:
ssh-user, ssh-server enable, no ssh-server enable
1.2.19 show telnet login
Command:
show telnet login
Function:
Display the information of th e Telnet client which currently establish es a Telnet connection with the switch.
Command Mode:
Admin and Configuration Mode.
Usage Guide:
Check the Telnet client messages connected through Telnet with the switch.
Example:
Switch#show telnet login
Authenticate login by local
Login user:
aa
1.3 Commands for Configuring Switch IP
1.3.1 interface vlan
Command:
interface vlan <vlan-id>
no interface vlan <vlan-id>
Function:
Enter the VLAN interface configuration mode; the no operation of this command will delete the existing VLAN
interface.
Parameters:
<vlan-id> is the VLAN ID of an existing VLAN, ranging from 1 to 4094.
Command Mode:
Global Configuration Mode.
Usage Guide:
Users should first make sure the existence of a VLAN before configuring it. User “exit” command to quit the VLAN
interface configuration mode back to the globa l confi guration mode.
Example:
Enter the VLAN interface configuration mode of VLAN1.
1-65
XGS3 Command Guide
Switch(config)#interfac e vlan 1
Switch(Config-if-Vlan1)#
1.3.2 interface ethernet 0
This command is not supported by the switch.
1.3.3 ip address
Command:
ip address <ip-address> <mask> [secondary]
no ip address [<ip-address> <mask>] [secondary]
Function:
Set the IP address and mask for the specified VLAN interface; the “no ip address <ip address><mask>
[secondary]” command deletes the specified IP address setting.
Parameter:
<ip-address> is the IP address in dot decimal format; <mask> is the subnet mask in dot decimal format;
[secondary] indicates the IP configured is a secondary IP address.
Default:
No IP address is configured upon switch shipment.
Command mode:
VLAN Interface Mode
Usage Guide:
A VLAN interface must be created first before the user can assign an IP address to the switch.
Example:
Set 10.1.128.1/24 as the IP address of VLAN1 interface.
Configure aggregatable global unicast address, site-local address and link-local address for the interface.
Parameters:
<ipv6address> is the prefix of an IPV6 address; <prefix-length>is the length of the prefix of an IPV6 address,
ranging from 3 to 128; eui-64 means that the eui64 interface id of the interface will automatically create an IPV6
address.
1-66
XGS3 Command Guide
Command Mode:
Interface Configuration Mode.
Default
None.
Usage Guide:
The prefix of an IPV6 address should not be a multicast address, or other kinds of IPV6 addresses with specific
usage. Different layer-three VLAN interfaces are forbidden to share a same address prefix. As for any global unicast
address, the prefix should be limited in the range from 2001:: to 3fff ::,with a length no shorter than 3. And the prefix
length of a site-local address or a link-local address should not be shorter than 10.
Examples:
Configure an IPV6 address at the layer-three interface of VLAN1: set the prefix as 2001:3f:ed8::99, the length of
which is 64.
Enable the switch to be a BootP Client and obtain IP address and gateway address through BootP negotiation; the
“no ip bootp-client enable” command disables the BootP Client function and releases the IP address obtained in
BootP.
Default:
BootP client function is disabled by default.
Command mode:
VLAN Interface Mode
Usage Guide:
Obtaining IP address through BootP, Manual configuration and DHCP are mutually exclusive, enabling any two
methods for obtaining IP address is not allowed. Note: To obtain IP address via BootP, a DHCP server or a BootP
server is required in the network.
Enables the switch to be a DHCP client and obtain IP address and gateway address through DHCP negotiation; the
“no ip dhcp-client enable” command disables the DHCP client function and releases the IP address obtained in
DHCP. Note: To obtain IP address via DHCP, a DHCP server is required in the network.
Default:
the DHCP client function is disabled by default.
Command mode:
VLAN Interface Mode
Usage Guide:
Obtaining IP address by DHCP, Manual configuration and BootP are mutually exclusive, enabling any 2 methods for
obtaining an IP address is not allowed.
Example:
Getting an IP address through DHCP.
Switch(config)#interfac e vlan 1
Switch(Config-if-Vlan1)#ip dhcp-client enable
Switch(Config-if-Vlan1)#exit
Switch(config)#
1.4 Commands for SNMP
1.4.1 debug snmp mib
Command:
debug snmp mib
no debug snmp mib
Function:
Enable the SNMP mib debugging; the "no debug snmp mib” command disables the debugging.
Command Mode:
Admin Mode.
Usage Guide:
When user encounters problems in applying SNMP, the SNMP debugging is available to locate the problem causes.
Example:
Switch#debug snmp mib
1.4.2 debug snmp kernel
Command:
debug snmp kernel
no debug snmp kernel
Function:
Enable the SNMP kernel debugging; the “no debug snmp kernel” command disables the debug gin g fu nct ion.
Command Mode:
Admin Mode.
1-68
XGS3 Command Guide
Usage Guide:
When user encounters problems in applying SNMP, the SNMP debugging is available to locate the problem causes.
Example:
Switch#debug snmp kernel
1.4.3 rmon enable
Command:
rmon enable
no rmon enable
Function:
Enable RMON; the “no rmon enable” command disables RMON.
Command mode:
Global Mode
Default:
RMON is disabled by default.
Example:
Enable RMON.
Switch(config)#rmon enable
Disable RMON.
Switch(config)#no rmon enabl e
1.4.4 show snmp
Command:
show snmp
Function:
Display all SNMP counter information.
Command mode:
Admin and Configuration Mode.
Example:
Switch#show snmp
0 SNMP packets input
0 Bad SNMP version errors
0 Unknown community name
0 Illegal operation for community name supplied
0 Encoding errors
0 Number of requested variables
0 Number of altered variables
0 Get-request PDUs
0 Get-next PDUs
0 Set-request PDUs
0 SNMP packets output
1-69
0 Too big errors (Max packet size 1500)
0 No such name error s
0 Bad values errors
0 General errors
0 Get-response PDUs
0 SNMP trap PDUs
Displayed information
Explanation
snmp packets input
Total number of SNMP packet inputs.
bad snmp version errors
Number of version information error packets.
unknown community name
Number of community name error packets.
illegal operation for community name supplied
Number of permission for community name error packets.
encoding errors
Number of encoding error packets.
number of requested variable
Number of variables requested by NMS.
number of altered variables
Number of variables set by NMS.
get-request PDUs
Number of packets received by “get” requests.
get-next PDUs
Number of packets received by “getnext” requests.
set-request PDUs
Number of packets received by “set” requests.
snmp packets output
Total number of SNMP packet outputs.
XGS3 Command Guide
1-70
too big errors
Number of “Too_ big” error SNMP packets.
maximum packet siz e
Maximum length of SNMP packets.
no such name errors
Number of packets requesting for non-existent MIB objects.
bad values errors
Number of “Bad_values” error SNMP packets.
general errors
Number of “General_errors” error SNMP packets.
no snmp-server community <string> [access {<num-std>|<name>}] [ipv6-access
{<ipv6-num-std>|<ipv6-name>}]
Function:
Configure the community string for the switch; the “no snmp-server community <string> [access
{<num-std>|<name>}] [ipv6-access {<ipv6-num-std> |<ipv6-name>}] “command deletes the configured
community string.
Parameter:
<string> is the community string set;
ro | rw is the specified access mode to MIB, ro for read-only and rw for read-write.
<num-std> is the access-class number for standard numeric ACL, ranging between 1-99;
<name> is the access-class name for standard ACL, the character string length is ranging between 1-32;
<ipv6-num-std> is the access-class number for stan dard numer ic IPv6 ACL, ranging between 500-599;
<name> is the access-class name for standard IPv6 ACL, the character string length is ranging between 1-32.
<read-view-name> is the name of readable view which includes 1-32 charact ers .
<write-view-name> is the name of writable view which includes 1-32 characters.
Command mode:
1-75
XGS3 Command Guide
Global Mode
Usage Guide:
The switch supports up to 4 community strings. It can realize the access-control for specifically community view by
binding the community name to specifically readable view or writable view.
Example:
Add a community string named “private” with read-write permission.
Switch(config)#snmp-server community private rw
Add a community string named “public” with read-only permission.
Switch(config)#snmp-server community public ro
Modify the read-write community string named “private” to read-only.
Switch(config)#snmp-server community private ro
Delete community string “private”.
Switch(config)#no snmp-server community private
Bind the read-only community str in g “public” to readable view “pviewr”.
Switch(config)#snmp-server community ro public read pviewr
Bind the read-write community string “private” to readable view “pviewr” and writable view “pvieww”.
Switch(config)#snmp-server community rw private read pviewr write pvieww
1.4.12 snmp-server enable
Command:
snmp-server enable
no snmp-server enable
Function:
Enable the SNMP proxy server function on the switch. The “no snmp-server enable” command disables the SNMP
proxy server function
Command mode:
Global mode
Default:
SNMP proxy server function is disabled by system default.
Usage guide:
To perform conf igur a tion m ana geme nt on the switch with ne t work manage software, t he S NMP proxy serv er funct ion
has to be enabled with this command.
Example:
Enable the SNMP proxy server function on the switch.
Switch(config)#snmp-server enable
1-76
XGS3 Command Guide
1.4.13 snmp-server enable traps
Command:
snmp-server enable traps
no snmp-server enable traps
Function:
Enable the switch to sen d Trap message; the “no snmp-server enable t raps” command di s able s th e sw it c h to se nd
Trap message.
Command mode:
Global Mode
Default:
Trap message is disabled by default.
Usage Guide:
When Trap me ss age i s e nab led, if Down/Up in d ev ice ports or of syste m oc curs , t he device will send Trap messages
to NMS that receives Trap messages.
Example:
Enable to send T r ap message s.
Switch(config)#snmp-server enable traps
Disable to send Trap me ssa ge s.
Switch(config)#no snmp-server enable traps
1.4.14 snmp-server engineid
Command:
snmp-server engineid <engine-string>
no snmp-server engineid
Function:
Configure the engine ID; the “no" form of this command restores to the default engine ID.
Command Mode:
Global mode
Parameter:
<engine-string> is the engine ID shown in 1-32 digit hex characters.
Default:
Default value is the company ID plus local MAC address.
This command is used to configure a new group; the “no” form of this command deletes this group.
Command Mode:
Global Mode
Parameter:
<group-string> group name which includes 1-32 characters
NoauthNopriv Applies the non recognizing and non encrypting safety level
AuthNopriv Applies the recognizing but non encrypting safety level
AuthPriv Applies the recognizing and encrypting safety level
read-string Name of readable view which includes 1-32 characters
write-string Name of writable view which includes 1-32 characters
notify-string Name of trappable view which includes 1-32 ch aract ers
<num-std> is the access-class number for standard numeric ACL, ranging between 1-99;
<name> is the access-class name for standard ACL, the character string length is ranging between 1-32;
<ipv6-num-std> is the access-class number for standard numeric IPv6 ACL, ranging between 500-599;
<name> is the access-class name for standard IPv6 ACL, the character string length is ranging between 1-32.
Usage Guide:
There is a default view “v1defaultviewname” in the system. It is recommended to use this view as the view name of
the notification. If the read or write view name is empty, corresponding operation will be disabled.
Example:
Create a group CompanyGroup, with the safety level of recognizing andencrypting, the read viewname isreadview,
and the writing is disabled.
Switch (config)#snmp-server group CompanyGroup AuthPriv read readview
deletet group
Switch (config)#no snmp-server group CompanyGroup AuthPriv
As for the v1/v2c versi ons th is com mand conf igure s the IPv4 or IPv6 address and Trap community character string of
the network manage station receiving the SNMP Trap message. And for v3 version, this command is used for
1-78
XGS3 Command Guide
receiving the network manage st ation IPv4 or IPv6 address and the T r ap user name and saf ety lev el; the “no” form o f
this command cancels this IPv4 or IPv6 address.
Command Mode:
Global Mode.
Parameter:
<host-ipv4-addr> | <host-ipv6-addr> is the IP address of the NMS managing station which receives Trap
message.
v1 | v2c | v3 i s theversion number when sending the trap.
NoauthNopriv | AuthNopriv | AuthPriv is the safety level v3 trap is applied, which may be non encrypted and non
authentication, non encrypted and authentication, encrypted and authentication.
<user-string> i s the community character string applied when sending the Trap message at v1/v2, and will be the
user name at v3.
Usage Guide:
The Community character string configured in this command is the default community string of the RMON event
group. If the RMON event group has no community character string configured, the community character string
configured in this command will be applied when se nding the Trap of RMON, and if the com munity character string i s
configured, its configuration will be applied when sending the RMON trap. This command allows configuration the
IPv4 or IPv6 address of the network manage station receiving the SNMP Trap message, but configure the version
number as v1 and v2c of the IPv4 and IPv6 address are less than 8 in all.
no snmp-server user <user-string> [access {<num-std>|<name>}] [ipv6-access
{<ipv6-num-std>|<ipv6-name>}]
Function:
Add a new user to an SNMP group; the "no” form of this command deletes this user.
Command Mode:
Global Mode.
Parameter:
<user-string> is the user name containing 1-32 characters.
<group-string> is the name of the group the user belongs to, containing 1-32 characters.
authPriv use DES for the packet encryption.
authNoPriv not use DES for the packet encryption.
auth perform packet authentication.
md5 packet authentication using HMAC MD5 algorithm.
sha packet authentication using HMAC SHA algorithm.
<word > user password, containing 8-32 character.
<num-std> is the access-class number for standard numeric ACL, ranging between 1-99;
<name> is the access-class name for standard ACL, the character string length is ranging between 1-32;
<ipv6-num-std> is the access-class number for standard numeric IPv6 ACL, ranging between 500-599;
<name> is the access-class name for standard IPv6 ACL, the character string length is ranging between 1-32.
Usage Guide:
If the encryption and a ut he nti c ation is not selected, the defau lt s et tin gs will be no encryption and no authentication. If
the encryption is selected, the authentication must be done. When deleting a user, if correct username and incorrect
group name is inputted, the user can still be deleted.
Example:
Add a new user tester in the UserGroup with an encryption safety level and HMAC md5 for authentication, the
password is hellohello
Switch (config)#snmp-server user tester UserGroup authPriv auth md5 hellohello
<source-url> is the location of the source files or directories to be copied; <destination-url> is the destination
address to which the files or directories to be copied; forms of <source-url> and <destination-url> vary depending
on different locations of the files or directories. ascii indicates the ASCII standard will be adopted; binary indicates
that the binary system will b e adopt ed in th e file t ransm ission (defau lt transm issio n method ). When URL repr esent s
an FTP address, its form should be:
ftp://<username>:<password>@{<ipaddress>|<ipv6address>|<hostname> }/<filename>,amongst <username> is the
FTP user name,<password> is t he FTP user password,<ipaddress>|<ipv6address> is the IPv4 or IPv6 address of
the FTP server/client,<hostname> is the name of the host mapping with the IPv6 address,it does not support the file
download and upload with hosts mapping with IPv4 addresses,<filename> is the name of the FTP upload/download
file.
Special keywords of the filename
Keywords
Source or destination addresses
running-config
Running configuration fil es
startup-config
Startup configuration files
nos.img
System files
nos.rom
System startup files
Command Mode:
Admin Mode.
Usage Guide:
This command supports command line hints, namely if the user can enter commands in following forms: copy
<filename> ftp:// or copy ftp:// <filename> and press Enter, following hints will be provided by the system:
ftp server ip/ipv6 address [x.x.x.x]/[x:x::x:x] >
ftp username>
ftp password>
ftp filename>
Requesting for FTP server address, user name, password and file name
Examples:
(1) Save images in the FLA SH to the FTP server of 10.1.1.1, FTP server userna me is Switch, password is s uperuser
<source-url> is the location of the source files or directories to be copied; <destination-url> i s the destinat ion
address to which the files or directories to be copied; forms of <source-url> and <destination-url> vary depending
on different locations of the files or directories. ascii indicates the ASCII standard will be adopted; binary indicates
that the binary system will b e adopt ed in th e file t ransm ission (defau lt transm issio n method ). When URL repr esent s
an TFTP address, its form should be: tftp://{<ipaddress>|<ipv6address>|<hostname>}/<filename>, amongst
<ipaddress>| <ipv6address> is the IPv4 or IPv6 address of the TFTP server/client, <hostname> is the name of the
host mapping with the IPv6 address, it does not support the file download and upload with hosts mapping with IPv4
addresses,<filename> is the name of the TFTP upload/download file.
Special keyword of the filename
Keywords
Source or destination
addresses
running-config
files
startup-config
files
nos.img
System files
nos.rom
System startup files
1-83
XGS3 Command Guide
Command Mode:
Admin Mode.
Usage Guide:
This command supports command line hints, namely if the user can enter commands in following forms: copy
<filename> tftp:// or copy tftp:// <filename> and press Enter, following hints will be provided by the system:
tftp server ip/ipv6 address[x.x.x.x]/[x:x::x:x]>
tftp filename>
Requesting for TFTP server address, file name
Example:
(1) Save images in the FLASH to the TFTP server of 10.1.1.1
Switch#copy nos.img tftp://10.1.1.1/nos.img
(2) Obtain system file nos.img from the TFTP server 10.1.1.1
Change the working directory for the storage device.
Parameters:
<directory> is the sub-directory name, a sequence of consecutive characters whose length ranges from 1 to 80.
Command Mode:
Admin Mode.
Default Settings:
The default working directory is Flash.
Usage Guide:
After this command implemented, the current storage device will switch to the new working directory, which can be
viewed by the “pwd” command.
Example:
Change the working directory of the current storage device to flash.
Switch#cd flash:
Switch#pwd
flash:/
Switch#
2.2 copy
Command:
copy <source-file-url > <dest-file-url>
Function:
Copy a designated file on the switch and store it as a new file.
Parameters:
<source-file-url> is the source file; <dest-file-url> is the destination file. When users operate on files stored in
backup main-control boardcards and line cards under IMG mode, URLs of the source file and the destination file
should take such a form as described in the following requirements.
1. The prefix of the source file URL should be in one of the following forms:
starting with “flash:/”
“ftp://username:pass@server-ip/file-name”
“tftp://server-ip/file-name”
2. The prefix of the destination file URL should be in one of the following forms:
starting with “flash:/”
“ftp://username:pass@server-ip/file-name”
“tftp://server-ip/file-name”
Command Mode:
2-89
XGS3 Command Guide
Admin Mode.
Default Settings:
None.
Usage Guide:
1. In this command, when the prefix of the source file URL is ftp:// or tftp://, that of the destination file URL should not
be either of them.
2. To use this command, the designated source file should exist, and the destination file should not be named the
same as any existing directory or file, otherwise, there might be a prompt warning about a failed copy operation or an
attempt to overwrite an existing file.
3. If the source and destination files are in different directories, with this command implemented, users can copy files
from other directories into the current one.
URL Example: The URL of files in root directory of Flash devices on it should be flash:/nos.img
Example:
Copy the file “flash:/nos.img” and store it as “flash/ 5.2.1.0.img”.
Switch#copy flash:/nos.img flash:/nos-5.2.1.0.img
Copy flash:/nos.img to flash:/nos-5.2.1.0.img? [Y:N] y
Copyed file flash:/nos.img to flash:/nos-5.2.1.0.img.
2.3 delete
Command:
delete <file-url>
Function:
Delete the designate file on the storage device.
Parameters:
<file-url> is the full path of the file to be deleted.
Command Mode:
Admin Mode.
Default Settings:
None.
Usage Guide:
The designated file will be deleted after implementing this command.
Example:
Delete file flash:/nos.img.
Switch#delete flash:/nos5.img
Delete file flash:/nos5.img?[Y:N]y
Deleted file flash:/nos.img.
2.4 dir
Command:
dir [WORD]
Function:
2-90
XGS3 Command Guide
Display the information of the designated directory on the storage device.
Parameters:
<WORD> is the name of the shown directory. There may be the following formats: directory name, slot-xx#directory
name, flash:/directory name, cf:/directory name.
Command Mode:
Admin Configuration Mode.
Default Settings:
No <WORD> means to display information of the current working directory.
Usage Guide:
Implementing this command will display information of files and sub-directories in the designated directory.
Note:
This command does not support a recursive display of all sub-directories.
Example:
Display information of the directory “flash:/”.
Switch#dir flash:/
nos.img 2,449,496 1980-01-01 00:01:06 ----
startup-config 2,064 1980-01-01 00:30:12 ----
Total 7, 932, 928 byte(s) in 4 file(s), free 4, 966, 400 byte(s)
Switch#
2.5 format
Command:
format <device>
Function:
Format the storage device.
Parameters:
<device> is the name of the device to be formatted.
Command Mode:
Admin Mode.
Default Settings:
None.
Usage Guide:
1. After formatting, all files on the storage device will be irrecoverably lost.
2. The only acceptable file system type of Format is FAT 32, without exception.
3. This command cannot be used to format flash.
2.6 mkdir
Command:
mkdir <directory>
Function:
2-91
XGS3 Command Guide
Create a sub-directory in the designated directory on a certain storage device .
Parameters:
<directory> is the sub-directory name, a sequence of consecutive characters, whose length ranges from 1 to 80.
Command Mode:
Admin Mode.
Default Settings:
None.
Usage Guide:
The new created dire ctory should not be named th e sam e a s any other directory or fi le in t he de sign ated d ir ec tory, or
located on a flash device. If any error occurs, a prompt will be displayed.
2.7 mount
Command:
mount <device>
Function:
Mount the designated device onto the file system.
Parameters:
<device > is the name of the device to be mounted onto the file system.
Command Mode:
Admin Mode.
Default Settings:
None.
Usage Guide:
The flash's status will automatically be mount ed, on whi ch fil e operation s can be impl em ent ed.
Example:
Mount the flash card onto the file system.
Switch#mount flash:
2.8 pwd
Command:
pwd
Function:
Display the current working directory.
Parameters:
None.
Command Mode:
Admin Mode.
Default Settings:
The default directory is flash.
Example:
Display the current working directory.
Switch#pwd
2-92
XGS3 Command Guide
flash:/
Switch#
2.9 rename
Command:
ename <source-file-url> <new-filename >
Function:
Rename a designated file on the switch.
Parameters:
<source-file-url>is the source file, in which whether specifying or not its path are both acceptable;
<new-filename>is a filename without speci fy ing its path.
Command Mode:
Admin Mode.
Default Settings:
None.
Usage Guide:
When using this command, if the new file name is not used as that of any existing directory or file, the rename
operation can be done, or a prompt will indicate its failure.
Example:
Change the name of file “nos.img” in the current working directory to “nos-5.2.1.0.img”.
Switch# rename nos5.img nos-5.2.1.0.img
Rename flash:/nos5.img to flash:/nos-5 .2.1.0.i mg ok!
2.10 rmdir
Command:
rmdir <directory>
Function:
Delete a sub-directory in the designated directory on a certain device .
Parameters:
<directory> is the sub-directory name, a sequence of consecutive characters whose length ranges from 1 to 80.
Command Mode:
Admin Mode.
Default Settings:
None.
Usage Guide:
The directory to be deleted should exist and be empty, that is, all files in the directory should be deleted before
deleting it, or an error prompt will be displayed.
2.11 unmount
Command:
2-93
unmount <device>
Function:
Unmount the designated device from the file system.
Parameters:
<device> is the device to be unmounted from the file system.
Command Mode:
Admin Mode.
Default Settings:
Unmount the FLASH from the file system is nonsupport.
Clear the nodes in the candidate list found by the commander switch.
Parameters: c
andidate-sn-list: sn of candidate switches, ranging from 1 to 256. More than one candidate can be specified.
mac-address: mac address of the switches (including all candidates, members and other switches).
Default:
Noparameter means to clear information of all switches.
Command Mode:
Admin Mode.
Usage Guide:
After executing this command, the information of this node will be deleted from the chain list saved on commander
switch. In 30 seconds, the commander w ill recreate a cluster topology and re-add this node. But after being readd ed,
the candidate id of the switch might change. The command can only be executed on commander switch es
Example:
Clear all candidate switch lists found by the comma nder sw it c h.
Switch#clear cluster nodes
3.2 cluster auto-add
Command:
cluster auto-add
no cluster auto-add
Function:
When this command is ex ecuted in t he com mander sw itch, the new ly discovered candida te switches w ill be a dded to
the cluster as a member switch automatically; the “no cluster auto-add” command disables this function.
Command mode:
Global Mode
Default:
This function is disabled by default. That 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 the auto adding function in the commander switch.
Switch(config)#cluster auto-add
3.3 cluster commander
Command:
3-95
XGS3 Command Guide
cluster commander [<cluster-name>]
no cluster commander
Function:
Set the switch as a commander switch, and create a cluster.
Parameter:
<cluster-name> is the cluster’s name, no longer than 32 characters.
Command mode:
Global Mode
Default:
Default setting is no comm and er sw itch. cl uster _na me is nul l by default.
Usage Guide:
This command sets the role of a switch as commander switch and creates a cluster, which can only be executed on
non commander switches. The cluster_name cannot be changed after the switch becoming a commander, and “no
cluster commander” should be executed first to do that. 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 as switch.
Switch(config)#cluster commander switch
3.4 cluster ip-pool
Command:
cluster ip-pool <commander-ip>
no cluster ip-pool
Function:
Configure private IP address pool for member switches of the cluster.
Parameters:
commander-ip:
cluster IP address pool for allocating internal IP addresses of the cluster commander-ip is the head address of the
address pool, of which the valid format is 10.x.x.x, in dotted-decima l not at i on; 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). IP address
pool should never be changed with commander configured. The change can only be done after the “no cluster
commander” command being executed.
Command mode:
Global Mode
Default:
The default address pool is 10.254.254.1.
Usage Guide:
When candidate switches becomes cluster members, the commander switch allocates a private IP address to each
member for the communication within the cluster, and thus to realized its management and maintenance of cluster
members. This command can only be used on non-commander switches. Once the cluster established, users can
not modify its IP address pool. The NO command of th is c om mand w ill r est ore t he a ddre ss pool back to default value,
which is 10.254.254.1.
Example:
Set the private IP address pool used by cluster member dev ices as 10.254.254.10
3-96
XGS3 Command Guide
Switch(config)#cluster ip-pool 10.254.254.10
3.5 cluster keepalive interval
Command:
cluster keepalive interval <second>
no cluster keepalive interval
Function:
Configure the time interval of keepalive messages within the cluster.
Parameters:
<second>: keepalive time interval, in seconds, ranging from 3 to 30.
Default:
The default value is 30 seconds.
Command Mode:
Global Configuration Mode.
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 it on a non commander switch, the configuration value will be saved but not used until the switch
becomes a commander. Before that, its keepalive interval is the one distributed by its commander.
Commander will send DP messages within the cluster once in every 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 back to its default value.
Example:
Set the keepalive interval in the cluster to 10 seconds.
Switch(config)#cluster keepalive interval 10
3.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 that can be tolerated.
Parameters:
loss-count: the tolerable max number of lost messages, ranging from 1 to 10.
Default:
The default value is 3.
Command Mode:
Global Configuration Mode
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 it on a non commander switch, the configuration value will be saved but not used until the switch
becomes a commander. Before that, its loss-count value is the one distributed by its commander.
3-97
XGS3 Command Guide
commander calculates the loss-count after sending each DP message by adding 1 to the loss-count of each swit ch
and clearing that of a switch after receiving a DR message from the latter. When a loss-count reaches the configured
value (3 by defaul t) w ithout receiving any DR message, the c ommander will delete th e switch from its can did ate 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 tolerable max number of lost keepalive messages in the cluster
back to its default value: 3.
Example:
Set the tolerable max number of lost keepalive messages in the cluster to 5.
Switch(config)#cluster keepalive loss-count 5
3.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 created by it.
Parameters:
nodes-sn:all cluster member switches as rec orded i n a chai n list, each w ith a node sn w hich can be v iewed by “show
cluster candidates” command. One or more candidates can be added as member at one time. The valid range of
candidate-sn-list is 1~256.
mac-address:the CPU Mac of candidate switches
member-id:A memb er i d c an be s pec ified to a candidate as it be co mes a mem ber, ranging f rom 1 to 128, increasing
from 1 by default.
nodes-sn is the automatically generated sn, which may change after the candidate becomes a member. Members
added this way will be actually treated as those added in mac-addr mode with all config files in mac-addr mode.
If more than one switch is added as member simultaneously, no member-id is allowed; neither when using nodes-sn
mode.
Default:
None.
Command Mode:
Global Mode
Usage Guide:
After executing this command, the switch will add those identified in <nodes-sn> or <mac-address>into the cluster
it belongs to. One or more candidates are allowed at one time, linked with ‘-‘ or ‘;’. A switch can only be member or
commander of one cluster, exclusively. Attempts to execute the command on a non commander switch will return
error. The no operat ion of t his comman d w ill delete the specified member switch, and turn it back to a candidate.
Example:
In the commander switc h, ad d the candidate switch which has the sequence nu mber as 1. In the commander switch,
add the switch whose the mac address is 11-22-33-44-55-66 to member, and the member-id is 5.
Switch(config)#cluster member nodes-sn 1
3-98
XGS3 Command Guide
Switch(config)#cluster member mac-address 11-22-33-44-55-66 id 5
3.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 automatically added
members to manually added ones to keep them.
Parameter:
None.
Default:
None.
Command Mode:
Global Mode.
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.
Switch(config)#cluster member auto-to-user
3.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: ranging from 1 to 128. Use hyphen “-” or s emic olo n “;” to specify more than one member; if no value is
provided, it means to reboot all member switches.
Default:
Boot all member switches.
Command mode:
Admin Mode.
Instructions:
In the commander switch, users can use this command to reset a member switch. If this command is executed in a
non-commander switch, an error will be displayed.
Example:
In the commander switch, reset the member switch 1.
Switch#cluster reset member 1
3-99
XGS3 Command Guide
3.10 cluster run
Command:
cluster run [key <WORD>][ vid <VID>]
no cluster run
key:all keys in one cluster should be the same, no longer than 16 characters.
vid:vlan id of the cluster, whose range is 1-4094.
Command mode:
Global Mode
Default:
Cluster function is disabled by default, key: NULL(\0) vid:1.
Instructions:
This command enables cluster function. Cluster function has to be enabled before implementing any other cluster
commands. The “no cluster run” disables cluster function. It is recommended that users allocate an exclusive vlan
for cluster(such as vlan100)
Note:Routing protocols should be disabled on the layer-3 interface where cluster vlan locates to avoid broadcasting
private route of the cluster.
Example:
Disable cluster function in the local switch.
Switch (config)#no cluster run
3.11 cluster update member
Command:
cluster update member <member-id> <src-url> <dst-filename> [ascii | binary]
Function:
Remotely upgrade member switches from the co mma nder switch.
Parameters:
member-id:ranging from 1 to 128. Use hyphen “-” or semicolon “;” to specify more than one member;
src-url:the location of source files to be copied;
dst-filename:the specified filename for saving the file in the sw itch flash;
ascii means t hat the f ile tran smission follows ASCII standard; binary means that the file transmission follows binary
standard, which is de default mode.
when src-url is a FTP address, its form will be: ftp://<username>:<password>@<ipadress>/<filename>,in which
<username> is the FTP username <password> is the FTP password <ipadress> is the IP address of the FTP
server,<filename> is the name of the file to be downloaded via FTP.
when src-url is a TFTP address, its f orm will be: tftp://<ipadress>/<filename>,in which <ipadress>is the IP address of
the TFTP server <filename> is the name of the file to be downloaded via.
Special keywords used in filename:
Keywords
source or destination address
3-100
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.