Page 2
Telesis, Inc. be liable for any incidental, special, indirect, or consequential damages whatsoever, including but not limited to lost profits, arising out of or related to this manual or the information contained herein, even if Allied Telesis, Inc. has been advised of, known, or should have known, the possibility of such damages.
Contents Preface ................................5 Safety Symbols Used in this Document ......................6 Contacting Allied Telesis ............................7 Chapter 1: Introduction ...........................9 GS950 PS Series of Gigabit Ethernet PoE+ Switches ..................10 Management Interfaces............................11 Management Functions from the Command Line Interface ................12 Command Line Interface Modes ........................13 Command Line Symbols ..........................14...
Page 4
Contents Chapter 6: File Transfer Commands ......................55 DOWNLOAD ..............................56 UPLOAD ................................58 Chapter 7: SNMP Commands ........................59 NO SNMP-SERVER COMMUNITY ......................... 60 NO SNMP-SERVER ENGINEID ........................61 NO SNMP-SERVER GROUP .......................... 62 NO SNMP-SERVER HOST ..........................64 NO SNMP-SERVER TRAPS ENABLE ......................
This guide describes the management commands in the command line interface of the GS950 PS Series of Gigabit Ethernet switches. The preface contains the following sections: “Safety Symbols Used in this Document” on page 6 “Contacting Allied Telesis” on page 7...
Preface Safety Symbols Used in this Document This document uses the following conventions. Note Notes provide additional information. Caution Cautions inform you that performing or omitting a specific action may result in equipment damage or loss of data. Warning Warnings inform you that performing or omitting a specific action may result in bodily injury.
GS950 PS Series Command Line Interface User’s Guide Contacting Allied Telesis If you need assistance with this product, you may contact Allied Telesis technical support by going to the Support & Services section of the Allied Telesis web site at www.alliedtelesis.com/support. You can find links for the following services on this page: ...
Chapter 1 Introduction The sections in this chapter are listed here: “GS950 PS Series of Gigabit Ethernet PoE+ Switches” on page 10 “Management Interfaces” on page 11 “Management Functions from the Command Line Interface” on page 12 ...
Chapter 1: Introduction GS950 PS Series of Gigabit Ethernet PoE+ Switches This manual applies to the following GS950 PS Series switches: AT-GS950/10PS Switch AT-GS950/16PS Switch AT-GS950/28PS Switch AT-GS950/48PS Switch The commands in this manual apply to all the above models.
GS950 PS Series Command Line Interface User’s Guide Management Interfaces The GS950 PS Series switches have three management interfaces. You access the interfaces over your network from your workstation. The interfaces are listed here: Web browser interface: This interface consists of a series of easy- to-use web browser windows that support non-secure HTTP and secure HTTPS.
Chapter 1: Introduction Management Functions from the Command Line Interface You can perform the following management functions from the command line interface: Display basic switch information, such as the management software version number and IPv4 and IPv6 addresses. Return all parameter settings to their default values.
GS950 PS Series Command Line Interface User’s Guide Command Line Interface Modes The command line interface has two levels or modes with different commands. The first mode is called the Privileged Exec mode. This mode is displayed first when you log on the command line interface to manage the switch.
Chapter 1: Introduction Command Line Symbols Table 1 defines the symbols used in the command descriptions in this guide. Table 1. Command Symbols Symbol Description keyword Keywords are represented in lowercase fix-width font. You have to enter keywords as shown in the command descriptions.
AT-GS950/28PS Gigabit Ethernet WebSmart Switch Command Line Interface Firmware Version: AT-S126 V1.0.0 (1.00.015) Copyright (C) 2015 Allied Telesis. All rights reserved. AT-GS950/28PS login: Figure 1. Login Prompt for the Command Line Interface 3. Enter the manager name. The default name is “manager”. The name is...
Page 16
Chapter 1: Introduction 4. When prompted for the password, enter the account’s password. The default password is “friend”. The password characters are not displayed on the screen. The password is case sensitive. The switch displays the command line prompt for the Privileged Exec mode, shown here: ATGS950_28PS# You are now logged on the command line interface in the switch.
GS950 PS Series Command Line Interface User’s Guide Tips on Using the Command Line Interface Here are a couple tips for entering commands in the command line interface: You can use the “?” question mark key to display mode commands, keywords, and variables.
Chapter 2: Basic Management Commands ? (Question Mark Key) Syntax Parameters None. Modes Privileged Exec and Global Configuration modes Description Use the question mark key to display on-line help messages. Typing the key at different points in a command displays different messages: ...
GS950 PS Series Command Line Interface User’s Guide CLEAR SCREEN Syntax clear screen Parameters None. Modes Privileged Exec mode Description Use this command to clear the screen. Example ATGS950_28PS# clear screen...
Chapter 2: Basic Management Commands CONFIG ACCOUNT Syntax config account username password password Parameters username Specifies a name for a new manager account. It can be up to twelve alphanumeric characters and is case sensitive. Spaces and special characters are not allowed. password Specifies a password for a manager account.
GS950 PS Series Command Line Interface User’s Guide CONFIGURE TERMINAL Syntax configure terminal Parameters None. Mode Privileged Exec mode Description Use this command to move from the Privileged Exec mode to the Global Configuration mode. Example ATGS950_28PS# configure terminal ATGS950_28PS(config)#...
Chapter 2: Basic Management Commands Syntax Parameters None. Mode Global Configuration mode Description Use this command to return to the Privileged Exec mode from the Global Configuration mode. Example ATGS950_28PS(config)# end ATGS950_28PS#...
GS950 PS Series Command Line Interface User’s Guide LOGOUT Syntax logout Parameters None. Mode Privileged Exec mode Description Use this command to end a command line management session. Example This example shows the sequence of commands to logging out from the Global Configuration mode: ATGS950_28PS(config)# end ATGS950_28PS# logout...
Chapter 2: Basic Management Commands REBOOT Syntax reboot Parameters None. Mode Privileged Exec mode Description Use this command to reset the switch. You might reset the unit if it is experiencing a problem. Note This command does not display a confirmation prompt. Caution The switch does not forward network traffic while it initializes its management software.
GS950 PS Series Command Line Interface User’s Guide RESET CONFIG Syntax reset config Parameters None. Mode Privileged Exec mode Description Use this command to restore the default settings to all the parameters on the switch, including the IPv4 and IPv6 addresses. To retain the IP addresses, refer to “RESET CONFIG EXCEPT IP”...
Chapter 2: Basic Management Commands RESET CONFIG EXCEPT IP Syntax reset config except ip Parameters None. Mode Privileged Exec mode Description Use this command to restore the default settings to all the parameters on the switch, except for the IPv4 and IPv6 addresses. Caution This command resets the switch.
GS950 PS Series Command Line Interface User’s Guide SAVE Syntax save Parameters None. Mode Privileged Exec mode Description Use this command to update the configuration file with the switch’s current configuration, for permanent storage. When you enter the command, the switch copies its parameter settings into the configuration file.
Chapter 2: Basic Management Commands SHOW SWITCH Syntax show switch Parameters None. Modes Privileged Exec and Global Configuration modes Description Use this command to view basic switch information. An example is shown in Figure 2. System Up For : 2 day(s), 3 hr(s), 6 min(s), 2 sec(s) Runtime Image : AT-S126 V1.0.0 (1.00.015) Boot Loader...
Chapter 3 IPv4 Management Address Commands The chapter contains the commands for assigning an IPv4 management address to the switch. The commands are listed here: “CONFIG IPIF SYSTEM” on page 32 “CONFIG IPIF SYSTEM BOOTP” on page 34 ...
Chapter 3: IPv4 Management Address Commands CONFIG IPIF SYSTEM Syntax config ipif system ipaddress ipaddress subnet_mask gw_ipaddress gateway Parameters ipaddress Specifies an IPv4 management address for the switch. The address is specified in this format: nnn.nnn.nnn.nnn Where NNN is a decimal number from 0 to 255. The numbers must be separated by periods.
Page 33
GS950 PS Series Command Line Interface User’s Guide Example This example assigns the switch the IPv4 management address 142.35.78.21, subnet mask 255.255.255.0, and default gateway 142.35.78.201: ATGS950_28PS# configure terminal ATGS950_28PS(config)# config system ipif ipaddress 142.35.78.21 255.255.55.0 gateway 142.35.78.201 This example assigns the switch the IPv4 management address 136.122.89.14, subnet mask 255.255.255.0, and default gateway 0.0.0.0: ATGS950_28PS# configure terminal ATGS950_28PS(config)# config system ipif ipaddress...
Chapter 3: IPv4 Management Address Commands CONFIG IPIF SYSTEM BOOTP Syntax config ipif system bootp Parameters None. Mode Global Configuration mode Description Use this command to activate the BOOTP client so that the switch receives an IPv4 management address from a BOOTP server on your network.
GS950 PS Series Command Line Interface User’s Guide CONFIG IPIF SYSTEM DHCP Syntax config ipif system dhcp Parameters None. Mode Global Configuration mode Description Use this command to activate the DHCP client so that the switch receives an IPv4 management address from a DHCP server on your network. The switch automatically queries the network for a DHCP server when you activate the client or whenever you reset or power cycle the switch.
Chapter 3: IPv4 Management Address Commands PING Syntax ping ip_addr Parameter ip_addr Specifies the IPv4 address of a network device. Modes Privileged Exec mode Description Use this command to have the switch send ICMP Echo Requests to network devices with IPv4 addresses. You might use the command to determine whether there is an active link between the switch and another network device, such as a RADIUS server or a Telnet client, to troubleshoot communication problems.
GS950 PS Series Command Line Interface User’s Guide SHOW IPIF Syntax show ipif Parameters None. Mode Privileged Exec and Global Configuration modes Description Use this command to display the IPv4 and IPv6 addresses of the switch. Figure 3 is an example of the information. Internet Address 192.168.1.1 Subnet Mask...
Chapter 4 IPv6 Management Address Commands The chapter contains the commands for assigning an IPv6 management address to the switch. The commands are listed here: “CONFIG IPIF SYSTEM DHCPV6_CLIENT” on page 40 “CONFIG IPIF SYSTEM IPV6” on page 42 ...
Chapter 4: IPv6 Management Address Commands CONFIG IPIF SYSTEM DHCPV6_CLIENT Syntax config ipif system dhcpv6_client enable|disable Parameters enable Enables the IPv6 DHCP client. disable Disables the IPv6 DHCP client. This is the default setting. Mode Global Configuration mode Description Use this command to enable or disable the IPv6 DHCP client on the switch.
Page 41
GS950 PS Series Command Line Interface User’s Guide ATGS950_28PS# configure terminal ATGS950_28PS(config)# config ipif system dhcpv6_client enable This example disables the client: ATGS950_28PS# configure terminal ATGS950_28PS(config)# config ipif system dhcpv6_client disable...
Chapter 4: IPv6 Management Address Commands CONFIG IPIF SYSTEM IPV6 Syntax config ipif system ipv6 ipv6address ipaddress subnet_mask Parameters ipaddress Specifies an IPv6 management address for the switch. The address is entered in this format: nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn Where N is a hexadecimal digit from 0 to F. The eight groups of digits have to be separated by colons.
Page 43
GS950 PS Series Command Line Interface User’s Guide Example This example assigns the switch the IPv6 management address 3710:17a9:11::190:a1d4 with mask 64: ATGS950_28PS# configure terminal ATGS950_28PS(config)# config ipif system ipv6 ipv6address 3710:17a9:11::190:a1d4 64...
Chapter 4: IPv6 Management Address Commands IPV6 ADDRESS LINK-LOCAL Syntax ipv6 address ipv6_address link-local Parameter ipv6_address Specifies an IPv6 local link address for the switch. The address is entered in this format: nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn Where N is a hexadecimal digit from 0 to F. The eight groups of digits have to be separated by colons.
GS950 PS Series Command Line Interface User’s Guide IPV6 AUTOMATIC LINK-LOCAL ADDRESS Syntax ipv6 automatic link-local address enable|disable Parameter enable Automatically assigns an IPv6 link-local address to the switch. disable Disables the automatic assignment of an IPv6 link-local address. Mode Global Configuration Mode Description Use this command to have the switch automatically assign itself an IPv6...
Chapter 4: IPv6 Management Address Commands IPV6 ENABLE Syntax ipv6 enable Parameters None. Mode Global Configuration mode Description Use this command to enable IPv6 address processing on the switch. You must enable IPv6 address processing to assign the switch an IPv6 address configuration.
GS950 PS Series Command Line Interface User’s Guide IPV6 GATEWAY Syntax ipv6 gateway ipv6_address Parameters ipv6_address Specifies an IPv6 gateway address for the switch. The address is entered in this format: nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn Where N is a hexadecimal digit from 0 to F. The eight groups of digits have to be separated by colons.
Chapter 4: IPv6 Management Address Commands NO IPV6 ENABLE Syntax no ipv6 enable Parameters None. Mode Global Configuration mode Description Use this command to disable IPv6 address processing on the switch. This is the default setting. The switch retains its IPv6 address configuration, but it stops processing IPv6 management functions.
GS950 PS Series Command Line Interface User’s Guide PING6 Syntax ping6 ipv6addr Parameters ipv6add Specifies the IPv6 address of a network device. Modes Privileged Exec mode Description Use this command to have the switch send ICMP Echo Requests to network devices with IPv6 addresses. You might use the command to determine whether there is an active link between the switch and another network device, such as a RADIUS server or a Telnet client, to troubleshoot communication problems.
Chapter 5 HTTP and HTTPS Commands This chapter describes the HTTP and HTTPS server commands. The commands are listed here: “IP HTTP SECURE-SERVER” on page 52 “NO IP HTTP SECURE-SERVER” on page 53 “SHOW IP HTTP SECURE-SERVER STATUS” on page 54...
Chapter 5: HTTP and HTTPS Commands IP HTTP SECURE-SERVER Syntax ip http secure-server Parameters None. Mode Global Configuration mode Description Use this command to activate the HTTPS server to manage the switch with secure web browser management sessions. Enabling the HTTPS server disables the HTTP server.
GS950 PS Series Command Line Interface User’s Guide NO IP HTTP SECURE-SERVER Syntax no ip http secure-server Parameters None. Mode Global Configuration mode Description Use this command to disable the HTTPS server and enable the HTTP server. Confirmation Command “SHOW IP HTTP SECURE-SERVER STATUS” on page 54 Example ATGS950_28PS# configure terminal ATGS950_28PS# no ip http secure-server...
Chapter 5: HTTP and HTTPS Commands SHOW IP HTTP SECURE-SERVER STATUS Syntax show ip http secure-server status Parameters None. Mode Privileged Exec and Global Configuration modes Description Use this command to display the status of the HTTPS server. Example ATGS950_28PS# show ip http secure-server status...
Chapter 6 File Transfer Commands This chapter describes commands for uploading or downloading files to the switch. The commands are listed here: “DOWNLOAD” on page 56 “UPLOAD” on page 58...
Chapter 6: File Transfer Commands DOWNLOAD Syntax download cfg_toTFTP|firmmware ipaddr ipv6addr path_filename Parameters cfg_toTFTP Downloads a configuration file to the switch. firmware Downloads new management software to the switch. ipadd Specifies the IPv4 address of a TFTP server on your network. ipv6add Specifies the IPv6 address of a TFTP server on your network.
Page 57
GS950 PS Series Command Line Interface User’s Guide Caution Downloading management software or a configuration file causes the switch to reset. The switch does not forward network traffic while writing the new file to flash memory and initializing its software. Do not interrupt the process by resetting or power cycling the switch.
Chapter 6: File Transfer Commands UPLOAD Syntax upload cfg_toTFTP ipadd ipv6addr path_filename Parameters ipaddr Specifies the IPv4 address of a TFTP server on your network. ipv6addr Specifies the IPv6 address of a TFTP server on your network. path_filename Specifies the path and filename where the TFTP server is to store the configuration file.
Chapter 7: SNMP Commands NO SNMP-SERVER COMMUNITY Syntax no snmp-server community community_name Parameter community_name Specifies a community name to be deleted. The name is case sensitive. Mode Global Configuration mode Description Use this command to delete community strings from the switch. You may delete only one community string at a time.
GS950 PS Series Command Line Interface User’s Guide NO SNMP-SERVER ENGINEID Syntax no snmp-server engineid Parameters None. Mode Global Configuration mode Description Use this command to return the SNMPv3 engine ID to the default value. Example This example returns the SNMPv3 engine ID to the default value: ATGS950_28PS# configure terminal ATGS950_28PS(config)# no snmp-server engineid...
Chapter 7: SNMP Commands NO SNMP-SERVER GROUP Syntax no snmp-server group groupname v1|v2c|v3 auth|noauth|priv Parameters groupname Specifies a name of a group to be deleted. The name is case sensitive. v1|v2c|v3 Specifies the SNMP version. The versions are listed here: v1: SNMPv1 v2c: SNMPv2c v3: SNMPv3...
Page 63
GS950 PS Series Command Line Interface User’s Guide minimum security level of privacy: ATGS950_28PS# configure terminal ATGS950_28PS(config)# no snmp-server group sta5west v3 priv...
Chapter 7: SNMP Commands NO SNMP-SERVER HOST Syntax no snmp-server host ipv4_address ipv6_address Parameters ipv4_address Specifies the IPv4 address of a trap receiver. ipv6_addr Specifies the IPv6 address of a trap receiver. Mode Global Configuration mode Description Use this command to delete IP addresses of trap receivers. You may delete only one IP address at a time.
GS950 PS Series Command Line Interface User’s Guide NO SNMP-SERVER TRAPS ENABLE Syntax no snmp-server traps enable Parameters None. Mode Global Configuration mode Description Use this command to disable the transmission of SNMP traps. Example ATGS950_28PS# configure terminal ATGS950_28PS(config)# no snmp-server traps enable...
Chapter 7: SNMP Commands NO SNMP-SERVER USER Syntax no snmp-server user username v1|v2c|v3 Parameters username Specifies a user name to be deleted. The name is case sensitive. v1|v2c|v3 Specifies the SNMP version of the user. The options are listed here: v1: SNMPv1 v2c: SNMPv2c v3: SNMPv3...
GS950 PS Series Command Line Interface User’s Guide NO SNMP-SERVER VIEWTREE Syntax no snmp-server viewtree viewtreename subtreeoid subtreeoid Parameters viewtreename Specifies a name of a view to be deleted. The name is case sensitive. subtreeoid Specifies the OID of the subtree of the view to be deleted. Mode Global Configuration mode Description...
Chapter 7: SNMP Commands SHOW SNMP Syntax show snmp Parameters None. Mode Privileged Exec and Global Configuration modes Description Use this command to display SNMP status. The status is always Enabled. Example ATGS950_28PS# show snmp...
GS950 PS Series Command Line Interface User’s Guide SHOW SNMP COMMUNITY Syntax show snmp community Parameters None. Mode Privileged Exec and Global Configuration modes Description Use this command to display the SNMP community strings. Example ATGS950_28PS# show snmp community...
Chapter 7: SNMP Commands SHOW SNMP ENGINEID Syntax show snmp engineid Parameters None. Mode Privileged Exec and Global Configuration modes Description Use this command to display the SNMP engineID. Example ATGS950_28PS# show snmp engineid...
GS950 PS Series Command Line Interface User’s Guide SHOW SNMP GROUP Syntax show snmp group Parameters None. Mode Privileged Exec and Global Configuration modes Description Use this command to display the SNMP groups. Example ATGS950_28PS# show snmp-server group...
Chapter 7: SNMP Commands SHOW SNMP-SERVER TRAPS-MANAGEMENT Syntax show snmp-server traps-management Parameters None. Mode Privileged Exec and Global Configuration modes Description Use this command to display the IP addresses of network devices to receive traps from the switch. Example ATGS950_28PS# show snmp-server traps-management...
GS950 PS Series Command Line Interface User’s Guide SHOW SNMP USER Syntax show snmp user Parameters None. Mode Privileged Exec and Global Configuration modes Description Use this command to display the SNMPv3 users. Example ATGS950_28PS# show snmp-server user...
Chapter 7: SNMP Commands SHOW SNMP VIEWTREE Syntax show snmp viewtree Parameter None. Mode Privileged Exec and Global Configuration modes Description Use this command to display the SNMP views. Example ATGS950_28PS# show snmp viewtree...
GS950 PS Series Command Line Interface User’s Guide SNMP-SERVER COMMUNITY Syntax snmp-server community community_name user user_name Parameter community_name Specifies a new community name. The name is case sensitive. user_name Specifies an existing user name. The name is case sensitive. Mode Global Configuration mode Description Use this command to add community strings to the switch.
Chapter 7: SNMP Commands SNMP-SERVER ENGINEID Syntax snmp-server engineid engine-id Parameter engine-id Specifies a new SNMPv3 engine ID. Mode Global Configuration mode Description Use this command to set the SNMPv3 engine ID. Example This example sets the SNMPv3 engine ID to 89ab532d782: ATGS950_28PS# configure terminal ATGS950_28PS(config)# snmp-server engineid 89ab532d782...
GS950 PS Series Command Line Interface User’s Guide SNMP-SERVER GROUP Syntax snmp-server group groupname v1|v2c|v3 auth|noauth|priv readviewname writeviewname [read ] [write ] [notify notifyviewname Parameters groupname Specifies a name for a new group. v1|v2c|v3 Specifies the SNMP version. The versions are listed here: v1: SNMPv1 v2c: SNMPv2c v3: SNMPv3...
Page 78
Chapter 7: SNMP Commands notifyviewname Specifies the name of an existing notify SNMPv3 view that members of the group can modify. The name is case sensitive. Mode Global Configuration Mode Description Use this command to add SNMPv3 groups. Example This example adds a group called “sta5west” with a minimum security level of privacy.
GS950 PS Series Command Line Interface User’s Guide SNMP-SERVER HOST Syntax snmp-server host ipv4_address ipv6_address version community_name/user_name v1|v2c|v3 auth|noauth|priv Parameters ipv4_address Specifies the IPv4 address of a network device to receive traps from the switch. ipv6_addr Specifies the IPv6 address of a network device to receive traps from the switch.
Page 80
Chapter 7: SNMP Commands Mode Global Configuration mode Description Use this command to specify the IP addresses of SNMP network devices to receive traps from the switch. The community and user names must already exist. For instructions, refer to “SNMP-SERVER COMMUNITY” on page 75.
GS950 PS Series Command Line Interface User’s Guide SNMP-SERVER TRAPS ENABLE Syntax snmp-server traps enable Parameters None. Mode Global Configuration mode Description Use this command to activate the transmission of SNMP traps. To disable traps, refer to “NO SNMP-SERVER TRAPS ENABLE” on page 65. Example ATGS950_28PS# configure terminal ATGS950_28PS# snmp-server traps enable...
Chapter 7: SNMP Commands SNMP-SERVER USER Syntax snmp-server user username groupname v1|v2c|v3 auth-password priv- [encrypted auth md5|sha ] [priv des password Parameters username Specifies a name for the new user account. The user name is case sensitive. groupname Specifies the SNMP group for the user. The group name is case sensitive.
Page 83
GS950 PS Series Command Line Interface User’s Guide Mode Global Configuration mode Description Use this command to add new users to groups for SNMP community strings. Example This example adds the user Smith to group Managers for v2c community strings: ATGS950_28PS# configure terminal ATGS950_28PS(config)# snmp-server user Smith Managers...
Chapter 7: SNMP Commands SNMP-SERVER VIEWTREE Syntax snmp-server viewtree viewname subtreeoid subtreeoid oidmask [oidmask ] included|excluded Parameters viewname Specifies a name for a new view. The maximum length is 32 alphanumeric characters. The string is case sensitive. Spaces are not allowed.
Page 85
GS950 PS Series Command Line Interface User’s Guide This example adds the new view “AlliedTelesis” that limits the available MIB objects to those in the OID 1.3.6.1.4.1.207: ATGS950_28PS# configure terminal ATGS950_28PS(config)# snmp-server viewtree AlliedTelesis subtreeoid 1.3.6.1 excluded ATGS950_28PS(config)# snmp-server viewtree AlliedTelesis subtreeoid 1.3.6.1.4.1.207 included...