Hirschmann RS20 series User manual

Technical Support
[email protected]
CLI L2B
Release 4.0 11/07
Reference Manual
Command Line Interface
Industrial ETHERNET Gigabit Switch
RS20

The naming of copyrighted trademarks in this manual, even when not specially indicated, should
not be taken to mean that these names may be considered as free in the sense of the trademark
and tradename protection law and hence that they may be freely used by anyone.
© 2007 Hirschmann Automation and Control GmbH
Manuals and software are protected by copyright. All rights reserved. The copying, reproduction,
translation, conversion into any electronic medium or machine scannable form is not permitted,
either in whole or in part. An exception is the preparation of a backup copy of the software for
your own use. For devices with embedded software, the end-user license agreement on the
enclosed CD applies
The performance features described here are binding only if they have been expressly
guaranteed in the contract. This publication has been created by Hirschmann Automation and
Control GmbH according to the best of our knowledge. Hirschmann reserves the right to change
the contents of this manual without prior notice. Hirschmann can give no guarantee in respect
of the correctness or accuracy of the details in this publication.
Hirschmann can accept no responsibility for damages, resulting from the use of the network
components or the associated operating software. In addition, we refer to the conditions of use
specified in the license contract.
Printed in Germany 11/23/07
Hirschmann Automation and Control GmbH
Stuttgarter Straße 45-51
72654 Neckartenzlingen
Tel. [phone]-1107

Content
CLI L2B
Release 4.0 11/07 3
Content
Content 3
1 Command Structure 11
1.1 Format 12
1.1.1 Command 13
1.1.2 Parameters 13
1.1.3 Values 14
1.1.4 Conventions 15
1.1.5 Annotations 16
1.1.6 Special keys 17
1.1.7 Special characters in scripts 18
1.1.8 Secrets in scripts 20
2 Quick Start up 21
2.1 Quick Starting the Switch 22
2.2 System Info and System Setup 23
3 Mode-based CLI 27
3.1 Mode-based Topology 29
3.2 Mode-based Command Hierarchy 30
3.3 Flow of Operation 32
3.4 “No” Form of a Command 34
3.4.1 Support for “No” Form 34
3.4.2 Behavior of Command Help ("?") 34
4 CLI Commands: Base 35
4.1 System Information and Statistics Commands 36
4.1.1 show arp switch 36
4.1.2 show bridge aging-time 36
4.1.3 show device-status 37
4.1.4 show authentication 38
4.1.5 show classofservice 38
4.1.6 show eventlog 39

Content
4CLI L2B
Release 4.0 11/07
4.1.7 show interface 40
4.1.8 show interface ethernet 42
4.1.9 show interface switchport 49
4.1.10 show logging 49
4.1.11 show mac-addr-table 50
4.1.12 show signal-contact 51
4.1.13 show running-config 52
4.1.14 show sysinfo 53
4.1.15 show temperature 55
4.1.16 snmp-server 55
4.2 Class of Service (CoS) Commands 56
4.2.1 classofservice dot1p-mapping 57
4.2.2 classofservice ip-dscp-mapping 58
4.2.3 classofservice trust 59
4.2.4 show classofservice dot1p-mapping 60
4.2.5 show classofservice ip-dscp-mapping 61
4.2.6 show classofservice trust 62
4.3 Management Commands 63
4.3.1 transport input telnet 63
4.3.2 bridge aging-time 64
4.3.3 network javascriptmode 64
4.3.4 network parms 65
4.3.5 network protocol 65
4.3.6 network priority 67
4.3.7 serial timeout 68
4.3.8 set prompt 69
4.3.9 show network 70
4.3.10 show serial 71
4.3.11 show snmp-access 72
4.3.12 show snmpcommunity 73
4.3.13 show snmptrap 74
4.3.14 show trapflags 75
4.3.15 snmp-access global 76
4.3.16 snmp-access version 77
4.3.17 snmp-server community 78
4.3.18 snmp-server community ipaddr 79
4.3.19 snmp-server community ipmask 80
4.3.20 snmp-server community mode 81
4.3.21 snmp-server community ro 82
4.3.22 snmp-server community rw 82

Content
CLI L2B
Release 4.0 11/07 5
4.3.23 snmp-server contact 82
4.3.24 snmp-server location 83
4.3.25 snmp-server sysname 83
4.3.26 snmp-server enable traps 84
4.3.27 snmp-server enable traps chassis 85
4.3.28 snmp-server enable traps l2redundancy 86
4.3.29 snmp-server enable traps linkmode 87
4.3.30 snmp-server enable traps multiusers 88
4.3.31 snmp-server enable traps stpmode 89
4.3.32 snmptrap 90
4.3.33 snmptrap ipaddr 91
4.3.34 snmptrap mode 91
4.4 Syslog Commands 92
4.4.1 logging buffered 92
4.4.2 logging buffered wrap 93
4.4.3 logging cli-command 94
4.4.4 logging console 95
4.4.5 logging host 96
4.4.6 logging host reconfigure 96
4.4.7 logging host remove 97
4.5 Device Configuration Commands 99
4.5.1 auto-negotiate 99
4.5.2 auto-negotiate all 100
4.5.3 media-module remove 100
4.5.4 monitor session 101
4.5.5 monitor session mode 102
4.5.6 monitor session <session-id> source/destination 103
4.5.7 set igmp 104
4.5.8 set igmp 105
4.5.9 set igmp automatic-mode 105
4.5.10 set igmp forward-all 106
4.5.11 set igmp forward-unknown 107
4.5.12 set igmp static-query-port 108
4.5.13 set igmp groupmembershipinterval 109
4.5.14 set igmp interfacemode 110
4.5.15 set igmp maxresponse 111
4.5.16 show igmpsnooping 112
4.5.17 show mac-filter-table igmpsnooping 113
4.5.18 show mac-filter-table stats 114
4.5.19 show monitor 115

Content
6CLI L2B
Release 4.0 11/07
4.5.20 show port 116
4.5.21 shutdown 118
4.5.22 shutdown all 119
4.5.23 snmp trap link-status 120
4.5.24 snmp trap link-status all 121
4.5.25 speed 122
4.6 User Account Management Commands 123
4.6.1 disconnect 123
4.6.2 show loginsession 124
4.6.3 show users 125
4.6.4 users defaultlogin 126
4.6.5 users login 127
4.6.6 users name 128
4.6.7 users passwd 129
4.6.8 users snmpv3 accessmode 130
4.6.9 users snmpv3 authentication 131
4.6.10 users snmpv3 encryption 132
4.7 System Utilities 133
4.7.1 clear eventlog 133
4.7.2 traceroute 133
4.7.3 clear arp-table-switch 134
4.7.4 clear config 135
4.7.5 clear counters 135
4.7.6 clear hiper-ring 135
4.7.7 clear igmpsnooping 136
4.7.8 clear mac-addr-table 136
4.7.9 clear pass 137
4.7.10 clear signal-contact 137
4.7.11 copy 138
4.7.12 device-status 139
4.7.13 device-status 139
4.7.14 logout 140
4.7.15 ping 141
4.7.16 signal-contact 141
4.7.17 signal-contact 141
4.7.18 temperature 143
4.7.19 reboot 143
4.7.20 reload 144
4.8 LLDP - Link Layer Discovery Protocol 145

Content
CLI L2B
Release 4.0 11/07 7
4.8.1 show lldp 145
4.8.2 show lldp config 145
4.8.3 show lldp config chassis 146
4.8.4 show lldp config chassis admin-state 146
4.8.5 show lldp config chassis notification-interval 147
4.8.6 show lldp config chassis re-init-delay 147
4.8.7 show lldp config chassis tx-delay 148
4.8.8 show lldp config chassis tx-hold-mult 148
4.8.9 show lldp chassis tx-interval 148
4.8.10 show lldp config port 149
4.8.11 show lldp config port tlv 150
4.8.12 show lldp remote-data 151
4.8.13 lldp 152
4.8.14 lldp config chassis admin-state 153
4.8.15 lldp config chassis notification-interval 153
4.8.16 lldp config chassis re-init-delay 154
4.8.17 lldp config chassis tx-delay 154
4.8.18 lldp config chassis tx-hold-mult 155
4.8.19 lldp chassis tx-interval 155
4.8.20 clear lldp config all 156
4.8.21 lldp admin-state 156
4.8.22 lldp fdb-mode 157
4.8.23 lldp hm-mode 157
4.8.24 lldp max-neighbors 158
4.8.25 lldp notification 158
4.8.26 lldp tlv link-aggregation 158
4.8.27 lldp tlv mac-phy-config-state 159
4.8.28 lldp tlv max-frame-size 159
4.8.29 lldp tlv mgmt-addr 159
4.8.30 lldp tlv port-desc 160
4.8.31 lldp tlv protocol 160
4.8.32 lldp tlv sys-cap 160
4.8.33 lldp tlv sys-desc 161
4.8.34 lldp tlv sys-name 161
4.9 SNTP - Simple Network Time Protocol 163
4.9.1 show sntp 163
4.9.2 show sntp anycast 163
4.9.3 show sntp client 164
4.9.4 show sntp operation 165
4.9.5 show sntp status 165

Content
8CLI L2B
Release 4.0 11/07
4.9.6 show sntp time 166
4.9.7 no sntp 166
4.9.8 sntp anycast address 167
4.9.9 sntp anycast transmit-interval 167
4.9.10 sntp client accept-broadcast 168
4.9.11 sntp client offset 168
4.9.12 sntp client request-interval 169
4.9.13 no sntp client server 169
4.9.14 sntp client server primary 169
4.9.15 sntp client server secondary 171
4.9.16 sntp operation 172
4.9.17 sntp time system 172
4.10 PoE - Power over Ethernet 173
4.10.1 show inlinepower 173
4.10.2 show inlinepower port 173
4.10.3 inlinepower 174
4.10.4 inlinepower 175
4.10.5 clear inlinepower 175
5 CLI Commands: Switching 177
5.1 MRP 179
5.1.1 show mrp 179
5.1.2 show mrp current-domain 180
5.1.3 mrp 181
5.1.4 mrp current-domain 182
5.1.5 mrp delete-domain 183
5.1.6 mrp new-domain 183
5.2 HIPER-Ring 185
5.2.1 show hiper-ring 186
5.2.2 show hiper-ring info 187
5.2.3 hiper-ring 187
5.2.4 hiper-ring mode 188
5.2.5 hiper-ring port primary 188
5.2.6 hiper-ring port secondary 189
5.3 DHCP Relay Commands 191
5.3.1 show dhcp-relay 191
5.3.2 dhcp-relay 192
5.3.3 dhcp-relay 193

Content
CLI L2B
Release 4.0 11/07 9
6 CLI Commands: Security 195
6.1 Security Commands 197
6.1.1 users defaultlogin 197
6.1.2 users login 198
6.2 HTTP Commands 199
6.2.1 ip http secure-port 199
6.2.2 ip http secure-protocol 200
6.2.3 ip http secure-server 201
6.2.4 ip http server 202
6.2.5 show ip http 203
7 Glossary 205
8 Index 223
9 Hirschmann Competence 227

Content
10 CLI L2B
Release 4.0 11/07

Command Structure
CLI L2B
Release 4.0 11/07 11
1 Command Structure
The Command Line Interface (CLI) syntax, conventions and terminology are
described in this section. Each CLI command is illustrated using the structure
outlined below.

Command Structure
12
1.1 Format
CLI L2B
Release 4.0 11/07
1.1 Format
Commands are followed by values, parameters, or both.
UExample 1
network parms <ipaddr> <netmask> [gateway]
Dnetwork parms
is the command name.
D<ipaddr> <netmask>
are the required values for the command.
D[gateway]
is the optional value for the command.
UExample 2
snmp-server location <loc>
Dsnmp-server location
is the command name.
D<loc>
is the required parameter for the command.
UExample 3
clear config
Dclear config
is the command name.

Command Structure
CLI L2B
Release 4.0 11/07
1.1 Format
13
1.1.1 Command
The text in courier font must be typed exactly as shown.
1.1.2 Parameters
Parameters are order dependent.
Parameters may be mandatory values, optional values, choices, or a combi-
nation.
D<parameter>. The <> angle brackets indicate that a mandatory param-
eter must be entered in place of the brackets and text inside them.
D[parameter]. The [] square brackets indicate that an optional parame-
ter may be entered in place of the brackets and text inside them.
Dchoice1 | choice2. The | indicates that only one of the parameters
should be entered.
DThe {} curly braces indicate that a parameter must be chosen from the list
of choices.

Command Structure
14
1.1 Format
CLI L2B
Release 4.0 11/07
1.1.3 Values
ipaddr This parameter is a valid IP address, made
up of four decimal bytes ranging from 0 to
255. The default for all IP parameters con-
sists of zeros (that is, 0.0.0.1). The inter-
face IP address of 0.0.0.0 is invalid. In
some cases, the IP address can also be
entered as a 32-bit number.
macaddr The MAC address format is six hexadeci-
mal numbers separated by colons, for
example 00:06:29:32:81:40.
areaid Area IDs may be entered in dotted-decimal
notation (for example, 0.0.0.1). An area ID
of 0.0.0.0 is reserved for the backbone.
Area IDs have the same form as IP
addresses, but are distinct from IP
addresses. The IP network number of the
sub-netted network may be used for the
area ID.
slot/port Valid slot and port number separated by
forward slashes. For example, 0/1 repre-
sents slot number 0 and port number 1.
logical slot/port Logical slot and port number. This is appli-
cable in the case of a link-aggregation
(LAG). The operator can use the logical
slot/port to configure the link-aggregation.

Command Structure
CLI L2B
Release 4.0 11/07
1.1 Format
15
1.1.4 Conventions
Network addresses are used to define a link to a remote host, workstation or
network. Network addresses are shown using the following syntax:
Double quotation marks such as "System Name with Spaces" set off user de-
fined strings. If the operator wishes to use spaces as part of a name param-
eter then it must be enclosed in double quotation marks.
Empty strings (““) are not valid user defined strings.
Command completion finishes spelling the command when enough letters of
a command are typed to uniquely identify the command word. The command
may be executed by typing <enter> (command abbreviation) or the com-
mand word may be completed by typing the <tab> or <space bar> (command
completion).
The value 'Err' designates that the requested value was not internally acces-
sible. This should never happen and indicates that there is a case in the soft-
ware that is not handled correctly.
The value of '-----' designates that the value is unknown.
Address Type Format Range
ipaddr 192.168.11.110 0.0.0.0 to 255.255.255.255
(decimal)
macaddr A7:C9:89:DD:A9:B3 hexidecimal digit pairs
Table 1: Network Address Syntax

Command Structure
16
1.1 Format
CLI L2B
Release 4.0 11/07
1.1.5 Annotations
The CLI allows the user to type single-line annotations at the command
prompt for use when writing test or configuration scripts and for better read-
ability. The exclamation point (‘!’) character flags the beginning of a com-
ment. The comment flag character can begin a word anywhere on the
command line and all input following this character is ignored. Any command
line that begins with the character ‘!’ is recognized as a comment line and ig-
nored by the parser.
Some examples are provided below:
! Script file for setting the CLI prompt
set prompt example-switch
! End of the script file

Command Structure
CLI L2B
Release 4.0 11/07
1.1 Format
17
1.1.6 Special keys
The following list of special keys may be helpful to enter command lines.
BS delete previous character
Ctrl-A go to beginning of line
Ctrl-E go to end of line
Ctrl-F go forward one character
Ctrl-B go backward one character
Ctrl-D delete current character
Ctrl-U, X delete to beginning of line
Ctrl-K delete to end of line
Ctrl-W delete previous word
Ctrl-T transpose previous character
Ctrl-P go to previous line in history buffer
Ctrl-R rewrites or pastes the line
Ctrl-N go to next line in history buffer
Ctrl-Y print last deleted character
Ctrl-Q enables serial flow
Ctrl-S disables serial flow
Ctrl-Z return to root command prompt
Tab, <SPACE> command-line completion
Exit go to next lower command prompt
? list choices

Command Structure
18
1.1 Format
CLI L2B
Release 4.0 11/07
1.1.7 Special characters in scripts
Some of the configuration parameters are strings that can contain special
characters. When the switch creates a script from the running configuration
(by use of the command #show running-config <scriptname.cli>), these spe-
cial characters are written to the script with a so-called escape character pre-
ceding them. This ensures that when applying the script, these characters
are regarded as a normal part of the configuration parameter, not having the
special meaning they usually have.
Character (plain) Meaning, when entered in the CLI
! Begin of a comment, ! and the rest of the line will be ignored
" Begin or end of a string that may contain space characters
' Begin or end of a string that may contain space characters
? Shows possible command keywords or parameters
\ The backslash has no special meaning here but because it is used as the
escape character, it now bears a special meaning (this part of the concept
is not backward compatible).
Tab. 2: Special characters
Character (escaped) Meaning, when entered in the CLI
\! ! is part of the string
\" " is part of the string
\' ' is part of the string
? ? is part of the string
\ \ is part of the string
Tab. 3: Special characters escaped

Command Structure
CLI L2B
Release 4.0 11/07
1.1 Format
19
The commands with strings that may contain these special characters are
listed below.
Note: Not every string is allowed to contain special characters. The string
that is output with the escape characters (if necessary) is shown as "...".
When a device creates a script, a human-readable header is included that
lists the special characters and the escape characters:
!Parameter string escape handling \, 1
!Characters to be preceded with escape char (\): \, !, ", ', ?
Command Note
!System Description "..." "At the beginning of the script
!System Version "..." "At the beginning of the script
Tab. 4: Commands in Privileged Exec mode
Command Note
snmp-server location "..."
snmp-server contact "..."
snmp-server community "..."
snmp-server community ipaddr <ip> "..."
snmp-server community ipmask <ip> "..."
snmp-server community ro "..."
snmp-server community rw "..."
no snmp-server community mode "..."
no snmp-server community "..."
ptp subdomain-name "..."
Tab. 5: Commands in Global Config mode
Command Note
name "..."
Tab. 6: Commands in Interface Config mode

Command Structure
20
1.1 Format
CLI L2B
Release 4.0 11/07
1.1.8 Secrets in scripts
A configuration may include secrets (e. g., passwords). When creating a
script, these secrets are written to it in a scrambled form, not in clear text.
These secrets may be up to 31 characters long. The format for a scrambled
secret is: ":v1:<scrambled secret>:" (without the quotes ("), they were added
for readability). v1 denotes the scrambling method (v1 in this case), the value
of the scrambled secret is a 64-digit hex string.
The following commands produce scrambled secrets (if necessary):
Applying or validating a script requires the following conditions for a scram-
bled secret, else it will be considered invalid (usually only relevant if a script
is edited manually):
Dstring must not be longer than 64 hex digits
Dstring must only contain the digits 0-9 and the characters A-F (or a-f)
Dstring length must be even
Command Note
ip ospf authentication encrypt <secret> <id> Software L3P
ip ospf authentication simple <secret> Software L3P
ip rip authentication encrypt <secret> <id> Software L3E and L3P
ip rip authentication simple <secret> Software L3E and L3P
ip vrrp <id> authentication simple <secret> Software L3E and L3P
radius server key acct <ip> <password>
radius server key auth <ip> <password>
users passwd <username> <password>
users snmpv3 encryption <username> des <password>
Tab. 7: Commands in Global Config mode
Command Note
area <ip> virtual-link <ip> authentication encrypt <secret> <id> Encrypted Authentication
area <ip> virtual-link <ip> authentication simple <secret> Simple Authentication
Tab. 8: Commands in Router OSPF mode (software L3P)