User manual | SCALANCE XB-200 Command Line Interface

SCALANCE XB-200 Command Line
1
___________________
Introduction
Interface
2
___________________
General information
SIMATIC NET
3
___________________
Configuration
Industrial Ethernet switches
SCALANCE XB-200 Command
Line Interface
Configuration Manual
Functions specific to
4
___________________
SCALANCE
5
___________________
System time
6
___________________
Network structures
7
___________________
Network protocols
Layer 2 management
8
___________________
protocols
9
___________________
Load control
10
___________________
Security and authentication
11
___________________
Diagnostics
04/2015
C79000-G8976-C361-02
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will
be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to
property damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions.
Qualified personnel are those who, based on their training and experience, are capable of identifying risks and
avoiding potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:
WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended
or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.
Siemens AG
Division Process Industries and Drives
Postfach 48 48
90026 NÜRNBERG
GERMANY
C79000-G8976-C361-02
Ⓟ 03/2015 Subject to change
Copyright © Siemens AG 2015.
All rights reserved
Table of contents
1
Introduction ........................................................................................................................................... 15
1.1
2
3
Information on the Configuration Manual................................................................................15
General information .............................................................................................................................. 19
2.1
General information on the Command Line Interface.............................................................19
2.2
Structure of the Command Line Interface ...............................................................................20
2.3
Configuration limits .................................................................................................................21
2.4
Features not supported ...........................................................................................................22
2.5
The CLI command prompt ......................................................................................................23
2.6
Symbols of the CLI commands ...............................................................................................24
2.7
2.7.1
2.7.2
Addresses and interface names .............................................................................................25
Naming interfaces ...................................................................................................................25
Address types, address ranges and address masks ..............................................................26
2.8
2.8.1
2.8.2
2.8.3
2.8.4
2.8.4.1
2.8.4.2
2.8.4.3
2.8.4.4
2.8.4.5
2.8.4.6
2.8.4.7
2.8.4.8
General CLI commands ..........................................................................................................27
clear screen ............................................................................................................................27
end ..........................................................................................................................................28
exit...........................................................................................................................................28
Help functions and supported input ........................................................................................29
help .........................................................................................................................................29
The command "?" ...................................................................................................................30
Completion of command entries .............................................................................................31
Abbreviated notation of commands ........................................................................................31
Reusing the last used commands ...........................................................................................32
Working through a command sequence .................................................................................32
show history ............................................................................................................................33
clear history .............................................................................................................................34
Configuration ........................................................................................................................................ 35
3.1
3.1.1
3.1.1.1
3.1.1.2
3.1.1.3
3.1.1.4
3.1.1.5
3.1.1.6
3.1.1.7
3.1.1.8
3.1.1.9
3.1.1.10
3.1.1.11
3.1.1.12
System ....................................................................................................................................35
The "show" commands ...........................................................................................................35
show cli-console-timeout.........................................................................................................35
show coordinates ....................................................................................................................36
show device information .........................................................................................................36
show ethernetip .......................................................................................................................37
show hardware ........................................................................................................................37
show im ...................................................................................................................................38
show interface mtu ..................................................................................................................38
show interfaces .......................................................................................................................39
show interfaces ... counters ....................................................................................................40
show ip interface .....................................................................................................................41
show pnio ................................................................................................................................42
show lldp neighbors ................................................................................................................43
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
3
Table of contents
3.1.1.13
3.1.1.14
3.1.1.15
3.1.1.16
3.1.1.17
3.1.2
3.1.3
3.1.4
3.1.5
3.1.6
3.1.7
3.1.8
3.1.9
3.1.9.1
3.1.9.2
3.1.9.3
3.1.9.4
3.1.9.5
3.1.9.6
3.1.9.7
3.1.9.8
3.1.9.9
3.1.9.10
3.1.9.11
3.1.9.12
3.1.9.13
3.1.10
3.1.10.1
3.1.10.2
3.1.10.3
3.1.10.4
3.1.10.5
3.1.10.6
3.1.10.7
3.1.10.8
3.1.10.9
3.1.10.10
3.1.10.11
3.1.10.12
3.1.10.13
3.1.10.14
3.1.10.15
3.1.10.16
3.1.10.17
show lldp status...................................................................................................................... 43
show broadcast-block config.................................................................................................. 44
show unicast-block config ...................................................................................................... 45
show multicast-block config ................................................................................................... 45
show versions ........................................................................................................................ 46
clear counters......................................................................................................................... 47
configure terminal................................................................................................................... 48
disable .................................................................................................................................... 48
enable .................................................................................................................................... 49
logout ..................................................................................................................................... 50
ping ........................................................................................................................................ 50
clear line vty ........................................................................................................................... 51
Commands in the global configuration mode ........................................................................ 52
interface ................................................................................................................................. 53
no interface ............................................................................................................................ 54
cli-console-timeout ................................................................................................................. 55
no cli-console-timeout ............................................................................................................ 56
coordinates height .................................................................................................................. 57
coordinates latitude ................................................................................................................ 57
coordinates longitude ............................................................................................................. 58
ethernetip ............................................................................................................................... 59
pnio ........................................................................................................................................ 60
system contact ....................................................................................................................... 60
system location ...................................................................................................................... 61
system name .......................................................................................................................... 61
username ............................................................................................................................... 62
Commands in the interface configuration mode .................................................................... 63
alias ........................................................................................................................................ 63
no alias ................................................................................................................................... 64
broadcast-block ...................................................................................................................... 64
no broadcast-block ................................................................................................................. 65
duplex ..................................................................................................................................... 66
no duplex ................................................................................................................................ 67
lldp .......................................................................................................................................... 67
no lldp ..................................................................................................................................... 68
multicast-block ....................................................................................................................... 69
no multicast-block .................................................................................................................. 70
negotiation.............................................................................................................................. 70
no negotiation......................................................................................................................... 71
shutdown ................................................................................................................................ 72
no shutdown ........................................................................................................................... 73
speed ..................................................................................................................................... 73
unicast-block .......................................................................................................................... 74
no unicast-block ..................................................................................................................... 75
3.2
3.2.1
3.2.2
3.2.3
3.2.4
3.2.5
3.2.6
3.2.6.1
Load and Save ....................................................................................................................... 76
File list .................................................................................................................................... 76
show loadsave files ................................................................................................................ 77
show loadsave tftp ................................................................................................................. 77
load tftp .................................................................................................................................. 78
save filetype ........................................................................................................................... 79
Commands in the global configuration mode ........................................................................ 80
loadsave ................................................................................................................................. 80
SCALANCE XB-200 Command Line Interface
4
Configuration Manual, 04/2015, C79000-G8976-C361-02
Table of contents
4
5
3.2.7
3.2.7.1
3.2.7.2
3.2.7.3
3.2.7.4
3.2.7.5
3.2.7.6
3.2.7.7
Commands in the LOADSAVE configuration mode ...............................................................81
delete ......................................................................................................................................81
password .................................................................................................................................82
no password ............................................................................................................................83
tftp filename ............................................................................................................................84
tftp load ...................................................................................................................................85
tftp save ..................................................................................................................................86
tftp server ................................................................................................................................87
3.3
3.3.1
Reset and Defaults .................................................................................................................88
restart ......................................................................................................................................88
3.4
3.4.1
3.4.2
3.4.3
3.4.3.1
3.4.3.2
Configuration Save & Restore ................................................................................................89
show running-config ................................................................................................................89
write startup-config..................................................................................................................91
Commands in the global configuration mode .........................................................................92
auto-save ................................................................................................................................93
no auto-save ...........................................................................................................................94
3.5
3.5.1
3.5.2
3.5.2.1
3.5.2.2
SINEMA ..................................................................................................................................95
show sinema ...........................................................................................................................95
Commands in the global configuration mode .........................................................................95
sinema ....................................................................................................................................96
no sinema ...............................................................................................................................97
Functions specific to SCALANCE .......................................................................................................... 99
4.1
4.1.1
4.1.2
4.1.2.1
4.1.2.2
WBM .......................................................................................................................................99
show web-session-timeout .....................................................................................................99
Commands in the global configuration mode .......................................................................100
web-session-timeout .............................................................................................................100
no web-session-timeout ........................................................................................................101
4.2
4.2.1
4.2.1.1
4.2.1.2
Panel button ..........................................................................................................................102
Commands in the global configuration mode .......................................................................102
panel-button control-factory-defaults ....................................................................................102
no panel-button control-factory-defaults ...............................................................................103
System time ........................................................................................................................................ 105
5.1
5.1.1
5.1.2
5.1.2.1
5.1.2.2
System time setting...............................................................................................................105
show time ..............................................................................................................................105
Commands in the global configuration mode .......................................................................105
time .......................................................................................................................................106
time set .................................................................................................................................106
5.2
5.2.1
5.2.2
5.2.2.1
5.2.3
5.2.3.1
5.2.3.2
5.2.3.3
NTP client .............................................................................................................................108
show ntp info .........................................................................................................................108
Commands in the global configuration mode .......................................................................108
ntp .........................................................................................................................................109
Commands in the NTP configuration mode ..........................................................................109
ntp server ..............................................................................................................................110
no ntp server .........................................................................................................................111
ntp time diff ...........................................................................................................................112
5.3
5.3.1
SNTP client ...........................................................................................................................113
show sntp broadcast-mode status ........................................................................................113
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
5
Table of contents
5.3.2
5.3.3
5.3.4
5.3.4.1
5.3.5
5.3.5.1
5.3.5.2
5.3.5.3
5.3.5.4
6
show sntp unicast-mode status............................................................................................ 113
show sntp status .................................................................................................................. 114
Commands in the global configuration mode ...................................................................... 115
sntp ...................................................................................................................................... 115
Commands in the SNTP configuration mode ...................................................................... 116
sntp client addressing-mode ................................................................................................ 116
sntp time diff ......................................................................................................................... 117
sntp unicast-server ipv4 ....................................................................................................... 118
no sntp unicast-server ipv4 .................................................................................................. 119
Network structures ...............................................................................................................................121
6.1
Introduction to the section "Network structures" .................................................................. 121
6.2
6.2.1
6.2.1.1
6.2.1.2
6.2.1.3
6.2.1.4
6.2.1.5
6.2.1.6
6.2.1.7
6.2.1.8
6.2.1.9
6.2.1.10
6.2.2
6.2.2.1
6.2.2.2
6.2.2.3
6.2.2.4
6.2.2.5
6.2.2.6
6.2.3
6.2.3.1
6.2.3.2
6.2.3.3
6.2.3.4
6.2.3.5
6.2.3.6
6.2.3.7
6.2.3.8
6.2.4
6.2.4.1
6.2.4.2
6.2.4.3
6.2.4.4
6.2.4.5
6.2.4.6
6.2.4.7
VLAN .................................................................................................................................... 122
The "show" commands ........................................................................................................ 122
show mac-address-table ...................................................................................................... 122
show mac-address-table dynamic multicast ........................................................................ 123
show mac-address-table dynamic unicast ........................................................................... 124
show mac-address-table static multicast ............................................................................. 125
show mac-address-table static unicast ................................................................................ 126
show mac-address-table count ............................................................................................ 127
show vlan ............................................................................................................................. 127
show vlan device info ........................................................................................................... 128
show vlan learning params .................................................................................................. 129
show vlan port config ........................................................................................................... 129
Commands in the global configuration mode ...................................................................... 130
interface range ..................................................................................................................... 130
no interface range ................................................................................................................ 131
mgmt vlan ............................................................................................................................. 132
vlan ....................................................................................................................................... 133
no vlan .................................................................................................................................. 134
vlan range ............................................................................................................................ 135
Commands in the interface configuration mode .................................................................. 136
switchport acceptable-frame-type ........................................................................................ 136
no switchport acceptable-frame-type ................................................................................... 137
switchport access vlan ......................................................................................................... 137
no switchport access vlan .................................................................................................... 138
switchport priority default ..................................................................................................... 139
no switchport priority default ................................................................................................ 140
switchport pvid ..................................................................................................................... 140
no switchport pvid ................................................................................................................ 141
Commands in the VLAN configuration mode ....................................................................... 142
ip address ............................................................................................................................. 142
ip address dhcp .................................................................................................................... 143
no ip address........................................................................................................................ 144
name .................................................................................................................................... 145
no name ............................................................................................................................... 146
ports ..................................................................................................................................... 147
no ports ................................................................................................................................ 149
6.3
6.3.1
6.3.2
Spanning Tree...................................................................................................................... 151
Introduction to the section Spanning Tree ........................................................................... 151
The "show" commands ........................................................................................................ 151
SCALANCE XB-200 Command Line Interface
6
Configuration Manual, 04/2015, C79000-G8976-C361-02
Table of contents
7
6.3.2.1
6.3.2.2
6.3.2.3
6.3.2.4
6.3.2.5
6.3.2.6
6.3.2.7
6.3.2.8
6.3.3
6.3.4
6.3.5
6.3.5.1
6.3.5.2
6.3.5.3
6.3.5.4
6.3.5.5
6.3.5.6
6.3.5.7
6.3.5.8
6.3.5.9
6.3.6
6.3.6.1
6.3.6.2
6.3.6.3
6.3.6.4
6.3.6.5
6.3.6.6
6.3.6.7
6.3.6.8
6.3.6.9
6.3.6.10
6.3.6.11
6.3.6.12
6.3.6.13
6.3.6.14
6.3.6.15
show spanning-tree...............................................................................................................151
show spanning-tree active ....................................................................................................152
show spanning-tree bridge ...................................................................................................153
show spanning-tree detail .....................................................................................................154
show spanning-tree interface ................................................................................................154
show spanning-tree root .......................................................................................................155
show spanning-tree passive-listening-compatibility ..............................................................156
show spanning-tree interface layer2-gateway-port ...............................................................157
clear spanning-tree detected protocols.................................................................................158
clear spanning-tree counters ................................................................................................159
Commands in the global configuration mode .......................................................................159
spanning-tree ........................................................................................................................159
no spanning-tree ...................................................................................................................160
spanning-tree compatibility ...................................................................................................161
no spanning-tree compatibility ..............................................................................................162
spanning-tree priority ............................................................................................................163
no spanning-tree priority .......................................................................................................164
spanning-tree passive-listening-compatibility .......................................................................165
no spanning-tree passive-listening-compatibility ..................................................................165
Time settings for the Spanning Tree protocol .......................................................................166
Commands in the interface configuration mode ...................................................................169
spanning-tree ........................................................................................................................169
no spanning-tree ...................................................................................................................171
spanning-tree auto-edge .......................................................................................................172
no spanning-tree auto-edge ..................................................................................................173
spanning-tree bpdu-transmit .................................................................................................173
spanning-tree bpdu-receive ..................................................................................................174
spanning-tree bpdufilter ........................................................................................................175
spanning-tree layer2-gateway-port .......................................................................................175
no spanning-tree layer2-gateway-port ..................................................................................176
spanning-tree loop-guard ......................................................................................................177
no spanning-tree loop-guard .................................................................................................177
spanning-tree restricted-role .................................................................................................178
no spanning-tree restricted-role ............................................................................................179
spanning-tree restricted-tcn ..................................................................................................180
no spanning-tree restricted-tcn .............................................................................................181
6.4
6.4.1
6.4.2
6.4.3
Passive Listening ..................................................................................................................182
show passive-listening ..........................................................................................................182
passive listening ....................................................................................................................183
no passive-listening ..............................................................................................................184
Network protocols ............................................................................................................................... 185
7.1
7.1.1
7.1.2
7.1.3
7.1.4
7.1.5
7.1.5.1
7.1.5.2
7.1.5.3
7.1.5.4
IPv4 protocol .........................................................................................................................185
show ip gateway ...................................................................................................................185
show ip telnet ........................................................................................................................186
show dcp server ....................................................................................................................186
show dcp forwarding .............................................................................................................187
Commands in the global configuration mode .......................................................................187
ip gateway .............................................................................................................................188
no ip gateway ........................................................................................................................188
ip echo-reply .........................................................................................................................189
no ip echo-reply ....................................................................................................................190
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
7
Table of contents
7.1.5.5
7.1.5.6
7.1.5.7
7.1.5.8
7.1.6
7.1.6.1
telnet-server ......................................................................................................................... 190
no telnet-server .................................................................................................................... 191
dcp server ............................................................................................................................ 192
no dcp server ....................................................................................................................... 193
Commands in the interface configuration mode .................................................................. 193
dcp forwarding...................................................................................................................... 194
7.2
7.2.1
7.2.2
7.2.3
7.2.3.1
7.2.3.2
7.2.3.3
DHCP client.......................................................................................................................... 195
show ip dhcp client stats ...................................................................................................... 195
show ip dhcp client ............................................................................................................... 195
Commands in the global configuration mode ...................................................................... 196
ip dhcp config-file-request .................................................................................................... 196
no ip dhcp config-file-request ............................................................................................... 197
ip dhcp client mode .............................................................................................................. 198
7.3
7.3.1
7.3.1.1
7.3.1.2
7.3.1.3
7.3.1.4
7.3.1.5
7.3.1.6
7.3.1.7
7.3.1.8
7.3.1.9
7.3.1.10
7.3.1.11
7.3.1.12
7.3.1.13
7.3.2
7.3.2.1
7.3.2.2
7.3.2.3
7.3.2.4
7.3.2.5
7.3.2.6
7.3.2.7
7.3.2.8
7.3.2.9
7.3.2.10
7.3.2.11
7.3.2.12
7.3.2.13
7.3.2.14
7.3.2.15
7.3.2.16
7.3.2.17
7.3.2.18
7.3.2.19
7.3.2.20
7.3.2.21
SNMP ................................................................................................................................... 199
The "show" commands ........................................................................................................ 199
show snmp ........................................................................................................................... 199
show snmp community ........................................................................................................ 199
show snmp engineID ........................................................................................................... 200
show snmp filter ................................................................................................................... 200
show snmp group ................................................................................................................. 201
show snmp group access .................................................................................................... 201
show snmp inform statistics ................................................................................................. 202
show snmp notif ................................................................................................................... 202
show snmp targetaddr ......................................................................................................... 203
show snmp targetparam ...................................................................................................... 203
show snmp tcp ..................................................................................................................... 204
show snmp user ................................................................................................................... 204
show snmp viewtree ............................................................................................................ 205
Commands in the global configuration mode ...................................................................... 205
snmpagent ........................................................................................................................... 206
no snmpagent ...................................................................................................................... 206
snmp agent version .............................................................................................................. 207
snmp access ........................................................................................................................ 208
no snmp access ................................................................................................................... 209
snmp community index ........................................................................................................ 210
no snmp community index ................................................................................................... 211
snmp group .......................................................................................................................... 212
no snmp group ..................................................................................................................... 213
snmp notify ........................................................................................................................... 214
no snmp notify ...................................................................................................................... 215
snmp targetaddr ................................................................................................................... 216
no snmp targetaddr .............................................................................................................. 218
snmp targetparams .............................................................................................................. 218
no snmp targetparams ......................................................................................................... 220
snmp v1-v2 readonly ............................................................................................................ 221
no snmp v1-v2 readonly ....................................................................................................... 221
snmp user ............................................................................................................................ 222
no snmp user ....................................................................................................................... 223
snmp view ............................................................................................................................ 224
no snmp view ....................................................................................................................... 225
SCALANCE XB-200 Command Line Interface
8
Configuration Manual, 04/2015, C79000-G8976-C361-02
Table of contents
8
7.4
7.4.1
7.4.2
7.4.3
7.4.4
7.4.4.1
7.4.4.2
7.4.4.3
7.4.4.4
7.4.4.5
7.4.4.6
7.4.4.7
SMTP client ...........................................................................................................................226
show events smtp-server ......................................................................................................226
show events sender email ....................................................................................................226
show events smtp-port ..........................................................................................................227
Commands in the Events configuration mode ......................................................................227
smtp-server ...........................................................................................................................228
no smtp-server ......................................................................................................................229
sender mail-address .............................................................................................................229
no sender mail-address ........................................................................................................230
send test mail ........................................................................................................................231
smtp-port ...............................................................................................................................231
no smtp-port ..........................................................................................................................232
7.5
7.5.1
7.5.2
7.5.2.1
7.5.2.2
HTTP server ..........................................................................................................................233
show ip http server status .....................................................................................................233
Commands in the global configuration mode .......................................................................234
ip http ....................................................................................................................................234
no ip http ...............................................................................................................................235
7.6
7.6.1
7.6.2
HTTPS server .......................................................................................................................236
show ip http secure server status .........................................................................................236
show ssl server-cert ..............................................................................................................237
7.7
7.7.1
7.7.2
7.7.2.1
7.7.2.2
ARP .......................................................................................................................................238
show ip arp ............................................................................................................................238
Commands in the global configuration mode .......................................................................239
arp timeout ............................................................................................................................239
no arp timeout .......................................................................................................................240
7.8
7.8.1
7.8.2
7.8.2.1
7.8.2.2
SSH server ............................................................................................................................241
show ip ssh ...........................................................................................................................241
Commands in the global configuration mode .......................................................................242
ssh-server .............................................................................................................................242
no ssh-server ........................................................................................................................243
Layer 2 management protocols ........................................................................................................... 245
8.1
Introduction to the section "Layer 2 management protocols" ...............................................245
8.2
8.2.1
8.2.2
8.2.3
8.2.4
8.2.5
8.2.5.1
8.2.5.2
8.2.5.3
8.2.5.4
8.2.5.5
8.2.5.6
8.2.5.7
IGMP snooping .....................................................................................................................245
show ip igmp snooping .........................................................................................................245
show ip igmp snooping forwarding-database .......................................................................246
show ip igmp snooping statistics ..........................................................................................247
show ip igmp snooping switch-ip ..........................................................................................247
Commands in the global configuration mode .......................................................................248
ip igmp snooping version ......................................................................................................248
ip igmp vlan-snooping ...........................................................................................................249
no ip igmp vlan-snooping ......................................................................................................250
ip igmp snooping clear counters ...........................................................................................250
ip igmp snooping switch-ip ....................................................................................................251
ip igmp snooping port-purge-interval ....................................................................................252
no ip igmp snooping port-purge-interval ...............................................................................253
8.3
8.3.1
8.3.1.1
IGMP querier .........................................................................................................................254
Commands in the Global Configuration mode ......................................................................254
ip igmp snooping querier ......................................................................................................254
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
9
Table of contents
9
8.3.1.2
no ip igmp snooping querier................................................................................................. 255
8.4
8.4.1
8.4.2
8.4.3
8.4.3.1
8.4.3.2
8.4.3.3
8.4.4
8.4.4.1
8.4.4.2
8.4.4.3
8.4.4.4
8.4.4.5
8.4.5
8.4.5.1
8.4.5.2
8.4.5.3
8.4.5.4
8.4.5.5
8.4.5.6
8.4.5.7
Ring redundancy and standby connection ........................................................................... 256
clear hrp counters ................................................................................................................ 256
clear standby counter ........................................................................................................... 257
The "show" commands ........................................................................................................ 258
show hrp counters ................................................................................................................ 258
show ring-redundancy .......................................................................................................... 258
show ring-redundancy manager counters ........................................................................... 259
Commands in the global configuration mode ...................................................................... 259
ring-redundancy configuration ............................................................................................. 260
ring-redundancy mode ......................................................................................................... 260
no ring-redundancy .............................................................................................................. 261
ring-redundancy standby ..................................................................................................... 262
no ring-redundancy standby ................................................................................................ 262
Commands in the redundancy configuration mode ............................................................. 263
ring ports .............................................................................................................................. 263
standby connection-name .................................................................................................... 264
no standby connection-name ............................................................................................... 265
standby force-master ........................................................................................................... 266
no standby force-master ...................................................................................................... 266
standby port ......................................................................................................................... 267
no standby port .................................................................................................................... 268
8.5
8.5.1
8.5.2
8.5.3
8.5.4
8.5.4.1
8.5.4.2
Unicast ................................................................................................................................. 269
show mac-address-table dynamic unicast ........................................................................... 269
show mac-address-table static unicast ................................................................................ 270
show unicast-block config .................................................................................................... 271
Commands in the global configuration mode ...................................................................... 271
mac-address-table static unicast ......................................................................................... 272
no mac-address-table static unicast .................................................................................... 273
8.6
8.6.1
8.6.2
8.6.3
8.6.4
8.6.5
8.6.5.1
8.6.5.2
Multicast ............................................................................................................................... 274
Introduction to the multicast section..................................................................................... 274
show multicast-block config ................................................................................................. 274
show mac-address-table dynamic multicast ........................................................................ 275
show mac-address-table static multicast ............................................................................. 276
Commands in the global configuration mode ...................................................................... 277
mac-address-table static multicast....................................................................................... 277
no mac-address-table static multicast ................................................................................. 279
Load control .........................................................................................................................................281
9.1
9.1.1
9.1.2
9.1.2.1
9.1.2.2
9.1.2.3
9.1.2.4
9.1.2.5
9.1.2.6
Rate control .......................................................................................................................... 281
show rate-limit output ........................................................................................................... 281
Commands in the interface configuration mode .................................................................. 282
rate-limit output .................................................................................................................... 282
no rate-limit output ............................................................................................................... 283
storm-control ........................................................................................................................ 284
no storm-control ................................................................................................................... 285
storm-control level ................................................................................................................ 286
no storm-control level ........................................................................................................... 287
9.2
9.2.1
Static MAC filtering .............................................................................................................. 288
Commands in the global configuration mode ...................................................................... 288
SCALANCE XB-200 Command Line Interface
10
Configuration Manual, 04/2015, C79000-G8976-C361-02
Table of contents
10
9.2.1.1
9.2.1.2
9.2.1.3
9.2.1.4
9.2.2
9.2.2.1
9.2.2.2
mac-address-table static multicast .......................................................................................288
no mac-address-table static multicast ..................................................................................289
mac-address-table static unicast ..........................................................................................290
no mac-address-table static unicast .....................................................................................291
Commands in the interface configuration mode ...................................................................293
switchport ingress-filter .........................................................................................................293
no switchport ingress-filter ....................................................................................................294
9.3
9.3.1
9.3.2
9.3.3
9.3.3.1
9.3.3.2
9.3.3.3
9.3.3.4
Dynamic MAC aging .............................................................................................................295
show mac-address-table aging-time .....................................................................................295
show mac-address-table aging-status ..................................................................................295
Commands in the global configuration mode .......................................................................296
mac-address-table aging-time ..............................................................................................296
no mac-address-table aging-time .........................................................................................297
mac-address-table aging ......................................................................................................298
no mac-address-table aging .................................................................................................299
9.4
9.4.1
9.4.2
9.4.2.1
Flow control ...........................................................................................................................300
show flow-control ..................................................................................................................300
Commands in the interface configuration mode ...................................................................301
flowcontrol .............................................................................................................................301
9.5
9.5.1
9.5.2
9.5.3
9.5.3.1
9.5.4
9.5.4.1
9.5.4.2
Service classes .....................................................................................................................302
show qos cos-map ................................................................................................................302
show qos dscp-map ..............................................................................................................302
Commands in the Global configuration mode ......................................................................303
qos ........................................................................................................................................303
Commands in the QOS configuration mode .........................................................................304
cos-map ................................................................................................................................304
dscp-map ..............................................................................................................................305
Security and authentication ................................................................................................................. 307
10.1
10.1.1
10.1.2
User rights management ......................................................................................................307
show users ............................................................................................................................307
whoami ..................................................................................................................................308
10.2
10.2.1
10.2.2
10.2.3
10.2.3.1
10.2.3.2
10.2.3.3
10.2.3.4
RADIUS client .......................................................................................................................309
show radius statistics ............................................................................................................309
show radius server ................................................................................................................309
Commands in the global configuration mode .......................................................................310
login authentication ...............................................................................................................310
no login authentication ..........................................................................................................311
radius-server .........................................................................................................................312
no radius-server ....................................................................................................................314
10.3
10.3.1
10.3.2
10.3.2.1
10.3.2.2
10.3.2.3
10.3.2.4
Management Access Control List .........................................................................................315
show authorized-managers ..................................................................................................315
Commands in the Global configuration mode ......................................................................316
authorized-manager ..............................................................................................................316
no authorized-manager .........................................................................................................317
authorized-manager ip-source ..............................................................................................317
no authorized-manager ip-source .........................................................................................320
10.4
10.4.1
Port Access Control List Locked Ports .................................................................................321
show lock port .......................................................................................................................321
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
11
Table of contents
11
10.4.2
10.4.2.1
10.4.2.2
10.4.3
10.4.3.1
10.4.3.2
10.4.4
10.4.4.1
10.4.4.2
Commands in the Global configuration mode ...................................................................... 322
clear-all-static-unicast .......................................................................................................... 322
auto-learn ............................................................................................................................. 322
Commands in the interface configuration mode .................................................................. 323
switchport lock...................................................................................................................... 323
no switchport lock................................................................................................................. 324
Commands in the AUTOLEARN mode ................................................................................ 325
start ...................................................................................................................................... 325
stop ...................................................................................................................................... 326
10.5
10.5.1
10.5.1.1
10.5.2
10.5.2.1
10.5.2.2
10.5.2.3
10.5.2.4
Port Based Network Access Control .................................................................................... 327
The "show" commands ........................................................................................................ 327
show dot1x ........................................................................................................................... 327
Commands in the interface configuration mode .................................................................. 328
dot1x port-control ................................................................................................................. 328
no dot1x port-control ............................................................................................................ 329
dot1x reauthentication .......................................................................................................... 330
no dot1x reauthentication ..................................................................................................... 331
Diagnostics ..........................................................................................................................................333
11.1
11.1.1
11.1.2
11.1.3
11.1.4
11.1.5
11.1.6
11.1.7
11.1.8
11.1.9
11.1.10
11.1.11
11.1.12
11.1.13
11.1.14
11.1.15
11.1.15.1
11.1.15.2
11.1.16
11.1.16.1
11.1.16.2
11.1.16.3
11.1.16.4
11.1.16.5
11.1.16.6
11.1.16.7
11.1.16.8
11.1.16.9
11.1.16.10
11.1.16.11
11.1.16.12
11.1.16.13
Event and fault handling ...................................................................................................... 334
logging console .................................................................................................................... 334
no logging console ............................................................................................................... 335
show events config .............................................................................................................. 335
show events severity ............................................................................................................ 336
show events faults config ..................................................................................................... 337
show events faults status ..................................................................................................... 337
show startup-information ...................................................................................................... 338
show logbook ....................................................................................................................... 338
clear logbook ........................................................................................................................ 339
show fault counter ................................................................................................................ 340
clear fault counter................................................................................................................. 340
fault report ack ..................................................................................................................... 341
show cabletest interface ...................................................................................................... 342
show power-line-state .......................................................................................................... 343
Commands in the global configuration mode ...................................................................... 343
events ................................................................................................................................... 343
cabletest interface ................................................................................................................ 344
Commands in the Events configuration mode ..................................................................... 345
add log ................................................................................................................................. 345
client config .......................................................................................................................... 346
no client config ..................................................................................................................... 347
event config .......................................................................................................................... 348
no event config ..................................................................................................................... 350
severity ................................................................................................................................. 351
no severity ............................................................................................................................ 352
power ................................................................................................................................... 353
no power .............................................................................................................................. 354
link ........................................................................................................................................ 355
no link ................................................................................................................................... 356
syslogserver ......................................................................................................................... 357
no syslogserver .................................................................................................................... 358
SCALANCE XB-200 Command Line Interface
12
Configuration Manual, 04/2015, C79000-G8976-C361-02
Table of contents
11.2
11.2.1
11.2.2
11.2.2.1
11.2.2.2
Syslog client ..........................................................................................................................359
show events syslogserver .....................................................................................................359
Commands in the Events configuration mode ......................................................................359
syslogserver ..........................................................................................................................360
no syslogserver .....................................................................................................................361
11.3
11.3.1
11.3.2
11.3.2.1
11.3.2.2
11.3.2.3
11.3.2.4
11.3.2.5
11.3.2.6
11.3.3
11.3.3.1
11.3.3.2
11.3.3.3
11.3.3.4
RMON ...................................................................................................................................362
show rmon ............................................................................................................................362
Commands in the global configuration mode .......................................................................363
rmon ......................................................................................................................................363
no rmon .................................................................................................................................364
rmon alarm ............................................................................................................................365
no rmon alarm .......................................................................................................................366
rmon event ............................................................................................................................367
no rmon event .......................................................................................................................368
Commands in the interface configuration mode ...................................................................369
rmon collection stats .............................................................................................................369
no rmon collection stats ........................................................................................................370
rmon collection history ..........................................................................................................370
no rmon collection history .....................................................................................................372
11.4
11.4.1
11.4.2
11.4.3
11.4.4
11.4.4.1
11.4.4.2
11.4.4.3
11.4.4.4
11.4.4.5
11.4.4.6
11.4.4.7
11.4.4.8
11.4.4.9
Port Mirroring ........................................................................................................................373
show monitor .........................................................................................................................373
show monitor barrier .............................................................................................................374
show monitor session ...........................................................................................................374
Commands in the global configuration mode .......................................................................375
monitor ..................................................................................................................................375
no monitor .............................................................................................................................376
monitor barrier enabled .........................................................................................................377
no monitor barrier enabled ....................................................................................................378
monitor session destination ..................................................................................................378
no monitor session destination .............................................................................................379
monitor session source .........................................................................................................380
no monitor session source ....................................................................................................382
no monitor session ................................................................................................................383
11.5
11.5.1
11.5.2
11.5.3
11.5.3.1
11.5.3.2
11.5.3.3
11.5.3.4
11.5.4
11.5.4.1
11.5.4.2
11.5.4.3
11.5.4.4
11.5.4.5
11.5.4.6
11.5.4.7
11.5.4.8
Loop detection ......................................................................................................................384
show loopd ............................................................................................................................384
show loopd interface .............................................................................................................385
Commands in the global configuration mode .......................................................................386
loopd .....................................................................................................................................386
no loopd ................................................................................................................................387
loopd vlan mode....................................................................................................................387
no loopd vlan mode...............................................................................................................388
Commands in the Interface Configuration mode ..................................................................389
loopd {blocked | forwarder | sender} .....................................................................................389
loopd {tx-interval | detect-threshold | reaction-timeout} ........................................................390
loopd port reset .....................................................................................................................391
no loopd port reset ................................................................................................................392
loopd reaction local ...............................................................................................................392
no loopd reaction local ..........................................................................................................393
loopd reaction remote ...........................................................................................................394
no loopd reaction remote ......................................................................................................395
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
13
Table of contents
Index ...................................................................................................................................................397
SCALANCE XB-200 Command Line Interface
14
Configuration Manual, 04/2015, C79000-G8976-C361-02
1
Introduction
1.1
Information on the Configuration Manual
Validity of this configuration manual
This Configuration Manual covers the following products:
● SCALANCE XB-200
Below, the products are also called IE switches.
There are two variants of each device with different article numbers. The two variants
differ only in their factory settings. All other properties are identical.
This Configuration Manual applies to the following software version:
● SCALANCE XB-200 firmware as of version 1.1
Factory settings
EtherNet/IP variants
● Industrial Ethernet protocol: EtherNet/IP
● Redundancy mechanism: RSTP
PROFINET variants
● Industrial Ethernet protocol: PROFINET
● Redundancy mechanism: Ring redundancy
Purpose of the Configuration Manual
This Configuration Manual is intended to provide you with the information you require to
install, commission and operate IE switches. It provides you with the information you require
to configure the IE switches.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
15
Introduction
1.1 Information on the Configuration Manual
Orientation in the documentation
Apart from the configuration manual you are currently reading, the products also have the
following documentation:
● Configuration manual "SCALANCE XB-200 Web Based Management"
This document is intended to provide you with the information you require to commission
and configure SCALANCE XB-200 IE switches using the Web Based Management.
● Operating Instructions "SCALANCE XB-200"
This document contains information on installing, connecting up and approvals for the
products.
Further documentation
In the system manuals "Industrial Ethernet / PROFINET Industrial Ethernet" and "Industrial
Ethernet / PROFINET passive network components", you will find information on other
SIMATIC NET products that you can operate along with the devices of this product line in an
Industrial Ethernet network.
There, you will find among other things optical performance data of the communications
partner that you require for the installation.
You will find the system manuals here:
● On the data medium that ships with some products:
– Product CD / product DVD
– SIMATIC NET Manual Collection
● On the Internet pages of Siemens Industry Online Support under the following entry IDs:
– 27069465 (http://support.automation.siemens.com/WW/view/en/27069465)
Industrial Ethernet / PROFINET Industrial Ethernet System Manual
– 84922825 (http://support.automation.siemens.com/WW/view/en/84922825)
Industrial Ethernet / PROFINET - Passive network components System Manual
SIMATIC NET manuals
You will find the SIMATIC NET manuals here:
● On the data medium that ships with some products:
– Product CD / product DVD
– SIMATIC NET Manual Collection
● On the Internet pages of Siemens Industry Online Support
(http://support.automation.siemens.com/WW/view/en).
SCALANCE XB-200 Command Line Interface
16
Configuration Manual, 04/2015, C79000-G8976-C361-02
Introduction
1.1 Information on the Configuration Manual
SIMATIC NET glossary
Explanations of many of the specialist terms used in this documentation can be found in the
SIMATIC NET glossary.
You will find the SIMATIC NET glossary here:
● SIMATIC NET Manual Collection or product DVD
The DVD ships with certain SIMATIC NET products.
● On the Internet under the following entry ID:
50305045 (http://support.automation.siemens.com/WW/view/en/50305045)
Security information
Siemens provides products and solutions with industrial security functions that support the
secure operation of plants, solutions, machines, equipment and/or networks. They are
important components in a holistic industrial security concept. With this in mind, Siemens’
products and solutions undergo continuous development. Siemens recommends strongly
that you regularly check for product updates.
For the secure operation of Siemens products and solutions, it is necessary to take suitable
preventive action (e.g. cell protection concept) and integrate each component into a holistic,
state-of-the-art industrial security concept. Third-party products that may be in use should
also be considered. For more information about industrial security, visit
http://www.siemens.com/industrialsecurity.
To stay informed about product updates as they occur, sign up for a product-specific
newsletter. For more information, visit http://support.automation.siemens.com.
License conditions
Note
Open source software
Read the license conditions for open source software carefully before using the product.
You can download the license conditions in the WBM on the "System > Load&Save" page.
Trademarks
The following and possibly other names not identified by the registered trademark sign ® are
registered trademarks of Siemens AG:
SIMATIC NET, SCALANCE, C-PLUG, OLM
Firmware
The firmware is signed and encrypted. This ensures that only firmware created by Siemens
can be downloaded to the device.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
17
Introduction
1.1 Information on the Configuration Manual
SCALANCE XB-200 Command Line Interface
18
Configuration Manual, 04/2015, C79000-G8976-C361-02
General information
2.1
2
General information on the Command Line Interface
Introduction
All the configuration settings for the device can be made using the Command Line Interface
(CLI). The CLI therefore provides the same options as Web Based Management (WBM).
You should therefore also read the detailed explanations of the parameters in the
SCALANCE XB-200 Web Based Management configuration manual.
The CLI also allows remote configuration over Telnet.
Starting the CLI in a Windows console
Follow the steps outlined below to start the Command Line Interface in a Windows console:
1. Open a Windows console and type in the command "telnet" followed by the IP address
of the device you are configuring:
C:\>telnet <IP address>
2. Enter your login and password.
As an alternative, you can also enter the command "telnet" in the Start > Run menu
followed by the IP address of the device you are configuring.
Note
Command sets depend on the logged-in user. Changing configuration data is possible only
with the "admin" login.
Requirement for use of the CLI
You should only use the command line interface if you are an experienced user.
Even commands that bring about fundamental changes to the configuration are executed
without a prompt for confirmation.
Errors in the configuration can mean that no further operation is possible in the entire
network.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
19
General information
2.2 Structure of the Command Line Interface
2.2
Structure of the Command Line Interface
Grouping of the commands in the various modes
The commands of the Command Line Interface are grouped according to various modes.
Apart from a few exceptions (help, exit), commands can only be called up in the mode to
which they are assigned. This grouping allows different levels of access rights for each
individual group of commands. The following graphic is an overview of the available modes.
User EXEC mode
This mode is active after you log in with the user name user in a console window. In this
mode, you can use show commands to display the current values of configuration
parameters. It is not possible to modify parameters in this mode.
To be able to modify configuration parameters, you need to change to the Privileged EXEC
mode.
Privileged EXEC mode
You change to this mode if you log in with the name "admin" or enter the command enable in
User EXEC mode. There are two ways of exiting the Privileged EXEC mode:
1. The exit command logs you out; the Login Prompt prompt appears.
2. The disable command brings you back one level from the Privileged EXEC mode to the
User EXEC mode. (The disable command is not available in the User EXEC mode.)
SCALANCE XB-200 Command Line Interface
20
Configuration Manual, 04/2015, C79000-G8976-C361-02
General information
2.3 Configuration limits
Global configuration mode
In this mode, you can make basic configuration settings. In addition to this, you can also call
up modes for the configuration of special interfaces or functions, for example to configure a
VLAN. You change to this mode by entering configure terminal in the Privileged EXEC
mode. To exit this mode, enter end.
Other configuration modes
From the Global configuration mode, you can change to other configuration modes for
special tasks. These are either general configuration modes (for example line configuration,
interface configuration) or protocol-specific configuration modes (SNTP, NTP).
2.3
Configuration limits
Configuration limits of the device
The following table lists the configuration limits for Web Based Management and the
Command Line Interface of the device.
The ability to use various functions depends on the device type being used.
Configurable function
System
Syslog server
3
E-mail server
3
SNMP trap recipient
1
NTP server
1
Virtual LANs (including VLAN 1)
Mirroring sessions
Security
10
SNTP server
Agent interfaces
Layer 2
Maximum number
1
17
1
Unicast filtering
128
Multicast groups
256
Static MAC addresses in the forward database (FDB)
128
IP addresses from RADIUS servers
Management ACLs (access rules for management)
3
10
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
21
General information
2.4 Features not supported
2.4
Features not supported
The following features are not supported by the IE switches SCALANCE XB-200 with
firmware version 1.1:
● Multiple Spanning Tree Protocol (MSTP)
● Link Aggregation/Port Channel
● Out-of-band interface (cpu0)
● Loopback
● Layer 3 features
● IPv6
● FQDN
Even if these features are listed as parameters in the documentation and are displayed with
the help functions help and ?, you cannot execute them with a SCALANCE XB-200.
SCALANCE XB-200 Command Line Interface
22
Configuration Manual, 04/2015, C79000-G8976-C361-02
General information
2.5 The CLI command prompt
2.5
The CLI command prompt
Overview
The Command Line Interface prompt shows the following information:
● The mode in which the CLI is currently operating.
Most commands can only be called in a particular mode. You should therefore check the
CLI mode based on the command prompt.
– User Exec mode: CLI>
– Privileged Exec mode and configuration modes: CLI(...)#
● The selected interface when the CLI is in an Interface Configuration mode.
In the Interface Configuration mode, the parameters are configured for one specific
interface. The command prompt is displayed in the form CLI(config-if-$$$)# where the
placeholder $$$ is replaced by the identifier of the Interface. You select the Interface by
setting suitable parameters for the interface command.
● An identifier when the Trial mode is enabled.
If you first test changes to the configuration and then want to discard them, disable the
Auto save function with the no auto-save command. You are then in Trial mode.
Changes to the configuration that you have not saved are indicated by an asterisk in front
of the command prompt: *CLI(...)#.
You save the changes to the configuration with the command write startup-config. With
the auto-save command, you enable the Auto save function again.
Note
Upper and lower case
The Command Line Interface does not distinguish between upper case and lower case
letters.
Make sure, however, that names used by the operating system or other programs are
correctly written.
Blank
To use blanks in a text, enter the text in quotes, for example "H e l l o"
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
23
General information
2.6 Symbols of the CLI commands
2.6
Symbols of the CLI commands
Symbols for representing CLI commands
When setting parameters for CLI commands, the following characters are used:
Character
Meaning
< ... >
mandatory parameter
Instead of the expression in parenthesis, you must enter a
value
[ ... ]
optional parameter
Instead of the expression in parenthesis, you can enter a
value
( ... )
Value or range of values
Enter a value to replace the expression in parenthesis
( ... - ... )
Range of values
Enter a value from this range
{ ... }
Selection list
Select one more elements from the list
{ ... | ... }
exclusive selection
Select exactly one element from this list
These characters are used in combinations to describe mandatory and optional entries.
There is a general description of some of these combinations below:
Character combinations
Meaning
< variable >
Instead of the expression in parentheses<>, enter a
permitted value
< variable (a - b) >
Instead of the expression in parentheses <>, enter a
value from the range "a" to "b"
[< variable 1 >< variable 2 >]
The parameter pair is optional.
If you use the parameter assignment, you need to
enter a permitted value to replace both expressions in
parenthesis <>
[ keyword < variable (a - b)>]
The parameter assignment is optional.
If you use the keyword, you need to enter a value
from the range "a" to "b" to replace the expression in
parenthesis <>
[ keyword < variable (a - b) unit >]
The parameter assignment is optional.
If you use the keyword, you need to enter a value
from the range "a" to "b" to replace the expression in
parenthesis <>.
"Unit" is one of the variables and is also replaced by
the entry.
[keyword { A | B | C }]
The parameter assignment is optional.
If you use the keyword, you need to specify exactly
one of the values "A", "B" or "C"
keyword { [A] [B] [C] }
After the keyword, enter one or more of the values
"A", "B" or "C"
SCALANCE XB-200 Command Line Interface
24
Configuration Manual, 04/2015, C79000-G8976-C361-02
General information
2.7 Addresses and interface names
2.7
Addresses and interface names
2.7.1
Naming interfaces
Addressing interfaces
The devices have several types of interface that are addressed in different ways.
Addressing physical interfaces
The following notation applies to all commands that address a physical interface:
● Enter the command "interface".
● Specify the interface type <interface-type>.
● After a space, enter the interface identifier,
<interface-id>.
The interface identifier is made up of the module number and the port number separated
by a slash.
You call a Fast Ethernet interface on the second port of module 0 with the following
command. interface fa 0/2
Addressing logical interfaces
The following notation applies to all commands that address a logical interface:
● Enter the command "interface".
● Enter the keyword for the logical interface, vlan.
● After a space, enter the number of the interface you assigned when you created it, <vlanid(1-4094)>.
You call VLAN ports as follows: interface vlan 1
Available physical interfaces
Available interface types
SCALANCE XB-200 support the following interface types:
interface-type
fast-ethernet
Abbreviation/acronym
fa
Available interface identifiers
All physical interfaces of the SCALANCE XB-200 are called module 0.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
25
General information
2.7 Addresses and interface names
Available logical interfaces
● VLAN
The device supports up to 17 VLANs.
To be able to use a VLAN, create it with the vlan command.
Identification of the interfaces in the command prompt of the Interface configuration mode
To configure the interface use the command interface in the global configuration mode.
Since you configure precisely one of the existing interfaces in the Interface configuration
mode, the command prompt shows not only the mode but also the name of this interface.
The command prompt is as follows:
cli(config-if-$$$)#
The placeholder $$$ is replaced by the following name of the interface:
Type of interface
fast-ethernet
vlan
Command prompt
cli(config-if-Fa0-$) #
cli(config-if-vlan-$)#
The placeholders $ or $-$ denote the numbering of the interface.
2.7.2
Address types, address ranges and address masks
Overview
Since the various types of addresses can be represented by different notations, the notations
used in the Command Line Interface are shown below:
● IPv4 addresses
Addresses for the Internet Protocol version 4 are written in the decimal notation of four
numbers from the range 0 to 255, separated by a period.
Note
With leading zeros, the numbers are interpreted as octal numbers, e.g.: 192.168.070.071
→ 192.168.56.57.
● Network masks
A network mask is a series of bits that describes the network part of an IP address.
The notation is normally decimal in keeping with the IP address.
● Alternative notation for network masks
In contrast to the notation described above, network masks can also be represented as a
number of 1 bits. The mask of the decimal representation 255.255.0.0 is then written as
/16.
The syntax is then for example: <ipaddress> / 16
Note that there must be a space before and after the "/".
SCALANCE XB-200 Command Line Interface
26
Configuration Manual, 04/2015, C79000-G8976-C361-02
General information
2.8 General CLI commands
● MAC addresses
In the syntax of the Command Line Interface, a MAC address is represented as a
sequence of 6 bytes in hexadecimal format, in each case separated by a colon.
The syntax is then, for example aa:aa:aa:aa:aa:aa
● Multicast addresses
Layer 2 multicast addresses as used on this device use the notation of MAC addresses.
For permitted address ranges, check the rules or ask your network administrator.
2.8
General CLI commands
This section describes commands that you can call up in any mode.
2.8.1
clear screen
Description
With this command, you clear the screen.
The command prompt is displayed.
Syntax
Call the command without parameters:
clear screen
Result
The screen is cleared.
The command prompt is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
27
General information
2.8 General CLI commands
2.8.2
end
Description
With this command, you close all configuration modes.
You are then in the Privileged EXEC mode.
Requirement
You are in a configuration mode.
Syntax
Call the command without parameters:
end
Result
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
2.8.3
exit
Description
With this command, you close the current mode.
You are then at the next higher level in the user modes.
If you are in Privileged EXEC Modus or in User EXEC Modus mode, you will be logged out.
Syntax
Call the command without parameters:
exit
Result
The current mode was exited.
SCALANCE XB-200 Command Line Interface
28
Configuration Manual, 04/2015, C79000-G8976-C361-02
General information
2.8 General CLI commands
2.8.4
Help functions and supported input
The Command Line Interface provides various functions that are helpful when making
entries in the command line:
● help
● ?
● Command completion with the tab key
● Automatic completion of incomplete commands
● Paging in the list of most recently used commands
● Display of the list of most recently used commands (show history)
2.8.4.1
help
Description
With this command, you display the help entry for a command or the command list.
Syntax
Call up help with the following parameters:
help [command]
Here, you replace [command] with the command for which you require help.
If the command for which you require help consists of several words, enter these words
without spaces.
Result
The syntax of the command is displayed.
Syntax
If you call up help without parameters, you will obtain a list of all permitted commands in the
current mode:
help
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
29
General information
2.8 General CLI commands
Result
The mode-specific as well as the global commands are displayed.
Note
Incomplete command names
If you have specified an incomplete command when calling help, a list of all commands that
start with the term you have entered is created.
2.8.4.2
The command "?"
Description
With this command, you call up the command list.
Syntax
Enter a question mark to obtain a list of all permitted commands in the current mode:
?
For this command, you do not need to press the enter key. The command executes
immediately after you type the character.
Result
The mode-specific as well as the global commands are displayed.
Note
Incomplete command names
If you have specified an incomplete command when calling the help function, a list of all
commands that start with the term you have entered is created.
Note
Output in pages
With long lists, the results are displayed as pages. If -- more -- appears at the lower edge of
the display, you can move to the next page with the spacebar. If the display is in pages, you
cannot page back. You exit the page display with the q key.
SCALANCE XB-200 Command Line Interface
30
Configuration Manual, 04/2015, C79000-G8976-C361-02
General information
2.8 General CLI commands
2.8.4.3
Completion of command entries
Description
The command interpreter of the Command Line Interface supports you when you enter
commands.
As soon as the first characters of the command have been entered in the input line, the
system can complete the entry as long as the character string is unambiguous.
This can be repeated after entering further characters.
Procedure
Enter the first characters of the command.
Press the tab key.
Result
The command interpreter completes the input as long as the command is unambiguous.
If you enter a character string that cannot be completed to form a command, an error
message is displayed.
● The command is not unique: % Ambiguous Command
● The command is unknown: % Invalid Command
● The command is incomplete: % Incomplete command
If the entry is not yet complete, enter further characters.
With ?, you obtain a list of the possible commands.
Repeat this if necessary until the command is complete and can execute.
2.8.4.4
Abbreviated notation of commands
Description
The command interpreter of the Command Line Interface also detects commands if only the
first character of the command or its parts is entered.
This is only possible if all the parts of the abbreviated input can be assigned to exactly one
command or to the parts of the command.
Example
The show event config command can be replaced by the expression sh e c.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
31
General information
2.8 General CLI commands
2.8.4.5
Reusing the last used commands
Description
The Command Line Interface saves the last 14 commands used in a list assigned to the
particular mode. This can then only be called up in the relevant mode.
Example:
In the Global Configuration mode, all entered commands are saved. If you entered
commands earlier in the Interface Configuration mode, these commands are not included in
the list of the Global Configuration mode. You can only call up and reuse these commands in
the Interface Configuration mode.
Procedure
You can page through the list of the commands most recently used using the arrow up and
arrow down keys.
If the command you are looking for is displayed, you can edit the command line as required
and execute the command with the enter key.
Further notes
You display the list of commands last used with the show history command. This function is
available in every mode.
2.8.4.6
Working through a command sequence
Separators for multiple commands in one line
You can call up several commands one after the other in one line in the CLI.
Separate the commands with a semicolon (;).
After completing your input, start the processing of this command sequence with the enter
key.
Example
The command sequence
CLI#conf t; int vlan 1; no ip address dhcp; ip address 192.168.1.1 255.255.255.0;
end; write startup
has the same effect as:
CLI#conf t
CLI(config)#int vlan 1
CLI(config-if-vlan-1)#no ip address dhcp
CLI(config-if-vlan-1)#ip address 192.168.1.1 255.255.255.0
CLI(config-if-vlan-1)#end
CLI#write startup
SCALANCE XB-200 Command Line Interface
32
Configuration Manual, 04/2015, C79000-G8976-C361-02
General information
2.8 General CLI commands
2.8.4.7
show history
Description
This command shows the last 14 commands you entered.
The commands are listed in the order in which they were called up. The show history
command is listed as the last command to be entered.
The list depends on the mode. In the Global configuration mode, the last 14 commands
entered in this mode are displayed. These commands are not included in the list of the
Interface configuration mode.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show history
Result
The list of used commands is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
33
General information
2.8 General CLI commands
2.8.4.8
clear history
Description
This command deletes the last commands you entered.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
clear history
Result
The last commands to be input are deleted.
You display a list of the last 14 commands entered with the show history command.
SCALANCE XB-200 Command Line Interface
34
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3
The following is described in this section:
● System settings
● Saving and loading configurations and firmware
3.1
System
This section describes commands with which general system properties can be displayed
and configured.
3.1.1
The "show" commands
This section describes commands with which you display various settings.
3.1.1.1
show cli-console-timeout
Description
This command shows the global configuration for the timeout of the CLI console.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show cli-console-timeout
Result
The configuration for the timeout is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
35
Configuration
3.1 System
3.1.1.2
show coordinates
Description
This command shows the system coordinates.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show coordinates
Result
The system coordinates are displayed.
3.1.1.3
show device information
Description
This command shows information about the device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show device information
Result
The information about the device is displayed.
SCALANCE XB-200 Command Line Interface
36
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.1.4
show ethernetip
Description
This command shows the current EtherNet/IP configuration.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ethernetip
Result
The current EtherNet/IP configuration is displayed.
3.1.1.5
show hardware
Description
This command shows the type and number as well as the position of the installed interface
cards of the system.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show hardware
Result
The table of interface cards is displayed.
The slot ID, the status and the type or name of the card is listed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
37
Configuration
3.1 System
Note
With SCALANCE XB-200, the slot ID is always 0. The table therefore shows precisely one
row.
3.1.1.6
show im
Description
This command shows information on device-specific vendor and maintenance data such as
the article number, serial number, version numbers etc.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show im
Result
The information is displayed.
3.1.1.7
show interface mtu
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you show the setting for the Maximum Transmission Unit (MTU) of the
interfaces on the device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
38
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
show interface mtu [{vlan<vlan-id(1-4094)>|
port-channel<port-channel-id(1-8)>|
<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
vlan
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
port-channel
Keyword for a port channel connection
-
port-channel-id
Number of the addressed port channel
1 ... 8
Type of interface
Enter a valid interface.
vlan-id
interface-type
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If no parameters are specified, the settings for all interfaces are displayed.
Result
The settings for the maximum transmission unit (MTU) of interfaces are displayed.
3.1.1.8
show interfaces
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
This command shows the status and the configuration of one, several or all interfaces.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
39
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
show interfaces
[{
[<interface-type><interface-id>]
[{description|stormcontrol|flowcontrol|status}]
|
{vlan<vlan-id(1-4094)>}
|
port-channel<port-channel-id(1-8)>
}]
The parameters have the following meaning:
Parameter
interface-type
interface-id
Description
Range of values / note
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
description
Shows the description of the interface
-
stormcontrol
Shows the storm control settings
-
flowcontrol
Shows the flow control settings
-
status
Shows the status of the interface
-
vlan
Keyword for a VLAN connection
-
vlan-id
Number of the addressed VLAN
1 ... 4094
port-channel
Keyword for a port channel connection
-
port-channel-id
Number of the addressed port channel
1 ... 8
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the status and configuration of
all available interfaces will be displayed.
Result
The status and the configuration of the selected interfaces are displayed.
3.1.1.9
show interfaces ... counters
Description
This command shows the counters of one, several or all interfaces.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
40
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
show interfaces
[{<interface-type><interface-id>]|{vlan<vlan-id(1-4094)>}]counters
The parameters have the following meaning:
Parameter
interface-type
interface-id
Description
Range of values / note
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
vlan
Keyword for a VLAN connection
-
vlan-id
Number of the addressed VLAN
1 ... 4094
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available counters.
Result
The counters of the selected interfaces are displayed.
3.1.1.10
show ip interface
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
show ip interface
Description
This command shows the configuration of one, several or all IP interfaces.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
41
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
show ip interface
[{
vlan <vlan-id(1-4094)> |
<interface-type> <interface-id> |
loopback
}]
The parameters have the following meaning:
Parameter
vlan
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
interfacetype
interface-id
Type or speed of the interface
Enter a valid interface.
loopback
Loopback
vlan-id
Module no. and port no. of the interface
-
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
If you do not select any parameter from the parameter list, the configuration is displayed for
all available IP interfaces.
Result
The configuration of the selected IP interface is displayed.
3.1.1.11
show pnio
Description
This command shows the current PROFINET IO configuration.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show pnio
SCALANCE XB-200 Command Line Interface
42
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Result
The current PROFINET IO configuration is displayed.
3.1.1.12
show lldp neighbors
Description
This command shows the current content of the neighborhood table.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameter assignment:
show lldp neighbors
Result
The neighborhood table is displayed.
3.1.1.13
show lldp status
Description
This command shows per port whether LLDP frames are sent or received.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show lldp status[{port<interface-type><interface-id>}]
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
43
Configuration
3.1 System
The parameters have the following meaning:
Parameter
port
interface-type
interface-id
Description
Values
Keyword for a port description.
-
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on identifiers of interfaces and addresses, refer to the section "Addresses
and interface names (Page 25)".
Result
The information is displayed.
3.1.1.14
show broadcast-block config
Description
This command shows the broadcast blocking settings for ports.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show broadcast-block config [port<interface-type><interface-id)>]
The parameters have the following meaning:
Parameter
port
Description
Range of values / note
Keyword for a port description
-
interface-type
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The broadcast blocking settings for ports are displayed.
SCALANCE XB-200 Command Line Interface
44
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.1.15
show unicast-block config
Description
This command shows the unicast blocking settings for ports.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show unicast-block config [port<interface-type><interface-id)>]
The parameters have the following meaning:
Parameter
port
interface-type
interface-id
Description
Range of values / note
Keyword for a port description
-
Type or speed of the interface
Enter a valid interface
Module no. and port no. of the interface
For information on names of interfaces and addresses, refer to the section "Addresses and
interface names (Page 25)".
Result
The unicast blocking settings for ports are displayed.
3.1.1.16
show multicast-block config
Description
This command shows the multicast blocking settings for ports.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
45
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
show multicast-block config[port<interface-type><interface-id)>]
The parameters have the following meaning:
Parameter
port
interface-type
interface-id
Description
Range of values / note
Keyword for a port description
-
Type of interface
Enter a valid interface
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If no parameters are specified, the settings for all ports are displayed.
Result
The multicast blocking settings for ports are displayed.
3.1.1.17
show versions
Description
This command shows the version information of the entire system.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show versions
Result
The version information of the entire system is displayed.
SCALANCE XB-200 Command Line Interface
46
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.2
clear counters
Description
With this command, you reset the counters of an interface.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call up the command with the following parameters:
clear counters [<interface-type><interface-id>]
The parameters have the following meaning:
Parameter
interface-type
interface-id
Description
Range of values / note
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
If no parameters are specified, the counters for all interfaces are reset.
Result
The counters of the interface are reset.
Further notes
You can display the statistical information of the interfaces with the show interfaces counters command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
47
Configuration
3.1 System
3.1.3
configure terminal
Description
With this command, you change to the Global configuration mode.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call the command without parameters:
configure terminal
Result
You are now in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Further notes
You exit the Global configuration mode with the end command.
3.1.4
disable
Description
With this command, you close the Privileged EXEC mode.
You are then in the User EXEC mode.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
SCALANCE XB-200 Command Line Interface
48
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Syntax
Call the command without parameters:
disable
Result
You are in the User EXEC mode.
The command prompt is as follows:
cli>
3.1.5
enable
Description
With this command, you change to the Privileged EXEC mode.
Requirement
You are in the User EXEC mode.
The command prompt is as follows:
cli>
Syntax
Call the command without parameters:
enable
Result
You are prompted to enter the administrator password. After logging in successfully, you are
in the Privileged EXEC mode.
The command prompt is as follows:
cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
49
Configuration
3.1 System
3.1.6
logout
Description
With this command, you exit the Command Line Interface.
If you are connected to the device via telnet, the session is closed.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
logout
Result
The CLI session is ended and the Windows Login prompt is displayed.
3.1.7
ping
Description
With this command, you request a response from a device in the network.
This allows you to check whether or not another node is reachable.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
ping [ip]<destination-address>
[size<byte(0-2080)>]
[count<packet_count(1-10)>]
[timeout<seconds(1-100)>]
SCALANCE XB-200 Command Line Interface
50
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
The parameters have the following meaning:
Parameter
Description
Range of values
Uses an IP address
-
Address of the called node
Enter a valid IP address or a valid
hostname.
size
Keyword for the size of the packets to be
transferred
-
byte
Keyword for the size of the packets in bytes 0 … 2080
ip
destinationaddress
count
packet_count
timeout
Keyword for the number of packets to be
requested
-
Number of packets
1 … 10
Response wait time
-
If this time expires, the request is reported
as "timed out".
seconds
Time to the timeout in seconds
1 … 100
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default values are used.
At system start or when using the restart command with the option memoryor factory, the
following defaults apply:
Parameter
size
count
time-out
Default value
32
3
1
Result
The messages relating to the response of the called node are displayed.
3.1.8
clear line vty
Description
With this command, you close a console session on the device.
With the forceful-clear option, you close a session and that is not reacting.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
51
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
clear line vty {<line-number(2-9)>|all}[forceful-clear]
The parameters have the following meaning:
Parameter
Description
Range of values / note
Number of the connection that will be
terminated
2 ... 9
all
terminates all connections
-
forceful-clear
closes a session that is not reacting
-
line-number
Result
The console session is closed.
Further notes
You show the logged-on users with the show users command.
See also
Addresses and interface names (Page 25)
3.1.9
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
52
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.9.1
interface
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you change to the Interface configuration mode.
There you can edit the settings for one interface. You select the interface with the
parameters of this command. If you specify a logical interface that does not exist, it will be
created. The name of the selected interface is displayed in the command prompt.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
interface {cpu0|vlan<vlan-id(1-4094)>|port-channel<port-channel-id(1-8)>|<interfacetype><interface-id>}
The parameters have the following meaning:
Parameter
cpu0
vlan
Description
Values
The configuration mode for the "Out-of-Band
interface" is called up.
-
Keyword for a VLAN connection
-
vlan-id
Number of the addressed VLAN
1 … 4094
port-channel
Keyword for a port channel connection
-
port-channel-id
Number of the addressed port channel
1…8
interface-type
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
53
Configuration
3.1 System
The placeholder $$$ is replaced by the following name of the interface:
Type of interface
vlan
fast-ethernet
Command prompt
cli(config-if-vlan-$)#
cli(config-if-Fa$-$)#
The placeholders $ or $-$ denote the numbering of the interface.
For the value ranges for the VLAN logical interface, refer to the upper table. You can only
call up interfaces that you created with the vlan command.
The ranges of values from the physical interfaces depend on the hardware configuration.
Further notes
You exit the Interface configuration mode with the end or exit command.
You delete a logical interface with the no interface command.
You display the status and the configuration of the interfaces with the show interfaces
command.
3.1.9.2
no interface
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you delete a logical interface.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no interface{vlan<vlan-id(1-4094)>|port-channel<port-channel-id(1-8)>}
SCALANCE XB-200 Command Line Interface
54
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
The parameters have the following meaning:
Parameter
vlan
vlan-id
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 … 4094
port-channel
Keyword for a port channel connection
-
port-channel-id
Number of the addressed port channel
1…8
For information on addresses and interfaces, refer to the section "Addresses and interface
names (Page 25)".
Result
The logical interface is deleted.
Further notes
You configure an interface with the interface command.
You display the status and the configuration of the interfaces with the show interfaces
command.
3.1.9.3
cli-console-timeout
Description
With this command, you enable the automatic logout and you configure the timeout setting
for the CLI.
Note
No automatic logout from the CLI
If the connection is not terminated after the set time, check the setting of the "keepalive"
function on the Telnet client. If the set interval is shorter than the configured time, the lower
value applies. You have set, for example, 300 seconds for the automatic logout and 120
seconds for the "keepalive" function. In this case, a packet is sent every 120 seconds that
keeps the connection up.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
55
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
cli-console-timeout [seconds(60-600)]
The parameters have the following meaning:
Parameter
seconds
Description
Range of values / note
Time in seconds until automatic logout
after the last entry
Default: 300
60 ... 600
Result
The time is configured and automatic logout is enabled.
Further notes
You disable automatic logout with the no cli-console-timeout command.
You display the current timeout setting with the show cli-console-timeout command.
3.1.9.4
no cli-console-timeout
Description
With this command, you disable the automatic logout.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no cli-console-timeout
Result
Automatic logout is disabled.
Further notes
You enable automatic logout with the cli-console-timeout command.
You display the current timeout setting with the show cli-console-timeout command.
SCALANCE XB-200 Command Line Interface
56
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.9.5
coordinates height
Description
With this command, you enter a height coordinate.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
coordinates height <meter>
The parameter has the following meaning:
Parameter
meter
Description
Range of values / note
Input box for the height coordinate
max. 32 characters
To use spaces in the entry, enter
the height coordinate in quotes:
coordinates height "123 456"
Result
The height coordinate is created.
3.1.9.6
coordinates latitude
Description
With this command, you enter a latitude coordinate.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
coordinates latitude <latitude>
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
57
Configuration
3.1 System
The parameter has the following meaning:
Parameter
latitude
Description
Range of values / note
Input box for the latitude coordinate
max. 32 characters
To use spaces in the entry, enter
the latitude coordinate in quotes:
coordinates latitude "123
456"
Result
The latitude coordinate is created.
3.1.9.7
coordinates longitude
Description
With this command, you enter a longitude coordinate.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
coordinates longitude <longitude>
The parameter has the following meaning:
Parameter
longitude
Description
Range of values / note
Input box for the longitude coordinate
max. 32 characters
To use spaces in the entry, enter
the longitude coordinate in
quotes: coordinates longitude
"123 456"
Result
The longitude coordinate is created.
SCALANCE XB-200 Command Line Interface
58
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.9.8
ethernetip
Description
With this command, you set whether EtherNet/IP will be enabled or disabled after the next
device restart.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
ethernetip [off|on]
The parameters have the following meaning:
Parameter
off
on
Description
Range of values / note
EtherNet/IP will be disabled after the next
restart.
-
EtherNet/IP will be enabled after the next
restart.
If a PROFINET connection is established; in other words the PNIO AR
status is "Online", you cannot enable
EtherNet/IP.
Result
EtherNet/IP is enabled or disabled after the next restart.
Further notes
You can display the current EtherNet/IP configuration with the show ethernetip command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
59
Configuration
3.1 System
3.1.9.9
pnio
Description
With this command, you configure the setting for PNIO after the next restart of the device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
pnio [off | on]
The parameters have the following meaning:
Parameter
off
on
Description
Range of values / note
PNIO is deactivated.
If a PROFINET connection is established; in
other words the PNIO AR status is "Online",
you cannot disable PNIO.
PNIO is activated.
-
Result
PNIO is enabled or disabled after the next restart.
Further notes
You display the current PNIO configuration with the show pnio command.
3.1.9.10
system contact
Description
With this command, you enter contact information for the system.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
60
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
system contact <string>
The parameter has the following meaning:
Parameter
string
Description
Range of values / note
Input box for contact information
max. 255 characters
Result
The contact information is created in the system.
3.1.9.11
system location
Description
With this command, you enter the location information for the system.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
system location <string>
The parameter has the following meaning:
Parameter
string
Description
Range of values / note
Input box for the location information
max. 255 characters
Result
The location information is created in the system.
3.1.9.12
system name
Description
This command, you enter a name for the system.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
61
Configuration
3.1 System
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
system name <string>
The parameter has the following meaning:
Parameter
string
Description
Range of values / note
Input box for the name
max. 255 characters
Result
The name is created in the system.
3.1.9.13
username
Description
With this command, you change the password of a user.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
username {user|admin}password<passwd>
The parameters have the following meaning:
Parameter
user
admin
password
passwd
Description
the password for the user is changed
the password for the administrator is changed
Keyword for a password
Value for the password
SCALANCE XB-200 Command Line Interface
62
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Result
The password is changed.
Note
Changing the password in Trial mode
Even if you change the password in Trial mode, this change is saved immediately.
3.1.10
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
3.1.10.1
alias
Description
With this command, you assign a name to an interface. The name only provides information
and has no effect on the configuration.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
alias <port-name>
The parameter has the following meaning:
Parameter
port-name
Description
Range of values / note
Name of the interface
max. 63 characters
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
63
Configuration
3.1 System
Result
The interface was assigned a name.
Further notes
You delete the name of the interface with the no alias command.
3.1.10.2
no alias
Description
With this command, you delete the name of the interface.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameter assignment:
no alias
Result
The name of the interface is removed.
Further notes
You configure the name of the interface with the alias command.
3.1.10.3
broadcast-block
Description
With this command, you enable the blocking of broadcast frames on an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
64
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Syntax
Call the command without parameter assignment:
broadcast-block
Result
Broadcast frames are blocked.
Further notes
You disable the blocking of broadcast frames with the no broadcast-block command.
3.1.10.4
no broadcast-block
Description
With this command, you disable the blocking of broadcast frames on an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameter assignment:
no broadcast-block
Result
The blocking of broadcast frames is disabled.
Further notes
You enable the blocking of broadcast frames with the broadcast-block command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
65
Configuration
3.1 System
3.1.10.5
duplex
Description
Electrical interfaces can be operated in full duplex mode or half duplex mode. The options
here depend on the connected device.
Optical connections are always operated in full duplex mode since they have a fiber for each
transmission direction.
With this command, you configure the duplex mode of an interface. The same mode must be
set for connected interfaces.
Requirement
● Autonegotiation is disabled.
● You are in the Interface configuration mode of an electrical interface.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
duplex {full|half}
The parameters have the following meaning:
Parameter
full
half
Description
Range of values / note
The Interface will be operated in full
duplex mode.
Default: full
The Interface will be operated in half
duplex mode
-
Result
The duplex mode of the interface is configured.
Further notes
You can reset the duplex mode of the Interface to the default value with the no duplex
command.
You disable autonegotiation with the no negotiation command.
SCALANCE XB-200 Command Line Interface
66
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.10.6
no duplex
Description
With this command, you reset the duplex mode of an interface to the default value.
The default value is full.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no duplex
Result
The duplex mode of the Interface is reset to the default value.
Further notes
You configure the duplex mode of the interface with the duplex command.
3.1.10.7
lldp
Description
With this command, you enable the sending and receipt of LLDP packets on the interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
lldp{transmit|receive}
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
67
Configuration
3.1 System
The parameters have the following meaning:
Parameter
transmit
receive
Description
Range of values / note
The sending of LLDP packets is enabled.
Default: enabled
The receipt of LLDP packets is enabled.
Default: enabled
Note
Enabling both options
When you call this command, you can only select one option.
If you want to enable both options, call up the command again.
Result
Sending or receipt of LLDP packets is enabled.
Further notes
You disable the sending or receipt of LLDP packets with the no lldp command.
3.1.10.8
no lldp
Description
With this command, you disable the sending or receipt of LLDP packets on the interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
no lldp{transmit|receive}
The parameters have the following meaning:
Parameter
transmit
receive
Description
the sending of LLDP packets is disabled
the receipt of LLDP packets is disabled
SCALANCE XB-200 Command Line Interface
68
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Note
Disabling both options
When you call this command, you can only select one option.
If you want to disable both options, call up the command again.
Result
Sending or receipt of LLDP packets is disabled.
Further notes
You enable the sending or receipt of LLDP packets with the lldp command.
3.1.10.9
multicast-block
Description
With this command, you enable the blocking of multicast frames on an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameter assignment:
multicast-block
Result
Multicast frames are blocked.
Further notes
You disable the blocking of multicast frames with the no multicast-block command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
69
Configuration
3.1 System
3.1.10.10
no multicast-block
Description
With this command, you disable the blocking of multicast frames on an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameter assignment:
no multicast-block
Result
The blocking of multicast frames is disabled.
Further notes
You enable the blocking of multicast frames with the mulitcast-block command.
3.1.10.11
negotiation
Description
With this command, you enable autonegotiation of connection parameters on an interface.
Autonegotiation must be set for every interface of connected interfaces.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
negotiation
SCALANCE XB-200 Command Line Interface
70
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
Result
The automatic negotiation of connection parameters on an interface is activated.
Further notes
You disable the autonegotiation of connection parameters with the no negotiation
command.
3.1.10.12
no negotiation
Description
With this command, you disable autonegotiation of connection parameters on an interface.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no negotiation
Result
The automatic negotiation of connection parameters on an interface is deactivated.
Further notes
You enable the autonegotiation of connection parameters with the negotiation command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
71
Configuration
3.1 System
3.1.10.13
shutdown
Description
With this command, you shut down the interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
shutdown [complete]
The parameter has the following meaning:
Parameter
Description
Range of values / note
without
parameters
The interface is disabled but the connection remains.
-
complete
The interface is disabled and the connection to the partner For every optical port that
device is terminated.
you disable with the shutdown complete command, the current
consumtion of the device
is reduced by 30 mA.
Result
The Interface is shut down.
If you execute this command without parameters, a connection remains displayed. The LED
for the port status flashes. However no data is sent or received.
Further notes
You activate the interface with the no shutdown command.
You can display the status of this function and other information with the show
interfacescommand.
SCALANCE XB-200 Command Line Interface
72
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.10.14
no shutdown
Description
With this command, you shut down an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no shutdown
Result
The Interface is activated.
Further notes
You deactivate the interface with the shutdown command.
You can display the status of this function and other information with the show interfaces
command.
3.1.10.15
speed
Description
With this command, you configure the transmission speed of an interface.
Note
Availability of this function
The transmission speed can only be configured for electrical data transfer.
On optical connections, the transmission speed is fixed.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
73
Configuration
3.1 System
Syntax
Call up the command with the following parameters:
speed {10|100}
The parameters have the following meaning:
Parameter
Description
10
Transmission speed 10 Mbps
100
Transmission speed 100 Mbps
Result
The transmission speed of the interface is configured.
3.1.10.16
unicast-block
Description
With this command, you enable the blocking of unknown unicast frames on an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameter assignment:
unicast-block
Result
Unicast frames are blocked.
Further notes
You disable the blocking of unicast frames with the no unicast-block command.
You display the status of this function with show unicast-block config.
SCALANCE XB-200 Command Line Interface
74
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.1 System
3.1.10.17
no unicast-block
Description
With this command, you disable the blocking of unknown unicast frames on an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameter assignment:
no unicast-block
Result
The blocking of unicast frames is disabled.
Further notes
You enable the blocking of unicast frames with the unicast-block command.
You display the status of this function with show unicast-block config.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
75
Configuration
3.2 Load and Save
3.2
Load and Save
This section describes commands for displaying, copying, saving and downloading files for
the device.
Note
Note that during the installation of a previous version, the configuration data can be lost. In
this case, the device starts up with the factory configuration settings after the firmware has
been installed.
3.2.1
File list
Overview of the file types
File type
Description
Config
Start configuration
ConfigPack
Detailed configuration information. for example, start configuration, users,
certificates
Copyright
OSS licenses
Debug
This file contains information for Siemens Support.
EDS
Electronic Data Sheet (EDS)
Electronic data sheets for describing devices in the EtherNet/IP mode
Firmware
Firmware
GSDML
Information on the device properties
HTTPSCert
HTTPS certificate
LogFile
File with entries from the event log table
MIB
Private MSPS MIB file "scalance_x_xb200_msps.mib"
RunningCLI
This file contains an overview of the current configuration in the form of CLI
commands. You can download the text file. The file is not intended to be uploaded again unchanged.
Script
CLI script file
StartupInfo
Startup log file
Users
File with user names and passwords
SCALANCE XB-200 Command Line Interface
76
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.2 Load and Save
3.2.2
show loadsave files
Description
This command shows the current Load&Save file information.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show loadsave files
Result
The current Load&Save file information is displayed.
3.2.3
show loadsave tftp
Description
This command shows the current configuration of the TFTP server for Load&Save.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show loadsave tftp
Result
The current configuration of the TFTP server for Load&Save is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
77
Configuration
3.2 Load and Save
3.2.4
load tftp
Description
With this command, you load the files from a TFTP server.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
load tftp ipv4 <ipv4-address> [port <tcp port (1-65535)>] file <filename> filetype
<filetype>
The parameters have the following meaning:
Parameter
Description
Range of values / note
Keyword for an IPv4 address
-
Value for an IPv4 unicast address
Enter a valid IPv4 unicast address.
port
Keyword for the port of the server via
which the TFTP connection runs
-
tcp port
Number of the port
1 … 65535
ipv4
ipv4-address
Default: 69
file
filename
Keyword for a file name to be assigned Name of the file
max. 100 characters
filetype
Keyword for the file type to be loaded
-
filetype
Name of the file type
max. 100 characters
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
Result
The file is loaded on the device from the TFTP server.
Further notes
With the "show loadsave files" command, you can display the file types.
SCALANCE XB-200 Command Line Interface
78
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.2 Load and Save
3.2.5
save filetype
Description
With this command, you save files on a TFTP server.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
save filetype <filetype> tftp ipv4 <ipv4-address> [port <tcp port (1-65535)>] file
<filename>
The parameters have the following meaning:
Parameter
filetype
filetype
Description
Range of values / note
Keyword for a file type to be loaded
-
Name of the file type
max. 100 characters
tftp
Keyword for a TFTP server
-
ipv4
Keyword for an IPv4 address
-
Value for an IPv4 unicast address
port
Enter a valid IPv4 unicast address.
Keyword for the port of the server via
which the TFTP connection runs
-
tcp port
Number of the port
ipv4-address
1 … 65535
Default: 69
file
filename
Keyword for a file name to be assigned Name of the file
max. 100 characters
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
Result
The file is saved on the TFTP server.
Further notes
With the "show loadsave files" command, you can display the file types.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
79
Configuration
3.2 Load and Save
3.2.6
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
3.2.6.1
loadsave
Description
With this command, you change to the LOADSAVE configuration mode.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
loadsave
Result
You are now in the LOADSAVE configuration mode.
The command prompt is as follows:
cli(config-loadsave)#
Further notes
You exit the LOADSAVE configuration mode with the exit command.
SCALANCE XB-200 Command Line Interface
80
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.2 Load and Save
3.2.7
Commands in the LOADSAVE configuration mode
This section describes commands that you can call up in the LOADSAVE configuration
mode.
In the Global Configuration mode, enter the loadsave command to change to this mode.
You display the valid file types for the commands in the LOADSAVE Configuration mode
with the global command show loadsave tftp.
● If you exit the LOADSAVE configuration mode with the exitcommand, you return to the
Global Configuration mode.
● If you exit the LOADSAVE configuration mode with the end command, you return to the
Privileged EXEC mode.
3.2.7.1
delete
Description
With this command, you call up the possible files or delete a specific file.
Requirement
You are in the LOADSAVE configuration mode.
The command prompt is as follows:
cli(config-loadsave)#
Syntax
Call up the command with the following parameters:
delete{showfiles|filetype<filetype>}
The parameters have the following meaning:
Parameter
showfiles
filetype
filetype
Description
Range of values / note
Shows the available files
-
Keyword for the file type to be deleted
-
Name of the file type
max. 100 characters
Result
The files are displayed or the file is deleted.
Further notes
With the "show loadsave files" command, you can display the file types.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
81
Configuration
3.2 Load and Save
3.2.7.2
password
Description
With this command, you activate and configure the password for a file.
Requirement
You are in the LOADSAVE configuration mode.
The command prompt is as follows:
cli(config-loadsave)#
Syntax
Call up the command with the following parameters:
password {showfiles|filetype<filetype>[pw<password>]}
The parameters have the following meaning:
Parameter
showfiles
filetype
filetype
Description
Values
Shows the available files
-
Shows that the file type follows that will be loaded
-
Name of the file type
max. 100 characters
pw
Keyword for the password
-
password
Password
Enter the password for the file.
Result
The password for the file is configured and activated.
Further notes
You disable the password with the no password command.
SCALANCE XB-200 Command Line Interface
82
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.2 Load and Save
3.2.7.3
no password
Description
With this command, you disable the password for a file.
Requirement
You are in the LOADSAVE configuration mode.
The command prompt is as follows:
cli(config-loadsave)#
Syntax
Call up the command with the following parameters:
no password {showfiles|filetype<filetype>}
The parameters have the following meaning:
Parameter
showfiles
filetype
filetype
Description
Values
Shows the available files
-
Shows that the file type follows that will be loaded
-
Name of the file type
max. 100 characters
Result
The password for the file is disabled.
Further notes
You enable the password for the user certificate with the password command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
83
Configuration
3.2 Load and Save
3.2.7.4
tftp filename
Description
With this command, you assign a name to a file type.
The file type decides the type that is affected by the tftp load or tftp save action. The
name decides the file to be copied to or from the TFTP server.
Requirement
You are in the LOADSAVE configuration mode.
The command prompt is as follows:
cli(config-loadsave)#
Syntax
Call up the command with the following parameters:
tftp filename {showfiles|filetype< filetype >name<filename>}
The parameters have the following meaning:
Parameter
Description
Range of values / note
Shows the available files
-
filetype
Keyword for a file type to be assigned
a name
-
filetype
Name of the file type
max. 100 characters
name
Keyword for a file name to be assigned to the file type
filename
Name of the file
showfiles
max. 100 characters
Result
The file types are displayed or the file type is assigned a name.
Further notes
With the "show loadsave files" command, you can display the file types.
SCALANCE XB-200 Command Line Interface
84
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.2 Load and Save
3.2.7.5
tftp load
Description
With this command, you load a file from a TFTP server into the file system of the device. The
TFTP protocol is used for the transfer. You can also display a list of available files.
Requirement
● The name of the file is specified
● You are in the LOADSAVE configuration mode.
The command prompt is:
cli(config-loadsave)#
Syntax
Call up the command with the following parameters:
tftp load{showfiles|filetype<filetype>}
The parameters have the following meaning:
Parameter
showfiles
filetype
filetype
Description
Range of values / note
Shows the available files
-
Keyword for a file type to be loaded
-
Name of the file type
max. 100 characters
Result
The file types are displayed or the file is downloaded to the device.
Further notes
You configure the name of the file with the tftp filename command.
With the "show loadsave files" command, you can display the file types.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
85
Configuration
3.2 Load and Save
3.2.7.6
tftp save
Description
With this command, you copy a file from the file system of the device to a TFTP server. The
TFTP protocol is used for the transfer. You can also display a list of available files.
Requirement
● The name of the file is specified
● You are in the LOADSAVE configuration mode.
The command prompt is:
cli(config-loadsave)#
Syntax
Call up the command with the following parameters:
tftp save {showfiles|filetype<filetype>}
The parameters have the following meaning:
Parameter
showfiles
filetype
filetype
Description
Range of values / note
Shows the available files
-
Keyword for a file type to be loaded
-
Name of the file type
max. 100 characters
Result
The file types are displayed or the file is copied.
Further notes
You configure the name of the file with the tftp filename command.
With the "show loadsave files" command, you can display the file types.
SCALANCE XB-200 Command Line Interface
86
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.2 Load and Save
3.2.7.7
tftp server
Description
With this command, you configure the access to a TFTP server.
Requirement
You are in the LOADSAVE configuration mode.
The command prompt is as follows:
cli(config-loadsave)#
Syntax
Call up the command with the following parameters:
tftp server ipv4 <ipv4-address>[port<tcp port(1-65535)>]
The parameters have the following meaning:
Parameter
ipv4
Description
Range of values / note
Keyword for an IPv4 address
-
ipv4-address
Value for an IPv4 unicast address
Enter a valid IPv4 unicast address.
port
Keyword for the port of the server via
which the TFTP connection runs
-
tcp port
Number of the port
1 … 65535
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
Result
The settings for the access to the selected TFTP server are configured.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
87
Configuration
3.3 Reset and Defaults
3.3
Reset and Defaults
This section describes commands for restarting the device and for restoring the original
configuration.
3.3.1
restart
Description
With this command, you restart the device.
Select one of the following configuration settings:
● Device restart with the current configuration
● Device restart with the factory configuration settings.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call up the command with the following parameters:
restart[{factory}]
The parameters have the following meaning:
Parameter
factory
Description
Restarts the system with the factory configuration settings
If you do not select any parameters from the parameter list, the system restarts with the
current configuration.
Result
The device is restarted with the selected settings.
SCALANCE XB-200 Command Line Interface
88
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.4 Configuration Save & Restore
3.4
Configuration Save & Restore
This section describes commands for displaying, saving and restoring configuration settings.
3.4.1
show running-config
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
This command shows configuration settings of the device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show running-config
[{
syslog|dhcp|qos|stp|la|pnac|vlan<vlan-id(1-4094)>|
interface
{port-channel<port-channel-id(1-8)>|
<interface-type><interface-list>|
vlan<vlan-id(1-4094)>
}|
ssh|ssl|acl|ip|snmp|radius|rmon|igmp|sntp|http|
broadcast-blocking|multicast-blocking|locked-port|auto-logout|
time|ntp|auto-save|panel-button|cos-map|dscp-map|
output-rate-limit|unicast-blocking|ospf|vrrp|loopd|events}]
[all]
The parameters have the following meaning:
Parameter
syslog
dhcp
Description
Range of values / note
Shows the configuration settings of the Syslog function
-
shows the configuration settings of the Dynamic Host Configuration Protocol
-
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
89
Configuration
3.4 Configuration Save & Restore
Parameter
Description
Range of values / note
shows the configuration settings of QoS
(Quality of Service)
-
stp
Shows the configuration settings of the
Spanning Tree protocol
-
la
Shows the configuration settings of the Link
Aggregation function
-
pnac
shows the configuration settings of the portbased network access control
-
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
qos
vlan
vlan-id
interface
Keyword for a an interface description
-
port-channel
Keyword for a port channel connection
-
port-channel-id
Number of the addressed port channel
1 ... 8
Type of interface
Enter a valid interface.
interface-type
interface-list
Module no. and port no. of the interface
ssh
Shows the configuration settings of the Secure Shell protocol
-
ssl
Shows the configuration settings of the Secure Sockets Layer protocol
-
acl
Shows the configuration settings of the access control lists
-
ip
Shows the configuration settings of the Internet Protocol
-
snmp
Shows the configuration settings of the Simple Network Management Protocol
-
radius
shows the configuration settings of the Remote Authentication Dial-In User service
-
Shows the configuration settings of the Remote Monitoring function
-
Shows the configuration settings of the Internet Group Management Protocol
-
Shows the configuration settings of the Simple Network Time Protocol
-
http
Shows the configuration settings of the Hypertext Transfer Protocol
-
broadcast-blocking
Shows the configuration settings of the
broadcast blocking
-
multicast-blocking
Shows the configuration settings of the multicast blocking
-
locked-port
Shows the configuration settings of the
locked port function
-
auto-logout
Shows the configuration settings of the auto
logout function
-
time
Shows the configuration settings of the system time
-
ntp
Shows the configuration settings of the Network Time Protocol
-
rmon
igmp
sntp
SCALANCE XB-200 Command Line Interface
90
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.4 Configuration Save & Restore
Parameter
auto-save
Description
Range of values / note
Shows the configuration settings of the auto
save function
-
panel-button
Shows the configuration settings of the Panel Button function
cos-map
Shows the configuration settings of the COS
function
-
dscp-map
Shows the configuration settings of the
DSCP map function
-
Shows the configuration settings of the output rate limit function
-
Shows the configuration settings of the
unicast blocking
-
output-rate-limit
unicast-blocking
ospf
Shows the configuration settings of the Open Shortest Path First
vrrp
Shows the configuration settings of the Virtual Router Redundancy Protocol
-
loopd
Shows the configuration settings of loop
detection
-
events
Shows the configuration settings of the
events
-
all
shows all configuration settings and all default parameters. Some parameters cannot
be changed.
-
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The selected configuration settings of the device are displayed.
3.4.2
write startup-config
Description
With this command, you save the changes to the configuration in the configuration file.
The use of this command is required in the Trial mode. It can also be used in "auto save
mode".
Requirement
● The Trial mode is activated.
● You are in the Privileged EXEC mode.
The command prompt is:
*cli(...)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
91
Configuration
3.4 Configuration Save & Restore
Syntax
Call the command without parameter assignment:
write startup-config
Result
The changes are saved in the configuration file.
Use the restart command without parameters to restart the system with this configuration.
Further notes
You enable the auto save function or disable the Trial mode with the auto-save command.
You disable the auto save function or enable the Trial mode with the no auto-save
command.
3.4.3
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
92
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.4 Configuration Save & Restore
3.4.3.1
auto-save
Description
The CLI can save changes to the configuration automatically.
If you first want to test changes made to the configuration so that you can discard them
afterwards if necessary, you can disable the auto save function.
You are then in the Trial mode.
Changes to the configuration that you have not saved, are indicated by an asterisk in front of
the command prompt: *cli(...)#.
You save the changes to the configuration with the write startup-config command.
With the auto-save command, you enable the auto save function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
auto-save
As default the function is "enabled".
Result
The auto save function is enabled.
Further notes
You save changes to the configuration in the Trial mode with the write startup-config
command.
You disable the function with the no auto-save command.
You can display the status of this function and other information with the show device
informationcommand.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
93
Configuration
3.4 Configuration Save & Restore
3.4.3.2
no auto-save
Description
With this command, you disable the auto save function.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no auto-save
Result
The auto save function is disabled. The Trial mode is activated.
Further notes
You enable the function with the auto-save command.
You can display the status of this function and other information with the show device
informationcommand.
You save changes to the configuration in the Trial mode with the write startupconfig
command.
SCALANCE XB-200 Command Line Interface
94
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.5 SINEMA
3.5
SINEMA
3.5.1
show sinema
Description
This command shows whether the SINEMA configuration interface is enabled or disabled.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show sinema
Result
The setting of the SINEMA configuration interface is displayed.
3.5.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
95
Configuration
3.5 SINEMA
3.5.2.1
sinema
Description
With this command, you enable the SINEMA configuration interface.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
sinema
Result
The SINEMA configuration interface is enabled.
Further notes
You disable the SINEMA configuration interface with the no sinema command.
You display the setting whether the SINEMA configuration interface is enabled or disabled
with the command show sinema.
SCALANCE XB-200 Command Line Interface
96
Configuration Manual, 04/2015, C79000-G8976-C361-02
Configuration
3.5 SINEMA
3.5.2.2
no sinema
Description
With this command, you disable the SINEMA configuration interface.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
no sinema
Result
The SINEMA configuration interface is disabled.
Further notes
You enable the SINEMA configuration interface with the sinema command.
You display the setting whether the SINEMA configuration interface is enabled or disabled
with the command show sinema.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
97
Configuration
3.5 SINEMA
SCALANCE XB-200 Command Line Interface
98
Configuration Manual, 04/2015, C79000-G8976-C361-02
Functions specific to SCALANCE
4
This part contains the sections that describe functions specific to SCALANCE.
4.1
WBM
On the device, you can limit the time available for access with Web Based Management. If
no entry is made for a specific time, the WBM session is closed.
This section describes commands relevant for the configuration of this feature.
4.1.1
show web-session-timeout
Description
This command shows the timeout setting for the WBM.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show web-session-timeout
Result
The timeout setting for the WBM is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
99
Functions specific to SCALANCE
4.1 WBM
4.1.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
4.1.2.1
web-session-timeout
Description
With this command, you enable the automatic logoff and you configure the timeout setting for
the WBM.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
web-session-timeout[seconds(60-3600)]
The parameter has the following meaning:
Parameter
seconds
Description
Range of values / note
Time in seconds until automatic logout
after the last entry
Default: 900
60 … 3600
Result
The time is configured and automatic logout is enabled.
Further notes
You disable automatic logoff with the no web-session-timeout command.
You display the current timeout setting with the show web-session-timeout command.
SCALANCE XB-200 Command Line Interface
100
Configuration Manual, 04/2015, C79000-G8976-C361-02
Functions specific to SCALANCE
4.1 WBM
4.1.2.2
no web-session-timeout
Description
With this command, you disable the automatic logoff.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no web-session-timeout
Result
Automatic logoff is disabled.
Further notes
You enable automatic logoff with the web-session-timeout command.
You display the current timeout setting with the show web-session-timeout command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
101
Functions specific to SCALANCE
4.2 Panel button
4.2
Panel button
This section describes the commands relevant for working with the Panel Button function.
4.2.1
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
4.2.1.1
panel-button control-factory-defaults
Description
With this command, you enable the following function of the "RESET" button:
● When the button is pressed for more than 12 seconds, there is a restart with the factory
settings.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
panel-button control-factory-defaults
Result
The function of the "RESET" button for restarting with factory settings is enabled.
Further notes
You disable this function with the no panel-button control-factory-defaults command.
SCALANCE XB-200 Command Line Interface
102
Configuration Manual, 04/2015, C79000-G8976-C361-02
Functions specific to SCALANCE
4.2 Panel button
4.2.1.2
no panel-button control-factory-defaults
Description
With this command, you disable the following function of the "RESET" button:
● When the button is pressed for more than 12 seconds, there is a restart with the factory
settings.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
no panel-button control-factory-defaults
Result
The function of the "RESET" button for restarting with factory settings is enabled or disabled.
Further notes
You enable this function with the panel-button control-factory-defaults command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
103
Functions specific to SCALANCE
4.2 Panel button
SCALANCE XB-200 Command Line Interface
104
Configuration Manual, 04/2015, C79000-G8976-C361-02
5
System time
5.1
System time setting
This section describes commands relevant for the configuration of the system time.
5.1.1
show time
Description
This command shows the settings of the system clock.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show time
Result
The settings for the system clock are displayed.
5.1.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
105
System time
5.1 System time setting
5.1.2.1
time
Description
With this command, you configure the way in which the system time is obtained.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
time{manual|ntp|sntp|SINEC}
The parameters have the following meaning:
Parameter
manual
ntp
sntp
SINEC
Description
The system time is entered by the user
The system time is obtained from an NTP server
The system time is obtained from an SNTP server
The system time is obtained using the "SIMATIC time protocol"
Result
The method of obtaining the system time is configured.
Further notes
You display the settings for the system clock with the show time command.
5.1.2.2
time set
Description
With this command, you set the system clock.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
106
Configuration Manual, 04/2015, C79000-G8976-C361-02
System time
5.1 System time setting
Syntax
Call up the command with the following parameters:
time set hh:mm:ss <day (1-31)>
{january|february|march|april|may|june|july|august|september|october|november|decembe
r}
<year (2000 - 2035)>
The parameters have the following meaning:
Parameter
Description
Range of values / note
Time of day
Hour, minute, second each separated by ":" no link
day
Day of the month
1 ... 31
-
Month
january, february, march, april,
may, june, july, august, september, october, november, december
year
Year
2000 ... 2035
hh:mm:ss
Result
The system time is set.
Further notes
You display the settings for the system clock with the show time command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
107
System time
5.2 NTP client
5.2
NTP client
This section describes commands relevant for configuration of the NTP client.
5.2.1
show ntp info
Description
This command shows the current settings for the Network Time Protocol (NTP).
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ntp info
Result
The current NTP settings are displayed.
5.2.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
108
Configuration Manual, 04/2015, C79000-G8976-C361-02
System time
5.2 NTP client
5.2.2.1
ntp
Description
With this command, you change to the Network Time Protocol (NTP).
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
ntp
Result
You are now in the NTP configuration mode.
The command prompt is as follows:
cli(config-ntp)#
Further notes
You exit the NTP configuration mode with the end or exit command.
5.2.3
Commands in the NTP configuration mode
This section describes commands that you can call up in the NTP configuration mode.
In the Global configuration mode, enter the ntp command to change to this mode.
● If you exit the NTP configuration mode with the exit command, you return to the Global
configuration mode.
● If you exit the NTP configuration mode with the end command, you return to the Privileged
EXEC mode.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
109
System time
5.2 NTP client
5.2.3.1
ntp server
Description
With this command, you configure the connection to a server on the NTP client.
Note
To avoid time jumps, make sure that there is only one time server in the network.
Requirement
You are in the NTP configuration mode.
The command prompt is as follows:
cli(config-ntp)#
Syntax
Call up the command with the following parameters:
ntp server ipv4 <ip_addr>[port<1025-36564>][poll<seconds(64-1024)>]
The parameter has the following meaning:
Parameter
ipv4
Description
Range of values / note
Keyword for an IPv4 address
-
ip_addr
Value for the IPv4 address of the time server
Enter a valid IPv4 address
port
UDP port of the time server
1025 … 36564
Keyword for the time after which the time of day is requested again
-
Value for the time in seconds
64 … 1024
poll
seconds
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The connection to a server is configured on the NTP client.
Further notes
You delete the connection to a server with the no ntp server command.
SCALANCE XB-200 Command Line Interface
110
Configuration Manual, 04/2015, C79000-G8976-C361-02
System time
5.2 NTP client
5.2.3.2
no ntp server
Description
With this command, you delete the connection to a server on the NTP client.
Requirement
You are in the NTP configuration mode.
The command prompt is as follows:
cli(config-ntp)#
Syntax
Call the command without parameter assignment:
no ntp server
Result
The connection to a server is deleted on the NTP client.
Further notes
You configure the connection to a server with the ntp server command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
111
System time
5.2 NTP client
5.2.3.3
ntp time diff
Description
With this command, you configure the time difference between the device and the NTP
server.
Requirement
You are in the NTP configuration mode.
The command prompt is as follows:
cli(config-ntp)#
Syntax
Call up the command with the following parameters:
ntp time diff <(+/-hh:mm)>
The parameter has the following meaning:
Parameter
+
hh
mm
Description
Time zones to the west of the NTP server time zone
Time zones to the east of the NTP server time zone
Number of hours difference
Number of minutes difference
Enter the number of hours and number of minutes with two digits each.
Default: No time difference.
Result
The time difference between the device and the NTP server is configured.
SCALANCE XB-200 Command Line Interface
112
Configuration Manual, 04/2015, C79000-G8976-C361-02
System time
5.3 SNTP client
5.3
SNTP client
This section describes commands relevant for configuration of the SNTP client.
5.3.1
show sntp broadcast-mode status
Description
This command shows the current configuration of the broadcast mode of SNTP.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show sntp broadcast-mode status
Result
The current SNTP broadcast configuration is displayed.
5.3.2
show sntp unicast-mode status
Description
This command shows the current configuration of the unicast mode of SNTP.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show sntp unicast-mode status
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
113
System time
5.3 SNTP client
Result
The current SNTP unicast configuration is displayed.
5.3.3
show sntp status
Description
This command shows the settings of the Simple Network Time Protocol.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show sntp status
Result
The settings of SNTP are displayed.
SCALANCE XB-200 Command Line Interface
114
Configuration Manual, 04/2015, C79000-G8976-C361-02
System time
5.3 SNTP client
5.3.4
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
5.3.4.1
sntp
Description
With this command, you change to the SNTP configuration mode.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
sntp
Result
You are now in the SNTP configuration mode.
The command prompt is as follows:
cli(config-sntp)#
Further notes
You exit the SNTP configuration modewith the end or exit command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
115
System time
5.3 SNTP client
5.3.5
Commands in the SNTP configuration mode
This section describes commands that you can call up in the SNTP configuration mode.
In the Global configuration mode, enter the sntp command to change to this mode.
● If you exit the SNTP configuration mode with the exit command, you return to the Global
configuration mode.
● If you exit the SNTP configuration mode with the end command, you return to the
Privileged EXEC mode.
5.3.5.1
sntp client addressing-mode
Description
With this command, you configure the addressing mode of the SNTP client as unicast or
broadcast.
Requirement
● The SNTP client is activated.
● You are in the SNTP Configuration mode.
The command prompt is:
cli(config-sntp)#
Syntax
Call up the command with the following parameters:
sntp client addressing-mode{unicast|broadcast}
The parameters have the following meaning:
Parameter
unicast
broadcast
Description
Range of values / note
configures the SNTP client in unicast mode
Default: unicast enabled
configures the SNTP client in broadcast mode
-
Result
The addressing mode of the SNTP client is configured.
Further notes
You display this setting and other information with the show sntp status command.
You display the settings for the unicast mode with the show sntp unicast-mode status
command.
You display the settings for the broadcast mode with the show sntp broadcast-mode status
command.
SCALANCE XB-200 Command Line Interface
116
Configuration Manual, 04/2015, C79000-G8976-C361-02
System time
5.3 SNTP client
5.3.5.2
sntp time diff
Description
With this command, you configure the time difference of the system time relative to the UTC
time.
Requirement
● The SNTP server must have started up.
● You are in the SNTP Configuration mode.
The command prompt is:
cli(config-sntp)#
Syntax
Call up the command with the following parameters:
sntp time diff <(+/-hh:mm)>
The parameter has the following meaning:
Parameter
+
hh
mm
Description
Time zones to the west of the SNTP server time zone
Time zones to the east of the SNTP server time zone
Number of hours difference
Number of minutes difference
Enter the time difference as follows:
● with sign
● without spaces
● Hours and minutes both two digits (with leading zero)
Default: no time difference
Result
The time zone of the system time is configured.
Further notes
You can display the settings of this function and other information with the show sntp
statuscommand.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
117
System time
5.3 SNTP client
5.3.5.3
sntp unicast-server ipv4
Description
With this command, you configure an SNTP unicast server.
Note
To avoid time jumps, make sure that there is only one time server in the network.
Requirement
● The addressing mode of the SNTP client is configured as "unicast".
● You are in the SNTP configuration mode.
The command prompt is:
cli(config-sntp)#
Syntax
Call up the command with the following parameters:
sntp unicast-server ipv4 <ucast_addr> [port<1025-36564>][poll<seconds(16-16284)>]
The parameters have the following meaning:
Parameter
Description
Range of values / note
Keyword for an IP address
-
ucast_addr
Value for an IPv4 unicast address
Enter a valid IPv4 unicast address.
port
UDP port of the time server
1025 … 36564
poll
Keyword for the time after which the
time of day is requested again
-
Value for the time in seconds
16 ... 16284
ipv4
seconds
Default: 123
Result
The SNTP unicast server is configured.
Further notes
You can reset the setting to the default with the no sntp unicast-server ipv4 command.
You display this setting and other information with the show sntp unicast–mode status
command.
SCALANCE XB-200 Command Line Interface
118
Configuration Manual, 04/2015, C79000-G8976-C361-02
System time
5.3 SNTP client
5.3.5.4
no sntp unicast-server ipv4
Description
With this command, you delete the attributes for an SNTP unicast server and reset the
address.
Requirement
You are in the SNTP configuration mode.
The command prompt is as follows:
cli(config-sntp)#
Syntax
Call up the command with the following parameters:
no sntp unicast-server ipv4<ucast_addr>
The parameters have the following meaning:
Parameter
ucast_addr
Description
Range of values
Value for an IPv4 unicast address
Enter a valid IPv4 unicast address.
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The SNTP unicast server is reset to the default value.
Further notes
You configure the setting with the sntp unicast-server ipv4 command.
You display this setting and other information with the show sntp unicast–mode status
command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
119
System time
5.3 SNTP client
SCALANCE XB-200 Command Line Interface
120
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.1
6
Introduction to the section "Network structures"
This part contains the sections that describe the commands for configuring and managing
various network structures.
The following technologies are available:
● The establishment of independent structures even across the boundaries of subnets
using virtual networks (VLANs)
This can result in the following advantages:
– Administration:
Devices can be grouped together to form a logical units regardless of their physical
location
– Performance:
By prioritizing, time-critical data (process data, streams) can be given priority for
transfer
– Security:
The transition between VLANs can only be controlled by an administrator
● Detection and monitoring of parallel connections or loops in an Ethernet network by
setting up a tree structure (loop detection)
● Improved reliability by adapting the tree structure if transmission is disrupted (Spanning
Tree)
● Splitting up of the network into smaller units that are connected together via managed
connection pairs (standby connection)
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
121
Network structures
6.2 VLAN
6.2
VLAN
This section describes commands for configuring and managing virtual networks (VLANs).
6.2.1
The "show" commands
This section describes commands with which you display various settings.
6.2.1.1
show mac-address-table
Description
This command shows the table with the static and dynamic unicast MAC addresses and
multicast MAC addresses.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table [vlan<vlan-range>][address<aa:aa:aa:aa:aa:aa>]
[interface <interface-type><interface-id>]
The parameters have the following meaning:
Parameter
Description
Range of values / note
Keyword for a VLAN or VLAN range
-
vlan-range
Number of the addressed VLAN or
VLAN range
1 ... 4094
address
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
vlan
interface
interface-type
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
SCALANCE XB-200 Command Line Interface
122
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
Result
The entries of the MAC addresses table are displayed.
6.2.1.2
show mac-address-table dynamic multicast
Description
This command shows the table with the dynamic multicast MAC addresses assigned by the
device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table dynamic multicast[vlan<vlan-range>]
[address<aa:aa:aa:aa:aa:aa>]
[{interface<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
vlan
vlan-range
address
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
interface
Keyword for a an interface description
-
Type of interface
Enter a valid interface
interface-type
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
Result
The dynamic multicast MAC addresses are displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
123
Network structures
6.2 VLAN
6.2.1.3
show mac-address-table dynamic unicast
Description
This command shows the table with the dynamic unicast MAC addresses assigned by the
device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table dynamic unicast[vlan<vlan-range>]
[address<aa:aa:aa:aa:aa:aa>][{interface<interface-type>
<interface-id>}]
The parameters have the following meaning:
Parameter
vlan
vlan-range
address
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
interface
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface
interface-type
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
Result
The dynamic unicast MAC addresses are displayed.
SCALANCE XB-200 Command Line Interface
124
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
6.2.1.4
show mac-address-table static multicast
Description
This command shows the table with the static multicast MAC addresses.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table static multicast[vlan<vlan-range>]
[address<aa:aa:aa:aa:aa:aa>][{interface<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
vlan
vlan-range
address
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
interface
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface
interface-type
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
Result
The static multicast MAC addresses are displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
125
Network structures
6.2 VLAN
6.2.1.5
show mac-address-table static unicast
Description
This command shows the table with the static unicast MAC addresses.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table static unicast[vlan<vlan-range>]
[address<aa:aa:aa:aa:aa:aa>][{interface<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
vlan
vlan-range
address
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
interface
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface
interface-type
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
Result
The static unicast MAC addresses are displayed.
SCALANCE XB-200 Command Line Interface
126
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
6.2.1.6
show mac-address-table count
Description
With this command, you show the number of MAC addresses for all or a selected VLAN.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table count[vlan<vlan-id(1-4094)>]
The parameters have the following meaning:
Parameter
vlan
vlan-id
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
If you do not select any parameter from the parameter list, the total number of entries is
displayed for all VLANs.
Result
The number of MAC addresses for the selected VLAN is displayed.
6.2.1.7
show vlan
Description
This command shows the specific information for all or a selected VLAN.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
127
Network structures
6.2 VLAN
Syntax
Call up the command with the following parameters:
show vlan[brief|id<vlan-range>|summary]
The parameters have the following meaning:
Parameter
Description
Range of values / note
Shows brief information about all
VLANs
-
id
Keyword for a VLAN or VLAN range
-
vlan-range
Number of the addressed VLAN or
VLAN range
1 ... 4094
summary
Shows a summary of the VLANs
brief
If you do not select any parameter from the parameter list, the entries of all available
interfaces are displayed.
Result
The information for the selected VLAN is displayed.
6.2.1.8
show vlan device info
Description
This command shows all the global information that is valid for all VLANs.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show vlan device info
Result
The global information is displayed.
SCALANCE XB-200 Command Line Interface
128
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
6.2.1.9
show vlan learning params
Description
This command shows the parameters for the automatic learning of addresses for selected or
all VLANs (active and inactive VLANs).
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show vlan learning params[vlan<vlan-range>]
The parameters have the following meaning:
Parameter
vlan
vlan-range
Description
Range of values / note
Keyword for a VLAN or VLAN range
-
Number of the addressed VLAN or
VLAN range
1 ... 4094
If you do not select any parameter from the parameter list, the entries of all available
interfaces are displayed.
Result
The settings for the automatic learning of addresses are displayed.
6.2.1.10
show vlan port config
Description
This command shows the VLAN-specific information for ports.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
129
Network structures
6.2 VLAN
Syntax
Call up the command with the following parameters:
show vlan port config[{port<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
port
interface-type
interface-id
Description
Range of values / note
Keyword for a port
-
Type of interface
Enter a valid interface.
Module no. and port no. of the interface
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries of all available
interfaces are displayed.
Result
The information about the ports is displayed.
6.2.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
6.2.2.1
interface range
Description
With this command, you can put several interfaces or the interfaces of VLANs together and
configure them together. The configurations are valid for all interfaces of the specified range.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
130
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
Syntax
Call up the command with the following parameters:
interface range
(
{<interface-type> <0/a-b,0/c,...>}
{vlan <vlan-id(1-4094)> - <vlan-id(2-4094)>}
)
The parameters have the following meaning:
Parameter
interface-type
0/a-b, 0/c,...
Description
Range of values / note
Keyword for an interface
Enter a valid interface.
Module no. and port no. of the interface
vlan
Keyword for a VLAN connection
-
vlan-id
Number of the addressed VLAN
1 ... 4094
Number of the addressed VLAN
2 ... 4094
vlan-id
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you want to address several VLANs with this command, you must insert a blank before
and after the hyphen, for example interface range vlan 5 - 10.
Result
The interfaces or interfaces of VLANs were put together to form an interface range.
The command prompt is as follows:
cli(config-if-vlan-range)#
The configuration commands you enter in a mode apply to all interfaces of this area.
Further notes
With the no interface range command, you remove VLANs from this range or break it up.
6.2.2.2
no interface range
Description
With this command, you remove the interfaces or interfaces of VLANs from the interface
range or break it up if you first remove all previously added interfaces.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
131
Network structures
6.2 VLAN
Syntax
Call up the command with the following parameters:
no interface range vlan <vlan-id(1-4094)> - <vlan-id(2-4094)>
The parameters have the following meaning:
Parameter
vlan
vlan-id
vlan-id
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
Number of the addressed VLAN
2 ... 4094
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you address several VLANs, you must insert a blank before and after the hyphen, for
example no interface range vlan 5 - 10.
Result
The VLANs have been removed from the specified interface area.
Further notes
With the interface range command, you can put several interfaces or VLANs together to be
able to configure them together.
6.2.2.3
mgmt vlan
Description
With this command, you change the agent VLAN ID. You can only use VLANs that have
already been configured.
Note
Changing the agent VLAN ID
If the configuration PC is connected directly to the device via Ethernet and you change the
agent VLAN ID, the device is no longer reachable via Ethernet following the change.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
132
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
Syntax
Call up the command with the following parameters:
mgmt vlan <vlan-id(1-4094)>
The parameter has the following meaning:
Parameter
vlan-id
Description
Range of values
Number of the addressed VLAN
1 ... 4094
Result
The Agent VLAN ID has been changed.
Further notes
You show the configuration of the IP interfaces with the show ip interface command.
6.2.2.4
vlan
Description
With this command, you create a VLAN on the device and change to the VLAN configuration
mode.
In the provider backbone bridge mode, this command is used to create user, service and
backbone VLANs.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
vlan <vlan-id(1-4094)>
The parameter has the following meaning:
Parameter
vlan-id
Description
Range of values / note
Number of the addressed VLAN
1 ... 4094
Do not enter any leading zeros with the number of the VLAN.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
133
Network structures
6.2 VLAN
Result
The VLAN is created.
You are now in the VLAN configuration mode.
The command prompt is as follows:
cli(config-vlan-$$$)#
Further notes
You delete the VLAN with the no vlan command.
You can display information about the VLAN with the show vlan command.
6.2.2.5
no vlan
Description
With this command, you delete a VLAN on the device.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameter:
no vlan <vlan-id(2-4094)>
Parameter
vlan-id
Description
Range of values / note
Number of the addressed VLAN
2 ... 4094
The VLAN with number 1 cannot be deleted.
Result
The VLAN is deleted
Further notes
With the vlan command, you create a VLAN on the device.
You can display information about the VLAN with the show vlan command.
SCALANCE XB-200 Command Line Interface
134
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
6.2.2.6
vlan range
Description
With this command, you can select several VLANs and configure them together. The
configurations are valid for all selected VLANs.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
vlan range <vlan-id(1-4094)> - <vlan-id(2-4094)>
The parameters have the following meaning:
Parameter
vlan-id
vlan-id
Description
Range of values / note
Number of the addressed VLAN
1 ... 4094
Number of the addressed VLAN
2 ... 4094
Enter a space before and after the hyphen, e.g. vlan range 5 - 10.
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The command prompt is as follows:
CLI(config-vlan-range)#
Configuration commands you enter with this command prompt apply to all selected VLANs.
Further notes
With the command exit, you return to the Global configuration mode.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
135
Network structures
6.2 VLAN
6.2.3
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
6.2.3.1
switchport acceptable-frame-type
Description
With this command, you configure which types of frames are accepted.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
switchport acceptable-frame-type{all|tagged}
The parameters have the following meaning:
Parameter
all
tagged
Description
Range of values / note
All frames are accepted.
Default: all
Untagged frames are discarded.
-
Result
The setting is enabled.
Further notes
You can reset the setting to the default with the no switchport acceptable-frame-type
command.
You can display the status of this function and other information with the show vlan port
command.
config
SCALANCE XB-200 Command Line Interface
136
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
6.2.3.2
no switchport acceptable-frame-type
Description
With this command, you reset the setting for the types of frames accepted by the interface to
the default value.
The default value is all.
The interface accepts tagged and untagged frames.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no switchport acceptable-frame-type
Result
The setting is reset to the default value.
Further notes
You configure the setting with the switchport acceptable-frame-type command.
You can display the status of this function and other information with the show vlan port
configcommand.
6.2.3.3
switchport access vlan
Description
With this command, you assign an VLAN to an interface and configure the port VLAN
identifier (PVID) for it.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
137
Network structures
6.2 VLAN
Syntax
Call up the command with the following parameters:
switchport access vlan <vlan-id(1-4094)>
The parameter has the following meaning:
Parameter
vlan-id
Description
Range of values / note
Number of the addressed VLAN
1 ... 4094
Result
The Interface is added to the VLAN as an untagged port and the corresponding VLAN ID is
set.
Further notes
You can reset the setting to the default with the no switchport access vlan command.
You display the setting and other information with the show vlan port config command.
6.2.3.4
no switchport access vlan
Description
With this command, you reset the setting for the port VLAN identifier (PVID) for an interface
to the default value.
The default value is 1.
Requirement
You are in the interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no switchport access vlan
Result
The setting is reset to the default value.
SCALANCE XB-200 Command Line Interface
138
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
Further notes
You configure the setting with the switchport access vlan command.
You can display the status of this function and other information with the show vlan port
configcommand.
6.2.3.5
switchport priority default
Description
With this command, you configure the priority default for the interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
switchport priority default <0-7>
The parameter has the following meaning:
Parameter
-
Description
Value for the priority default
Range of values / note
0 ... 7
Default: 0
Result
The setting for the default priority of the interface is configured.
Further notes
You reset the priority default to the original default with the no switchport priority default
command.
You display this setting and other information with the show vlan port config command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
139
Network structures
6.2 VLAN
6.2.3.6
no switchport priority default
Description
With this command, you reset the priority default for the interface to the default value.
The default value is 0.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no switchport priority default
Result
The setting is reset to the default value.
Further notes
You configure the priority default with the switchport priority default command.
You display this setting and other information with the show vlan port config command.
6.2.3.7
switchport pvid
Description
With this command, you assign an interface to a VLAN and configure the port VLAN
identifier (PVID) for it. If a received frame has no VLAN tag, it has a tag added with the VLAN
ID specified here and is sent according to the switch rules for the port.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
140
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
Syntax
Call up the command with the following parameters:
switchport pvid <vlan-id(1-4094)>
The parameter has the following meaning:
Parameter
vlan-id
Description
Range of values / note
Number of the addressed VLAN
1 ... 4094
Result
The PVID is configured
Further notes
You can reset the setting to the default with the no switchport pvid command.
You configure the VLAN ID with the switchport access vlan command.
You display the setting and other information with the show vlan port config command.
6.2.3.8
no switchport pvid
Description
With this command, you reset the setting for the port VLAN identifier (PVID) for an interface
to the default value.
The default value is 1.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no switchport pvid
Result
The setting is reset to the default value.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
141
Network structures
6.2 VLAN
Further notes
You configure the setting with the switchport pvid command.
You configure the VLAN ID with the switchport access vlan command.
You can display the status of this function and other information with the show vlan port
config command.
6.2.4
Commands in the VLAN configuration mode
This section describes commands that you can call up in the VLAN Configuration mode.
In the Global Configuration mode, enter the vlan $$$ command to change to this mode.
When doing this, you need to replace the $$$ placeholders with the relevant VLAN ID.
Commands relating to other topics that can be called in the VLAN Configuration mode can
be found in the relevant sections.
● If you exit the VLAN Configuration mode with the exit command, you return to the Global
Configuration mode.
● If you exit the VLAN Configuration mode with the end command, you return to the
Privileged EXEC mode.
6.2.4.1
ip address
Description
With this command, you assign an IP address.
Requirement
You are in the VLAN configuration mode.
The command prompt is as follows:
cli(config-vlan-$$$)#
Syntax
Call up the command with the following parameters:
ip address <ip-address> {<subnet-mask>| / <prefix-length(0-32)>}
SCALANCE XB-200 Command Line Interface
142
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
The parameter has the following meaning:
Parameter
ip-address
subnet-mask
prefix-length
Description
Range of values / note
IP address
Specify a valid IP address.
Subnet mask
Enter a valid subnet mask.
Decimal representation of the mask as a number
of "1" bits
0 ... 32
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The IP address is assigned.
Note
Effectiveness of the command
The command is effective immediately. If you configure the interface via which you access
the device, the connection will be lost!
Further notes
You delete the setting with the no ip address command.
6.2.4.2
ip address dhcp
Description
With this command, you assign an IP address using DHCP.
Requirement
You are in the VLAN configuration mode.
The command prompt is as follows:
cli(config-vlan-$$$)#
Syntax
Call the command without parameter assignment:
ip address dhcp
Result
The IP address is assigned using DHCP.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
143
Network structures
6.2 VLAN
Further notes
You delete the setting with the no ip address command.
6.2.4.3
no ip address
Description
With this command, you delete the assignment of an IP address and disable DHCP.
Requirement
You are in the VLAN configuration mode.
The command prompt is as follows:
cli(config-vlan-$$$)#
Syntax
Call up the command with the following parameters:
no ip address [{ <ucast_addr> | dhcp }]
The parameter has the following meaning:
Parameter
ucast-addr
dhcp
Description
Range of values / note
Value for an IPv4 unicast address
Enter a valid IPv4 unicast address.
Specify this parameter if you want to
disable the DHCP function explicitly.
-
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
If DHCP was enabled on this interface, DHCP is now disabled. Any existing dynamically
learned IP address will be automatically converted to a static IP address.
If static IP addresses were configured and if no explicit IP address was transferred as a
parameter, all static IP addresses will be deleted from this interface.
If a static IP address was specified explicitly, this address is deleted from this interface.
Note
Effectiveness of the command
The command is effective immediately.
If you configure the interface via which you access the device, you can lose the connection!
SCALANCE XB-200 Command Line Interface
144
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
Further notes
You assign an IP address with the ip address or ip address dhcp command.
6.2.4.4
name
Description
With this command, you assign a name to the VLAN.
Requirement
You are in the VLAN Configuration mode.
The command prompt is as follows:
cli(config-vlan-$$$)#
Syntax
Call up the command with the following parameters:
name <vlan-name>
The parameter has the following meaning:
Parameter
vlan-name
Description
Range of values / note
Name that will be assigned to the VLAN
max. 32 characters
Result
The VLAN is assigned a name.
Further notes
You delete name assignment for a VLAN with the no name command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
145
Network structures
6.2 VLAN
6.2.4.5
no name
Description
With this command, you delete the name assignment for a VLAN.
Requirement
You are in the VLAN configuration mode.
The command prompt is as follows:
cli(config-vlan-$$$)#
Syntax
Call the command without parameters:
no name
Result
The name of the VLAN is deleted.
Further notes
You assign the VLAN a name with the command name.
SCALANCE XB-200 Command Line Interface
146
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
6.2.4.6
ports
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you generate a list that specifies the behavior of the interfaces and
replaces the existing VLAN configuration.
● Member Port (tagged port)
The interface is added permanently to the list of incoming and outgoing connections.
Tagged and untagged frames are transferred.
● Untagged Port
The interface transfers untagged frames. If the VLAN ID (PVID) is set, incoming untagged
frames are given a tag with the VLAN ID specified there. If the received frames already
contain a VLAN ID, frames are only accepted if their VLAN ID matches the set PVID. With
outgoing frames, the tag with the VLAN ID is removed.
● Forbidden ports
This interface is not used for communication in a VLAN
The "tagged port" and "untagged port" you specify with this command are used for outgoing
data traffic.
Requirement
You are in the VLAN configuration mode.
The command prompt is as follows:
cli(config-vlan-$$$)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
147
Network structures
6.2 VLAN
Syntax
Call up the command with the following parameters:
ports
(
[<interface-type><0/a-b,0/c,...>]
[<interface-type><0/a-b,0/c,...>]
[port-channel<a,b,c-d>]
)
[
untagged<interface-type> <0/a-b,0/c,...>
(
[<interface-type><0/a-b,0/c,...>]
[port-channel <a,b,c-d>]
[all]
)
]
[
forbidden<interface-type><0/a-b,0/c,...>
[<interface-type><0/a-b,0/c,...>]
[portchannel<a,b,c-d>]
]
[name<vlan-name>]
The parameters have the following meaning:
Parameter
interface-type
/a-b,0/c,...
Description
Range of values / note
Type or speed of the interface
Enter a valid interface.
Port no. of the interface
port-channel
Keyword for a port channel
-
a,b,c-d
Port no. of the interface
Enter a valid interface name
Keyword for interfaces or ports that
transfer data packets without VLAN
marking
-
untagged
all
Specifies that all interfaces or ports are set to "untagged"
forbidden
Keyword for forbidden interfaces or
ports
-
name
Keyword for the name assignment
-
vlan-name
Name of the VLAN
max. 32 characters
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The existing VLAN configuration is replaced. To add individual interfaces, you need to
recreate the full list.
SCALANCE XB-200 Command Line Interface
148
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.2 VLAN
Further notes
You display details of the function with the show vlan command.
You reset the settings with the no ports command.
6.2.4.7
no ports
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you remove ports from a VLAN.
Requirement
You are in the VLAN configuration mode.
The command prompt is as follows:
cli(config-vlan-$$$)#
Syntax
Call up the command with the following parameters:
no ports
(
[<interface-type><0/a-b,0/c,...>]
[<interface-type><0/a-b,0/c,...>]
[port-channel<a,b,c-d>]
[all]
)
[
untagged<interface-type> <0/a-b,0/c,...>
(
[<interface-type><0/a-b,0/c,...>]
[port-channel <a,b,c-d>]
[all]
)
]
[
(
forbidden<interface-type><0/a-b,0/c,...>
[<interface-type><0/a-b,0/c,...>]
[portchannel<a,b,c-d>]
[all]
)
]
[name<vlan-name>]
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
149
Network structures
6.2 VLAN
The parameters have the following meaning:
Parameter
interface-type
/a-b,0/c,...
Description
Range of values / note
Type of interface
Enter a valid interface.
Port no. of the interface
port-channel
Keyword for a port channel
-
a,b,c-d
Port no. of the interface
Enter a valid interface.
Keyword for interfaces or ports that transfer
data packets without VLAN marking
-
Specifies that all interfaces or ports are set
to "untagged"
-
Keyword for forbidden interfaces or ports
-
Keyword for the name assignment
-
Name of the VLAN
max. 32 characters
untagged
all
forbidden
name
vlan-name
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The ports are removed from the VLAN configuration.
Further notes
It is possible to remove individual ports from a VLAN configuration without needing to rewrite
the entire configuration (in contrast to creating ports because it is not possible to add
individual ports later).
You display details of the function with the show vlan command.
You configure the setting with the ports command.
SCALANCE XB-200 Command Line Interface
150
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3
Spanning Tree
6.3.1
Introduction to the section Spanning Tree
The Spanning Tree Protocol is used to monitor a LAN for redundant connections. These are
blocked and reactivated when necessary if there are changes to the network topology.
This section describes the commands of the Spanning Tree Protocol (STP) and the Rapid
Spanning Tree Protocol (RSTP).
Note
Avoiding bad configurations
When using the commands in this section, you should take particular care because a bad
configuration of this function can have serious negative affects on the network.
6.3.2
The "show" commands
6.3.2.1
show spanning-tree
Description
This command shows the settings of the spanning tree function.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show spanning-tree [{summary|blockedports|pathcost method}]
The parameters have the following meaning:
Parameter
summary
Description
Shows a summary
blockedports
Shows the blocked ports
pathcost method
Shows whether 16-bit (short) or 32 bit (long) values are used in the calculation
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
151
Network structures
6.3 Spanning Tree
Result
The settings for the spanning tree function are displayed.
Further notes
You can show further settings for special aspects of the Spanning Tree Protocol with the
following commands:
● show spanning-tree active
● show spanning-tree bridge
● show spanning-tree detail
● show spanning-tree interface
● show spanning-tree root
6.3.2.2
show spanning-tree active
Description
This command shows the settings for the active ports of the spanning tree function.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show spanning-tree active [detail]
The parameter has the following meaning:
Parameter
detail
Description
Shows settings in detail
Result
The settings for the active ports of the spanning tree function are displayed.
SCALANCE XB-200 Command Line Interface
152
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.2.3
show spanning-tree bridge
Description
This command shows the settings of the spanning tree function of the bridge.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show spanning-tree bridge
[{address|forward-time|hello-time|id|max-age|protocol|priority|detail}]
The parameters have the following meaning:
Parameter
address
Description
Shows the MAC address of the bridge
forward-time
Shows the time that the bridge is in the listening mode when changing from the
blocking mode to the learning mode
hello-time
Shows the time after which the bridge sends configuration frames (BPDUs)
id
Shows the ID of the bridge
max-age
protocol
priority
detail
Shows the maximum age of the data packet after which it is deleted
Shows the protocol used
Shows the priority of the bridge
Shows detailed information about the spanning tree settings of the interface
Result
The settings for the spanning tree function of the bridge are displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
153
Network structures
6.3 Spanning Tree
6.3.2.4
show spanning-tree detail
Description
This command shows the detailed settings of the spanning tree function.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show spanning-tree detail
Result
The detailed settings for the spanning tree function are displayed.
6.3.2.5
show spanning-tree interface
Description
This command shows the settings of the ports for the spanning tree function.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show spanning-tree interface <interface-type><interface-id>
[{cost|priority|portfast|rootcost|restricted-role|
restricted-tcn|state|stats|detail}]
SCALANCE XB-200 Command Line Interface
154
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
The parameters have the following meaning:
Parameter
interface-type
interface-id
cost
priority
portfast
rootcost
restricted-role
restricted-tcn
Description
Range of values / note
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
Shows the port costs used to calculate
the lowest-cost path.
-
Shows the priority of the port.
-
Shows whether spanning-tree portfast is enabled.
-
Shows the costs of the path to the root
bridge.
-
Shows whether spanning-tree restricted-role is enabled.
-
Shows whether spanning-tree restricted-tcn is enabled.
-
Shows the status of the interface.
-
stats
Shows the counters of the various
BPDU transmissions.
-
detail
Shows detailed information about the
spanning tree settings of the interface.
-
state
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
Result
The settings of the ports for the spanning tree function are displayed.
6.3.2.6
show spanning-tree root
Description
This command shows the settings of the root bridge for the spanning tree function.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show spanning-tree root
[{address|cost|forward-time|id|max-age|port|priority|detail}]
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
155
Network structures
6.3 Spanning Tree
The parameters have the following meaning:
Parameter
address
cost
forward-time
id
Description
Shows the MAC address of the root bridge
Shows the costs of the connection to the root bridge.
Shows the time that the bridge is in the listening mode when changing from the
blocking mode to the learning mode
Shows the ID of the root bridge
max-age
port
Shows the maximum age of the data packet after which it is deleted
Shows the interface via which the spanning tree is set up
priority
Shows the priority of the bridge
detail
Shows detailed information about the root bridge
Result
The settings of the root bridge for the spanning tree function are displayed.
6.3.2.7
show spanning-tree passive-listening-compatibility
Description
This command shows whether or not the "Enhanced Passive Listening Compatibility"
function is enabled or disabled.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameter assignment:
show spanning-tree passive-listening-compatibility
Result
The setting for the "Enhanced Passive Listening Compatibility" function is displayed.
SCALANCE XB-200 Command Line Interface
156
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
Further notes
You enable the "Enhanced Passive Listening Compatibility" function with the spanning-tree
passive-listening-compatibility command.
You disable the "Enhanced Passive Listening Compatibility" function with the no spanningtree passive-listening-compatibility command.
6.3.2.8
show spanning-tree interface layer2-gateway-port
Description
This command shows the settings of Layer 2 Gateway Port (L2GP). For example the priority,
the MAC address and the status of L2GP are displayed.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show spanning-tree interface
[<interface-type><interface-id>]
layer2-gateway-port
The parameters have the following meaning:
Parameter
interface-type
interface-id
Description
Range of values / note
Type or speed of the interface
Enter a valid interface
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The settings for Layer 2 Gateway Port (L2GP) are displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
157
Network structures
6.3 Spanning Tree
6.3.3
clear spanning-tree detected protocols
Description
With this command, you restart the protocol transmission process on a specific or on all
interfaces and force renegotiation of the connection settings with the neighboring devices.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call up the command with the following parameters:
clear spanning-tree detected protocols
[{interface<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
interface
interface-type
interface-id
Description
Range of values / note
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the process is restarted for all
interfaces.
Result
The connection settings for spanning tree are renegotiated.
SCALANCE XB-200 Command Line Interface
158
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.4
clear spanning-tree counters
Description
With this command, you reset all the statistical counters of the spanning tree function at the
device and port level.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
clear spanning-tree counters
Result
The spanning tree counters are reset.
6.3.5
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
6.3.5.1
spanning-tree
Description
The Spanning Tree Protocol is used to monitor a LAN for redundant connections. These are
blocked and reactivated when necessary if there are changes to the network topology.
With this command, you enable the spanning tree function.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
159
Network structures
6.3 Spanning Tree
Requirement
● The ring redundancy is disabled.
● You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
spanning-tree
Result
The spanning tree function is enabled.
If you enable Spanning Tree, passive listening is disabled.
Further notes
The default setting of the function with PROFINET variants is "disabled".
The default setting of the function with EtherNet/IP variants is "enabled".
You disable the ring redundancy function with the no ring-redundancy command.
You disable the spanning tree function with the no spanning tree command.
You can display the status of this function and other information with the show spanning tree
command.
detail
You can display information about active ports with the show spanning tree active
command.
6.3.5.2
no spanning-tree
Description
With this command, you disable the spanning tree function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
160
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
Syntax
Call the command without parameters:
no spanning-tree
Result
The spanning tree function is disabled.
Further notes
You enable the spanning tree function with the spanning tree command.
You can display the status of this function and other information with the show spanning tree
detail command.
You can display information about active ports with the show spanning tree active
command.
6.3.5.3
spanning-tree compatibility
Description
With this command, you configure the compatibility version of the protocol that will be used
by the spanning tree function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
spanning-tree compatibility {stp|rst}
The parameters have the following meaning:
Parameter
stp
rst
Description
The version is compatible with the Spanning Tree protocol
The version is compatible with the Rapic Spanning Tree protocol
Result
The compatibility version of the protocol is selected.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
161
Network structures
6.3 Spanning Tree
Further notes
You can reset the setting to the default with the no spanning-tree compatibility command.
You can display the status of this function and other information with the show spanning tree
detailcommand.
You can display information about active ports with the show spanning tree active
command.
6.3.5.4
no spanning-tree compatibility
Description
With this command, you reset the compatibility version of the protocol of the spanning tree
function to the default value.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no spanning-tree compatibility
Result
The compatibility version is reset to the default value.
Further notes
You configure the setting with the spanning-tree compatibility command.
SCALANCE XB-200 Command Line Interface
162
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.5.5
spanning-tree priority
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you configure the priority of the device. Which device becomes the root
bridge is decided based on the priority. The bridge with the highest priority becomes the root
bridge. The lower the value, the higher the priority.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
spanning-tree[mst <instance-id(1-64)>] priority <value(0-61440)>
The parameters have the following meaning:
Parameter
mst
instance-id
Description
Range of values / note
Keyword for a Multiple Spanning Tree
instance
-
Number of the instance
1 ... 64
priority
Keyword for the priority
-
value
Value for the priority
0 ... 61440
Default: 32768
You can only change the value for the priority in the steps of 4096.
Result
The priority of the device is configured.
Further notes
You can reset the setting to the default with the no spanning-tree priority command.
You display this setting and other information with the commands that start with show
spanning tree ....
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
163
Network structures
6.3 Spanning Tree
6.3.5.6
no spanning-tree priority
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you reset the priority of the device back to the default value.
The default value is 32768.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no spanning-tree[mst <instance-id(1-64)>]priority
The parameters have the following meaning:
Parameter
mst
instance-id
Description
Range of values / note
Keyword for a Multiple Spanning Tree
instance
-
Number of the instance
1 ... 64
Result
The priority of the device is reset to the default value.
Further notes
You configure the setting with the spanning-tree priority command.
You display this setting and other information with the commands that start with show
spanning tree ....
SCALANCE XB-200 Command Line Interface
164
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.5.7
spanning-tree passive-listening-compatibility
Description
With this command you enable the "Enhanced Passive Listening Compatibility" function.
If you enable the "Enhanced Passive Listening Compatibility" function, the IE switch sends
topology change frames via the (R)STP edge port that caused the topology change.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
spanning-tree passive-listening-compatibility
Result
The "Enhanced Passive Listening Compatibility" function is enabled.
Further notes
You disable the function with the no spanning-tree passive-listening-compatibility
command.
You can display the status of this function with the show spanning-tree passive-listeningcompatibilitycommand.
6.3.5.8
no spanning-tree passive-listening-compatibility
Description
With this command you disable the "Enhanced Passive Listening Compatibility" function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
165
Network structures
6.3 Spanning Tree
Syntax
Call the command without parameter assignment:
no spanning-tree passive-listening-compatibility
Result
The "Enhanced Passive Listening Compatibility" function is disabled.
Further notes
You enable the function with the spanning-tree passive-listening-compatibility command.
You can display the status of this function with the show spanning-tree passive-listening-
compatibilitycommand.
6.3.5.9
Time settings for the Spanning Tree protocol
spanning-tree
Description
With this command, you configure the various time settings of the spanning tree function:
● With the forward-time option, you configure the time after which a port changes its
spanning tree status from "Blocking" to "Forwarding".
● With the hello-time option, you configure the time after which the bridge sends its
configuration frames (BPDUs).
● With the max-age option, you configure the time after which the information of the BPDUs
becomes invalid.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
spanning-tree{forward-time<seconds(4-30)>|hello-time<seconds(1-2)>|
max-age<seconds(6-40)>}
SCALANCE XB-200 Command Line Interface
166
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
The parameters have the following meaning:
Parameter
forward-time
seconds
Description
Range of values / note
Keyword for the time after which a port
changes its spanning tree status from
"Blocking" to "Forwarding"
-
Time after which the changeover takes
place
4 ... 30
hello-time
Keyword for the time after which the
bridge sends its configuration BPDUs
seconds
Time after which they are sent
Default: 15
1 ... 2
Default: 2
max-age
seconds
Keyword for the time after which the
information of the BPDUs becomes
invalid
-
Maximum age of the BPDUs in seconds
6 ... 40
Default: 20
Note
Dependencies when setting the timing
If you specify the time settings for spanning tree, you need to keep to the following two rules:
• 2 * (forward-time - 1) ≥ max-age
• max-age ≥ 2 * (hello-time + 1)
Result
The selected setting for the time is configured.
Further notes
You can reset the time to the default with the no spanning-tree command (time settings).
You display these settings and other information with the commands that start with show
spanning tree ....
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
167
Network structures
6.3 Spanning Tree
no spanning-tree
Description
With this command, you reset the various time settings of the spanning tree function to the
default value.
The default values are as follows:
Parameter
forward-time
hello-time
max-age
Default value
15 seconds
2 seconds
20 seconds
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no spanning-tree{forward-time|hello-time|max-age}
The parameters have the following meaning:
Parameter
forward-time
hello-time
max-age
Description
Time after which a port changes its spanning tree status from "Blocking" to
"Forwarding"
Time after which the bridge sends its configuration frames (BPDUs)
Time after which the information of the BPDUs becomes invalid
Result
The selected setting for the time is reset to the default value.
Further notes
You configure the time with the spanning-tree command (time settings).
You display these settings and other information with the commands that start with show
spanning tree ....
SCALANCE XB-200 Command Line Interface
168
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.6
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
6.3.6.1
spanning-tree
Description
With this command, you configure the various properties of the spanning tree function:
● With the cost option, you configure the port costs used to calculate the lowest-cost path.
● With the disable option, you disable the interface for the spanning tree function.
● With the link-type option, you configure the connection status of the following network
segment. The following settings are possible:
– point-to-point – the interface communicates with precisely one network component
– shared - the interface is connected to more than one network component
● With the portfast option, you enable the PortFast function on the interface. The interface
is connected to an end device and can therefore ignore the waiting time before changing
to Forwarding mode.
● With the port-priority option, you configure the priority of the interface for negotiating a
spanning tree configuration.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
spanning-tree {cost <0-200000000>|disable|
link-type{point-to-point|shared}|portfast|
port-priority<0-240>}
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
169
Network structures
6.3 Spanning Tree
The parameters have the following meaning:
Parameter
cost
Description
Range of values / note
Keyword
0 ... 200000000
Describes the costs of the port for
calculating the lowest cost path.
Default:
if dynamic calculation of the path
costs is not enabled:
•
disable
link-type
disables the interface for spanning tree
200000 for physical interfaces
Default:
The spanning tree function is
enabled on the interface
Connection status of the following
network segment
•
point-to-point
• shared
Default:
•
point-to-point
The connection is configured
as full-duplex
•
shared
in all other cases
portfast
Enables the PortFast function
port-priority
Priority of the interface
Default: disabled
0 ... 240 in steps of 16
Default: 128
Note
Configure multiple properties
With each call of the command, you can configure precisely one property.
If you want to configure several properties, call the command several times.
Result
The selected property is configured.
Further notes
You can reset the setting to the default with the no spanning-tree (properties) command.
You display these settings and other information with the commands that start with show
spanning tree ....
SCALANCE XB-200 Command Line Interface
170
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.6.2
no spanning-tree
Description
With this command, you reset the various properties of the spanning tree function to the
default value:
The default values are as follows:
Parameter
cost
Default value
if dynamic calculation of the path costs is not enabled:
•
disable
link-type
200000 for physical interfaces
The spanning tree function is enabled on the interface
•
point-to-point
The connection is configured as full-duplex
•
portfast
port-priority
shared
in all other cases
disabled
128
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
no spanning-tree {cost|disable|link-type|portfast|port-priority}
The parameters have the following meaning:
Parameter
cost
disable
link-type
Description
Keyword for the costs of the port for calculating the lowest-cost path.
Enables the interface for spanning tree.
Connection status of the following network segment
portfast
Disables the PortFast function.
port-priority
Keyword for the priority of the interface
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
171
Network structures
6.3 Spanning Tree
Note
Configure multiple properties
With each call of the command, you can configure precisely one property.
If you want to configure several properties, call the command several times.
Result
The selected setting was reset to the default value.
Further notes
You configure the setting with the spanning-tree command (properties).
You display these settings and other information with the commands that start with show
spanning tree ....
6.3.6.3
spanning-tree auto-edge
Description
With this command, you enable automatic discovery of a bridge connected to the interface.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
spanning-tree auto-edge
Result
The automatic discovery of a bridge on the interface is enabled.
Further notes
The automatic discovery of a bridge on the interface is enabled with the no spanning-tree
auto-edge command.
SCALANCE XB-200 Command Line Interface
172
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.6.4
no spanning-tree auto-edge
Description
With this command, you disable automatic discovery of a bridge connected to the interface.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no spanning-tree auto-edge
Result
The automatic discovery of a bridge on the interface is disabled.
Further notes
The automatic discovery of a bridge on the interface is disabled with the spanning-tree
command.
auto-edge
6.3.6.5
spanning-tree bpdu-transmit
Description
With this command, you enable or disable the BPDU transmit status at the port.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
spanning-tree bpdu-transmit{enabled|disabled}
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
173
Network structures
6.3 Spanning Tree
The parameters have the following meaning:
Parameter
enabled
disabled
Description
Range of values / note
BPDU packets are transmitted at the
port
Default: enabled
BPDU packets are not transmitted at
the port
-
Result
The BPDU transmit status has switched over.
Further notes
You can display the status of this function and other information with the show spanning tree
interface command with the detail option.
6.3.6.6
spanning-tree bpdu-receive
Description
With this command, you enable or disable the BPDU receive status at the port.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
spanning-tree bpdu-receive{enabled|disabled}
The parameters have the following meaning:
Parameter
enabled
disabled
Description
Range of values / note
BPDU packets are received at the port
Default: enabled
BPDU packets are ignored at the port
-
Result
The BPDU receive status is enabled or disabled.
SCALANCE XB-200 Command Line Interface
174
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
Further notes
You can display the status of this function and other information with the show spanning tree
interface command with the detail option.
6.3.6.7
spanning-tree bpdufilter
Description
With this command, you configure the BPDU transmit status for a port.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
spanning-tree bpdufilter{disable|enable}
The parameters have the following meaning:
Parameter
disable
enable
Description
Range of values / note
The transfer of BPDU packets is disabled for the port
Default: disabled
The transfer of BPDU packets is enabled for the port
-
Result
The BPDU transmit status is configured.
6.3.6.8
spanning-tree layer2-gateway-port
Description
With this command, you configure a port as a layer 2 gateway port.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
175
Network structures
6.3 Spanning Tree
Syntax
Call the command without parameters:
spanning-tree layer2-gateway-port
Result
The port is configured as a layer 2 gateway port.
Further notes
You delete the configuration of a port as a layer 2 gateway port with the commandno
spanning-tree layer2-gateway-port.
You can display other information with the show spanning tree interface command with the
detail option.
6.3.6.9
no spanning-tree layer2-gateway-port
Description
With this command, you delete the configuration of the port as a layer 2 gateway port.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no spanning-tree layer2-gateway-port
Result
The configuration of the port as a layer 2 gateway port is deleted.
Further notes
You configure a port as a layer 2 gateway port with the commandspanning-tree layer2-
gateway-port.
You can display other information with the show spanning tree interface command with the
option.
detail
SCALANCE XB-200 Command Line Interface
176
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.6.10
spanning-tree loop-guard
Description
This function prevents alternative ports or root ports becoming designated ports if there is a
disruption of a one-way link.
With this command, you enable the function.
Requirement
● Spanning tree is enabled.
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
spanning-tree loop-guard
Result
The "Spanning Tree Loop Guard" function is enabled.
Further notes
You disable the setting with the no spanning-tree loop-guard command.
You can display the status of this function and other information with the following
commands:
● show spanning-tree detail
● show spanning-tree active detail
● show spanning-tree interface
6.3.6.11
no spanning-tree loop-guard
Description
This function prevents alternative ports or root ports becoming designated ports if there is a
disruption of a one-way link.
With this command, you disable the function.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
177
Network structures
6.3 Spanning Tree
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no spanning-tree loop-guard
Result
The "Spanning Tree Loop Guard" function is disabled.
Further notes
You enable the setting with the spanning-tree loop-guard command.
You can display the status of this function and other information with the following
commands:
● show spanning-tree detail
● show spanning-tree active detail
● show spanning-tree interface
6.3.6.12
spanning-tree restricted-role
Description
With this command, you prevent the port adopting the role of root port.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
spanning-tree restricted-role
As default the function is "disabled".
SCALANCE XB-200 Command Line Interface
178
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
Result
The port is prevented from adopting the role of root port.
Further notes
You cancel the lock with the no spanning-tree restricted-role command.
You can display the status of this function and other information with the show spanning tree
command.
detail
6.3.6.13
no spanning-tree restricted-role
Description
With this command, you release the port for the role as root port.
Requirement
You are in the interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no spanning-tree restricted-role
Result
The port is released for the role of root port.
Further notes
You prevent the port adopting the role of the root port with the spanning-tree restrictedcommand.
role
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
179
Network structures
6.3 Spanning Tree
6.3.6.14
spanning-tree restricted-tcn
Description
With this command, you restrict the port for the Topology Change Notification (TCN)
function. The port cannot initiate any modifications to the network topology.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
spanning-tree restricted-tcn
Result
The port is prevented from using the TCN function.
Further notes
You cancel the lock with the no spanning-tree restricted-tcn command.
You can display the status of this function and other information with the show spanning tree
detail command.
SCALANCE XB-200 Command Line Interface
180
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.3 Spanning Tree
6.3.6.15
no spanning-tree restricted-tcn
Description
With this command, you release the port for the TCN function.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no spanning-tree restricted-tcn
Result
The port is released for the TCN function.
Further notes
You restrict the port for the TCN function with the spanning-tree restricted-tcn command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
181
Network structures
6.4 Passive Listening
6.4
Passive Listening
This section describes commands of the passive listening function.
If you enable passive listening, the IE switch forwards (R)STP configuration frames (BPDUs)
transparently even when (R)STP is disabled for it. The IE switch also reacts to topology
change frames. When the IE switch receives a TC frame, it deletes the MAC address table.
6.4.1
show passive-listening
Description
This command shows whether or not "passive listening" is enabled.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show passive-listening
Result
disabled is displayed
enabled is displayed.
if "passive listening" is disabled. If "passive listening" is enabled,
SCALANCE XB-200 Command Line Interface
182
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network structures
6.4 Passive Listening
6.4.2
passive listening
Description
This command enables "passive listening".
Requirement
Note
No simultaneous operation with STP/RSTP
"Passive listening" can only be enabled when STP/RSTP is disabled.
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
passive-listening
Result
The "passive listening" function is enabled.
Further notes
You disable "passive listening" with the no passive-listening command.
You display the status of "passive listening" with the show passive-listening command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
183
Network structures
6.4 Passive Listening
6.4.3
no passive-listening
Description
This command disables "passive listening".
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no passive-listening
Result
The "passive listening" function is disabled.
Further notes
You enable "passive listening" with the passive-listening command.
You display the status of "passive listening" with the show passive-listening command.
SCALANCE XB-200 Command Line Interface
184
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7
This part contains the sections that describe the commands for working with the various
network protocols.
7.1
IPv4 protocol
This section describes commands of the Internet Protocol (IP) version 4.
7.1.1
show ip gateway
Description
This command shows the default gateway configured for the device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ip gateway
Result
The default gateway is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
185
Network protocols
7.1 IPv4 protocol
7.1.2
show ip telnet
Description
This command shows the admin status and the port number of the Telnet server.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ip telnet
Result
The admin status and the port number of the Telnet server are displayed.
7.1.3
show dcp server
Description
This command shows whether or not the DCP function is enabled on the device.
If the DCP function is enabled, the read and write permissions are displayed.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show dcp server
Result
The overview of the status of the DCP function and access rights is displayed.
SCALANCE XB-200 Command Line Interface
186
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.1 IPv4 protocol
7.1.4
show dcp forwarding
Description
This command shows an overview of the DCP forwarding behavior on one or all interfaces.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show dcp forwarding [port<interface-type><interface-id>]
The parameters have the following meaning:
Parameter
port
interface-type
interface-id
Description
Range of values / note
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The overview of the DCP forwarding behavior is displayed.
7.1.5
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
187
Network protocols
7.1 IPv4 protocol
7.1.5.1
ip gateway
Description
With this command, you configure the default gateway.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
ip gateway <gateway>
The parameter has the following meaning:
Parameter
gateway
Description
Range of values
Specifies the IP address of the gateway
enter a valid IP address
Result
The entry is configured.
Further notes
You delete the default gateway with the no ip gateway command.
You show the default gateway with the show ip gateway command.
7.1.5.2
no ip gateway
Description
With this command, you delete the default gateway.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
188
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.1 IPv4 protocol
Syntax
Call up the command with the following parameters:
no ip gateway <gateway>
The parameter has the following meaning:
Parameter
gateway
Description
Range of values
Specifies the IP address of the gateway.
Specify a valid IP address.
Result
The entry is deleted.
Further notes
You configure the default gateway with the ip gateway command.
You show the default gateway with the show ip gateway command.
7.1.5.3
ip echo-reply
Description
To check the availability of a network node, packets of the Internet Control Message Protocol
(ICMP) can be sent to it. These packets of type 8 request the recipient to send a packet back
to the sender (echo reply).
With this command you enable the network node to react to ping queries.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
ip echo-reply
Result
"ICMP echo reply messages" are enabled. The network node reacts to ping queries.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
189
Network protocols
7.1 IPv4 protocol
Further notes
You disable the setting with the no ip echo-reply command.
7.1.5.4
no ip echo-reply
Description
With this command you stop the network node reacting to ping queries.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no ip echo-reply
Result
"ICMP echo reply messages" are disabled. The network node does not react to ping queries.
Further notes
You change the setting with the ip echo-reply command.
7.1.5.5
telnet-server
Description
With this command, you enable the Telnet server.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
190
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.1 IPv4 protocol
Syntax
Call the command without parameters:
telnet-server
As default the function is "enabled".
Result
The Telnet server is enabled.
Further notes
You disable the Telnet server with the no telnet-server command.
7.1.5.6
no telnet-server
Description
With this command, you disable the Telnet server.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no telnet-server
Result
The Telnet server is disabled.
Further notes
You enable the Telnet server with the telnet-server command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
191
Network protocols
7.1 IPv4 protocol
7.1.5.7
dcp server
Description
With this command, you configure the read and write permissions for the DCP server and
enable it.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
dcp server {read-only|read-write}
The parameters have the following meaning:
Parameter
read-only
read-write
Description
Range of values / note
only reading is permitted on the DCP
server
-
reading and writing is permitted on the
DPC server
Default: read-write
Result
The read and write permissions for the DPC server are configured.
The DCP server is enabled.
Further notes
You disable the DCP server with the no dcp server command.
SCALANCE XB-200 Command Line Interface
192
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.1 IPv4 protocol
7.1.5.8
no dcp server
Description
With this command, you disable the DCP server.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no dcp server
Result
The DCP server is disabled.
Further notes
You enable and configure the DCP server with the dcp server command.
7.1.6
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
193
Network protocols
7.1 IPv4 protocol
7.1.6.1
dcp forwarding
Description
With this command, you configure the forwarding behavior of the interface for DCP frames.
Note
PNIO configuration
Since DCP is a PROFINET protocol, the configuration created here is only effective with the
VLAN associated with the TIA interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
dcp forwarding {block|forward}
The parameters have the following meaning:
Parameter
block
forward
Description
Range of values / note
DCP frames are discarded
-
DCP frames are forwarded
Default: forward
Result
The forwarding behavior of the interface for DCP frames is configured.
SCALANCE XB-200 Command Line Interface
194
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.2 DHCP client
7.2
DHCP client
This section describes commands of the Dynamic Host Configuration Protocol (DHCP).
7.2.1
show ip dhcp client stats
Description
With this command, you display the statistical counters of the DHCP client.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ip dhcp client stats
Result
The counters are displayed.
7.2.2
show ip dhcp client
Description
With this command, you display the configuration settings of the DHCP client.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ip dhcp client
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
195
Network protocols
7.2 DHCP client
Result
The configuration settings of the DHCP client are displayed.
7.2.3
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
7.2.3.1
ip dhcp config-file-request
Description
If the DHCP config file request option is set, the device requests the TFTP address and the
name of a configuration file from the DHCP server. If the device is restarted following the
completed download, the configuration settings are read from this file.
With this command, you enable the DHCP config file request option.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
ip dhcp config-file-request
Result
The DHCP config file request option is enabled.
Further notes
You disable the DHCP config file request option with the no ip dhcp config-file-request
command.
SCALANCE XB-200 Command Line Interface
196
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.2 DHCP client
7.2.3.2
no ip dhcp config-file-request
Description
With this command, you disable the DHCP config file request option.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no ip dhcp config-file-request
Result
The DHCP config file request option is disabled.
Further notes
You enable the DHCP config file request option with the ip dhcp config-file-request
command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
197
Network protocols
7.2 DHCP client
7.2.3.3
ip dhcp client mode
Description
With this command, you configure the type of identifier with which the DHCP client logs on
with its DHCP server.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
ip dhcp client mode {mac|client-id<client-id>|sysname|pnio-name-of-station}
The parameters have the following meaning:
Parameter
mac
client-id
client-id
Description
Range of values / note
The client registers with its MAC address
-
The client registers with the assigned
ID
-
Name of the assigned ID
max. 32 characters
sysname
The client registers with the assigned
system name
-
pnio-name-ofstation
The client registers with the PNIO
name. The name is assigned with the
PST tool.
-
Result
The registration mode of the DHCP client is configured.
SCALANCE XB-200 Command Line Interface
198
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
7.3
SNMP
This section describes commands of the Simple Network Management Protocol (SNMP).
7.3.1
The "show" commands
This section describes commands with which you display various settings.
7.3.1.1
show snmp
Description
This command shows the status information of SNMP.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show snmp
Result
The status information is displayed.
7.3.1.2
show snmp community
Description
This command shows the details of the configured of SNMP communities.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
199
Network protocols
7.3 SNMP
Syntax
Call the command without parameters:
show snmp community
Result
The details of the configured SNMP communities are displayed.
7.3.1.3
show snmp engineID
Description
This command shows the SNMP identification number of the device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show snmp engineID
Result
The SNMP identification number of the device is displayed.
7.3.1.4
show snmp filter
Description
This command shows the configured SNMP filters.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
200
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Syntax
Call the command without parameters:
show snmp filter
Result
The configured SNMP filters are displayed.
7.3.1.5
show snmp group
Description
This command shows the configured SNMP groups.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show snmp group
Result
The configured SNMP groups are displayed.
7.3.1.6
show snmp group access
Description
This command shows the rights of the configured SNMP groups.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
201
Network protocols
7.3 SNMP
Syntax
Call the command without parameters:
show snmp group access
Result
The rights of the configured SNMP groups are displayed.
7.3.1.7
show snmp inform statistics
Description
This command shows the statistics of the Inform Messages.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show snmp inform statistics
Result
The statistics of the Inform Messages are displayed.
7.3.1.8
show snmp notif
Description
With this command, you display the configured SNMP notification types.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
202
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Syntax
Call the command without parameters:
show snmp notif
Result
The configured SNMP notification types are displayed.
7.3.1.9
show snmp targetaddr
Description
This command shows the configured SNMP target addresses.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show snmp targetaddr
Result
The configured SNMP target addresses are displayed.
7.3.1.10
show snmp targetparam
Description
This command shows the configured SNMP target parameters.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
203
Network protocols
7.3 SNMP
Syntax
Call the command without parameters:
show snmp targetparam
Result
The configured SNMP target parameters are displayed.
7.3.1.11
show snmp tcp
Description
This command shows the configuration for SNMP via TCP.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show snmp tcp
Result
The configuration for SNMP via TCP is displayed.
7.3.1.12
show snmp user
Description
This command shows the settings for the SNMP user.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
204
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Syntax
Call the command without parameters:
show snmp user
Result
The settings for the SNMP user are displayed.
7.3.1.13
show snmp viewtree
Description
This command shows the settings for the SNMP tree views.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show snmp viewtree
Result
The settings for the SNMP tree views are displayed.
7.3.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
205
Network protocols
7.3 SNMP
7.3.2.1
snmpagent
Description
With this command, you enable the SNMP agent function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
snmpagent
Result
The SNMP agent function is enabled.
Further notes
You disable the SNMP agent function with theno snmpagent command.
7.3.2.2
no snmpagent
Description
With this command, you disable the SNMP agent function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no snmpagent
SCALANCE XB-200 Command Line Interface
206
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Result
The SNMP agent function is disabled.
Further notes
You enable the SNMP agent function with the snmpagent command.
7.3.2.3
snmp agent version
Description
With this command, you configure whether all SNMP queries or only SNMPv3 queries are
processed.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp agent version{v3only|all}
The parameters have the following meaning:
Parameter
v3only
all
Description
Range of values / note
only SNMPv3 queries are processed
-
all SNMP queries are processed
Default: all
Result
The setting is configured.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
207
Network protocols
7.3 SNMP
7.3.2.4
snmp access
Description
With this command, you configure the access to an SNMP group.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp access <GroupName>{v1|v2c|v3{auth|noauth|priv}}
[read <ReadView|none>][write <WriteView|none>][notify <NotifyView|none>]
[{volatile|nonvolatile}]
The parameters have the following meaning:
Parameter
GroupName
-
-
Description
Range of values / note
Name of the group to which access is
configured
max. 32 characters
Selects the version of the protocol
used
•
v1
•
v2c
•
v3
•
auth
Selects the authentication method:
enables MD5 or SHA as authentication method
•
noauth
no authentication
•
priv
enables authentication and
encryption
read
write
the data can be read
•
Keyword
ReadView
•
none
the data can be read and written
•
Keyword
WriteView
•
none
SCALANCE XB-200 Command Line Interface
208
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Parameter
notify
Storage type
Description
Range of values / note
Changes can be set as a tag
•
Keyword
NotifyView
•
none
specifies whether the settings remain
following a restart
•
volatile (volatile):
The settings are lost after a
restart
•
nonvolatile (non-volatile):
The settings are retained after
a restart
The keywords need to be specified.
If optional parameters are not specified when configuring a group, the default value will be
used.
Result
The settings for access to an SNMP group are configured.
Further notes
You delete the access to an SNMP group with the no snmp access command.
You display the configured SNMP groups with the show snmp group command.
You display the access configurations for SNMP groups with the show snmp group access
command.
You display the configured SNMP tree views with the show snmp viewtree command.
7.3.2.5
no snmp access
Description
With this command, you delete the access to an SNMP group.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp access <GroupName>{v1|v2c|v3{auth|noauth|priv}}
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
209
Network protocols
7.3 SNMP
The parameters have the following meaning:
Parameter
GroupName
Version
Authentication
Description
Range of values / note
Name of the group to which access is
deleted
max. 32 characters
Selects the version of the protocol
used
•
v1
•
v2c
•
v3
•
auth
•
noauth
•
priv
Selects the authentication method:
Result
The access to an SNMP group is deleted.
Further notes
You configure the setting with the snmp access command.
You display the configured SNMP groups with the show snmp group command.
You display the access configurations for SNMP groups with the show snmp group access
command.
You display the configured SNMP tree views with the show snmp viewtree command.
7.3.2.6
snmp community index
Description
With this command, you configure the details of an SNMP community.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp community index <CommunityIndex> name <CommunityName>
security <SecurityName> [context <Name>][{volatile|nonvolatile}]
SCALANCE XB-200 Command Line Interface
210
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
The parameters have the following meaning:
Parameter
CommunityIndex
name
CommunityName
security
SecurityName
context
Description
Range of values / note
Index of the community
max. 32 characters
Keyword for the name of the community
-
Name of the community
max. 32 characters
Keyword for the security name
-
Security name
max. 32 characters
Keyword for the context name
-
Name
Context name
max. 32 characters
Storage type
specifies whether the settings remain
following a restart
•
volatile (volatile):
The settings are lost after a
restart
•
nonvolatile (non-volatile):
The settings are retained after
a restart
If optional parameters are not specified when configuring a community, the default values
apply.
Result
The settings are configured.
Further notes
You delete the details of an SNMP community with the no snmp community index command.
You show the details of an SNMP community with the show snmp community command.
You show the status information of the SNMP communication with the show snmp command.
7.3.2.7
no snmp community index
Description
With this command, you delete the details of an SNMP community.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
211
Network protocols
7.3 SNMP
Syntax
Call up the command with the following parameters:
no snmp community index <CommunityIndex>
The parameter has the following meaning:
Parameter
CommunityIndex
Description
Range of values / note
Name of the community
max. 32 characters
Result
The details of an SNMP community are deleted.
Further notes
You configure the details of an SNMP community with the snmp community index command.
You show the details of an SNMP community with the show snmp community command.
You show the status information of the SNMP communication with the show snmp command.
7.3.2.8
snmp group
Description
With this command, you configure the details of an SNMP group.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp group <GroupName> user <UserName>security-model{v1|v2c|v3}
[{volatile|nonvolatile}]
The parameters have the following meaning:
Parameter
GroupName
user
UserName
Description
Range of values / note
Name of the group
max. 32 characters
Keyword for the user name
-
Name of the user
max. 32 characters
SCALANCE XB-200 Command Line Interface
212
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Parameter
security-model
Storage type
Description
Range of values / note
specifies which security settings will be
used
•
v1
•
v2c
•
v3
•
volatile (volatile):
specifies whether the settings remain
following a restart
The settings are lost after a
restart
•
nonvolatile (non-volatile):
The settings are retained after
a restart
If optional parameters are not specified when configuring a group, the default values apply.
Result
The details of the group are configured.
Further notes
You delete the details of an SNMP group with the no snmp group command.
You display the created SNMP groups with the show snmp group command.
You display the created SNMP user with the show snmp user command.
7.3.2.9
no snmp group
Description
With this command, you delete the details of an SNMP group.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no snmp group <GroupName> user <UserName>security-model{v1|v2c|v3}
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
213
Network protocols
7.3 SNMP
The parameters have the following meaning:
Parameter
GroupName
user
Description
Range of values / note
Name of the group
max. 32 characters
Keyword for the user name
-
UserName
Name of the user
max. 32 characters
security-model
Specifies which security settings are
used for sending
•
v1
•
v2c
•
v3
Result
The details of the group are deleted.
Further notes
You change the details of an SNMP group with the snmp group command.
You display the created SNMP groups with the show snmp group command.
You display the created SNMP user with the show snmp user command.
7.3.2.10
snmp notify
Description
With this command, you configure the details of the SNMP notifications.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp notify <NotifyName> tag <TagName> type {Trap|Inform}
[{volatile|nonvolatile}]]
The parameters have the following meaning:
Parameter
NotifyName
tag
TagName
Description
Range of values / note
Name of the SNMP notification
max. 32 characters
Keyword for a target key
-
Name of the target key
max. 32 characters
SCALANCE XB-200 Command Line Interface
214
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Parameter
Type
Description
Range of values / note
Type of the SNMP notification
•
Trap
generates a trap
•
Inform
generates a log entry or sends
an entry to the log server
Storage type
specifies whether the settings remain
following a restart:
•
volatile (volatile):
The settings are lost after a
restart
•
nonvolatile (non-volatile):
The settings are retained after
a restart
Result
The details of the SNMP notifications are configured.
Further notes
You delete the details of an SNMP group with the no snmp notify command.
You display the configured SNMP notifications with the show snmp notif command.
You display the configured SNMP target addresses with the show snmp targetaddr
command.
7.3.2.11
no snmp notify
Description
With this command, you delete the details of the SNMP notifications.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no snmp notify <NotifyName>
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
215
Network protocols
7.3 SNMP
The parameter has the following meaning:
Parameter
NotifyName
Description
Range of values / note
Name of the notification
max. 32 characters
Result
The details of the SNMP notifications are deleted.
Further notes
You change the details of an SNMP group with the snmp notify command.
You display the configured SNMP notifications with the show snmp notif command.
You display the configured SNMP target addresses with the show snmp targetaddr
command.
7.3.2.12
snmp targetaddr
Description
With this command, you configure the SNMP target addresses.
Requirement
● The SNMP target parameters are configured.
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp targetaddr <TargetAddressName> param <ParamName> {ipv4<IPAddress>}
[timeout <Seconds(1-1500)] [retries <RetryCount(1-3)]
[taglist <TagIdentifier | none>] [{volatile | nonvolatile}]
[port <integer (1-65535)>]
The parameters have the following meaning:
Parameter
TargetAddressName
param
ParamName
Description
Range of values
Name of the target address
max. 32 characters
Keyword for the parameter name
-
Name of the destination address or
the designation of the parameter
name
max. 32 characters
SCALANCE XB-200 Command Line Interface
216
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Parameter
ipv4
IPAddress
Description
Range of values
Keyword for an IPv4 address
-
Value for an IPv4 unicast address
Enter a valid IPv4 unicast address.
timeout
Keyword for the time the SNMP
agent waits for a response before it
repeats the inform request message
-
Seconds
Time in seconds
1 ... 1500
retries
RetryCount
taglist
TagIdentifier
none
volatile
nonvolatile
Keyword for the maximum number of attempts to obtain a response to an
inform request message
Number of attempts
1 ... 3
Keyword for tag list
-
Tag identifier that selects the destination address for SNMP.
Specify the tag identifier.
No tag identifier
-
Specifies whether the settings remain following a restart.
•
volatile:
The default settings are used after a restart.
•
nonvolatile:
The saved settings are used after a restart.
port
Keyword for the port number at
which the SNMP manager receives
traps and inform messages
-
integer
Port number
1 ... 65535
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If optional parameters are not specified when configuring, the following defaults apply:
Parameter
taglist
Default value
snmp
Type of storage
volatile
port
162
Result
The SNMP target address is configured.
Further notes
You delete the SNMP target address with the no snmp targetaddr command.
You display the SNMP target address with the show snmp targetaddr command.
You configure the SNMP target parameters with the snmp targetparams command.
You display the SNMP target parameters with the show snmp targetparam command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
217
Network protocols
7.3 SNMP
7.3.2.13
no snmp targetaddr
Description
With this command, you delete the SNMP target address.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no snmp targetaddr <TargetAddressName>
The parameter has the following meaning:
Parameter
TargetAddressName
Description
Range of values / note
SNMP target address
max. 32 characters
Result
The SNMP target address is deleted.
Further notes
You change the SNMP target address with the snmp targetaddr command.
You display the SNMP target address with the show snmp targetaddr command.
7.3.2.14
snmp targetparams
Description
With this command, you configure the SNMP target parameters.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
218
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Syntax
Call up the command with the following parameters:
snmp targetparams <ParamName>
user <UserName>
security-model {v1|v2c|v3{auth|noauth|priv}}
message-processing {v1|v2c|v3}[{volatile|nonvolatile}]
The parameters have the following meaning:
Parameter
ParamName
Description
Range of values / note
Name of the SNMP parameter
max. 32 characters
Keyword for the user name
-
UserName
Value for the user name
max. 32 characters
security-model
Specifies which SNMP version is used. •
With SNMPv3 a security level (authentication, encryption) can also be configured.
user
•
SNMP version
–
–
–
v1
v2c
v3
Security level for v3
–
auth
Authentication enabled /
no encryption enabled
–
noauth
No authentication enabled,
no encryption enabled
–
message-processing
priv
Authentication enabled /
encryption enabled
Specifies which SNMP version is used •
for processing the messages and
whether the settings remain following a
restart.
•
SNMP version
–
–
–
v1
v2c
v3
Settings after the restart
–
volatile (volatile):
–
nonvolatile (non-
The settings are lost after
a restart
volatile):
The settings are retained
after a restart
Keywords need to be specified.
If optional parameters are not specified when configuring, the default values apply.
Result
The SNMP target parameters are configured.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
219
Network protocols
7.3 SNMP
Further notes
You delete the SNMP target parameters with the no snmp targetparams command.
You display settings of this function with the show snmp targetparam command.
You configure the user profile with the snmp user command.
You configure a filter with the snmp filterprofile command.
You display the list of users with the show snmp user command.
7.3.2.15
no snmp targetparams
Description
With this command, you delete the SNMP target parameters.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no snmp targetparams <ParamName>
The parameter has the following meaning:
Parameter
ParamName
Description
Range of values / note
Name of the SNMP parameter
max. 32 characters
Result
The SNMP target parameters are deleted.
Further notes
You change the SNMP target parameters with the snmp targetparams command.
You display settings of this function with the show targetparam command.
SCALANCE XB-200 Command Line Interface
220
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
7.3.2.16
snmp v1-v2 readonly
Description
With this command, you block write access for SNMPv1 and SNMPv2 PDUs.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
snmp v1-v2 readonly
Result
Write access for SNMPv1 and SNMPv2 PDUs is blocked.
Further notes
You release write access for SNMPv1 and SNMPv2 PDUs with the no snmp v1-v2 readonly
command.
7.3.2.17
no snmp v1-v2 readonly
Description
With this command, you enable write access for SNMPv1 and SNMPv2 PDUs.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no snmp v1-v2 readonly
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
221
Network protocols
7.3 SNMP
Result
Write access for SNMPv1 and SNMPv2 PDUs is enabled.
Further notes
You block write access for SNMPv1 and SNMPv2 PDUs with the snmp v1-v2 readonly
command.
7.3.2.18
snmp user
Description
With this command, you configure the details of an SNMP user.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp user <UserName>[auth{md5|sha} <passwd>[priv DES<passwd>]]
[{volatile|nonvolatile}]
The parameters have the following meaning:
Parameter
UserName
auth
passwd
priv DES
Description
Range of values / note
Name of the user
max. 32 characters
specifies that authentication takes place
and which algorithm is used
•
md5 (Message Digest 5)
• sha (Secure Hash Algorithm)
Default: No authentication
Password for authentication
max. 32 characters
specifies that there is encryption
Default: no encryption
passwd
Value for the password of the encryption max. 32 characters
Storage type
specifies whether the settings remain
following a restart:
•
volatile (volatile):
The default settings are used after a
restart
•
nonvolatile (non-volatile):
The saved settings are used after a
restart
If optional parameters are not specified when configuring an SNMP user, the defaults values
apply.
SCALANCE XB-200 Command Line Interface
222
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Result
The details of the SNMP user are configured.
Further notes
You delete the settings with the no snmp user command.
You display the configured users with the show snmp user command.
7.3.2.19
no snmp user
Description
With this command, you delete the details of an SNMP user.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no snmp user <UserName>
The parameter has the following meaning:
Parameter
UserName
Description
Range of values / note
Name of the user
max. 32 characters
Result
The details of the SNMP user are deleted.
Further notes
You change the settings with the snmp user command.
You display the configured users with the show snmp user command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
223
Network protocols
7.3 SNMP
7.3.2.20
snmp view
Description
With this command, you configure an SNMP view.
Requirement
● An SNMP group has been created
● The access to the group is configured with snmp access
● You are in the Global Configuration mode.
The command prompt is:
cli(config)#
Syntax
Call up the command with the following parameters:
snmp view <ViewName><OIDTree>[mask<OIDMask>]{included|excluded}
[{volatile|nonvolatile}]
The parameters have the following meaning:
Parameter
ViewName
OIDTree
mask
Description
Range of values / note
Name of the SNMP view
max. 32 characters
Object ID
Path information of the MIB tree
Keyword for the OID mask
-
OIDMask
Mask that filters access to the elements of the MIB tree
A series of "0" and "1" separated
by dots in keeping with the path
information of the MIB tree
View type
Specifies whether the filtered elements
are used or excluded
•
include (Default)
•
excluded
specifies whether the settings remain
following a restart:
•
volatile (volatile):
The settings are lost after a
restart
•
nonvolatile (non-volatile):
The settings are retained after
a restart (default)
Storage type
If optional parameters are not specified when configuring, the default values apply.
Result
The SNMP view is configured.
SCALANCE XB-200 Command Line Interface
224
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.3 SNMP
Further notes
You delete the view with the no snmp view command.
You display the configured view trees with the show snmp viewtree command.
You display the SNMP group access rights with the show snmp group access command.
You configure the SNMP group access rights with the snmp access command.
7.3.2.21
no snmp view
Description
With this command, you delete an SNMP view.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no snmp view <ViewName><OIDTree>
The parameters have the following meaning:
Parameter
ViewName
OIDTree
Description
Range of values / note
Name of the view
max. 32 characters
Object ID
Path information of the MIB tree
Result
The SNMP view is deleted.
Further notes
You configure a view with the snmp view command.
You display the configured view trees with the show snmp viewtree command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
225
Network protocols
7.4 SMTP client
7.4
SMTP client
This section describes commands of the Simple Mail Transfer Protocol (SMTP).
7.4.1
show events smtp-server
Description
This command shows the configured e-mail servers.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show events smtp-server
Result
The configured e-mail servers are displayed.
7.4.2
show events sender email
Description
This command shows the configured e-mail sender address.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show events sender email
SCALANCE XB-200 Command Line Interface
226
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.4 SMTP client
Result
The configured e-mail sender address is displayed.
7.4.3
show events smtp-port
Description
This command shows the configured SNMP port.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show events smtp-port
Result
The configured SMTP port is displayed.
7.4.4
Commands in the Events configuration mode
This section describes commands that you can call up in the EVENTS configuration mode.
In the Global configuration mode, enter the events command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
● If you exit the EVENTS configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the EVENTS configuration mode with the end command, you return to the
Privileged EXEC mode.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
227
Network protocols
7.4 SMTP client
7.4.4.1
smtp-server
Description
With this command, you configure an entry for an SMTP server.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
smtp-server {ipv4 <ucast_addr>} <receiver mail-address>
The parameters have the following meaning:
Parameter
ipv4
ucast_addr
receiver mail-address
Description
Range of values
Keyword for an IPv4 address
-
Value for an IPv4 unicast address
Enter a valid IPv4 unicast address.
Name of the recipient
max. 100 characters
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
An entry for the SMTP server is configured.
Further notes
You delete an SMTP server entry with the no smtp-server command.
SCALANCE XB-200 Command Line Interface
228
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.4 SMTP client
7.4.4.2
no smtp-server
Description
With this command, you delete an SMTP server entry.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
no smtp-server ipv4 <ucast_addr>
The parameter has the following meaning:
Parameter
ipv4
ucast_addr
Description
Range of values
Keyword for an IPv4 address
-
Value for an IPv4 address
Enter a valid IPv4 address.
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The SMTP server entry is deleted.
Further notes
You configure an e-mail server entry with the smtp-server command.
7.4.4.3
sender mail-address
Description
With this command, you configure the e-mail name of the sender.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
229
Network protocols
7.4 SMTP client
Syntax
Call up the command with the following parameters:
sender mail-address <mail-address>
The parameter has the following meaning:
Parameter
mail-address
Description
Range of values / note
Email name of the sender
max. 100 characters
Result
The e-mail name of the sender is configured.
Further notes
You reset the e-mail name of the sender with the no sender mail-address.
You display the setting with the show events sender email command.
7.4.4.4
no sender mail-address
Description
With this command, you reset the e-mail name of the sender.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call the command without parameters:
no sender mail-address
Result
The e-mail name of the sender is reset.
Further notes
You configure the e-mail name of the sender with the sender mail-address.
You display the setting with the show events sender email command.
SCALANCE XB-200 Command Line Interface
230
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.4 SMTP client
7.4.4.5
send test mail
Description
With this command, you send an e-mail according to the currently configured SMTP settings.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call the command without parameters:
send test mail
Result
An e-mail according to the currently configured SMTP settings is sent.
Further notes
You can display the current SMTP settings with the show events smtp-server command.
7.4.4.6
smtp-port
Description
With this command, you configure an SMTP port.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
smtp-port <smtp-port(1-65535)>
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
231
Network protocols
7.4 SMTP client
The parameter has the following meaning:
Parameter
smtp-port
Description
Range of values / note
Value for the SMTP port
1 ... 65535
Default: 25
Result
An SMTP port is configured.
Further notes
You can reset the setting to the default with the no smtp-port command.
You display the setting with the show smtp-port command.
7.4.4.7
no smtp-port
Description
With this command, you reset the SMTP port to the default.
The default value is 25.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call the command without parameters:
no smtp-port
Result
The SMTP port is reset to the default value.
Further notes
You configure the setting with the smtp-port command.
You display the setting with the show smtp-port command.
SCALANCE XB-200 Command Line Interface
232
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.5 HTTP server
7.5
HTTP server
This section describes commands of the Hypertext Transfer Protocol (HTTP).
7.5.1
show ip http server status
Description
This command shows the status of the HTTP server.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ip http server status
Result
The status of the HTTP server is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
233
Network protocols
7.5 HTTP server
7.5.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
7.5.2.1
ip http
Description
With this command, you enable HTTP on the device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
ip http
As default the function is "enabled".
Result
HTTP is enabled on the device.
Further notes
You can display the setting of this function and other information with the show ip http
server statuscommand.
You deactivate HTTP on the device with the no ip http command.
SCALANCE XB-200 Command Line Interface
234
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.5 HTTP server
7.5.2.2
no ip http
Description
With this command, you disable HTTP on the device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no ip http
Result
HTTP is disabled on the device.
Further notes
You can display the setting of this function and other information with the show ip http
server statuscommand.
You enable HTTP with the ip http command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
235
Network protocols
7.6 HTTPS server
7.6
HTTPS server
This section describes commands of the Hypertext Transfer Protocol Secure (HTTPS).
7.6.1
show ip http secure server status
Description
This command shows the status of the HTTPS server.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ip http secure server status
Result
The status, cipher suite and version of the HTTPS server are displayed.
SCALANCE XB-200 Command Line Interface
236
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.6 HTTPS server
7.6.2
show ssl server-cert
Description
This command shows the SSL server certificate.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ssl server-cert
Result
The SSL server certificate is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
237
Network protocols
7.7 ARP
7.7
ARP
This section describes commands of the Address Resolution Protocol (ARP).
7.7.1
show ip arp
Description
With this command, you display the IP ARP table.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show ip arp [{Vlan<vlan-id(1-4094)>|<interface-type><interface-id>|
<ip-address>|<mac-address>|summary|information}]
The parameters have the following meaning:
Parameter
Vlan
vlan-id
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
interface-type
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
ip-address
Shows the IP addresses of the entries
in the ARP table
-
Shows the MAC addresses of the entries in the ARP table
-
summary
Shows a summary of the entries in the
ARP table
-
information
Displays information on the ARP configuration
-
mac-address
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the IP ARP table is displayed.
Result
The IP ARP table is displayed.
SCALANCE XB-200 Command Line Interface
238
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.7 ARP
7.7.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
7.7.2.1
arp timeout
Description
With this command, you configure the timeout setting of the ARP cache.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
arp timeout <seconds(30-86400)>
The parameter has the following meaning:
Parameter
Description
seconds
Range of values /
note
Value for the timeout in seconds
30 ... 86400
Default: 300
Result
The setting for the timeout setting of the ARP cache is configured.
Further notes
You can reset the timeout setting to the default with the no arp timeout command.
You can display the status of this function and other information with the show ip arp
command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
239
Network protocols
7.7 ARP
7.7.2.2
no arp timeout
Description
With this command, you reset the timeout setting of the ARP cache back to the default value.
The default value for the timeout setting is 300 seconds.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no arp timeout
Result
The timeout setting for the ARP cache is reset to the default value.
Further notes
You change the timeout setting with the arp timeout command.
You can display the status of this function and other information with the show ip arp
command.
SCALANCE XB-200 Command Line Interface
240
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.8 SSH server
7.8
SSH server
This section describes commands of the Secure Shell (SSH) Server.
7.8.1
show ip ssh
Description
This command shows the settings of the SSH server.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ip ssh
Result
The settings for the SSH server are displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
241
Network protocols
7.8 SSH server
7.8.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
7.8.2.1
ssh-server
Description
With this command, you enable the SSH protocol on the device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
ssh-server
As default the function is "enabled".
Result
The SSH protocol is enabled on the device.
Further notes
You disable the SSH protocol with the no ssh-server command.
SCALANCE XB-200 Command Line Interface
242
Configuration Manual, 04/2015, C79000-G8976-C361-02
Network protocols
7.8 SSH server
7.8.2.2
no ssh-server
Description
With this command, you disable the SSH protocol on the device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no ssh-server
Result
The SSH protocol is disabled on the device.
Further notes
You enable the SSH protocol with the ssh-server command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
243
Network protocols
7.8 SSH server
SCALANCE XB-200 Command Line Interface
244
Configuration Manual, 04/2015, C79000-G8976-C361-02
8
Layer 2 management protocols
8.1
Introduction to the section "Layer 2 management protocols"
In this part, you will find sections relating to the topics GARP, IGMP snooping and IGMP
querying.
8.2
IGMP snooping
This section describes the snooping functionality of the Internet Group Management
Protocol.
8.2.1
show ip igmp snooping
Description
This command shows information about IGMP snooping for all or a selected VLAN.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode or in the Global
configuration mode.
The command prompt is as follows:
cli>
or cli# or cli(config)#
Syntax
Call up the command with the following parameters:
show ip igmp snooping [Vlan<vlan id]
The parameters have the following meaning:
Parameter
Vlan
vlan id
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
245
Layer 2 management protocols
8.2 IGMP snooping
Result
The information about IGMP snooping is displayed.
8.2.2
show ip igmp snooping forwarding-database
Description
This command shows the multicast forwarding entries for all or a selected VLAN.
Requirement
● IGMP snooping is enabled on the device
● You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is:
cli> or cli#
Syntax
Call up the command with the following parameters:
show ip igmp snooping forwarding-database [Vlan<vlan id>]
The parameters have the following meaning:
Parameter
Vlan
vlan id
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The multicast forwarding entries are displayed.
SCALANCE XB-200 Command Line Interface
246
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.2 IGMP snooping
8.2.3
show ip igmp snooping statistics
Description
This command shows the statistical information about IGMP snooping for all or a selected
VLAN.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show ip igmp snooping statistics [Vlan<vlan id>]
The parameters have the following meaning:
Parameter
Vlan
vlan id
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The statistical information is displayed.
8.2.4
show ip igmp snooping switch-ip
Description
This command shows the IP address of the source for IGMP snooping.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
247
Layer 2 management protocols
8.2 IGMP snooping
Syntax
Call the command without parameters:
show ip igmp snooping switch-ip
Result
The IP address is displayed.
8.2.5
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
8.2.5.1
ip igmp snooping version
Description
This command specifies which version of IGMP the device will use. When shipped, the
device uses IGMPv3.
Note
There is no separate show command to display the version of IGMP used by the device.
This information is shown when you enter the show ip igmp snooping command in the User
EXEC mode or in the Privileged EXEC mode.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
ip igmp snooping version {v1 | v2 | v3}
SCALANCE XB-200 Command Line Interface
248
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.2 IGMP snooping
The parameters have the following meaning:
Parameter
v1
v2
v2
Description
IGMPv1
IGMPv2
IGMPv3
Result
The version of IGMP used by the device is specified.
8.2.5.2
ip igmp vlan-snooping
Description
With this command, you enable IGMP snooping for all VLANs.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
ip igmp vlan-snooping
Result
IGMP snooping is enabled for all VLANs.
Further notes
You disable IGMP snooping with the no ip igmp vlan-snooping command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
249
Layer 2 management protocols
8.2 IGMP snooping
8.2.5.3
no ip igmp vlan-snooping
Description
With this command, you disable IGMP snooping for all VLANs.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no ip igmp vlan-snooping
Result
IGMP snooping is disabled for all VLANs.
Further notes
You enable IGMP snooping with the ip igmp vlan-snooping command.
8.2.5.4
ip igmp snooping clear counters
Description
With this command, you delete the counters for all or a selected VLAN.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
ip igmp snooping clear counters [Vlan<vlan id>]
SCALANCE XB-200 Command Line Interface
250
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.2 IGMP snooping
The parameters have the following meaning:
Parameter
vlan
vlan id
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select a VLAN, the counters of all VLANs will be deleted.
Result
The counters are deleted.
8.2.5.5
ip igmp snooping switch-ip
Description
With this command, you configure the IP address of the source for IGMP snooping.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
ip igmp snooping switch-ip<switch-ipaddr>
The parameter has the following meaning:
Parameter
switch-ipaddr
Description
Range of values / note
Address of the source
specify a valid IP address
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The IP address is configured.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
251
Layer 2 management protocols
8.2 IGMP snooping
8.2.5.6
ip igmp snooping port-purge-interval
Description
The time after which a port is deleted from the list if no IGMP router control packets are
received is known as the purge time.
With this command, you configure this purge time for a port for a VLAN in seconds.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
ip igmp snooping port-purge-interval <(130-1225)seconds>
The parameters have the following meaning:
Parameter
Description
Range of values / note
-
Value for the purge time in seconds
130 ... 1225
Default: 260
Result
The purge time is configured.
Further notes
You can reset the setting to the default with the no ip igmp snooping port-purge-interval
command.
You can display the status of this function and other information with the show ip igmp
snooping globals command.
SCALANCE XB-200 Command Line Interface
252
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.2 IGMP snooping
8.2.5.7
no ip igmp snooping port-purge-interval
Description
With this command, you reset the setting for the purge time to the default value.
The default value is 260 seconds.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no ip igmp snooping port-purge-interval
Result
The purge time is reset to the default value.
Further notes
You configure the setting with the ip igmp snooping port-purge-interval command.
You can display the status of this function and other information with the show ip igmp
snooping globalscommand.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
253
Layer 2 management protocols
8.3 IGMP querier
8.3
IGMP querier
This section describes the commands for the query functionality of the Internet Group
Management Protocol (IGMP).
8.3.1
Commands in the Global Configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
8.3.1.1
ip igmp snooping querier
Description
With this command, you configure the IGMP snooping switch as querier.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
ip igmp snooping querier
As default the function is "disabled".
Result
The IGMP snooping switch is configured as querier.
Further notes
You delete the setting with the no ip igmp snooping querier command.
You can display the status of this function and other information with the show ip igmp
snooping command.
SCALANCE XB-200 Command Line Interface
254
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.3 IGMP querier
8.3.1.2
no ip igmp snooping querier
Description
With this command, you delete the configuration of an IGMP snooping switch as querier.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no ip igmp snooping querier
Result
The configuration of the IGMP snooping switch as querier is deleted.
Further notes
You configure the setting with the ip igmp snooping querier command.
You can display the status of this function and other information with the show ip igmp
snooping command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
255
Layer 2 management protocols
8.4 Ring redundancy and standby connection
8.4
Ring redundancy and standby connection
The ring redundancy function allows several devices to be interconnected in a ring structure.
Since such a topology is not supported in normal network operation, such rings are logically
disconnected using the Media Redundancy Protocol (MRP) or the High Speed Redundancy
Protocol (HRP). If one component fails, all other elements of the ring can still be reached.
The device that logically disconnects the ring is known as the Redundancy Manager (RM).
The simple structure of the individual MRP rings allows shorter reaction times if disruptions
occur.
Complex network topologies cannot be set up with this function.
This means that two rings can be connected redundantly in each case via two links (master,
slave). This function is known as the standby connection.
One link is active on an interface of the master device and the second is inactive on an
interface of the slave device.
Note
Position of master and slave device
The master and slave device of a standby connection (link pair between different structures
of the ring redundancy) must be located in the same ring.
This section describes commands of the ring redundancy function.
Note
Avoiding bad configurations
When using the commands in this section, you should take particular care because a bad
configuration of this function can have serious negative affects on the network.
8.4.1
clear hrp counters
Description
With this command, you reset the HRP counters.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
SCALANCE XB-200 Command Line Interface
256
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.4 Ring redundancy and standby connection
Syntax
Call the command without parameters:
clear hrp counters
Result
The HRP counters have been reset.
8.4.2
clear standby counter
Description
With this command, you reset the counters of the standby function.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call the command without parameters:
clear standby counter
Result
The standby counter is reset.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
257
Layer 2 management protocols
8.4 Ring redundancy and standby connection
8.4.3
The "show" commands
This section describes commands with which you display various settings.
8.4.3.1
show hrp counters
Description
With this command, you display the following information:
● How often the device as redundancy manager switched to the active status, i.e. closed
the ring.
● The maximum delay time of the test frames of the redundancy manager.
● How often the IE switch has changed the standby status from "Passive" to "Active".
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show hrp counters
Result
The counters are displayed.
8.4.3.2
show ring-redundancy
Description
With this command, you show the current configuration of the ring redundancy and standby
functions.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
258
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.4 Ring redundancy and standby connection
Syntax
Call the command without parameters:
show ring-redundancy
Result
The current configurations are displayed.
8.4.3.3
show ring-redundancy manager counters
Description
With this command, you display the following information:
● How often the device as redundancy manager switched to the active status, i.e. closed
the ring.
● The maximum delay time of the test frames of the redundancy manager.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show ring-redundancy manager counters
Result
The counters are displayed.
8.4.4
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
259
Layer 2 management protocols
8.4 Ring redundancy and standby connection
8.4.4.1
ring-redundancy configuration
Description
With this command, you change to the Redundancy Configuration mode.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
ring-redundancy configuration
Result
You are now in the Redundancy Configuration mode.
The command prompt is as follows:
cli(config-red)#
Further notes
You exit the Redundancy Configuration mode with the end or exit command.
8.4.4.2
ring-redundancy mode
Description
With this command, you enable the ring redundancy function on a device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
ring-redundancy mode {ard | mrpauto | mrpclient | hrpclient | hrpmanager}
SCALANCE XB-200 Command Line Interface
260
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.4 Ring redundancy and standby connection
The parameters have the following meaning:
Parameter
ard
Description
Range of values / note
Enables the automatic redundancy mode
(Automatic Redundancy Detection)
•
Default setting with PROFINET
variants: enabled
•
Default setting with EtherNet/IP
variants: disabled
mrpauto
Enables the automatic MRP manager
-
mrpclient
Enables ring redundancy with the MRP
protocol as client
-
hrpclient
Enables ring redundancy with the HRP
protocol as client
-
hrpmanager
Enables ring redundancy with the HRP
protocol in ring redundancy manager
mode
-
Result
The ring redundancy function is enabled and the redundancy mode is selected.
Further notes
You disable the ring redundancy function with the no ring-redundancy command.
8.4.4.3
no ring-redundancy
Description
With this command, you disable the ring redundancy function on a device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no ring-redundancy
Result
The ring redundancy function is disabled.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
261
Layer 2 management protocols
8.4 Ring redundancy and standby connection
Further notes
You enable the ring redundancy function with the ring-redundancy mode command.
8.4.4.4
ring-redundancy standby
Description
With this command, you enable the standby function.
Requirement
● HRP is enabled
● You are in the Global configuration mode.
The command prompt is:
cli(config)#
Syntax
Call the command without parameters:
ring-redundancy standby
Result
The standby function is enabled.
Further notes
You disable the setting with the no ring-redundancy standby command.
You can display the status of this function and other information with the show ringredundancycommand.
8.4.4.5
no ring-redundancy standby
Description
With this command, you disable the standby function.
Requirement
● HRP is enabled
● You are in the Global configuration mode.
The command prompt is:
cli(config)#
SCALANCE XB-200 Command Line Interface
262
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.4 Ring redundancy and standby connection
Syntax
Call the command without parameters:
no ring-redundancy standby
Result
The standby function is disabled.
Further notes
You enable the setting with the ring-redundancy standby command.
You can display the status of this function and other information with the show ring-
redundancycommand.
8.4.5
Commands in the redundancy configuration mode
This section describes commands that you can call up in the Redundancy Configuration
mode.
In the Global Configuration mode, enter the ring-redundancy configuration command to
change to this mode.
● If you exit the Redundancy Configuration mode with the exit command, you return to the
Global Configuration mode.
● If you exit the Redundancy Configuration mode with the end command, you return to the
Privileged EXEC mode.
8.4.5.1
ring ports
Description
With this command, you configure the ports of the ring redundancy manager or ring
redundancy client on a device.
● Redundancy manager
– In the normal status, the network structure is operated via port. The other port is only
used by the ring redundancy manager for checking.
– If there is a disruption, the two parts of the ring operate via both ports.
● Redundancy client
– The client forwards all frames.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
263
Layer 2 management protocols
8.4 Ring redundancy and standby connection
Requirement
You are in the Redundancy configuration mode.
The command prompt is as follows:
cli(config-red)#
Syntax
Call up the command with the following parameters:
ring ports <iftype1><ifnum1><iftype2><ifnum2>
The parameters have the following meaning:
Parameter
iftype1
ifnum1
Description
Specifies the interface type for the first ring port
Specifies the number of the interface for the first ring port
iftype2
Specifies the interface type for the second ring port
ifnum2
Specifies the number of the interface for the second ring port
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Note
Differing port addresses
The first and second port must be configured on different interfaces
Result
The ports of the ring redundancy are configured.
8.4.5.2
standby connection-name
Description
With this command, you assign a name to the standby connection on the device.
Requirement
You are in the Redundancy configuration mode.
The command prompt is as follows:
cli(config-red)#
SCALANCE XB-200 Command Line Interface
264
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.4 Ring redundancy and standby connection
Syntax
Call up the command with the following parameters:
standby connection-name <string(32)>
The parameter has the following meaning:
Parameter
Description
Range of values / note
<string(32)>
Name of the connection
max. 32 characters
Result
The standby connection is assigned a name.
8.4.5.3
no standby connection-name
Description
With this command, you delete the name of a standby connection.
Requirement
You are in the Redundancy Configuration mode.
The command prompt is as follows:
cli(config-red)#
Syntax
Call the command without parameters:
no standby connection-name
Result
The name of the standby connection is deleted.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
265
Layer 2 management protocols
8.4 Ring redundancy and standby connection
8.4.5.4
standby force-master
Description
With this command, you enable the standby force-master function.
Requirement
● HRPis enabed
● You are in the Redundancy configuration mode.
The command prompt is:
cli(config-red)#
Syntax
Call the command without parameters:
standby force-master
Result
The standby force-master function is enabled.
Further notes
You disable the setting with the no standby force-master command.
You can display the status of this function and other information with the show ringredundancycommand.
8.4.5.5
no standby force-master
Description
With this command, you disable the standby force-master function.
Requirement
● HRPis enabed
● You are in the Redundancy configuration mode.
The command prompt is:
cli(config-red)#
SCALANCE XB-200 Command Line Interface
266
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.4 Ring redundancy and standby connection
Syntax
Call the command without parameters:
no standby force-master
Result
The standby force-master function is disabled.
Further notes
You enable the setting with the standby force-master command.
You can display the status of this function and other information with the show ringredundancycommand.
8.4.5.6
standby port
Description
With this command, you configure and enable the port for a standby connection on a device.
Requirement
You are in the Redundancy configuration mode.
The command prompt is as follows:
cli(config-red)#
Syntax
Call up the command with the following parameters:
standby port {<interface-type> <interface-id>}
The parameters have the following meaning:
Parameter
interface-type
interface-id
Description
Range of values / note
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The ports for a standby connection are configured and enabled.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
267
Layer 2 management protocols
8.4 Ring redundancy and standby connection
Further notes
You disable the setting with the no standby port command.
You display the status of this function and other information show ring-redundancy.
8.4.5.7
no standby port
Description
With this command, disable the port for a standby connection on a device.
Requirement
You are in the Redundancy configuration mode.
The command prompt is as follows:
cli(config-red)#
Syntax
Call up the command with the following parameters:
no standby port [<interface-type><interface-id>}
The parameters have the following meaning:
Parameter
interface-type
interface-id
Description
Range of values / note
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The ports for a standby connection are disabled.
Further notes
You enable the setting with the standby port command.
You display the status of this function and other information show ring-redundancy.
SCALANCE XB-200 Command Line Interface
268
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.5 Unicast
8.5
Unicast
The commands in this section configure the procedures for handling Unicast frames.
The commands allow the following:
● Filtering of Unicast frames
● Blocking of ports
● Automatic learning of Unicast
● Blocking unknown Unicast frames.
With the "show" commands, you can display the configuration data.
8.5.1
show mac-address-table dynamic unicast
Description
This command shows the table with the dynamic unicast MAC addresses assigned by the
device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table dynamic unicast[vlan<vlan-range>]
[address<aa:aa:aa:aa:aa:aa>][{interface<interface-type>
<interface-id>}]
The parameters have the following meaning:
Parameter
vlan
vlan-range
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
address
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
interface
Keyword for a an interface description
-
interface-type
Type or speed of the interface
Enter a valid interface
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
269
Layer 2 management protocols
8.5 Unicast
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
Result
The dynamic unicast MAC addresses are displayed.
8.5.2
show mac-address-table static unicast
Description
This command shows the table with the static unicast MAC addresses.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table static unicast[vlan<vlan-range>]
[address<aa:aa:aa:aa:aa:aa>][{interface<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
vlan
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
address
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
Keyword for a an interface description
-
interface-type
Type or speed of the interface
Enter a valid interface
interface-id
Module no. and port no. of the interface
vlan-range
interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
Result
The static unicast MAC addresses are displayed.
SCALANCE XB-200 Command Line Interface
270
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.5 Unicast
8.5.3
show unicast-block config
Description
This command shows the unicast blocking settings for ports.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show unicast-block config [port<interface-type><interface-id)>]
The parameters have the following meaning:
Parameter
port
interface-type
interface-id
Description
Range of values / note
Keyword for a port description
-
Type or speed of the interface
Enter a valid interface
Module no. and port no. of the interface
For information on names of interfaces and addresses, refer to the section "Addresses and
interface names (Page 25)".
Result
The unicast blocking settings for ports are displayed.
8.5.4
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
271
Layer 2 management protocols
8.5 Unicast
8.5.4.1
mac-address-table static unicast
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you generate a static unicast MAC address entry in the forwarding
database.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
mac-address-table static unicast<aa:aa:aa:aa:aa:aa>
vlan<vlan-id(1-4094)>
interface([<interface-type><0/a-b, 0/c,...>]
[<interface-type><0/a-b, 0/c,...>]
[port-channel<a,b,c-d>])
The parameters have the following meaning:
Parameter
Description
Range of values / note
-
MAC address of the interface
aa:aa:aa:aa:aa:aa
vlan
Keyword for a VLAN connection
-
vlan-id
Number of the addressed VLAN
1 ... 4094
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
interface
interface-type
0/a-b, 0/c,...
port-channel
Module no. and port no. of the interface
Keyword for a port channel
-
Specifies the name of a port channel
a,b,c-d
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The entry in the forwarding database is generated.
SCALANCE XB-200 Command Line Interface
272
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.5 Unicast
Further notes
With the show mac-address-table static unicast command, you display the list of
configured entries.
With the no mac-address-table static unicast command, you delete an entry.
8.5.4.2
no mac-address-table static unicast
Description
With this command, you disable the "static unicast" function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no mac-address-table static unicast <aa:aa:aa:aa:aa:aa> vlan <vlan-id(1-4094)>
The parameters have the following meaning:
Parameter
aa:aa:aa:aa:aa:aa
vlan
vlan-id
Description
Range of values / note
MAC address
Specify a valid MAC address.
Keyword for a VLAN connection
-
Range of values of the VLAN
1 ... 4094
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default value is used.
Result
The "static unicast" function is disabled.
Further notes
You activate the setting with the no mac-address-table static unicast command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
273
Layer 2 management protocols
8.6 Multicast
8.6
Multicast
8.6.1
Introduction to the multicast section
The commands in this section configure the procedures for handling Multicast frames.
The commands allow the following:
● Configuration of groups
● IGMP
● Blocking unknown Multicast frames.
With the "show" commands, you can display the configuration data.
8.6.2
show multicast-block config
Description
This command shows the multicast blocking settings for ports.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show multicast-block config[port<interface-type><interface-id)>]
The parameters have the following meaning:
Parameter
port
interface-type
interface-id
Description
Range of values / note
Keyword for a port description
-
Type of interface
Enter a valid interface
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If no parameters are specified, the settings for all ports are displayed.
SCALANCE XB-200 Command Line Interface
274
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.6 Multicast
Result
The multicast blocking settings for ports are displayed.
8.6.3
show mac-address-table dynamic multicast
Description
This command shows the table with the dynamic multicast MAC addresses assigned by the
device.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table dynamic multicast[vlan<vlan-range>]
[address<aa:aa:aa:aa:aa:aa>]
[{interface<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
vlan
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
address
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
Keyword for a an interface description
-
interface-type
Type of interface
Enter a valid interface
interface-id
Module no. and port no. of the interface
vlan-range
interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
Result
The dynamic multicast MAC addresses are displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
275
Layer 2 management protocols
8.6 Multicast
8.6.4
show mac-address-table static multicast
Description
This command shows the table with the static multicast MAC addresses.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show mac-address-table static multicast[vlan<vlan-range>]
[address<aa:aa:aa:aa:aa:aa>][{interface<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
vlan
vlan-range
Description
Range of values / note
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
address
Keyword for a MAC address
-
aa:aa:aa:aa:aa:aa
MAC address
-
interface
Keyword for a an interface description
-
interface-type
Type or speed of the interface
Enter a valid interface
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
Result
The static multicast MAC addresses are displayed.
SCALANCE XB-200 Command Line Interface
276
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.6 Multicast
8.6.5
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
8.6.5.1
mac-address-table static multicast
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you generate a static multicast MAC address entry in the forwarding
database.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
mac-address-table static multicast<aa:aa:aa:aa:aa:aa>
vlan<vlan-id(1-4094)>
interface([<interface-type><0/a-b,0/c,...>]
[<interface-type><0/a-b,0/c,...>]
[port-channel<1-8>]])
[forbidden-ports([<interface-type><0/a-b,0/c,...>]
[<interface-type><0/ab,0/c, ...>]
[port-channel <1-8>]])
The parameters have the following meaning:
Parameter
Description
Range of values / note
-
MAC address of the interface
aa:aa:aa:aa:aa:aa
vlan
Keyword for a VLAN connection
-
vlan-id
Number of the addressed VLAN
1 ... 4094
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
277
Layer 2 management protocols
8.6 Multicast
Parameter
interface
interface-type
Description
Range of values / note
Keyword for a an interface description
-
Type of interface
Enter a valid interface.
0/a-b, 0/c,...
Module no. and port no. of the interface
port-channel
Specifies the name of a port channel
forbidden-ports
1-8
Keyword for the interface description of the blocked ports
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The entry in the forwarding database is generated.
Further notes
With the show mac-address-table static multicast command, you display the list of
configured entries.
With the no mac-address-table static multicast command, you delete an entry.
SCALANCE XB-200 Command Line Interface
278
Configuration Manual, 04/2015, C79000-G8976-C361-02
Layer 2 management protocols
8.6 Multicast
8.6.5.2
no mac-address-table static multicast
Description
With this command, you delete a static multicast address.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no mac-address-table static multicast <aa:aa:aa:aa:aa:aa> vlan <vlan-id(1-4094)>
The parameters have the following meaning:
Parameter
vlan
Description
Range of values / note
Keyword for a VLAN connection
1 ... 4094
address
Keyword for a MAC address
-
-
MAC address
aa:aa:aa:aa:aa:aa
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default value is used.
Result
The "static multicast" function is disabled.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
279
Layer 2 management protocols
8.6 Multicast
SCALANCE XB-200 Command Line Interface
280
Configuration Manual, 04/2015, C79000-G8976-C361-02
9
Load control
This part contains the sections describing the functions for controlling and balancing network
load.
9.1
Rate control
This section describes commands for controlling and restricting the data transmission rate of
an interface.
9.1.1
show rate-limit output
Description
This command shows the packet rate for limiting the outgoing data stream of one or all
interfaces.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show rate-limit output[interface<interface-type><interface-id>]
The parameters have the following meaning:
Parameter
Description
Range of values / note
Keyword for a an interface description
-
interface-type
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameter from the parameter list, the entries are displayed for all
available interfaces.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
281
Load control
9.1 Rate control
Result
The entries are displayed.
9.1.2
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
9.1.2.1
rate-limit output
Description
With this command, you configure and enable the data rate in Kbps for limiting the outgoing
data stream of the interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
rate-limit output <rate-value>
The parameters have the following meaning:
Parameter
rate-value
Description
Range of values / note
Value for the in data rate in Kbps
Default:
The data rate is set to 0. The
outgoing data stream is not limited.
If you do not select any parameters from the parameter list, the default value is used.
SCALANCE XB-200 Command Line Interface
282
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.1 Rate control
Result
The limitation of the outgoing data stream of the interface with the data rate is enabled.
Further notes
You disable the function with the no rate-limit output command.
9.1.2.2
no rate-limit output
Description
With this command, you disable the data rate for limiting the outgoing data stream of the
interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no rate-limit-output
Result
The limitation of the outgoing data stream of the interface with the data rate is disabled.
Further notes
You enable the function with the rate-limit-output command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
283
Load control
9.1 Rate control
9.1.2.3
storm-control
Description
With this command, you enable data rate for limiting the incoming data stream of the
interface for broadcast, multicast or unknown unicast packets.
Note
Applications
Storm control is only supported on physical interfaces.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
storm-control{broadcast|multicast|dlf}
The parameters have the following meaning:
Parameter
broadcast
Description
Limits broadcast packets
multicast
Limits multicast packets
dlf
Limits unicast packets with unresolvable addresses
(dfl = destination lookup fail)
As default the function is "disabled" for all transfer types.
Note
Configuration of the threshold value
The default value for the storm control level is 0 Kbps. The incoming data stream is not
limited.
To have the incoming data stream limited, configure the threshold value with the stormcontrol level command.
Result
The storm control function is enabled.
SCALANCE XB-200 Command Line Interface
284
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.1 Rate control
Further notes
You enable the function with the no storm-controlcommand.
You configure the threshold value for the storm control function with the storm-control level
command.
9.1.2.4
no storm-control
Description
With this command, you disable the storm control function for broadcast, multicast or
unknown unicast packets.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
no storm-control{broadcast|multicast|dlf}
The parameters have the following meaning:
Parameter
broadcast
multicast
dlf
Description
Disables broadcast storm control
Disables multicast storm control
Disables unknown unicast storm control
if you call up the function without parameters, it is disabled for all types of transmission.
Result
The storm control function is disabled.
Further notes
You enable the function with the storm-control command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
285
Load control
9.1 Rate control
9.1.2.5
storm-control level
Description
With this command, you configure the value for the storm control function in Kbps.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
storm-control level <rate-value>
The parameters have the following meaning:
Parameter
rate-value
Description
Range of values / note
Value for the in data rate in Kbps
The value range depends on the
port speed. The entry is rounded
down to the next valid value. If
small values are entered, the
value is rounded up to the next
valid value.
Default:
The data rate is set to 0. The
incoming data stream is not limited.
Result
The value for the storm control function is configured.
Further notes
You can reset the setting to the default with the no storm-control level command.
SCALANCE XB-200 Command Line Interface
286
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.1 Rate control
9.1.2.6
no storm-control level
Description
With this command, you reset the value for the storm control function to the default value.
The default value for the storm control level is 0 Kbps. The incoming data stream is not
limited.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no storm-control level
Result
The value for the storm control function is reset to the default.
Further notes
You configure the value for the storm control function with the storm-control level
command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
287
Load control
9.2 Static MAC filtering
9.2
Static MAC filtering
This section describes commands for filtering data packet on an interface.
9.2.1
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
9.2.1.1
mac-address-table static multicast
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you generate a static multicast MAC address entry in the forwarding
database.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
mac-address-table static multicast<aa:aa:aa:aa:aa:aa>
vlan<vlan-id(1-4094)>
interface([<interface-type><0/a-b,0/c,...>]
[<interface-type><0/a-b,0/c,...>]
[port-channel<1-8>]])
[forbidden-ports([<interface-type><0/a-b,0/c,...>]
[<interface-type><0/ab,0/c, ...>]
[port-channel <1-8>]])
SCALANCE XB-200 Command Line Interface
288
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.2 Static MAC filtering
The parameters have the following meaning:
Parameter
Description
Range of values / note
-
MAC address of the interface
aa:aa:aa:aa:aa:aa
vlan
Keyword for a VLAN connection
-
vlan-id
Number of the addressed VLAN
1 ... 4094
interface
Keyword for a an interface description
-
Type of interface
Enter a valid interface.
interface-type
0/a-b, 0/c,...
Module no. and port no. of the interface
port-channel
Specifies the name of a port channel
forbidden-ports
1-8
Keyword for the interface description of the blocked ports
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The entry in the forwarding database is generated.
Further notes
With the show mac-address-table static multicast command, you display the list of
configured entries.
With the no mac-address-table static multicast command, you delete an entry.
9.2.1.2
no mac-address-table static multicast
Description
With this command, you delete a static multicast MAC address entry from the forwarding
database.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no mac-address-table static multicast<aa:aa:aa:aa:aa:aa>
vlan<vlan-id(1-4094)>
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
289
Load control
9.2 Static MAC filtering
The parameters have the following meaning:
Parameter
Description
Range of values / note
-
MAC address of the interface
aa:aa:aa:aa:aa:aa
Keyword for the number of a VLAN
connection
-
Number of the addressed VLAN
1 ... 4094
vlan
vlan-id
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The entry is deleted from the forwarding database.
Further notes
With the show mac-address-table static multicast command, you display the list of
configured entries.
With the mac-address-table static multicast command, you create an entry.
9.2.1.3
mac-address-table static unicast
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you generate a static unicast MAC address entry in the forwarding
database.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
mac-address-table static unicast<aa:aa:aa:aa:aa:aa>
vlan<vlan-id(1-4094)>
interface([<interface-type><0/a-b, 0/c,...>]
[<interface-type><0/a-b, 0/c,...>]
[port-channel<a,b,c-d>])
SCALANCE XB-200 Command Line Interface
290
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.2 Static MAC filtering
The parameters have the following meaning:
Parameter
Description
Range of values / note
-
MAC address of the interface
aa:aa:aa:aa:aa:aa
vlan
Keyword for a VLAN connection
-
vlan-id
Number of the addressed VLAN
1 ... 4094
interface
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
interface-type
0/a-b, 0/c,...
Module no. and port no. of the interface
port-channel
Keyword for a port channel
-
Specifies the name of a port channel
a,b,c-d
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The entry in the forwarding database is generated.
Further notes
With the show mac-address-table static unicast command, you display the list of
configured entries.
With the no mac-address-table static unicast command, you delete an entry.
9.2.1.4
no mac-address-table static unicast
Description
With this command, you delete a static unicast MAC address entry from the forwarding
database.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no mac-address-table static unicast <aa:aa:aa:aa:aa:aa>
vlan<vlan-id(1-4094)>
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
291
Load control
9.2 Static MAC filtering
The parameters have the following meaning:
Parameter
Description
Range of values / note
-
MAC address of the interface
aa:aa:aa:aa:aa:aa
vlan
vlan-id
Keyword for a VLAN connection
-
Number of the addressed VLAN
1 ... 4094
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The entry is deleted from the forwarding database.
Further notes
With the show mac-address-table static unicast command, you display the list of
configured entries.
With the mac-address-table static unicast command, you create an entry.
SCALANCE XB-200 Command Line Interface
292
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.2 Static MAC filtering
9.2.2
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
9.2.2.1
switchport ingress-filter
Description
With incoming packets, the ingress filter checks whether the port on which the packet was
received belongs to the sending VLAN. If this is not the case, the packet is not processed.
With this command, you enable the ingress filter.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
switchport ingress-filter
Result
The ingress filter is activated.
Further notes
You disable the filter with the no switchport ingress-filter command.
You can display the status of the ingress filter and other settings with the show vlan port
command.
config
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
293
Load control
9.2 Static MAC filtering
9.2.2.2
no switchport ingress-filter
Description
With this command, you disable the ingress filter.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no switchport ingress-filter
Result
The ingress filter is deactivated.
Further notes
You enable the filter with the switchport ingress-filter command.
You can display the status of the ingress filter and other settings with the show vlan port
command.
config
SCALANCE XB-200 Command Line Interface
294
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.3 Dynamic MAC aging
9.3
Dynamic MAC aging
The section describes commands with which the aging of dynamically learned entries is
configured in a MAC address list.
9.3.1
show mac-address-table aging-time
Description
To ensure that the address entries are up-to-date, MAC addresses are only kept in the
address table for a specified time.
This command shows the time after which the MAC addresses are removed from the
address table.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show mac-address-table aging-time
Result
The time is displayed.
9.3.2
show mac-address-table aging-status
Description
This command shows whether or not MAC aging is enabled.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
295
Load control
9.3 Dynamic MAC aging
Syntax
Call the command without parameters:
show mac-address-table aging-status
Result
The status of the MAC aging is displayed.
9.3.3
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
9.3.3.1
mac-address-table aging-time
Description
With this command, you configure the aging of a dynamically learned entry in the MAC
address list.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
mac-address-table aging-time <seconds(10-630)>
The parameter has the following meaning:
Parameter
seconds
Description
Range of values / note
Life of the entry in seconds
10 ... 630
Default: 40
SCALANCE XB-200 Command Line Interface
296
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.3 Dynamic MAC aging
Result
The value of the aging of a dynamically learned entry is configured.
Further notes
You can reset the setting to the default with the no mac-address-table aging-time command.
You display the setting with the show mac-address-table aging-time command.
9.3.3.2
no mac-address-table aging-time
Description
With this command, you reset the value for the aging of a dynamically learned entry in the
MAC address list to the default value.
The default value is 40 s.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no mac-address-table aging-time
Result
The value of the aging of a dynamically learned entry is reset to the default value.
Further notes
You configure the setting with the mac-address-table aging-time command.
You display the setting with the show mac-address-table aging-time command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
297
Load control
9.3 Dynamic MAC aging
9.3.3.3
mac-address-table aging
Description
With this command, you enable the "Aging" function. The "Aging" function ensures that an
entry in the MAC address list that was learned dynamically is deleted again after a certain
time.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
mac-address-table aging
Result
The "Aging" function is enabled.
Further notes
You configure the time with the mac-address-table aging-time command.
You disable the "Aging" function with the no mac-address-table aging command.
SCALANCE XB-200 Command Line Interface
298
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.3 Dynamic MAC aging
9.3.3.4
no mac-address-table aging
Description
With this command, you disable the "Aging" function.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no mac-address-table aging
Result
The "Aging" function is disabled.
Further notes
You enable the "Aging" function with the mac-address-table aging command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
299
Load control
9.4 Flow control
9.4
Flow control
The flow control function monitors the incoming data traffic of a port. If there is overload
("Congestion", "Overflow") it sends a signal to the connection partner. If the flow control
function receives a signal at the sending end, it stops the data transmission to avoid loss of
data.
This section describes commands of the flow control function.
9.4.1
show flow-control
Description
This command shows the settings of the flow control function.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show flow-control [interface <interface-type><interface-id>]
The parameters have the following meaning:
Parameter
interface
interface-type
interface-id
Description
Range of values / note
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the information for the router will
be displayed.
Result
The settings of the flow control function are displayed.
SCALANCE XB-200 Command Line Interface
300
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.4 Flow control
9.4.2
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
9.4.2.1
flowcontrol
Description
The flow control function monitors a connection at the receiving end to make sure that not
more data is received than can be processed. If flow control detects a threat of data
overflow, the partner at the sending end is sent a signal to stop transmitting.
With this command, you configure the flow control function for an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
flowcontrol {on|off}
The parameters have the following meaning:
Parameter
on
off
Description
Enables the function
Disables the function
Result
The settings for the flow control function are configured.
Further notes
You can display the status of this function with the show flow-control command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
301
Load control
9.5 Service classes
9.5
Service classes
This section describes commands for configuring the assignment tables for service classes
and the Differentiated Services Code Point (DSCP).
9.5.1
show qos cos-map
Description
This command shows assignment table for service classes.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show qos cos-map
Result
The assignment table for service classes is displayed.
9.5.2
show qos dscp-map
Description
This command shows assignment table for DSCP.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
302
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.5 Service classes
Syntax
Call the command without parameters:
show qos dscp-map
Result
The assignment table for DSCP is displayed.
9.5.3
Commands in the Global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
9.5.3.1
qos
Description
With this command, you change to the QOS configuration mode.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
qos
Result
You are now in the QOS configuration mode.
The command prompt is as follows:
cli(config-qos)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
303
Load control
9.5 Service classes
Further notes
You exit the QOS configuration modewith the command end or exit.
9.5.4
Commands in the QOS configuration mode
This section describes commands that you can call up in the QOS configuration mode.
In the Global configuration mode, enter the qos command to change to this mode.
● If you exit the QOS configuration mode with the exit command, you return to the Global
configuration mode.
● If you exit the QOS configuration mode with the end command, you return to the
Privileged EXEC mode.
9.5.4.1
cos-map
Description
In a network, each data stream is assigned a service class that decides its priority. In special
situations, it may be necessary to change this priority.
This change is made using a table in which the service classes are assigned to another
queue.
With this command, you configure the assignment table for service classes.
Requirement
You are in the QOS configuration mode.
The command prompt is as follows:
cli(config-qos)#
Syntax
Call up the command with the following parameters:
cos-map <cos(0-7)> queue <queue(1-4)>
The parameters have the following meaning:
Parameter
cos
Description
Range of values / note
Service class
0…7
Default: 1
queue
Keyword for a queue
queue
Queue that it is assigned to this service 1 … 4
class
Default: 2
-
SCALANCE XB-200 Command Line Interface
304
Configuration Manual, 04/2015, C79000-G8976-C361-02
Load control
9.5 Service classes
The service classes (COS) are assigned to the queues as follows in the default setting:
● COS 0 → Queue 2
● COS 1 → Queue 1
● COS 2 → Queue 1
● COS 3 → Queue 2
● COS 4 → Queue 3
● COS 5 → Queue 3
● COS 6 → Queue 4
● COS 7 → Queue 4
Result
The assignment table for service classes is configured.
9.5.4.2
dscp-map
Description
In a network, each IP packet is assigned a DSCP code that decides its priority. In special
situations, it may be necessary to change this priority.
This change is made using a table in which the DSCP codes are assigned to another queue.
With this command, you configure the assignment table for DSCP codes.
Requirement
You are in the QOS configuration mode.
The command prompt is as follows:
cli(config-qos)#
Syntax
Call up the command with the following parameters:
dscp-map <dscp (0-63)> queue <queue(1-4)>
The parameters have the following meaning:
Parameter
dscp
queue
queue
Description
Range of values / note
DSCP code
0 … 63
Keyword for a queue
-
Queue that is assigned to this DSCP
code
1…4
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
305
Load control
9.5 Service classes
The DSCP codes are assigned to the queues as follows in the default setting:
● DSCP codes 0 - 15 → Queue 1
● DSCP codes 16 - 31 → Queue 2
● DSCP codes 32 - 47 → Queue 3
● DSCP codes 48 - 63 → Queue 4
Result
The assignment table for DSCP codes is configured.
SCALANCE XB-200 Command Line Interface
306
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10
This part contains the sections that describe the access rights and authentication methods.
10.1
User rights management
This section describes commands for access as administrator and the configuration of the
authentication methods.
10.1.1
show users
Description
This command shows the logged-in CLI users.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call the command without parameters:
show users
Result
The logged-in CLI users are displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
307
Security and authentication
10.1 User rights management
10.1.2
whoami
Description
This command shows the user name of the logged in user.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
whoami
Result
The user name of the logged in user is displayed.
SCALANCE XB-200 Command Line Interface
308
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.2 RADIUS client
10.2
RADIUS client
RADIUS (Remote Authentication Dial-In User Service) is a client/server protocol that allows
the centralized authentication of users logging on in a physical or virtual network. This makes
central administration of user data possible.
This section describes commands relevant for the configuration of this service.
10.2.1
show radius statistics
Description
This command shows the connection statistics from the RADIUS client to the RADIUS
server.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call the command without parameters:
show radius statistics
Result
The connection statistics are displayed.
10.2.2
show radius server
Description
This command shows the RADIUS server configuration.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
309
Security and authentication
10.2 RADIUS client
Syntax
Call up the command with the following parameters:
show radius server [<ucast_addr>]
The parameters have the following meaning:
Parameter
ucast_addr
Description
Range of values / note
Value for an IPv4 unicast address
Enter a valid unicast address
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If no parameters are specified, all configured RADIUS servers are displayed.
Result
The RADIUS server configuration is displayed.
10.2.3
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
10.2.3.1
login authentication
Description
With this command, you enable authentication via a RADIUS server.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
login authentication {radius|local-and-radius}
SCALANCE XB-200 Command Line Interface
310
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.2 RADIUS client
The parameters have the following meaning:
Parameter
radius
local-and-radius
Description
Range of values / note
The login is via a RADIUS server.
-
The login is possible both with the
users that exist in the firmware (user
name and password) and via a
RADIUS server.
The local users have priority.
The user is first searched for in the
local database. If the user does
not exist there or the password
does not match, a RADIUS query
is sent.
Result
The authentication is made according to the selected parameter directly via a RADIUS
server or in the second step if the local logon fails.
Further notes
You disable the authentication via a RADIUS server with the no login authentication
command.
10.2.3.2
no login authentication
Description
With this command, you disable authentication via a RADIUS server.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
no login authentication
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
311
Security and authentication
10.2 RADIUS client
Result
The RADIUS authentication is deactivated.
Note
The login is possible only with a local user name and password. If the local logon fails, there
is no authentication via a RADIUS server.
Further notes
You enable the authentication via a RADIUS server with the login authentication
command.
10.2.3.3
radius-server
Description
With this command, you configure a RADIUS server entry on the RADIUS client.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
radius-server ipv4 <ipv4-address> [auth-port <portno(1-65535)>] [retransmit <1254>][key <secret-key-string>][primary]
The parameters have the following meaning:
Parameter
ipv4
Description
Range of values / note
Keyword for an IPv4 address.
-
ipv4-address
Value for the IPv4 address of the Syslog server
Enter a valid IPv4 address.
auth-port
Keyword for the UDP port number for
authentication
-
Number of the port
1 … 65535
portno
retransmit
<1-254>
Default: 1812
Keyword for the number of connection
retries
-
Maximum number of connection retries 1 ... 254
Default: 3
SCALANCE XB-200 Command Line Interface
312
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.2 RADIUS client
Parameter
key
secret-key-string
primary
Description
Range of values / note
Keyword for the key for communication between the authenticator and the
server
Value for the key
46 characters
Default: empty string
Identifies the RADIUS server as primary server
-
For information on addresses and interfaces, refer to the section "Addresses and interface
names (Page 25)".
If optional parameters are not specified when configuring, the default values apply.
Note
Primary server
In a network, only one RADIUS server can be selected as the primary server.
If you select a RADIUS server as the primary server, this replaces the server that previously
had the role of primary server.
Result
The entry for a connection between the RADIUS client and a server or the identification as
primary server is configured.
Further notes
You delete a RADIUS server entry with the no radius-server command.
You show the configuration of a RADIUS server on the client with the show radius server
command.
You show the statistical information of this function with the show radius statistics
command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
313
Security and authentication
10.2 RADIUS client
10.2.3.4
no radius-server
Description
With this command, you delete a RADIUS server entry on the client.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no radius-server <ipv4-address> [primary]
The parameters have the following meaning:
Parameter
ipv4-address
primary
Description
Range of values / note
IPv4 Internet address of the Syslog
server
Format: 0.0.0.0
Identifies the RADIUS server as primary server
-
For information on addresses and interfaces, refer to the section "Addresses and interface
names (Page 25)".
Result
The entry for a connection between the RADIUS client and a server or the identification as
primary server is deleted.
Further notes
You configure the connection of a RADIUS client to a server with the radius-server
command.
You show the configuration of a RADIUS server on the client with the show radius server
command.
You show the statistical information of this function with the show radius statistics
command.
SCALANCE XB-200 Command Line Interface
314
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.3 Management Access Control List
10.3
Management Access Control List
This section describes the commands relevant for working with the management access
control list.
10.3.1
show authorized-managers
Description
This command shows the information about the configuration of the authorized managers.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show authorized-managers[ip-source<ip-address>]
The parameters have the following meaning:
Parameter
ip-source
ip-address
Description
Range of values / note
Keyword for the network or host address
-
Value for an IP address
specify a valid IP address
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
Result
The information about the configuration of the authorized managers is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
315
Security and authentication
10.3 Management Access Control List
10.3.2
Commands in the Global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
10.3.2.1
authorized-manager
Description
With this command, you enable the authorized manager.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
authorized-manager
Result
The authorized manager is activated.
Further notes
You disable the function with the no authorized-manager command.
SCALANCE XB-200 Command Line Interface
316
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.3 Management Access Control List
10.3.2.2
no authorized-manager
Description
With this command, you disable the authorized manager.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
no authorized-manager
Result
The authorized manager is deactivated.
Further notes
You enable the function with the authorized-manager command.
10.3.2.3
authorized-manager ip-source
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you configure the interfaces and protocols via which an authorized
manager is allowed to access the device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
317
Security and authentication
10.3 Management Access Control List
Syntax
Call up the command with the following parameters:
authorized-manager ip-source <ip-address>
[{<subnet-mask>|/<prefixlength(0-32)>}]
[interface[<interface-type><0/a-b,0/c,...>]
[<interface-type><0/a-b,0/c,...>]]
[vlan<a,b or a-b or a,b,c-d>]
[cpu0]
[service[snmp][telnet][http][https][ssh]]
The parameters have the following meaning:
Parameter
ip-address
Description
Range of values / note
Specifies the network or the IP address Enter a valid IPv4 address or a
for which the IP manager is authorized network.
subnet-mask
Subnet mask that restricts the authorization
Enter a valid mask.
prefixlength
Decimal representation of the mask as
a number of "1" bits
0 ... 32
interface
Keyword for a an interface description
-
interface-type
Type of interface
Enter a valid interface.
0/a-b,0/c,...
Module no. and port no. of the interface
vlan
Keyword for a VLAN connection
-
a,b or a-b or
a,b,c-d
Number of a VLAN or VLAN range
Enter a valid VLAN or VLAN
range.
cpu0
the Out of Band- interface is configured as a management Interface
service
Specifies the services for which the
manager is authorized.
You can select several options.
•
snmp
•
telnet
•
http
•
https
•
ssh
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
The IP address 0.0.0.0 means "any manager".
SCALANCE XB-200 Command Line Interface
318
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.3 Management Access Control List
If optional parameters are not specified when configuring, the manager is authorized for all
services.
Note
Configuration of the first entry
As long as the list of authorized managers is empty, access to the system is not restricted.
As soon as the list contains an entry and the "authorized-manager" command is executed,
access to the system is blocked for all others.
You should therefore configure the interface via which you access the system first because
your access is otherwise blocked.
Result
The interfaces and protocols via which an authorized manager is allowed to access the
device are configured.
Note
No restrictions for console port
The restrictions do not apply to the serial console (console port).
Further notes
You delete an interface for access of an authorized manager with the no authorized-manager
command.
ip-source
You show the information about the configuration of the authorized managers with the show
command.
authorized-manager
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
319
Security and authentication
10.3 Management Access Control List
10.3.2.4
no authorized-manager ip-source
Description
With this command, you delete an interface via which an authorized manager is allowed to
access the device.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no authorized-manager ip-source <ip-address>
[{<subnet-mask>|/<prefixlength(0-32)>}]
The parameters have the following meaning:
Parameter
ip-address
subnet-mask
prefixlength
Description
Range of values / note
Specifies the network or the IP address for
which the IP manager is authorized
Enter a valid IP address or a
network
Subnet mask that restricts the authorization
Enter a valid mask
Decimal representation of the mask as a
number of "1" bits
0 ... 32
For information on identifiers of addresses and interfaces, refer to the section "Addresses
and interface names (Page 25)".
Result
An authorized manager is deleted from the list.
Further notes
You configure the interfaces and protocols via which an authorized manager is allowed to
access the device with the authorized-manager ip-source command.
You show the information about the configuration of the authorized managers with the show
command.
authorized-manager
SCALANCE XB-200 Command Line Interface
320
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.4 Port Access Control List Locked Ports
10.4
Port Access Control List Locked Ports
With the Port Access Control List Locked Ports functionality, MAC addresses that do not age
are collected on a port after the start command. With the stop command, these addresses
are converted to static entries in the address list and the aging is reactivated for all the
addresses that follow.
If the learning of addresses on this port is then disabled, data packets are only forwarded to
the static addresses entered in the table.
This section describes commands relevant for the configuration of this function.
10.4.1
show lock port
Description
This command shows whether or not the learning of MAC entries is enabled or locked on an
interface.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show lock port [<interface-type><interface-id>]
The parameters have the following meaning:
Parameter
interface-type
interface-id
Description
Range of values / note
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select an interface, the configuration of all interfaces is displayed.
Result
The configuration of the interface for the learning of MAC entries is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
321
Security and authentication
10.4 Port Access Control List Locked Ports
10.4.2
Commands in the Global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
10.4.2.1
clear-all-static-unicast
Description
With this command, you delete all static unicast MAC address entries from the MAC address
table.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
clear-all-static-unicast
Result
The static unicast MAC address entries are deleted from the MAC address table.
10.4.2.2
auto-learn
Description
With this command, you change to the AUTOLEARN mode.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
322
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.4 Port Access Control List Locked Ports
Syntax
Call the command without parameters:
auto-learn
Result
You are now in the AUTOLEARN mode.
The command prompt is as follows:
cli(config-auto-learn)#
Further notes
You exit the AUTOLEARN configuration modewith the command end or exit.
10.4.3
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
10.4.3.1
switchport lock
Description
With this command, you block the learning of MAC entries. Only the static address entries of
the MAC address list are used on the port.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
323
Security and authentication
10.4 Port Access Control List Locked Ports
Syntax
Call the command without parameters:
switchport lock
Result
The learning of MAC addresses is blocked.
Further notes
You enable the learning of MAC addresses with the no switchport lock command.
You display the configuration with the show lock port command.
10.4.3.2
no switchport lock
Description
With this command, you enable the learning of MAC addresses.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no switchport lock
Result
The learning of MAC addresses is enabled.
Further notes
You block the learning of MAC addresses with the switchport lock command.
You display the configuration with the show lock port command.
SCALANCE XB-200 Command Line Interface
324
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.4 Port Access Control List Locked Ports
10.4.4
Commands in the AUTOLEARN mode
This section describes commands that you can call up in the AUTOLEARN mode.
In the Global configuration mode, enter the auto-learn command to change to this mode.
● If you exit the AUTOLEARN mode with the exit command, you return to the Global
configuration mode.
● If you exit the AUTOLEARN mode with the end command, you return to the Privileged
EXEC mode.
10.4.4.1
start
Description
With this command, you start automatic learning. During automatic learning, the aging timer
is disabled for all learned addresses.
Requirement
You are in the AUTOLEARN mode.
The command prompt is as follows:
cli(config-auto-learn)#
Syntax
Call the command without parameters:
start
Result
The learned MAC addresses are entered in the "port database" with the aging time 0. (The
entries are NOT deleted when the "MAC Address Aging Time" expires).
Further notes
You stop automatic learning with the stop command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
325
Security and authentication
10.4 Port Access Control List Locked Ports
10.4.4.2
stop
Description
With this command, you stop automatic learning and convert all learned MAC addresses to
static entries.
Requirement
You are in the AUTOLEARN mode.
The command prompt is as follows:
cli(config-auto-learn)#
Syntax
Call the command without parameters:
stop
Result
Automatic learning is stopped and all learned entries are converted to static entries.
Further notes
You start automatic learning with the start command.
SCALANCE XB-200 Command Line Interface
326
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.5 Port Based Network Access Control
10.5
Port Based Network Access Control
This section describes commands for working with port-based network access control
(PNAC).
10.5.1
The "show" commands
This section describes commands with which you display various settings.
10.5.1.1
show dot1x
Description
This command shows information about port-based network access control (PNAC).
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show dot1x[{interface<interface-type><interface-id>|
statistics interface<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
interface
interface-type
interface-id
Description
Range of values / note
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
statistics interface
Keyword for the display of the statistical data of the dot1x Authenticator for
an interface
-
interface-type
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The dot1x information is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
327
Security and authentication
10.5 Port Based Network Access Control
10.5.2
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
10.5.2.1
dot1x port-control
Description
With this command, you configure port control parameter of the authenicator.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
dot1x port-control {auto|force-authorized|force-unauthorized}
The parameters have the following meaning:
Parameter
auto
Description
Range of values / note
Authentication according to IEEE
802.1x is enabled for the interface.
-
The data traffic via the interface is
permitted or blocked depending on the
authentication result.
force-authorized
data traffic via the interface is permitted Default: force-authorized enawithout restrictions
bled
force-unauthorized
data traffic via the interface is blocked
-
Result
The port control parameter is configured.
SCALANCE XB-200 Command Line Interface
328
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.5 Port Based Network Access Control
Further notes
You can reset the port control parameter to the default with the no dot1x port-control
command.
You can display the status of this function and other information with the show
dot1xcommand.
10.5.2.2
no dot1x port-control
Description
With this command, you reset the port control parameter of the authenicator to the default
value.
The default value is force-authorized.
With this, data traffic is permitted without restrictions.
Requirement
You are in the Interface Configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no dot1x port-control
Result
The port control parameter of the authenicator is reset to the default value.
Further notes
You configure the port control parameter with the dot1x port-control command.
You can display the status of this function and other information with the show
dot1xcommand.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
329
Security and authentication
10.5 Port Based Network Access Control
10.5.2.3
dot1x reauthentication
Description
With this command, you enable the 802.1x Re-Authentication function for the selected
interface. When the function is enabled, the authenticator repeats authentication of the client
periodically,
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
dot1x reauthentication
Result
Periodic authentication is enabled for the selected interfaces.
Further notes
You disable the function with the no dot1x reauthentication command.
You can display the status of this function and other information with the show
dot1xcommand.
SCALANCE XB-200 Command Line Interface
330
Configuration Manual, 04/2015, C79000-G8976-C361-02
Security and authentication
10.5 Port Based Network Access Control
10.5.2.4
no dot1x reauthentication
Description
With this command, you disable the function that repeats the authentication of the client by
the authenticator periodically.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no dot1x reauthentication
Result
Periodic authentication is disabled.
Further notes
You enable the function with the dot1x reauthentication command.
You can display the status of this function and other information with the show
dot1xcommand.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
331
Security and authentication
10.5 Port Based Network Access Control
SCALANCE XB-200 Command Line Interface
332
Configuration Manual, 04/2015, C79000-G8976-C361-02
11
Diagnostics
The monitoring of the system and error diagnostics are handled in different ways:
● Events and faults handling:
Predefined events generate a message. These messages can be distributed in different
ways:
– Entry in the local log
– Transfer to the Syslog server
– Sending as e-mail
– Sending as SNMP trap
● Syslog:
Configures the transfer to the Syslog server
● Remote Monitoring (RMON):
Variables of the Management Information Base are monitored for the violation of limit
values and messages are generated if they do. These messages are collected and can
be distributed in the following ways:
– Entry in the local log
– Sending as SNMP trap
– Transfer to the Syslog server
– Transfer to a network management station using SNMP
● Port mirroring:
Mirroring of ports to analyze the data stream without disturbing operation
● Loop detection:
Detection and elimination of damaging loops. Loops in the network can cause total failure
of the transfer and must be detected and eliminated.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
333
Diagnostics
11.1 Event and fault handling
11.1
Event and fault handling
In events and faults handling, you set the events whose messages will be distributed in one
of the available ways.
You configure the monitoring of certain system events and power supply and physical
interfaces in the Events configuration mode.
11.1.1
logging console
Description
With this command, you enable the logging of inputs and outputs to the console.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
logging console
Result
The logging function is enabled on the console.
Further notes
You disable the setting with the no logging console command.
As default the function is "disabled".
SCALANCE XB-200 Command Line Interface
334
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
11.1.2
no logging console
Description
With this command, you disable the logging of inputs and outputs to the console.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
no logging console
Result
The logging function is disabled on the console.
Further notes
You enable the setting with the logging console command.
As default the function is "disabled".
11.1.3
show events config
Description
This command shows the current configuration for forwarding the messages of the various
event types.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
335
Diagnostics
11.1 Event and fault handling
Syntax
Call the command without parameters:
show events config
Result
The current configuration of the events display is displayed.
11.1.4
show events severity
Description
This command shows the degree of severity of an event ("Info", "Warning" or "Critical")
starting at which a notification (sending of an e-mail, entry in the Syslog table, entry in the
Syslog file) is generated.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show events severity
Result
The corresponding degree of severity is shown for each type of notification.
Further notes
You configure the assignment of the degree of severity of an event and the type of
notification with the severity command.
SCALANCE XB-200 Command Line Interface
336
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
11.1.5
show events faults config
Description
This command shows the current configuration of the following error monitoring functions:
● Monitoring of the power supply for power outage
● Monitoring of the network connections for a change in the connection status
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show events faults config [{power|link}]
The parameters have the following meaning:
Parameter
power
link
Description
Monitoring of the power supply for power outage
Monitoring of the network connections for a change in the connection status
If no parameters are specified, the settings for both error monitoring functions are displayed.
Result
The current configuration of the selected error monitoring function is displayed.
11.1.6
show events faults status
Description
This command shows the status messages of fault monitoring of the power supply and
network connections.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
337
Diagnostics
11.1 Event and fault handling
Syntax
Call the command without parameters:
show events faults status
Result
A table with the status messages of the error monitoring functions is displayed.
11.1.7
show startup-information
Description
This command shows the startup information.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>orcli#
Syntax
Call the command without parameters:
show startup-information
Result
Startup information is shown.
11.1.8
show logbook
Description
With this command, you display the content of the logbook.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
338
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
Syntax
Call the command without parameters:
show logbook
or
Call up the command with the following parameters:
show logbook { info | warning | critical }
Parameter
The parameters have the following meaning:
Parameter
info
warning
critical
Description
Information
Warning
Critical
Result
The content of the logbook is displayed.
11.1.9
clear logbook
Description
With this command, you delete the content of the logbook.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call the command without parameters:
clear logbook
Result
The content of the logbook is deleted.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
339
Diagnostics
11.1 Event and fault handling
11.1.10
show fault counter
Description
This command shows the number of errors since the last startup.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show fault counter
Result
The number of faults is displayed.
Further notes
You reset the counter for the errors with the clear fault counter command.
11.1.11
clear fault counter
Description
With this command you reset the counter that shows the number of faults since the last
startup.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call the command without parameters:
clear fault counter
SCALANCE XB-200 Command Line Interface
340
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
Result
The counter is set to "0".
Further notes
You shows the number of faults since the last startup with the show fault counter command.
11.1.12
fault report ack
Description
With this command, you acknowledge (delete) the messages of the "Cold/Warm start" event.
Requirement
You are in the Privileged EXEC mode.
The command prompt is as follows:
cli#
Syntax
Call up the command with the following parameter:
fault report ack <fault-state-id>
The parameter has the following meaning:
Parameters
fault-state-id
Description
Value
ID of the message
Enter the ID of the message for the "Cold/Warm Start"
event.
To obtain the ID, use the "show events faults status"
command.
Result
The message is acknowledged.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
341
Diagnostics
11.1 Event and fault handling
11.1.13
show cabletest interface
Description
This command shows the result of the cable test of the interface.
Requirement
● The interface has no active data traffic.
● The cabletest interface function was used on the specified interface in the Global
configuration mode.
● You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is:
cli> or cli#
Syntax
Call up the command with the following parameters:
show cabletest interface <interface-type> <interface-id>
The parameters have the following meaning:
Parameter
interface-type
interface-id
Description
Range of values / note
Type of interface
Enter a valid interface.
Interface identifier
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The result is displayed.
Further notes
You enable the cable test function with the cabletest interface command in the Global
configuration mode.
SCALANCE XB-200 Command Line Interface
342
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
11.1.14
show power-line-state
Description
This command shows the status of the power supply.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show power-line-state
Result
The status of the power supply is displayed.
11.1.15
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
11.1.15.1
events
Description
With this command, you change to the EVENTS configuration mode.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
343
Diagnostics
11.1 Event and fault handling
Syntax
Call the command without parameters:
events
Result
You are now in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Further notes
You exit the EVENTS configuration mode with the command end or exit.
11.1.15.2
cabletest interface
Description
With this command, you enable the cable test for the specified interface.
Note
Wire pairs
Wire pairs 4-5 and 7-8 of 10/100 Mbps network cables are not used.
The wire pair assignment - pin assignment is as follows (DIN 50173):
Pair 1 = pin 1-2
Pair 2 = pin 3-6
Pair 3 = pin 4-5
Pair 4 = pin 7-8
Requirement
● The interface has no active data traffic.
● You are in the Global configuration mode.
The command prompt is:
cli(config)#
Syntax
Call up the command without parameters or with the following parameter assignment:
cabletest interface <interface-type> <interface-id> [force]
SCALANCE XB-200 Command Line Interface
344
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
The parameters have the following meaning:
Parameter
interface-type
interface-id
force
Description
Range of values / note
Type of interface
Enter a valid interface.
Interface identifier
Forces a link down during the test
Necessary parameter if there is a
link up on the interface.
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default value is used.
Result
Following the test phase, the result is displayed.
The value for the distance has a tolerance of +/- 1 m.
11.1.16
Commands in the Events configuration mode
This section describes commands that you can call up in the EVENTS configuration mode.
In the Global configuration mode, enter the events command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
● If you exit the EVENTS configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the EVENTS configuration mode with the end command, you return to the
Privileged EXEC mode.
11.1.16.1
add log
Description
With this command, you create an entry in the log.
Requirement
You are in the EVENTS Configuration mode.
The command prompt is as follows:
cli(config-events)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
345
Diagnostics
11.1 Event and fault handling
Syntax
Call the command without parameters:
add log <log entry>
The parameter has the following meaning:
Parameter
log entry
Description
Range of values / note
Entry in the logbook
max. 150 characters
Result
The entry has been made in the logbook.
11.1.16.2
client config
Description
With this command, you enable one of the clients that processes or forwards the messages
of the device.
The following clients are available:
● syslog: sends the messages to the Syslog server
● trap: sends the messages as SNMP trap to a configured recipient
● email: sends the messages as e-mail
Requirement
You are in the EVENTS Configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
client config {syslog|trap|email|all}
The parameters have the following meaning:
Parameter
syslog
trap
email
all
Description
Enables the client that sends the messages to the Syslog server
Enables the client that sends the SNMP traps
Enables the client that sends the e-mails
Enables all clients at once
SCALANCE XB-200 Command Line Interface
346
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
Result
The function of the client selected for the transfer is enabled.
Further notes
You display the status of the events and the clients with the show events config command.
You disable a client with the no client config command.
11.1.16.3
no client config
Description
With this command, you disable one of the clients that processes or forwards the messages
of the device.
Requirement
You are in the EVENTS Configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
no client config {syslog|trap|email|all}
The parameters have the following meaning:
Parameter
syslog
trap
email
all
Description
Disables the client that sends the messages to the Syslog server
Disables the client that sends the SNMP traps
Disables the client that sends the e-mails
Disables all clients at once
Result
The client selected for the transfer is disabled.
Further notes
You display the status of the events and the clients with the show events config command.
You enable the function with the client config command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
347
Diagnostics
11.1 Event and fault handling
11.1.16.4
event config
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you configure which of the various message types of the device will be
stored or forwarded.
The following events or message types are available:
● Message if there is cold or warm restart
● Message when there is a status change on a physical interface
● Message if there is an incorrect login
● Message when there is aRemote Monitoring alarm (RMON alarm)
● Message when there is a status change in the power supply
● Message when there is a status change in the redundancy manager (RM)
● Message when there is a status change on a standby connection
● Message when there is a status change in the error monitoring
● Message when there is a change in the spanning tree
● Message on status change of the VRRP routers
● Message if there is a status change in the detection of network loops
● Message on status change of OSPF routers
These messages can be processed by the clients in different ways:
● Entry in the logbook of the device
● Sending the message to the Syslog server
● Sending an e-mail
● Sending an SNMP trap
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
SCALANCE XB-200 Command Line Interface
348
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
Syntax
Call up the command with the following parameters:
event config
{cold-warmstart|linkchange|authentication-failure|
rmon-alarm|power-change|rm-state-change|standby-state-change|faultstate-change|
stp-change|vrrp-state-change|loopd-state-change|ospf-state-change|all}
{logtable|syslog|email|trap|faults|all}
The parameters have the following meaning:
Parameter
cold-warmstart
Description
Message if there is cold or warm restart
linkchange
Message when there is a status change on a physical interface
authenticationfailure
rmon-alarm
Message if there is an incorrect login
power-change
Message when there is a status change in the power supply
rm-state-change
standby-statechange
faultstate-change
Message when there is a RMONalarm
Message when there is a status change in the redundancy manager
Message when there is a status change on a standby connection
Message when there is a status change in the error monitoring
stp-change
Message when there is a change in the spanning tree
vrrp-state-change
Message on status change of VRRP routers
loopd-state-change
Message if there is a status change in the detection of network loops
ospf-state-change
Message on status change of OSPF routers
all
All messages
logtable
syslog
email
Client that processes the logbook entries
Client that sends the messages to the Syslog server
Client that sends the e-mails
trap
Client that sends the SNMP traps
faults
Error LED lights up. The setting is possible only for a cold or warm restart.
all
All clients at once
Result
The setting deciding which message of the device is stored or forwarded is configured.
Further notes
You display the status of the events and the clients with the show events config command.
You delete the settings with the no event config command.
With this command, the clients are not enabled.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
349
Diagnostics
11.1 Event and fault handling
To enable the clients, use the client config command.
Note
Changing several message types or clients
With each command call, you can only select one message type and one client.
If you want to process several message types or clients, it may be more efficient to first
select the all option and then disable individual elements.
11.1.16.5
no event config
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you configure which of the various message types of the device will no
longer be stored or forwarded.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
no event config
{cold-warmstart|linkchange|authentication-failure|
rmon-alarm|power-change|rm-state-change|standby-state-change|
faultstate-change|stp-change|vrrp-state-change|all}
{logtable|syslog|email|trap|faults|all}
The parameters have the following meaning:
Parameter
cold-warmstart
Description
Message if there is cold or warm restart
linkchange
Message when there is a status change on a physical interface
authenticationfailure
rmon-alarm
Message if there is an incorrect login
power-change
Message when there is a status change in the power supply
Message when there is a RMON alarm
SCALANCE XB-200 Command Line Interface
350
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
Parameter
rm-state-change
standby-statechange
faultstate-change
Description
Message when there is a status change in the redundancy manager
Message when there is a status change on a standby connection
Message when there is a status change in the error monitoring
stp-change
Message when there is a change in the spanning tree
vrrp-state-change
Message on status change of VRRP routers
all
All messages
logtable
Client that processes the logbook entries
syslog
Client that sends the messages to the Syslog server
email
trap
faults
all
Client that sends the e-mails
Client that sends the SNMP traps
Error LED lights up. The setting is possible only for a cold or warm restart.
All clients at once
Result
The setting deciding which messages of the device are not stored or forwarded is
configured.
Further notes
You display the status of the events and the clients with the show events config command.
You configure which of the various message types of the device will be stored or forwarded
with the event config command.
11.1.16.6
severity
Description
With this command, you configure the threshold values for the sending of system event
notifications.
Requirement
You are in the EVENTS Configuration mode.
The command prompt is as follows:
cli (config-events) #
Syntax
Call up the command with the following parameters:
severity { mail | log | syslog } { info | warning | critical }
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
351
Diagnostics
11.1 Event and fault handling
The parameters have the following meaning:
Parameter
Description
Range of values / note
Specifies the threshold value for sending system event
messages by e-mail.
-
log
Specifies the threshold value for entering system event
messages in the log table.
-
syslog
Specifies the threshold value for entering system event
messages in the Syslog file.
-
info
System events are processed as of the severity level
"Information".
-
System events are processed as of the severity level
"Critical".
-
mail
warning
critical
System events are processed as of the severity level
"Warning".
-
Result
The settings for sending system event messages are configured.
The "severity" function is enabled.
Further notes
You disable the setting with the no severity command.
You display the status of this function and other information show events severity
11.1.16.7
no severity
Description
With this command, you disable the setting for the threshold values for the sending of
system event notifications.
Requirement
You are in the EVENTS Configuration mode.
The command prompt is as follows:
cli (config-events) #
Syntax
Call up the command with the following parameters:
no severity { mail | log | syslog }
SCALANCE XB-200 Command Line Interface
352
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
The parameters have the following meaning:
Parameter
Description
Range of values / note
The setting of the threshold value for sending system
event messages by e-mail is disabled.
-
log
The setting of the threshold value for entering system
event messages in the log table disabled.
-
syslog
The setting of the threshold value the entering event
messages in the Syslog file is disabled.
-
mail
If you do not select any parameters from the parameter list, the default value is used.
Result
The settings for sending system event messages are configured.
Further notes
You enable the setting with the severity command.
You display the status of this function and other information show events severity.
11.1.16.8
power
Description
With this command, you configure and activate the monitoring of the power supplies.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
power [{L1|L2}]
The parameters have the following meaning:
Parameter
L1
L2
Description
Monitoring of power supply 1
Monitoring of power supply 2
If you do not select any parameters from the parameter list, the default value "L1 and L2" is
used.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
353
Diagnostics
11.1 Event and fault handling
Result
The setting for monitoring the power supplies is configured.
Further notes
You can display the current setting with the show events faults config command.
You disable the function with the no power command.
11.1.16.9
no power
Description
With this command, you disable the monitoring of the power supplies.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
no power [{L1|L2}}
The parameters have the following meaning:
Parameter
L1
L2
Description
No monitoring of power supply 1
No monitoring of power supply 2
If you do not select any parameters from the parameter list, the default value "L1 and L2" is
used.
Result
The setting for monitoring the power supplies is configured.
Further notes
You can display the current setting with the show events faults config command.
You enable the function with the power command.
SCALANCE XB-200 Command Line Interface
354
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
11.1.16.10
link
Description
With this command, you configure and enable the monitoring of the physical network
connections for cable breaks or for pulling of the connector.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
link {up|down}[{<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
up
down
interface-type
interface-id
Description
Range of values / note
Only the establishment of a connection
is signaled
-
Only a break on a connection is signaled
-
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select an interface, the function is enabled for all available interfaces.
Result
The settings for monitoring the physical network connections have been configured.
Further notes
You display the setting with the show events faults config command.
You disable the function with the no link command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
355
Diagnostics
11.1 Event and fault handling
11.1.16.11
no link
Description
With this command, you disable the monitoring of the physical network connections for cable
breaks or for pulling of the connector.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli(config-events)#
Syntax
Call up the command with the following parameters:
no {up|down}[{<interface-type><interface-id>}]
The parameters have the following meaning:
Parameter
up
down
interfacetype
interface-id
Description
Range of values / note
The message when establishing a connection is
disabled
-
The message when a connection is down is disabled
-
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select an interface, the function is disabled for all available interfaces.
Result
The settings for monitoring the physical network connections have been configured.
Further notes
You can display the current setting with the show events faults config command.
You enable the function with the link command.
SCALANCE XB-200 Command Line Interface
356
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.1 Event and fault handling
11.1.16.12
syslogserver
Description
With this command, you configure the Syslog server address.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli (config-events) #
Syntax
Call up the command with the following parameters:
syslogserver {ipv4 <ucast_addr>} [<port(1-65535)>]
The parameters have the following meaning:
Parameter
ipv4
ucast_addr
port
Description
Range of values / note
Keyword for an IP address
-
Syslog server IPv4 address
Enter a valid IPv4 address.
Serverport
1 .. 65535
Default: 514
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default value is used.
Result
The settings for the Syslog server are configured.
Further notes
You disable the setting with the no syslogserver command.
You can display the status of this function and other information with the show events config
command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
357
Diagnostics
11.1 Event and fault handling
11.1.16.13
no syslogserver
Description
With this command, you delete a Syslog server.
Requirement
You are in the EVENTS Configuration mode.
The command prompt is as follows:
cli (config-events) #
Syntax
Call up the command with the following parameters:
syslogserver {ipv4 <ucast_addr>}
The parameters have the following meaning:
Parameter
ipv4
ucast_addr
Description
Range of values / note
Keyword for an IP address
-
Syslog server IPv4 Address
Enter a valid IPv4 address.
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The Syslog server is deleted.
Further notes
You add a Syslog server syslogserver.
SCALANCE XB-200 Command Line Interface
358
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.2 Syslog client
11.2
Syslog client
With the commands in this section, the following settings are configured:
● Transfer of the messages to the Syslog server
● Local buffering and storage of messages
● Receipt and forwarding of messages from other devices (relay mode)
11.2.1
show events syslogserver
Description
This command shows the entries of the configured Syslog server.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show events syslogserver
Result
The entries of the configured Syslog server are displayed.
11.2.2
Commands in the Events configuration mode
This section describes commands that you can call up in the EVENTS configuration mode.
In the Global configuration mode, enter the events command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
● If you exit the EVENTS configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the EVENTS configuration mode with the end command, you return to the
Privileged EXEC mode.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
359
Diagnostics
11.2 Syslog client
11.2.2.1
syslogserver
Description
With this command, you configure the Syslog server address.
Requirement
You are in the EVENTS configuration mode.
The command prompt is as follows:
cli (config-events) #
Syntax
Call up the command with the following parameters:
syslogserver {ipv4 <ucast_addr>} [<port(1-65535)>]
The parameters have the following meaning:
Parameter
ipv4
ucast_addr
port
Description
Range of values / note
Keyword for an IP address
-
Syslog server IPv4 address
Enter a valid IPv4 address.
Serverport
1 .. 65535
Default: 514
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default value is used.
Result
The settings for the Syslog server are configured.
Further notes
You disable the setting with the no syslogserver command.
You can display the status of this function and other information with the show events config
command.
SCALANCE XB-200 Command Line Interface
360
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.2 Syslog client
11.2.2.2
no syslogserver
Description
With this command, you delete a Syslog server.
Requirement
You are in the EVENTS Configuration mode.
The command prompt is as follows:
cli (config-events) #
Syntax
Call up the command with the following parameters:
syslogserver {ipv4 <ucast_addr>}
The parameters have the following meaning:
Parameter
ipv4
ucast_addr
Description
Range of values / note
Keyword for an IP address
-
Syslog server IPv4 Address
Enter a valid IPv4 address.
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The Syslog server is deleted.
Further notes
You add a Syslog server syslogserver.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
361
Diagnostics
11.3 RMON
11.3
RMON
The RMON function provides commands with which variables of the Management
Information Base (MIB) can be monitored for violation of limit values and to store or forward
these events in the following ways:
● Entry in the local log
● Sending as SNMP trap
● Transfer to the Syslog server
● Transfer to a network management station using SNMP
11.3.1
show rmon
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
This command shows the settings of the remote monitoring function.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show rmon [statistics [<stats-index (1-65535)>]] [alarms] [events] [history [historyindex (1-65535)] [overview]]
The parameters have the following meaning:
Parameter
Description
Range of values / note
Shows counts for various packet characteristics and sizes.
-
stats-index
Index number for the statistical values
1 ... 65535
alarms
Shows the threshold values and event
assignments for alarms.
-
events
Shows the status and the actions that
are triggered.
-
statistics
SCALANCE XB-200 Command Line Interface
362
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.3 RMON
Parameter
Description
Range of values / note
Shows the stored statistical values for
earlier transmission periods.
-
history-index
Index number for the previous statistical values
1 ... 65535
overview
Displays an overview.
-
history
With this command, you can display several parameters with one call.
If you do not select any parameters from the parameter list, only the enabled or disabled
status is shown.
Result
The settings of the remote monitoring function are displayed.
11.3.2
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
11.3.2.1
rmon
Description
With this command, you enable the Remote Monitoring function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
rmon
Default: disabled
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
363
Diagnostics
11.3 RMON
Result
The Remote Monitoring function is enabled.
Further notes
You disable this function with the no rmon command.
You can display the status of this function and other information with the show rmon
command.
11.3.2.2
no rmon
Description
With this command, you disable the Remote Monitoring function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameter assignment:
no rmon
Default: disabled
Result
The Remote Monitoring function is disabled.
Further notes
You enable this function with the rmon command.
You can display the status of this function and other information with the show rmon
command.
SCALANCE XB-200 Command Line Interface
364
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.3 RMON
11.3.2.3
rmon alarm
Description
With this command, you configure an alarm for monitoring a MIB variable. The variable is
checked at specific intervals to determine whether or not it has exceeded or fallen below
threshold values. Events are assigned to these occurrences.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
rmon alarm <alarm-number><mib-object-id(255)>
<sample-interval-time(1-65535)>
{absolute|delta}
rising-threshold<value(0-2147483647)>[risingevent-number(1-65535)]
falling-threshold<value(0-2147483647)>[fallingevent-number(1-65535)]
[owner<ownername(127)>]
The parameters have the following meaning:
Parameter
alarm-number
mib-object-id
sample-intervaltime
absolute
delta
Description
Range of values / note
Number of the alarm
1 ... 52
Name of the MIB variable
max. 255 characters
Interval for the check [s]
1 ... 65535
The current absolute value of the moni- tored MIB is evaluated
The difference between the current and the previous value of the monitored
MIB is evaluated
rising-threshold
Keyword for threshold value for rising
or high variable values
-
value
Relevant threshold value
1 ... 2147483647
risingevent-number
Event number for this
1 ... 65535
Keyword for threshold value for falling
or low variable values
-
falling-threshold
value
Relevant threshold value
1 ... 2147483647
fallingevent-number
Event number for this
1 ... 65535
owner
User to which the alarm is assigned
-
User name of the user
max. 127 characters
ownername
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
365
Diagnostics
11.3 RMON
If you do not select a parameter from the parameter list, the events for high and low
threshold values are assigned the lowest event number available in the event table.
Note
MIB variables that can be monitored
With the RMON function, only MIB variables of the Ethernet interfaces can be monitored.
Note
Magnitude of the threshold values
The threshold value for falling or low variable values should be less than the threshold value
for rising or high variable values.
Note
Conditions for working with alarms
The events assigned to the alarms are configured.
The Remote monitoring function is started with the rmon command.
Result
The alarm for monitoring a MIB variable is configured.
Further notes
You delete an alarm with the no rmon alarm command.
You display the list of configured RMON alarms with the show rmon alarms command.
11.3.2.4
no rmon alarm
Description
With this command, you delete an alarm for monitoring a MIB variable.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
SCALANCE XB-200 Command Line Interface
366
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.3 RMON
Syntax
Call up the command with the following parameters:
no rmon alarm <number (1-52)>
The parameter has the following meaning:
Parameter
number
Description
Range of values / note
Number of the alarm to be deleted
1 ... 52
Result
The entry for monitoring a MIB variable is deleted.
11.3.2.5
rmon event
Description
With this command, you configure an event in the RMON Event Table.
You specify its name and the owner and whether or not an SNMP trap is generated.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
rmon event <number(1-52)>[description<event-description(127)>]
[owner<ownername(127)>][trap<notify(127)>]
The parameters have the following meaning:
Parameter
Description
Range of values / note
Number of the event
1 ... 52
Title of the event
-
Description of the event
max. 127 characters
owner
User to which the event is assigned
-
ownername
User name of the user
max. 127 characters
Specifies whether an SNMP trap
should be sent
-
Name of the community to which the
SNMP trap will be sent
max. 127 characters
number
description
event-description
trap
notify
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
367
Diagnostics
11.3 RMON
Result
The event is configured.
Further notes
You delete an entry with the no rmon event command.
You display the RMON Event Table with the show rmon events command.
You show the details of the SNMP community with the show snmp community command.
11.3.2.6
no rmon event
Description
With this command, you delete an entry from the RMON event table.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no rmon event <number (1-52)>
The parameter has the following meaning:
Parameter
number
Description
Range of values / note
Number of the event entry to be deleted
1 ... 52
Result
The entry is deleted from the RMON event table.
SCALANCE XB-200 Command Line Interface
368
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.3 RMON
11.3.3
Commands in the interface configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
11.3.3.1
rmon collection stats
Description
With this command, you start the recording of statistical data of an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
rmon collection stats <index (1-52)>[owner<ownername(127)>]
The parameters have the following meaning:
Parameter
index
owner
ownername
Description
Range of values / note
Number of the recording
1 ... 52
User to which the event is assigned
-
User name of the user
max. 127 characters
Result
The recording of statistical data is started.
Further notes
You can display the content of a recording with the show rmon statistics command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
369
Diagnostics
11.3 RMON
11.3.3.2
no rmon collection stats
Description
With this command, you end the recording of statistical data of an interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
no rmon collection stats <index (1-52)>
The parameter has the following meaning:
Parameter
index
Description
Range of values / note
Number of the recording
1 ... 52
Result
The recording of statistical data is ended.
11.3.3.3
rmon collection history
Description
With this command, you configure the collection of statistical data of the interface in a
selectable number of recording intervals ("Buckets ") with a specified period.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
370
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.3 RMON
Syntax
Call up the command with the following parameters:
rmon collection history<index(1-52)>
[buckets<bucket-number(1-65535)>]
[interval<seconds(1-3600)>]
[owner<ownername(127)>]
The parameters have the following meaning:
Parameter
index
buckets
bucket-number
Description
Range of values / note
Number of the recording
1 ... 65535
Maximum number of recording intervals
-
Number of recording intervals
1 ... 65535
Default: 50
interval
Duration of an individual recording
interval
-
seconds
Time in seconds
1 ... 3600
owner
User to which the event is assigned
-
User name of the user
max. 127 characters
Default: 1800
ownername
Default: monitor
If you do not select any parameter from the parameter list, the default values are used.
Result
The data is recorded.
Further notes
You can display the content of a recording with the show rmon history command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
371
Diagnostics
11.3 RMON
11.3.3.4
no rmon collection history
Description
With this command, you end the recording of statistical data of the interface.
Requirement
You are in the Interface configuration mode.
The command prompt is as follows:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
no rmon collection history <index(1-52)>
The parameter has the following meaning:
Parameter
index
Description
Range of values / note
Number of the recording
1 ... 52
Result
The data recording is ended.
SCALANCE XB-200 Command Line Interface
372
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.4 Port Mirroring
11.4
Port Mirroring
With the port mirroring function, you copy the data stream of one or more ports to another
interface to be able to analyze this data stream without disturbing operation.
Note
If the maximum data rate of the mirrored port is higher than that of the monitor port, data
may be lost and the monitor port no longer reflects the data traffic at the mirrored port.
Several ports can be mirrored to one monitor port at the same time.
Disable port mirroring if you want to connect a normal end device to the monitor port.
11.4.1
show monitor
Description
This command shows the status of the port mirroring function.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameters:
show monitor
Result
The status of the port mirroring function is displayed.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
373
Diagnostics
11.4 Port Mirroring
11.4.2
show monitor barrier
Description
This command shows the status of the communication via the monitor port. If you enable this
option, management of the switch via the monitor port is no longer reachable.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call the command without parameter assignment:
show monitor barrier
Result
The settings are displayed.
11.4.3
show monitor session
Description
This command shows the settings used for mirroring ports.
You obtain information about the ports from which incoming and/or outgoing data traffic is
mirrored and the port at which the mirrored data is output.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command with the following parameters:
show monitor {session <session-id(1-1)>}
SCALANCE XB-200 Command Line Interface
374
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.4 Port Mirroring
The parameters have the following meaning:
Parameter
session
session-id
Description
Range of values / note
Keyword for a session whose settings
are displayed
-
Number of the session
1
Result
The settings for mirroring ports are displayed.
11.4.4
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
11.4.4.1
monitor
Description
With this command, you enable the port mirroring function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
monitor
As default the function is "disabled".
Result
The port mirroring function is enabled.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
375
Diagnostics
11.4 Port Mirroring
Further notes
You can display the status of this function with the show monitorcommand.
You disable the function with the no monitor command.
11.4.4.2
no monitor
Description
With this command, you disable the port mirroring function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no monitor
Result
The port mirroring function is disabled.
Further notes
You can display the status of this function with the show monitorcommand.
You enable the function with the monitor command.
SCALANCE XB-200 Command Line Interface
376
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.4 Port Mirroring
11.4.4.3
monitor barrier enabled
Description
With this command, you disable the communication via the monitor port.
Note
Effects of monitor barrier enabled
If you enable this option, management of the switch via the monitor port is no longer
reachable. The following port-specific functions are changed:
• DCP forwarding is turned off
• LLDP is turned off
• Unicast, multicast and broadcast blocking is turned on
The previous statuses of these functions are no longer restored after disabling monitor
barrier again. They are reset to the default values and may need to be reconfigured.
You can reconfigure these functions manually even if monitor barrier is turned on. The data
traffic on the monitor port is also allowed again. If you do not require this, make sure that
only the data traffic you want to monitor is forwarded to the interface.
If mirroring is disabled, the listed port-specific functions are reset to the default values. This
reset takes place regardless of whether the functions were configured manually or
automatically by enabling monitor barrier.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
monitor barrier enabled
Result
Communication via the monitor port is disabled.
Further notes
You enable the communication with the no monitor barrier enabled command.
You display the configuration settings with the show monitor barrier command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
377
Diagnostics
11.4 Port Mirroring
11.4.4.4
no monitor barrier enabled
Description
With this command, you enable the communication via the monitor port.
Requirement
You are in the Global Configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no monitor barrier enabled
Result
Communication via the monitor port is enabled.
Further notes
You disable the communication with the monitor barrier enabled command.
You display the configuration settings with the show monitor barrier command.
11.4.4.5
monitor session destination
Description
With this command, you configure the destination for mirroring a port.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
monitor session <session-id(1-1)> destination
{interface <interface-type><interface-id>}
SCALANCE XB-200 Command Line Interface
378
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.4 Port Mirroring
The parameters have the following meaning:
Parameter
session-id
interface
Description
Values
Number of the session
1
Keyword for a an interface description
-
interface-type
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
As soon as you have configured the settings for the port to be monitored and the destination
port, the session is complete and active.
Further notes
You delete the destination for mirroring a port with the no monitor session ... destination
command.
You end and delete a session with the no monitor session command.
You display the configuration settings with the show monitor session command.
11.4.4.6
no monitor session destination
Description
With this command, you delete the destination for mirroring a port.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no monitor session <session-id(1-1)> destination
{interface <interface-type><interface-id>}
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
379
Diagnostics
11.4 Port Mirroring
The parameters have the following meaning:
Parameter
session-id
interface
Description
Range of values / note
Number of the session
1
Keyword for a an interface description
-
interface-type
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
The destination for the mirroring of a port is deleted.
Further notes
You configure the destination for mirroring a port with the monitor session ... destination
command.
You end and delete a session with the no monitor session command.
You display the configuration settings with the show monitor session command.
11.4.4.7
monitor session source
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
With this command, you configure the source for mirroring a port.
Requirement
● Monitoring is enabled.
● You are in the Global configuration mode.
The command prompt is:
cli(config)#
SCALANCE XB-200 Command Line Interface
380
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.4 Port Mirroring
Syntax
Call up the command for the port to be monitored with the following parameter assignment:
monitor session <session-id(1-1)> source
{interface {<interface-type> <interface-id> | port-channel <port-channel-id (1-8)>}
[{rx|tx|both}]}
The parameters have the following meaning:
Parameter
Description
Range of values / note
Number of the session
1
Keyword for a an interface description
-
interface-type
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
session-id
interface
port-channel
Keyword for a port channel connection
-
port-channel-id
Number of the addressed port channel
1 ... 8
rx
Received data traffic will be mirrored
(received)
tx
both
If you enable the mirroring function for a ring port, the ring port
Transmitted data traffic will be mirrored sends test frames even in the "link
down" status.
(transmitted)
Received and transmitted data traffic
will be mirrored
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default value (both) is used.
Result
As soon as you have configured the settings for the port to be monitored and the destination
port, the session is complete and active.
Further notes
You delete the source for mirroring a port with the no monitor session ... source command.
You end and delete a session with the no monitor session command.
You display the configuration settings with the show monitor session command.
See also
Features not supported (Page 22)
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
381
Diagnostics
11.4 Port Mirroring
11.4.4.8
no monitor session source
Description
With this command, you delete the source for mirroring a port or a VLAN.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command for the port to be monitored with the following parameter assignment:
no monitor session <session-id(1-1)> source
{interface <interface-type><interface-id>} [{rx|tx|both}]}
The parameters have the following meaning:
Parameter
session-id
interface
interface-type
Description
Range of values / note
Number of the session
1
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
interface-id
Module no. and port no. of the interface
rx
Received data traffic will be mirrored
(received)
tx
Transmitted data traffic will be mirrored (transmitted)
both
Received and transmitted data traffic
will be mirrored
-
-
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default value (both) is used.
Result
The source for the mirroring of a port is deleted.
Further notes
You configure the source for mirroring a port with the monitor session ... source command.
You end and delete a session with the no monitor session command.
You display the configuration settings with the show monitor session command.
SCALANCE XB-200 Command Line Interface
382
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.4 Port Mirroring
11.4.4.9
no monitor session
Description
With this command, you delete the monitor session.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call up the command with the following parameters:
no monitor session<session-id(1-1)>
The parameter has the following meaning:
Parameter
session-id
Description
Range of values / note
Number of the session
1
Result
The monitor session is deleted.
Further notes
You display the configuration settings with the show monitor session command.
You configure and start mirroring of a port with the monitor session command.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
383
Diagnostics
11.5 Loop detection
11.5
Loop detection
With the "Loop detection" function, you specify the ports for which loop detection will be
activated. The ports involved send special test frames - the loop detection frames. If these
frames are sent back to the device, there is a loop.
A "Local loop" involving this device means that the frames are received again at a different
port of the same device. If the sent frames are received again at the same port, there is a
"remote loop" involving other network components.
With the commands in this section, you start loop detection and decide which actions will be
used on the ports affected if loops are detected.
Note
A loop is an error in the network structure that needs to be eliminated. The loop detection
can help to find the errors more quickly but does not eliminate them.
Note
Note that loop detection is only possible at ports that were not configured as ring ports or
standby ports.
Note
Changing the configured port status with loop detection
The configuration of the port status can be changed with the "Loop Detection" function. If, for
example, the administrator has disabled a port, the port can be enabled again after a device
restart by "Loop Detection". The port status "link down" is not changed by "Loop Detection".
11.5.1
show loopd
Description
With this command, you display the information on loop detection.
Detected loops are shown.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
SCALANCE XB-200 Command Line Interface
384
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.5 Loop detection
Syntax
Call the command without parameters:
show loopd
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
Result
Information on loop detection is displayed.
11.5.2
show loopd interface
Note
The IE switch does not support all parameters, refer to the section "Features not supported
(Page 22)".
Description
Displays information on the loop interface.
Requirement
You are in the User EXEC mode or in the Privileged EXEC mode.
The command prompt is as follows:
cli>
or cli#
Syntax
Call up the command without parameters or with the following parameter assignment:
show loopd interface [{<interface-type> <interface-id> | port-channel <port-channelid (1-8)>}]
The parameters have the following meaning:
Parameter
interface
interface-type
interface-id
Description
Range of values / note
Keyword for a an interface description
-
Type or speed of the interface
Enter a valid interface.
Module no. and port no. of the interface
port-channel
Keyword for a port channel connection
-
port-channel-id
Number of the addressed port channel
1 ... 8
For information on names of addresses and interfaces, refer to the section "Addresses and
interface names (Page 25)".
If you do not select any parameters from the parameter list, the default value is used.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
385
Diagnostics
11.5 Loop detection
Result
The loop interface is displayed.
Further notes
You can display the status of this function and other information with the show loopd
command.
11.5.3
Commands in the global configuration mode
This section describes commands that you can call up in the Global configuration mode.
In Privileged EXEC mode, enter the configure terminal command to change to this mode.
Commands relating to other topics that can be called in the Global configuration mode can
be found in the relevant sections.
You exit the Global configuration mode with the end or exit command and are then in the
Privileged EXEC mode again.
11.5.3.1
loopd
Description
With this command, you enable the loop detection function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
loopd
Result
The loop detection function is enabled
Further notes
You disable the function with the no loopd command.
You can display the status of this function and other information with the show loopd
command.
SCALANCE XB-200 Command Line Interface
386
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.5 Loop detection
11.5.3.2
no loopd
Description
With this command, you enable the loop detection function.
Requirement
You are in the Global configuration mode.
The command prompt is as follows:
cli(config)#
Syntax
Call the command without parameters:
no loopd
Result
The loop detection function is disabled
Further notes
You enable the function with the loopd command.
You can display the status of this function and other information with the show loopd
command.
11.5.3.3
loopd vlan mode
Description
With this command, you enable the loop detection function for VLAN.
Requirement
● Loopd is activated
● You are in the Global configuration mode.
The command prompt is:
cli(config)#
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
387
Diagnostics
11.5 Loop detection
Syntax
Call the command without parameters:
loopd vlan mode
Result
The loop detection function is enabled for VLAN.
Further notes
You disable the function with the no loopd vlan mode command.
You can display the status of this function and other information with the show loopd
command
11.5.3.4
no loopd vlan mode
Description
With this command, you disable the loop detection function for VLAN.
Requirement
● Loopd is activated
● You are in the Global configuration mode.
The command prompt is:
cli(config)#
Syntax
Call the command without parameters:
no loopd vlan mode
Result
The loop detection function is disabled for VLAN.
Further notes
You enable the function with the loopd vlan mode command.
You can display the status of this function and other information with the show loopd
command
SCALANCE XB-200 Command Line Interface
388
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.5 Loop detection
11.5.4
Commands in the Interface Configuration mode
This section describes commands that you can call up in the interface configuration mode.
Depending on the Interface selected, various command sets are available.
In the Global configuration mode, enter the interface command to change to this mode.
Commands relating to other topics that can be called in the interface configuration mode can
be found in the relevant sections.
● If you exit the Interface configuration mode with the exit command, you return to the
Global configuration mode.
● If you exit the Interface configuration mode with the end command, you return to the
Privileged EXEC mode.
11.5.4.1
loopd {blocked | forwarder | sender}
Description
With this command you specify how the port handles loop detection frames.
Requirement
● Loop detection is enabled
● A Spanning Tree port, ring port or standby port cannot be the sender port.
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
loopd {blocked | forwarder | sender}
The parameters have the following meaning:
Parameter
blocked
forwarder
sender
Description
Range of values / note
The forwarding of loop detection
frames is blocked.
-
Loop detection frames from other devices are forwarded.
Default after enabling loop detection.
Loop detection frames are sent out and forwarded.
If you do not select any parameters from the parameter list, the default value is used.
Result
It has been configured how the port handles loop detection frames.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
389
Diagnostics
11.5 Loop detection
Further notes
You can display the status of this function and other information with the show loopd
command.
11.5.4.2
loopd {tx-interval | detect-threshold | reaction-timeout}
Description
With this command you configure the send interval, threshold value and reaction time for
loop detection.
Requirement
● Loop detection is enabled
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
Syntax
Call up the command with the following parameters:
loopd {tx-interval <mSec(500-5000)> | detect-threshold <integer(1-500)> | reactiontimeout <seconds(0-86400)>}
The parameters have the following meaning:
Parameter
tx-interval
Description
Range of values / note
Keyword for the send interval
-
Specifies the send interval for loop
detection frames in milliseconds.
500 ... 5000
detect-threshold
Keyword for the threshold value
-
integer
Specifies the threshold value after how 1 ... 500
many received loop detection frames, a Default: 2
loop is assumed and the device reacts
according to the setting.
reaction-timeout
Keyword for the time to the end of the
reaction time
-
seconds
Specifies the number of seconds after
which the device automatically changes to the status in which it was before
the loop.
0 ... 86400
mSec
Default: 1000
Default: 0
If you set the value "0", you need
to enable the port manually again
following a loop using the command loopd port reset.
If you do not select any parameters from the parameter list, the default value is used. The
default values apply only to a port enabled earlier with loopd sender.
SCALANCE XB-200 Command Line Interface
390
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.5 Loop detection
Result
The settings are suitably configured.
Further notes
You can display the status of this function and other information with the show loopd
command.
11.5.4.3
loopd port reset
Description
With this command, you enable a port that was blocked by loop detection.
Requirement
● Loop detection is enabled
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
loopd port reset
Result
The blocked port is enabled again.
Further notes
You disable the setting with the no loopd port reset command.
You can display the status of this function and other information with the show loopd
command.
See also
Addresses and interface names (Page 25)
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
391
Diagnostics
11.5 Loop detection
11.5.4.4
no loopd port reset
Description
With this command, you disable the port reset for loop detection.
Requirement
● Loop detection is enabled
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no loopd port reset
Result
The port reset function is disabled.
Further notes
You enable the setting with the loopd port reset command.
You can display the status of this function and other information with the show loopd
command.
See also
Addresses and interface names (Page 25)
11.5.4.5
loopd reaction local
Description
With this command, you activate the "disable" reaction for a local loop. If a local loop is
detected, the port is blocked.
Requirement
● Loop detection is enabled.
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
SCALANCE XB-200 Command Line Interface
392
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.5 Loop detection
Syntax
Call the command without parameters:
loopd reaction local
Result
"disable" is activated for the loopd reaction local function.
"disable" is the default after enabling loop detection.
Further notes
You enable the "no action" reaction with the no loopd reaction local command.
You can display the status of this function and other information with the show loopd
command.
See also
Addresses and interface names (Page 25)
11.5.4.6
no loopd reaction local
Description
With this command, you enable the "no action" reaction for a local loop. If a local loop is
detected, this has no effect on the port.
Requirement
● Loop detection is enabled.
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no loopd reaction local
Result
"no action" is activated for the loopd reaction local function.
"disable" is the default after enabling loop detection.
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
393
Diagnostics
11.5 Loop detection
Further notes
You enable the "disable" reaction with the loopd reaction local command.
You can display the status of this function and other information with the show loopd
command.
See also
Addresses and interface names (Page 25)
11.5.4.7
loopd reaction remote
Description
With this command, you enable the "disable" reaction for a remote loop. If a remote loop is
detected, the port is blocked.
Requirement
● Loop detection is enabled.
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
loopd reaction remote
Result
"disable" is activated for the loopd reaction remote function.
"disable" is the default after enabling loop detection.
Further notes
You enable the "no action" reaction with the no loopd reaction remote command.
You can display the status of this function and other information with the show loopd
command.
See also
Addresses and interface names (Page 25)
SCALANCE XB-200 Command Line Interface
394
Configuration Manual, 04/2015, C79000-G8976-C361-02
Diagnostics
11.5 Loop detection
11.5.4.8
no loopd reaction remote
Description
With this command, you enable the "no action" reaction for a remote loop. If a remote loop is
detected, this has no effect on the port.
Requirement
● loopd is enabled
● You are in the Interface configuration mode.
The command prompt is:
cli(config-if-$$$)#
Syntax
Call the command without parameters:
no loopd reaction remote
Result
"no action" is activated for the loop reaction remote function.
"disable" is the default after enabling loop detection.
Further notes
You enable the "disable" setting with the loopd reaction remote command.
You can display the status of this function and other information with the show loopd
command.
See also
Addresses and interface names (Page 25)
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
395
Diagnostics
11.5 Loop detection
SCALANCE XB-200 Command Line Interface
396
Configuration Manual, 04/2015, C79000-G8976-C361-02
Index
A
add log, 345
alias, 63
no alias, 64
arp timeout, 239
no arp timeout, 240
authorized-manager, 316
no authorized-manager, 317
authorized-manager ip-source, 317
no authorized-manager ip-source, 320
auto-learn, 322
auto-save, 93
no auto-save, 94
B
broadcast-block, 64
dcp server, 192
no dcp server, 193
delete, 81
disable, 48
dot1x port-control, 328
no dot1x port-control, 329
dot1x reauthentication, 330
no dot1x reauthentication, 331
dscp-map, 305
duplex, 66
no duplex, 67
E
enable, 49
end, 28
ethernetip, 59
event config, 348
no event config, 350
events, 343
exit, 28
C
clear counters, 47
clear fault counter, 340
clear history, 34
clear hrp counters, 256
clear line vty, 51
clear logbook, 339
clear screen, 27
clear spanning-tree counters, 159
clear spanning-tree detected protocols, 158
clear standby counter, 257
clear-all-static-unicast, 322
CLI commands
Symbolic representation, 24
cli-console-timeout, 55
no cli-console-timeout, 56
configure terminal, 48
coordinates height, 57
coordinates latitude, 57
coordinates longitude, 58
cos-map, 304
D
dcp forwarding, 194
F
fault report ack, 341
flowcontrol, 301
G
Glossary, 17
H
help, 29
I
interface, 53
no interface, 54
interface range, 130
no interface range, 131
ip address, 142
ip address dhcp, 143
ip dhcp client mode, 198
ip dhcp config-file-request, 196
no ip dhcp config-file-request, 197
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
397
Index
ip echo-reply, 189
no ip echo-reply, 190
ip gateway, 188
no ip gateway, 188
ip http, 234
no ip http, 235
ip igmp snooping clear counters, 250
ip igmp snooping port-purge-interval, 252
no ip igmp snooping port-purge-interval, 253
ip igmp snooping querier, 254
no ip igmp snooping querier, 255
ip igmp snooping switch-ip, 251
ip igmp snooping version, 248
ip igmp vlan-snooping, 249
no ip igmp vlan-snooping, 250
L
link, 355
no link, 356
lldp, 67
no lldp, 68
load tftp, 78
loadsave, 80
login authentication, 310
logout, 50
loopd, 389, 390
M
mac-address-table aging, 298
no mac-address-table aging, 299
mac-address-table aging-time, 296
no mac-address-table aging-time, 297
mac-address-table static multicast, 277, 288
no mac-address-table static multicast, 289
mac-address-table static unicast, 272, 290
no mac-address-table static unicast, 291
mgmt vlan, 132
monitor, 375
no monitor, 376
monitor barrier enabled, 377
no monitor barrier enabled, 378
monitor session
destination, 378
no ... destination, 379
no ... source, 382
no monitor session, 383
source, 380
multicast-block, 69
N
name, 145
no name, 146
negotiation, 70
no negotiation, 71
no broadcast-block, 65
no ip address, 144
no login authentication, 311
no multicast-block, 70
no panel-button control-factory-defaults, 103
no passive listening, 184
no radius-server, 314
no rmon, 364
no sinema, 97
no spanning-tree passive-listening-compatibility, 165
no unicast-block, 75
ntp, 109
ntp server, 110
no ntp server, 111
ntp time diff, 112
P
panel-button control-factory-defaults, 102
passive listening, 183
password, 82
no password, 83
ping, 50
pnio, 60
ports, 147
no ports, 149
power, 353
no power, 354
Q
qos, 303
R
radius server, 312
rate-limit-output, 282
no rate-limit-output, 283
redundancy, 260
restart, 88
ring ports, 263
ring redundancy, 260
no ring redundancy, 261
rmon, 363
SCALANCE XB-200 Command Line Interface
398
Configuration Manual, 04/2015, C79000-G8976-C361-02
Index
rmon alarm, 365
no rmon alarm, 366
rmon collection history, 370
no rmon collection history, 372
rmon collection stats, 369
no rmon collection stats, 370
rmon event, 367
no rmon event, 368
S
save filetype, 79
Scope of the manual, 15
send test mail, 231
sender mail-address, 229
no sender mail-address, 230
severity, 351
no severity, 352
show authorized-managers, 315
show broadcast-block config, 44
show cli-console-timeout, 35
show coordinates, 36
show dcp forwarding, 187
show dcp server, 186
show device information, 36
show dot1x, 327
show ethernetip, 37
show events config, 335
show events faults config, 337
show events faults status, 337
show events sender email, 226
show events severity, 336
show events smtp-port, 227
show events smtp-server, 226
show events syslogserver, 359
show fault counter, 340
show flow-control, 300
show hardware, 37
show history, 33
show hrp counters, 258
show in, 38
show interface mtu, 38
show interfaces, 39
show interfaces ... counters, 40
show ip arp, 238
show ip dhcp client, 195
show ip dhcp client stats, 195
show ip gateway, 185
show ip http secure server status, 236
show ip http server status, 233
show ip igmp snooping, 245
show ip igmp snooping forwarding-database, 246
show ip igmp snooping statistics, 247
show ip igmp snooping switch-ip, 247
show ip interface, 41
show ip ssh, 241
show ip telnet, 186
show lldp neighbors, 43
show lldp status, 43
show loadsave files, 77
show loadsave tftp, 77
show lock port, 321
show logbook, 338
show mac-address-table, 122
show mac-address-table aging-status, 295
show mac-address-table aging-time, 295
show mac-address-table count, 127
show mac-address-table dynamic multicast, 123, 275
show mac-address-table dynamic unicast, 124, 269
show mac-address-table static multicast, 125, 276
show mac-address-table static unicast, 126, 270
show monitor, 374
show monitor barrier, 374
show monitor status, 373
show multicast-block config, 45, 274
show ntp info, 108
show passive-listening, 182
show pnio, 42
show power-line-state, 343
show qos cos-map, 302
show qos dscp-map, 302
show radius server, 309
show radius statistics, 309
show rate-limit output, 281
show ring-redundancy, 258
show ring-redundancy manager counters, 259
show rmon, 362
show running-config, 89
show sinema, 95
show snmp, 199
show snmp community, 199
show snmp engineID, 200
show snmp filter, 200
show snmp group, 201
show snmp group access, 201
show snmp inform statistics, 202
show snmp notif, 202
show snmp targetaddr, 203
show snmp targetparam, 203
show snmp tcp, 204
show snmp user, 204
show snmp viewtree, 205
show sntp broadcast-mode status, 113
show sntp status, 114
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
399
Index
show sntp unicast-mode status, 113
show spanning-tree, 151
show spanning-tree active, 152
show spanning-tree bridge, 153
show spanning-tree detail, 154
show spanning-tree interface, 154
show spanning-tree interface layer2-gateway-port, 157
show spanning-tree passive-listening-compatibility, 156
show spanning-tree root, 155
show ssl server-cert, 237
show time, 105
show unicast-block config, 45, 271
show users, 307
show versions, 46
show vlan, 127
show vlan device info, 128
show vlan learning params, 129
show vlan port config, 129
show web-session-timeout, 99
shutdown, 72
no shutdown, 73
shutdown complete, 72
SIMATIC NET glossary, 17
SIMATIC NET manual, 16
sinema, 96
SMTP
no smtp-server, 229
smtp-server, 228
smtp-port, 231
no smtp-port, 232
snmp
client config, 346
no client config, 347
snmp access, 208
no snmp access, 209
snmp agent version, 207
snmp community index, 210
no snmp community index, 211
snmp group, 212
no snmp group, 213
snmp notify, 214
no snmp notify, 215
snmp targetaddr, 216
no snmp targetaddr, 218
snmp targetparams, 218
no snmp targetparams, 220
snmp user, 222
no snmp user, 223
snmp v1-v2 readonly, 221
no snmp v1-v2 readonly, 221
snmp view, 224
no snmp view, 225
snmpagent, 206
no snmpagent, 206
sntp, 115
sntp client addressing-mode, 116
sntp time diff, 117
sntp unicast-server, 118
sntp unicast-server ipv4
no sntp unicast-server ipv4, 119
spanning-tree, 159
no spanning-tree, 160
spanning-tree (properties), 169
no spanning-tree, 171
spanning-tree (time settings), 166
no spanning-tree, 168
spanning-tree auto-edge, 172
no spanning-tree auto-edge, 173
spanning-tree bpdufilter, 175
spanning-tree bpdu-receive, 174
spanning-tree bpdu-transmit, 173
spanning-tree compatibility, 161
no spanning-tree compatibility, 162
spanning-tree layer2-gateway-port, 175
no spanning-tree layer2-gateway-port, 176
spanning-tree loop-guard, 177
no spanning-tree loop-guard, 177
spanning-tree passive-listening-compatibility, 165
spanning-tree priority, 163
no spanning-tree priority, 164
spanning-tree restricted-role, 178
no spanning-tree restricted-role, 179
spanning-tree restricted-tcn, 180
no spanning-tree restricted-tcn, 181
speed, 73
ssh-server, 242
no ssh-server, 243
standby connection name, 264, 265
standby ports, 267, 268
start, 325
stop, 326
storm-control, 284
no storm-control, 285
storm-control level, 286
no storm-control level, 287
switchport acceptable-frame-type, 136
no switchport acceptable-frame-type, 137
switchport access vlan, 137
no switchport access vlan, 138
switchport ingress-filter, 293
no switchport ingress-filter, 294
switchport lock, 323
no switchport lock, 324
SCALANCE XB-200 Command Line Interface
400
Configuration Manual, 04/2015, C79000-G8976-C361-02
Index
switchport priority default, 139
no switchport priority default, 140
switchport pvid, 140
no switchport pvid, 141
syslogserver, 357, 360
no syslogserver, 358, 361
system contact, 60
system location, 61
System manual, 16
system name, 61
T
telnet-server, 190
no telnet-server, 191
tftp filename, 84
tftp load, 85
tftp save, 86
tftp server, 87
Downloading, 78
Saving, 79
time, 106
time set, 106
U
unicast-block, 74
username, 62
V
vlan, 133
no vlan, 134
vlan range, 135
W
web-session-timeout, 100
no web-session-timeout, 101
whoami, 308
write startup-config, 91
SCALANCE XB-200 Command Line Interface
Configuration Manual, 04/2015, C79000-G8976-C361-02
401
Index
SCALANCE XB-200 Command Line Interface
402
Configuration Manual, 04/2015, C79000-G8976-C361-02

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project