KGS-3120 Command Line Interface. Operation Manual

Transcription

1 KGS-3120 Command Line Interface Operation Manual DOC

2 (C) 2002 KTI Networks Inc. All rights reserved. No part of this documentation may be reproduced in any form or by any means or used to make any directive work (such as translation or transformation) without permission from KTI Networks Inc. KTI Networks Inc. reserves the right to revise this documentation and to make changes in content from time to time without obligation on the part of KTI Networks Inc. to provide notification of such revision or change. For more information, contact: United States KTI Networks Inc. P.O. BOX Houston, Texas Phone: Fax: URL: International Fax: URL: -2-

3 The information contained in this document is subject to change without prior notice. Copyright (C). All Rights Reserved. TRADEMARKS Ethernet is a registered trademark of Xerox Corp. WARNING: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and if not installed and used in accordance with the instruction manual may cause harmful interference in which case the user will be required to correct the interference at his own expense. NOTICE: (1) The changes or modifications not expressively approved by the party responsible for compliance could void the user's authority to operate the equipment. (2) Shielded interface cables and AC power cord, if any, must be used in order to comply with the emission limits. CISPR A COMPLIANCE: This device complies with EMC directive of the European Community and meets or exceeds the following technical standard. EN Limits and Methods of Measurement of Radio Interference Characteristics of Information Technology Equipment. This device complies with CISPR Class A. WARNING: This is a Class A product. In a domestic environment this product may cause radio interference in which case the user may be required to take adequate measures. CE NOTICE Marking by the symbol indicates compliance of this equipment to the EMC directive of the European Community. Such marking is indicative that this equipment meets or exceeds the following technical standards: EN 55022: Limits and Methods of Measurement of Radio Interference characteristics of Information Technology Equipment. EN 50082/1:Generic Immunity Standard -Part 1: Domestic Commercial and Light Industry. EN : Disturbances in supply systems caused by household appliances and similar electrical equipment - Part 2: Harmonics. -3-

4 Table of Contents 1. INTRODUCTION Introduction Command Syntax Symbols Variable Attribute Table Line-Editing Keys Look and Feel Rules Notes BASIC SWITCH COMMANDS BASIC SWITCH COMMAND LIST create account config account show account delete account show session show switch show serial_port config serial_port enable clipaging disable clipaging enable telnet disable telnet enable web disable web save reboot reset login logout SWITCH PORT COMMANDS config ports show ports SNMPv3 COMMANDS create snmp user delete snmp user show snmp user show snmp groups create snmp view delete snmp view show snmp view create snmp community delete snmp community show snmp community config snmp engineid show snmp engineid create snmp group delete snmp group create snmp host delete snmp host show snmp host SNMPv1/v2 COMMANDS create snmp community delete snmp community create snmp trap_receiver delete snmp trap_receiver config snmp community config snmp trap_receiver show snmp NETWORK MANAGEMENT COMMANDS

5 6.1 create trusted_host delete trusted_host show trusted_host config snmp system_name config snmp system_location config snmp system_contact enable rmon disable rmon enable snmp traps disable snmp traps enable snmp authenticate traps disable snmp authenticate traps UTILITY COMMANDS download upload ping traceroute NETWORK MONITORING COMMANDS show packet ports show error ports show utilization clear counters clear log show log enable syslog disable syslog show syslog config syslog host create syslog host delete syslog host show syslog host STP COMMANDS config stp config stp ports enable stp disable stp show stp show stp ports LAYER 2 FDB COMMANDS create fdb create multicast_fdb config multicast_fdb config fdb aging_time config multicast port_filtering_mode delete fdb clear fdb show multicast_fdb show fdb show multicast port_filtering_mode BROADCAST STORM CONTROL COMMANDS config traffic control show traffic control QOS COMMANDS config bandwidth_control show bandwidth_control config scheduling_mechanism show scheduling_mechanism config 802.1p user_priority show 802.1p user_priority config 802.1p default_priority

6 12.8 show 802.1p default_priority MIRROR CONFIGURATION COMMANDS config mirror port enable mirror disable mirror show mirror VLAN COMMANDS create vlan delete vlan config vlan add ports config vlan delete ports config vlan advertisement config gvrp enable gvrp disable gvrp show vlan show gvrp BASIC IP COMMANDS (For Layer 2) config ipif System show ipif LINK AGGREGATION COMMANDS create link_aggregation group_id delete link_aggregation group_id config link_aggregation config link_aggregation algorithm show link_aggregation IGMP SNOOPING COMMANDS config igmp_snooping config igmp_snooping querier config router_ports enable igmp_snooping disable igmp_snooping show igmp_snooping show igmp_snooping group show router_ports X COMMANDS enable 802.1x disable 802.1x show 802.1x config 802.1x capability config 802.1x auth_parameter config 802.1x auth_mode config 802.1x init config 802.1x reauth config radius add config radius delete config radius show radius ACL COMMANDS create access_profile delete access_profile config access_profile show access_profile TRAFFIC SEGMENTATION COMMANDS config traffic_segmentation show traffic_segmentation ROUTING TABLE COMMANDS (For Layer 2) create iproute

7 21.2 delete iproute default show iproute COMMAND LIST HISTORY COMMANDS ? show command_history dir config command_history BASIC IP COMMANDS (For Layer 3) create ipif delete ipif config ipif enable ipif disable ipif show ipif ARP COMMANDS create arpentry delete arpentry config arpentry config arp_aging time show arpentry clear arptable ROUTING TABLE COMMANDS (For Layer 3) create iproute delete iproute show iproute ROUTE REDISTRIBUTE COMMANDS create route redistribute dst ospf create route redistribute dst rip delete route redistribute config route redistribute dst ospf config route redistribute dst rip show route redistribute RIP COMMANDS config rip enable rip disable rip show rip IGMP COMMANDS config igmp show igmp show igmp group BOOTP RELAY COMMANDS config bootp_relay config bootp_relay add config bootp_relay delete enable bootp_relay disable bootp_relay show bootp_relay DNS REALY COMMANDS config dnsr config dnsr [add delete] static enable dnsr disable dnsr enable dnsr cache disable dnsr cache enable dnsr static disable dnsr static show dnsr

8 31 DVMRP COMMANDS config dvmrp enable dvmrp disable dvmrp show dvmrp routing_table show dvmrp neighbor show dvmrp nexthop show dvmrp PIM COMMANDS config pim enable pim disable pim show pim neighbor show pim IPMC COMMANDS show ipmc cache show ipmc MD5 Configuration COMMANDS config md create md delete md show md OSPF Configuration COMMANDS show ospf enable ospf disable ospf config ospf router_id show ospf area create ospf area delete ospf area config ospf area config ospf show ospf virtual_link create ospf virtual_link delete ospf virtual_link config ospf virtual_link show ospf aggregation create ospf aggregation delete ospf aggregation config ospf aggregation show ospf host_route create ospf host_route delete ospf host_route config ospf host_route show ospf lsdb show ospf neighbor show ospf virtual neighbor TIME AND SNTP COMMANDS config sntp show sntp Enable sntp Disable sntp config time config time_zone config dst show time LACP Configuration COMMANDS config lacp_ports show lacp_ports

9 38 PORT SECURITY COMMANDS config port_security delete port_security_entry clear port_security_entry show port_security AYMMETRIC VLAN enable asymmetric_vlan disable asymmetric_vlan show asymmetric_vlan MAC Notification enable mac_notification disable mac_notification config mac_notification config mac_notification ports show mac_notification show mac_notification ports SSH COMMAND config ssh algorithm show ssh algorithm config ssh authmode show ssh authmode config ssh user show ssh user authmode config ssh server enable ssh disable ssh show ssh server TACACS COMMANDS enable authen_policy disable authen_policy show authen_policy create authen_login method_list_name config authen_login delete authen_login method_list_name show autehn_login create authen_enable method_list_name config authen_enable delete authen_enable method_list_name show authen_enable config authen application show authen application create autehn server_group config authen server_group delete authen_server_group show autehn server_group create authen server_host config authen server_host delete authen server_host show authen server_host config authen parameter response_timeout config authen parameter attempt show authen parameter enable admin config admin local_enable VRRP COMMAND create vrrp ipif config vrrp ipif show vrrp delete vrrp enable(disable) vrrp

10 44 SSL COMMAND download certificate enable/disabled ssl enable/disabled certificate request show ssl show certificate System Message Text Variable Attribute Table

11 1. INTRODUCTION 1.1 Introduction The purpose of this document is to describe the CLI command sets of KGS-3120 switch product. Every command will be introduced in terms of purpose, format, description, parameters, and examples. 1.2 Command Syntax Symbols angle brackets <> square brackets [ ] vertical bar braces { } ipif <ipif_name 12> metric <value 1-31> Enclose a variable or value. You must specify the variable or value. For example, in the syntax create ipif <ipif_name> vlan <vlan_name> ipaddress <network_address> you must supply an IP interface name for <ipif_name>, a vlan name for <vlan_name>and an address for <network_address> when entering the command. Do not type the angle brackets. Enclose a required value or list of required arguments. One or more values or arguments must be specified. For example, in the syntax create account [admin user] you must specify either the admin-level or user-level account when entering the command. Do not type the square brackets. Separates mutually exclusive items in a list, one of which must be entered. For example, in the syntax show snmp [community trapreceiver detail] you must specify either the community or trapreceiver or detail in the command. Do not type the vertical bar. Enclose an optional value or a list of optional arguments. One or more values or arguments can be specified. For example, in the syntax config igmp [ <ipif_name> all ] { version <value> query_interval <sec> max_response_time <sec> robustness_variable<value> last_member_query_interval<value> state [enable disable] } Do not type the braces. 12 means the maximum length of IP interface name means the legal range of metric value. -11-

12 1.3 Variable Attribute Table Variable Name Maximum Length Type <portlist> - 15:n (Port #n), 15:n-m (Port range Port #n to Port#m) 15: * (all ports) <username> 15 String <password> 15 String <ipaddr> 15 IP-Address <netmask> 15 IP-Address <gateway> 15 IP-Address <vlan_name> 32 String <sw_name> 128 String <sw_location> 128 String <sw_contact> 128 String Password 15 String <community_string> 32 String <server_ip> 15 IP-Address <path_filename> 64 String <macaddr> 17 MAC-Address <ipif> 12 String 1.4 Line-Editing Keys Keys Delete Backspace Insert Delete character under cursor and shifts remainder of line to left. Delete character to left of cursor and shifts remainder of line to left. Toggle on and off. When toggled on, inserts text and shifts previous text to right. Left Arrow Right Arrow Tab p n or Space CTRL+C ESC q r a Enter Move cursor to left. Move cursor to right Help user to select an appropriate token. Display the previous page. Display the next page. Escape from displaying pages. Escape from displaying pages. Escape from displaying pages. Refresh the displaying pages Display the remaining pages. (The screen display will not pause again.) Display the next line. The screen display is pausing when show command output reaches the end of the page. -12-

13 1.5 Look and Feel Rules The following list the rules for all CLI commands to follow. 1. Show port number only in port field while stacking disabled. If stacking enabled, port field would be shown in unit:port format. 2. Port field has 6 characters, the format is uu:ppi. uu indicates device unit ID. pp indicates port ID of device. i indicates port status, x means not exist, M means master port of trunk group, T means trunk group member port. 3. Each field separated with 2 spaces. 4. Each field is left alignment, except time field. 5. Time field format, [003/12/12 11:11:11] or [00000 days 11:11:11] 6. Using [enable] or [disable] for config command and [Enabled] or [Disabled] for show command. 7. Counter is represented with 10 digits. 8. Separate result and previous or new prompt with a new line. 9. Use the longest field name and add a space as alignment position of [:] character. 10.No indent for result, question and messages, like Success and Fail. 11. Only three dots for some command during execution, like [Processing %]. The CLI script file reproduced by system also follow the above rules. 1.6 Notes 1. KGS-3120 as command prompt in the whole document. 2. KGS-3120 has unit ID 15 and [F] would be showed in the 7-segment display. 3. All commands are case-sensitive. 4. If the port is not exist in the unit, it would be marked with [x] in port ID field. 5. Each [config] command would return [Success] or [Fail] after execution. -13-

14 2 BASIC SWITCH COMMANDS 2.1 BASIC SWITCH COMMAND LIST create account [admin user] <username 15> config account <username> show account delete account <username> show session show switch show serial_port config serial_port { baud_rate [ ] auto_logout[ never 2_minutes 5_minutes 10_minutes 15_minutes] } enable clipaging disable clipaging enable telnet {<tcp_port_number >} disable telnet enable web {<tcp_port_number >} disable web save reboot reset { [config system] } login logout -14-

15 2.2 create account Used to create user accounts create account [admin user] <username 15> The create account command creates user accounts. The username is between 1 and 15 characters, the password is between 0 and 15 characters. The number of account (include admin and user) is up to 8. admin <username 15> user <username 15> Name of the admin account. Name of the user account. Examples To create the admin-level user [Admin]: create account admin Admin Command: create account admin Admin Enter a case-sensitive new password:***** Enter the new password again for confirmation:***** To create the user-level user [user1]: create account user user1 Command: create account user user1 Enter a case-sensitive new password:***** Enter the new password again for confirmation:***** -15-

16 2.3 config account Used to configure user accounts. config account <username> The config account command configures user accounts. Passwords must have a minimum of 0 character and can have a maximum of 15 characters. User names and passwords are case-sensitive. <username> Name of the account. The account must already be defined. Examples To configure the user password of [Admin] account : config account admin Command: config account admin The username does not exist. Enter the name of an existing user config account Admin Command: config account Admin Enter a old password:***** Enter a case-sensitive new password:***** Enter the new password again for confirmation:***** -16-

17 2.4 show account Used to display user accounts. show account The show account command displays user accounts that have been created. Parameter None. None. Example To display the accounts that have been created: show account Command: show account Current Accounts: Username Access Level Admin Admin user1 User Total Entries : 2-17-

18 2.5 delete account Used to delete an existing account. delete account <username> The delete account command deletes an existing account. Parameter <username> Name of the user who will be deleted. One active admin user must exist. Example To delete the user account [user1]: delete account user1 Command: delete account user1-18-

19 2.6 show session Used to display a list of currently logged-in users. show session The show session command displays a list of currently logged-in users. Parameter None. Example To display a list of currently logged-in users: show session Command: show session ID Login Time Live Time From Level Name days 01:07:08 11:22: user1 * days 01:07:17 22:33: Serial Port 4 Admin -19-

20 2.7 show switch Used to display the switch information. show switch The show switch command displays the switch information. Example To display the switch information: show switch Command: show switch Device Type : KGS-3120 Gigabit-Ethernet Switch Module 1 Type : KGM-340T 4-port 1000BASE-T module Module 2 Type : KGM-340F 4-port Gigabit SFP module Unit ID : 1 MAC Address : C IP Address : (Manual) VLAN Name : default Subnet Mask : Default Gateway : Boot PROM Version : Build Firmware Version : Build 1.00-B21 Hardware Version : 0A1 Device S/N : System Name : KGS-3120 L3 Switch System Location : HQ 5F System Contact : MIS Department II Spanning Tree : Disabled GVRP : Disabled IGMP Snooping : Disabled TELNET : Enabled (TCP 23) WEB : Enabled (TCP 80) RMON : Disabled RIP : Disabled DVMRP : Disabled PIM-DM : Disabled OSPF : Disabled -20-

21 2.8 show serial_port Used to display the current serial port setting. show serial_port The show serial_port command displays the current serial port setting. Parameter None. None. Example To display the serial port setting: show serial_port Command: show serial_port Baud Rate : 9600 Data Bits : 8 Parity Bits : None Stop Bits : 1 Auto-Logout : 10 mins -21-

22 2.9 config serial_port Used to configure the serial bit rate that will be used to communicate with the management host and the auto logout time for idle connections. auto_logout [never 2_minutes 5_min- config serial_port { baud_rate[ ] utes 10_minutes 15_minutes ] } The config serial_port command configures the serial bit rate that will be used to communicate with the management host and the auto logout time for idle connections. Parameter baud_rate The serial bit rate that will be used to communicate with the management host. There are four options as 9600, 19200,38400, auto_logout The auto logout time out setting : never Never timeout. 2_minutes When you idle over 2 minutes, the device will auto logout. 5_minutes When you idle over 5 minutes, the device will auto logout. 10_minutes When you idle over 10 minutes, the device will auto logout. 15_minutes When you idle over 15 minutes, the device will auto logout. Example To configure baud rate: config serial_port baud_rate 9600 Command: config serial_port baud_rate

23 2.10 enable clipaging Used to pause the scrolling of the console screen when the show command displays more than one page. enable clipaging The enable clipaging command enables pausing of the screen display when show command output reaches the end of the page. The default setting is enabled. Parameter None. Example To enable pausing of the screen display when show command output reaches the end of the page: enable clipaging Command: enable clipaging -23-

24 2.11 disable clipaging Used to disable pause the scrolling of the console screen when the show command displays more than one page. disable clipaging The disable clipaging command disables pausing of the screen display when show command output reaches the end of the page. The default setting is enabled. Parameter None. Example To disable pausing of the screen display when show command output reaches the end of the page: disable clipaging Command: disable clipaging -24-

25 2.12 enable telnet The switch allows you manage the switch via TELNET based management software. Use the command to enable TELNET and configure port number. enable telnet {<tcp_port_number >} The enable telnet command enables TELNET and configures port number. Parameter tcp_port_number The TCP port number. TCP ports are numbered between 1 and The well-known TCP port for the TELNET protocol is 23. Example To enable TELNET and configure port number: enable telnet 23 Command: enable telnet disable telnet Use the command to disable TELNET. disable telnet The disable telnet command disables TELNET. Example disable telnet Command: disable telnet -25-

26 2.14 enable web The switch allows you manage the switch via HTTP based management software. Use the command to enable HTTP and configure port number. enable web {<tcp_port_number >} The enable web command enables HTTP and configures port number. Parameter tcp_port_number The TCP port number. TCP ports are numbered between 1 and The well-known TCP port for the WEB protocol is 80. Example To enable HTTP and configure port number: enable web 80 Command: enable web disable web Use the command to disable HTTP. disable web The disable web command disables HTTP. Example To disable HTTP : disable web Command: disable web -26-

27 2.16 save Used to save changes in nonvolatile RAM. save The save command saves changes in nonvolatile RAM. Parameter None. Example save Command: save Saving all configurations to NV-RAM... Done reboot Used to restart the switch. reboot The reboot command restarts the switch. Parameter None. None. Example reboot Command: reboot Are you sure to proceed with the system reboot?(y/n) Please wait, the switch is rebooting

28 2.18 reset Used to reset all switch parameters. reset {[config system]} The reset command resets all switch parameters to the factory defaults. Parameter config system All parameters are reset to default settings except stacking setting. But device will not do save neither reboot. All parameters are reset to default settings. Then the switch will do factory reset, save and reboot If no any keyword specified, all parameters will be reset to default settings except IP address, user account, stacking setting and history log. But device will not do save neither reboot. Example reset Command: reset Are you sure to proceed with system reset except IP address?(y/n) reset config Command: reset config Are you sure to proceed with system reset?(y/n) reset system Command: reset system Are you sure to proceed with system reset, save and reboot?(y/n) Loading factory default configuration... Done. Saving all configuration to NV-RAM... Done. Please wait, the switch is rebooting

29 2.19 login Used to log in to the switch. login The login command log in to the switch. Parameter None. None. Example login Command: login UserName: 2.20 logout Used to log out of the switch. logout When you are finished using the facility, use the logout command to logout. None. Example logout Command: logout ********** * Logout * ********** -29-

30 3 SWITCH PORT COMMANDS config ports [ <portlist> all ] { speed [auto 10_half 10_full 100_half 100_full 1000_full ] flow_control [enable disable] learning [enable disable ] state [enable disable] description <desc 32> } 3.1 show ports {<portlist>} {description} 3.1 config ports Used to configure the switch port settings config ports [ <portlist> all ] { speed [auto 10_half 10_full 100_half 100_full 1000_full ] flow_control [enable disable] learning [enable disable ] state [enable disable] description <desc 32> } The config ports command changes switch port settings. Parameter portlist Specified a range of ports to be configured. (UnitID:port number). all For set all ports in the system, you may use all parameter. speed You can set port speed for the specified ports. auto Set port speed to auto negotiation. 10_half Set port speed to 10_half. 10_full Set port speed to 10_full. 100_half Set port speed to 100_half. 100_full Set port speed to 100_full. 1000_full Set port speed to 1000_full, this parameter is for fiber media only. flow_control You can turn on or turn off flow control on one or more ports. By set flow_control to enable or disable. learning You can turn on or turn off MAC address learning on one or more ports. state Enables or disables the specified port description Describe the port interface. Example To configure the speed of the port 1-3 of unit 1 to be 10 Mbps, duplex is full, learning on and state enabled: -30-

31 config ports 1-3 speed 1000_full flow_control enable learning enable state enable Command: config ports 1-3 speed 1000_full flow_control enable learning enable st ate enable 3.2 show ports Used to display the current configurations of a range of ports. show ports {<portlist>} {description} The show ports command displays the current configurations of a range of ports. No parameter will show all ports. Parameter portlist description Specified a range of ports to be displayed.(unitid:port number). Indicate if port description will be included in the display None. Example To display the configuration of the ports 1-8. show ports 1-8 Command: show ports 1-8 Port Port Settings Connection Address State Speed/Duplex/FlowCtrl Speed/Duplex/FlowCtrl Learning 1 Enabled Auto/Enabled 1000M/Full/802.3x Enabled 2 Enabled Auto/Disabled 1000M/Full/None Enabled 3 Enabled 100M/Full/Enabled 100M/Full/802.3x Enabled 4 Enabled 100M/Half/Enabled 100M/Half/BackP Enabled 5 Enabled 10M/Full/Disabled 10M/Full/None Enabled 6 Enabled 10M/Half/Disabled 10M/Half/None Enabled 7 Enabled Auto/Disabled 1000M/Full/None Disabled 8 Disabled Auto/Disabled Link Down Disabled -31-

32 4 SNMPv3 COMMANDS create snmp user <username 32> <groupname 32> {encrypted(1) [by_password(1) auth [md5(2) <auth_password 8-16 > sha(3) <auth_password 8-20 >] priv [none(1) des(2) <priv_password 8-16> ] by_key(2) auth [md5(2) <auth_key 32-32> sha(3) <auth_key 40-40>] priv [none(1) des(2) <priv_key 32-32> ]]} delete snmp user <username 32> show snmp user show snmp groups create snmp view <view_name 32> <oid> view_type [included excluded] delete snmp view <view_name 32> [all <oid>] show snmp view {<view_name 32>} create snmp community <community_string 32> view <view_name 32> [read_only read_write] delete snmp community <community_string 32> show snmp community { <community_string 32> } config snmp engineid <snmp_engineid> show snmp engineid create snmp group <groupname 32> [v1 v2c v3 [noauth_nopriv auth_nopriv auth_priv]] {read_view <view_name 32> write_view <view_name 32> notify_view <view_name 32>} delete snmp group <groupname 32> create snmp host <ipaddr> [v1 v2c v3 [noauth_nopriv auth_nopriv auth_priv] ] <auth_string 32> delete snmp host <ipaddr> show snmp host { <ipaddr> } Note: If SNMPv3 commands is used, the next chapter SNMPv1/v2 commands is not necessary. -32-

33 4.1 create snmp user Used to create a new user to an SNMP group originated by this command. create snmp user <username 32> <groupname 32> {encrypted(1) [by_password(1) auth [md5(2) <auth_password 8-16 > sha(3) <auth_password 8-20 >] priv [none(1) des(2) <priv_password 8-16> ] by_key(2) auth [md5(2) <auth_key 32-32> sha(3) <auth_key 40-40>] priv [none(1) des(2) <priv_key 32-32> ]]} The create snmp user command creates a new user to an SNMP group originated by this command. User can chose input authentication and privacy by password or by key. Parameter username The name of the user on the host that connects to the agent. The range is 1 to 32. groupname The name of the group to which the user is associated. The range is 1 to 32. encrypted Specifies whether the password appears in encrypted format. by_password Indicate input password for authentication and privacy by_key Indicate input key for authentication and privacy auth Initiates an authentication level setting session. The options are md5 and sha. md5 The HMAC-MD5-96 authentication level. sha The HMAC-SHA-96 authentication level. auth_password A authentication string used by MD5 or SHA1. priv_password A privacy string used by DES. auth_key A authentication key used by MD5 or SHA1, it is hex string type. priv_key A privacy key used by DES, it is hex string type. Example create snmp user kti Kn_group encrypted by_password auth md priv des Command: create snmp user kti Kn_group encrypted by_password auth md priv des

34 4.2 delete snmp user Used to remove a user from an SNMP group and delete the associated group in SNMP group. delete snmp user <username> The delete snmp user command removes a user from a SNMP group and deletes the associated group in SNMP group.. Parameter username The name of the user on the host that connects to the agent. Example delete snmp user kti Command: delete snmp user kti 4.3 show snmp user Used to display information on each SNMP username in the group username table. show snmp user The show snmp user command displays information on each SNMP username in the group username table. Example show snmp user Command: show snmp user Username Group Name SNMP Version Auth-Protocol PrivProtocol initial initial V3 None None Total Entries : 1-34-

35 4.4 show snmp groups Used to display the names of groups on the switch and the security model, level, the status of the different views. show snmp groups The show snmp groups command displays the names of groups on the switch and the security model, level, the status of the different views. Parameter None. None. Example show snmp group Command: show snmp groups Vacm Access Table Settings Group Name : public ReadView Name : CommunityView WriteView Name : Notify View Name : CommunityView Security Model : SNMPv1 Security Level : NoAuthNoPriv Group Name : public ReadView Name : CommunityView WriteView Name : Notify View Name : CommunityView Security Model : SNMPv2 Security Level : NoAuthNoPriv Group Name : initial ReadView Name : restricted WriteView Name : Notify View Name : restricted Securiy Model : SNMPv3 Securiy Level : NoAuthNoPriv Group Name : private ReadView Name : CommunityView -35-

36 WriteView Name : CommunityView Notify View Name : CommunityView Securiy Model : SNMPv1 Securiy Level : NoAuthNoPriv Group Name : private ReadView Name : CommunityView WriteView Name : CommunityView Notify View Name : CommunityView Security Model : SNMPv2 Security Level : NoAuthNoPriv Group Name : ReadGroup ReadView Name : CommunityView WriteView Name : Notify View Name : CommunityView Security Model : SNMPv1 Securiy Level : NoAuthNoPriv Group Name : ReadGroup ReadView Name : CommunityView WriteView Name : Notify View Name : CommunityView Security Model : SNMPv1 Security Level : NoAuthNoPriv Group Name : ReadGroup ReadView Name : CommunityView WriteView Name : Notify View Name : CommunityView Security Model : SNMPv2 Security Level : NoAuthNoPriv Group Name : WriteGroup ReadView Name : CommunityView WriteView Name : CommunityView Notify View Name : CommunityView Securiy Model : SNMPv1 Securiy Level : NoAuthNoPriv Group Name : WriteGroup ReadView Name : CommunityView WriteView Name : CommunityView Notify View Name : CommunityView Security Model : SNMPv1 Security Level : NoAuthNoPriv -36-

37 Group Name : WriteGroup ReadView Name : CommunityView WriteView Name : CommunityView Notify View Name : CommunityView Securiy Model : SNMPv2 Securiy Level : NoAuthNoPriv Group Name : Kn_group ReadView Name : CommunityView WriteView Name : CommunityView Notify View Name : CommunityView Security Model : SNMPv3 Security Level : authpriv Total Entries : create snmp view Used to assign views to community strings to limit which MIB objects an SNMP manager can access. create snmp view <view_name 32> <oid> view_type [included excluded] The create snmp view assigns views to community strings to limit which MIB objects an SNMP manager can access. Parameter view_name View name to be created. oid Object-Identified tree, MIB tree. view_type Specify the access type of the MIB tree in this view. included Includes for this view. excluded Excluded for this view. Example create snmp view ktiview view_type included Command: create snmp view ktiview view_type included -37-

38 4.6 delete snmp view Used to remove a view record. delete snmp view <view_name 32> [all <oid>] The delete snmp view command removes a view record. Parameter view_name all oid View the name of the user who will be deleted. All view record. Object-Identified tree, MIB tree. Example delete snmp view ktiview all Command: delete snmp view ktiview all -38-

39 4.7 show snmp view Used to display the SNMP view record. show snmp view {<view_name>} The show snmp view command displays the SNMP view record. Parameter view_name View name of the user who likes to show. None. Example show snmp view Command: show snmp view Vacm View Table Settings View Name Subtree View Type restricted Included restricted Included restricted Included restricted Included restricted Included CommunityView 1 Included CommunityView Excluded CommunityView Included Total Entries : 8-39-

40 4.8 create snmp community Use an SNMP community string to define the relationship between the SNMP manager and the agent. The community string acts like a password to permit access to the agent on the switch. You can specify one or more of the following characteristics associated with the string: 1. An access list of IP addresses of the SNMP managers that are permitted to use the community string to gain access to the agent. 2. A MIB view, which defines the subset of all MIB objects accessible to the given community. 3. Read and write or read-only permission for the MIB objects accessible to the community. create snmp community <community_string 32> view <view_name 32> [read_only read_write] The create snmp community command creates an SNMP community string. Parameter community_string Community string. Max string length is 32. view_name View name. A MIB view. Max length is 32 [read_only read_write] Read and write or read-only permission. Example create snmp community kti view CommunityView read_write Command: create snmp community kti view CommunityView read_write -40-

41 4.9 delete snmp community Used to remove a specific community string delete snmp community <community_string 32> The delete snmp community command removes a specific community string. Parameter community_string Community string will be deleted. Example delete snmp community kti Command: delete snmp community kti -41-

42 4.10 show snmp community Used to display the community string configurations show snmp community { <community_string> } The show snmp community command displays the community string configurations.. Parameter community_string Community string If not specify community string, all community string information will be displayed. Example DGS-3212SR:4#show snmp community Command: show snmp community SNMP Community Table Community Name View Name Access Right private CommunityView read_write public CommunityView read_only Total Entries : 2 DGS-3212SR:4# -42-

43 4.11 config snmp engineid Used to configure a identifier for the SNMP engine on the switch. config snmp engineid <snmp_engineid> The config snmp engineid command configures a identifier for the SNMP engine on the switch. Associated with each SNMP entity is a unique engineid. Parameter snmp_engineid Identify for the SNMP engine on the switch. It is octet string type. Example config snmp engineid Command: config snmp engineid

44 4.12 show snmp engineid Used to display the identification of the SNMP engine on the switch. show snmp engineid The show snmp engineid command displays the identification of the SNMP engine on the switch. The default value is suggested in RFC2271. The very first bit is 1, and the first four octets are set to the binary equivalent of the agent SNMP management private enterprise number as assigned by IANA, D_Link is 171. The fifth octet is 03 to indicates the rest is the MAC address of this device. The 6 th 11 th octets is MAC address. Parameter None. None. Example show snmp engineid Command: show snmp engineid SNMP Engine ID :

45 4.13 create snmp group Used to create a new SNMP group, or a table that maps SNMP users to SNMP views create snmp group <groupname> [v1 v2c v3 [noauth_nopriv auth_nopriv auth_priv]]{read_view <view_name> notify_view <view_name> notify_view <view_name>} The create snmp group command creates a new SNMP group. Parameter groupname v1 v2c v3 view_name The name of the group. the least secure of the possible security models. the second least secure of the possible security models. the most secure of the possible. Specifies authentication of a packet noauth_nopriv neither support packet authentication nor encrypting. auth_nopriv Support packet authentication. auth_priv Support packet authentication and encrypting. View name. A MIB view. Example create snmp group Kn_group v3 auth_priv read_view CommunityView write_view CommunityView notify_view CommunityView Command: create snmp group Kn_group v3 auth_priv read_view CommunityView wri te_view CommunityView notify_view CommunityView -45-

46 4.14 delete snmp group Used to remove a SNMP group. delete snmp group <groupname> The delete snmp group command removes a SNMP group. Parameter groupname The name of the group will be deleted. Example delete snmp group D_Link_group Command: delete snmp group D_Link_group -46-

47 4.15 create snmp host Used to create a recipient of an SNMP trap operation. create snmp host <ipaddr> [v1 v2c v3 [noauth_nopriv auth_nopriv auth_priv] ] <auth_string 32> The create snmp host command creates a recipient of an SNMP operation. Parameter ipaddr v1 v2c v3 auth_string The IP address of the recipient for which the traps are targeted. The least secure of the possible security models. The second least secure of the possible security models. The most secure of the possible. noauth_nopriv Neither support packet authentication nor encrypting. auth_nopriv Support packet authentication. auth_priv Support packet authentication and encrypting. authentication string Example create snmp host v3 noauth_nopriv initial Command: create snmp host v3 noauth_nopriv initial -47-

48 4.16 delete snmp host Used to delete a recipient of an SNMP trap operation. delete snmp host <ipaddr> The delete snmp host command deletes a recipient of an SNMP trap operation. Parameter ipaddr The IP address of the recipient for which the traps are targeted. Example delete snmp host Command: delete snmp host

49 4.17 show snmp host Used to display the recipient for which the traps are targeted. show snmp host { <ipaddr> } The show snmp host command displays the recipient for which the traps are targeted. Parameter ipaddr The IP address of the recipient for which the traps are targeted. If no parameter specified, all snmp hosts will be displayed. None. Example KGS-3120:4 show snmp host Command: show snmp host SNMP Host Table Host IP Address SNMP Version Community Name / SNMPv3 User Name V3 noauthnopriv initial V2c public Total Entries : 2-49-

50 5 SNMPv1/v2 COMMANDS create snmp community <community_string> [readonly readwrite] delete snmp community <community_string> create snmp trap_receiver <ipaddr> <community_string> delete snmp trap_receiver <ipaddr> config snmp community <community_string> [readonly readwrite] config snmp trap_receiver <ipaddr> <community_string> enable snmp traps disable snmp traps enable snmp authenticate traps disable snmp authenticate traps show snmp {community trap_receiver } P.S: If chapter 4 SNMPv3 commands is used, the SNMPv1/v2 commands is not necessary. -50-

51 5.1 create snmp community Used to create an SNMP community string. create snmp community <community_string> [readonly readwrite] The create snmp community command is used to create an SNMP community string and to specify the string as enabling read only or read-write privileges for the SNMP management host. Parameter community_string readonly readwrtie An alphanumeric string of up to 32 characters used to authentication of users wanting access to the switch SNMP agent. Allows the user using the above community string to have read only access to the switch SNMP agent. The default read only community string is public. Allows the user using the above community string to have read and write access to the switch SNMP agent. The default community string is private. A maximum of 4 community strings can be specified. Example To create a read-only level SNMP community [System] : create snmp community System readwrite Command: create snmp community System readwrite -51-

52 5.2 delete snmp community Used to delete an SNMP community string previously entered on the switch. delete snmp community <community_string> The delete snmp community command is used to delete an SNMP community string entered on the switch using the create snmp community command above. Parameter community_string An alphanumeric string of up to 32 characters used to authentication of users wanting access to the switch SNMP agent. Example To delete a read-only level SNMP community [System]: delete snmp community System Command: delete snmp community System -52-

53 5.3 create snmp trap_receiver Used to specify a management station, by IP address and community string, that will receive traps generated by the switch SNMP agent. create snmp trap_receiver <ipaddr> <community_string> The create snmp trap_receiver command is used to specify the IP address of a management station that will receive traps generated by the switch SNMP agent and the community string that will be used to authenticate the management station privileges. Parameter ipaddr The IP address of a management station that will receive SNMP traps generated by the switch SNMP agent. community_string An alphanumeric string of up to 32 characters that will be used to authenticate management stations that want to receive SNMP traps from the switch SNMP agent. A maximum of 3 trap receivers can be specified. Example To create a trap receiver in read-only level SNMP community: create snmp trap_receiver System Command: create snmp trap_receiver System -53-

54 5.4 delete snmp trap_receiver Used to delete a trap receiver entry on the switch made using create snmp trap_reciever above. delete snmp trap_receiver <ipaddr> The delete snmp trapreceiver command allows the user to delete an SNMP trap receiver specified previously using the create trap_receiver command above. Parameter ipaddr The IP address of the management station that is currently specified to receive traps from the switch SNMP agent. This management station will be deleted from the list of up to three that can be entered using the create snmp trap_receiver command above. Example To delete a trap receiver : delete snmp trap_receiver Command: delete snmp trap_receiver

55 5.5 config snmp community Used to configure an SNMP community string. config snmp community <community_string> [readonly readwrite] The config snmp community command configures an SNMP read or read/write community string. Parameter community_string readonly readwrtie A string of up to 32 characters used for authentication of users wanting access to the switch SNMP agent. The type of the SNMP community. The default community string is public. The type of the SNMP community. The default community string is private. Example To configure a SNMP community [System]: : config snmp community System readwrite Command: config snmp community System readwrite -55-

56 5.6 config snmp trap_receiver Used to configure a specified trap receiver. config snmp trap_receiver <ipaddr> <community_string> The config snmp trapreceiver command configures a specified trap receiver. A maximum of 3 trap receivers is allowed. Parameter ipaddr The IP address of the station to receive SNMP traps. community_string SNMP community strings. Example To configure a trap receiver in read-only level SNMP community: config snmp trap_receiver Develop Command: config snmp trap_receiver Develop -56-

57 5.7 show snmp Used to display the SNMP configurations on the switch. show snmp [community trap_receiver ] The show snmp command displays the following information: SNMP community strings, SNMP Trap Recipients, Switch name, location and contact information. Parameter community trap_receiver SNMP community strings. SNMP Trap Recipients None. Example To display snmp configurations: show snmp Command: show snmp System Name : DES3326 System Location : Taiwan System Contact : Kn SNMP Trap : Enabled Authenticate Traps : Enabled Community String System public Develop private Rights Read/Write Read-Only Read-Only Read/Write Total Entries : 4 IP Address Community String Develop Total Entries : 1-57-

58 6 NETWORK MANAGEMENT COMMANDS create trusted_host <ipaddr> delete trusted_host <ipaddr> show trusted_host {<ipaddr>} config snmp system_name {<sw_name>} config snmp system_location {<sw_location>} config snmp system_contact {<sw_contact>} enable rmon disable rmon enable snmp traps disable snmp traps enable snmp authenticates traps disable snmp authenticates traps 6.1 create trusted_host Used to create the trusted host. create trusted_host <ipaddr> The create trusted host command creates the trusted host. The switch allows you to specify up to three IP addresses that are allowed to manage the switch via in-band SNMP or TELNET based management software. These IP addresses must be members of the Management VLAN. If no IP addresses are specified, then there is nothing to prevent any IP address from accessing the switch, provided the user knows the Username and Password. Parameter ipaddr The IP address of the trusted host. Example create trusted_host Command: create trusted_host