WorkstationST - Network Monitor
WorkstationST - Network Monitor
2 GEI-100693E
For public disclosure
1 Introduction
The WorkstationST* Network Monitor provides the status of all devices (controllers,
computers, network switches) that are defined in the system and connected to at least one
of the Ethernet-based networks. Information is also provided about the health of each
network switch and its ports. The Network Monitor also allows proactive network
maintenance by providing visual indications and alarms of abnormal conditions. These
include devices not connected in their configured location, unknown devices being
connected to a switch, or attempts to gain unauthorized access to switch Simple Network
Management Protocol (SNMP) data.
During system startup, the Network Monitor determines where the devices are physically
connected. During normal system operation, changes in network topology should not
occur, therefore, any changes would indicate an abnormal condition. For example,
devices may be incorrectly reconnected after a network switch is replaced or new network
cables are run. This feature is also an important debugging tool because it allows network
issues to be spotted or ruled out very quickly. The Network Monitor also enhances
network stability and security by providing alarms in the event of an unauthorized
connection to the network.
With the release of ControlST* V04.07, the ToolboxST* application has been enhanced
to allow switch port connection information editing within the switch Component Editor,
rather than editing at each component’s network adapter. The ToolboxST application
imports the component network adapter information into each switch’s configuration
when the switch is first edited in the new version. Computers running WorkstationST
V04.06 and earlier use the component network adapter edited information. While it will
no longer be possible to view or edit the component network adapter switch connection
information at each Component Editor, any information that was configured before the
upgrade will remain available for any WorkstationST computer that has not been
upgraded. All upgraded WorkstationST computers will use the new switch-centric
information.
After an upgrade, any change to the network switch connection information from the
switch Component Editor will not be available for computers in a control system running
WorkstationST V04.06 and earlier. These earlier version WorkstationST Network
Monitor computers will need to be upgraded in order to use these network switch
connection information changes.
4 GEI-100693E
For public disclosure
2 Configuration
The Network Monitor feature uses the Windows® Simple Network Management Protocol
component to communicate with the network switch components. The Windows Simple
Network Management Protocol component must be installed on the Workstation
computer running the Network Monitor feature.
Click OK .
6 GEI-100693E
For public disclosure
2.1 System Information
The system network drawing displays all physical networks, as well as network switches
and devices, their physical locations, and their interconnection. The host name and IP
address of each device network connection on a per network basis, as well as the switch
and port where the physical connection is made is also provided. This information is
entered for the network switches and devices as they are added to the system in the
ToolboxST application. Samples of information contained in the system network drawing
are as follows.
Network Switch
8 GEI-100693E
For public disclosure
2.2 Networks
Information from the system network drawings must be entered into the ToolboxST
System Editor, as well as the ToolboxST devices. When a new system is created in the
ToolboxST application, it automatically includes a Unit Data Highway (UDH) network.
This is the default controller-level network to which all controllers are connected. The
Network Monitor only attempts to monitor devices connected to networks configured
with media type Ethernet and Transport type IP. Additional networks are added as needed.
10 GEI-100693E
For public disclosure
Select Name and enter a
name for the switch (such
as NS1 ).
Click Finish.
12 GEI-100693E
For public disclosure
Definitions of properties used to configure a selected network switch.
Connected Network is the communication path to the switch.
Description holds the user entered description for the switch. This text is displayed in
the switch ToolTips in the Network Status Viewer and should include the physical
location of the switch in order to help maintenance personnel locate and identify the
switch in the event of a failure.
GE Part Number is an optional setting.
Host Name is part of the communication path.
IP Address is part of the communication path.
Number of Ports specifies the number of ports the switch has. Note that for a stacked
switch arrangement, the total number of ports for both switches should be specified.
SNMP Community displays a password that retrieves data from the SNMP switch. This
value must match the SNMP Community value configured in the switch.
Stacked Switch Pair indicates whether the switch is operating in a Stacked Pair
arrangement.
Switch Type specifies the type of switch. If a switch type cannot be found that matches
the actual switch, one of the generic switch types can be used. Unknown switch types
may require trial and error in order to find a switch type that matches the behavior of the
actual switch.
Vendor Configuration Tool is an optional setting.
Port Type displays speed, and specifies whether the port is copper or fiber-based.
Port Description holds the user entered description for the port. This text is displayed
in the Network Status Viewer ToolTip for the port, and the text is included in alarms
generated for the special case Port Connection settings described below.
Port Connection defines the type of connection made to the port. The values and
descriptions are:
14 GEI-100693E
For public disclosure
port alarms. The description should include the name and port of the
switch that this port is connected to in order to facilitate troubleshooting
network issues. The Trunk Port selection should also be used for ports
connected to network routers or hubs.
ThirdPartyCriticalDeviceConnection is used to specify a port that is
connected to a third-party device (a device not represented in the system
configuration) that is critical to the operation of the plant and is expected
to be online at all times. Alarms will be generated in the event that the
port is down or disabled. The description field for critical third-party
connection ports is included in the Network Status Viewer ToolTip for
the port and also in the alarm text for any alarms generated for the port.
The description should include information about the device the port is
connected to so that the Network Status Viewer display and the alarms
associated with the port provide information about the connected device
to the user. This designation also serves the purpose of suppressing
Unknown Device alarms associated with the port. If a third-party device
is connected to a port using the default selection, the MAC Address of
the connected device will not match any of the native devices and an
Unknown Device alarm will be generated for the port.
PeripheralDeviceConnection is used to specify a port that is
connected to a third-party device (a device not represented in the system
configuration) that is not critical to the plant operation and may not
always be online, such as a printer. Alarms are only generated for the port
in the event that the port is disabled. This designation also serves the
purpose of suppressing Unknown Device alarms associated with the port.
Note When another switch port is connected to the port, or multiple devices (through a
router or hub) are connected to a port, configure the Trunk Node as True. The system
network diagram specifies which ports are configured as trunk nodes.
16 GEI-100693E
For public disclosure
Computers can be connected to all networks in the
system or a subset of them. A Network Adapter
is added for each network connection. Each
network adapter is configured according to the
system network drawing.
The following figure shows the corresponding settings in the WorkstationST component
in the ToolboxST application.
18 GEI-100693E
For public disclosure
2.6 Redundant HMI Example with HMI Trunk Ports
A simplified ControlST network implementation has been introduced that uses VLAN
tagging in the workstation NICs and the network switches in order to combine the PDH
and UDH VLANs onto a common network connection, referred to as a Trunk because
multiple VLANs coexist on the same connection. Only one set of teamed NICs is required
to provide full PDH and UDH redundancy. The following figure shows the physical
connections in this arrangement.
The following figure shows the corresponding settings in the WorkstationST component
in the ToolboxST application.
20 GEI-100693E
For public disclosure
2.7 Controller Example
Each controller is connected to the UDH network, and depending on redundancy, can
have up to three connections to the controller network. The network configuration for a
TMR controller displays as follows.
Note Network Adapter 0 represents the connections to the controller network, and each
connection can be assigned a unique switch and port location according to the system
network drawing.
22 GEI-100693E
For public disclosure
Instruction Guide GEI-100693E 23
For public disclosure
2.8.2 Network Status Viewer
The Network Status Viewer allows you to troubleshoot network issues down to the device
level. This utility retrieves status data from the Network Monitor.
� To open the Network Status Viewer: From the System Editor View menu,
click Network Status Viewer to display the Network Status Viewer.
24 GEI-100693E
For public disclosure
2.8.3 Network View Tab
The Network View tab displays the network hierarchy; the networks are the top-level
items. The switches are at the next level, followed by the devices.
26 GEI-100693E
For public disclosure
The following screen displays the configured and connected device views with the switch
connections expanded.
28 GEI-100693E
For public disclosure
2.8.6 Network Troubleshooting Example
The following is an example of the Network Status Viewer being used to determine any
network issues, the devices affected, and the cause.
32 GEI-100693E
For public disclosure
4 Troubleshooting
The most common issue associated with the Network Monitor is the inability to get
SNMP data from one or more network switches. This results in topology errors because
the Network Monitor is unable to determine which ports the devices are connected to, and
it results in a lack of port level data. The following screen shot shows the Network Status
Viewer display for a switch where the switch SNMP information cannot be read due to a
configuration error. The Status Viewer is indicating topology errors because it cannot
determine the state of the port and whether the configured device is connected to it. Note
also that the port information is uninitialized, especially the first field which should be the
port description. A blank port description with an uninitialized (0) value for MTU is the
best indication of a failure to read SNMP data from the switch.
Failure to read SNMP data from all of the switches is an indication that the Windows
Simple Network Management Protocol component is not installed on the WorkstationST
computer running the Network Monitor feature. Failure to read SNMP data from a subset
of switches is an indication that the SNMP Community setting for the switch in the
ToolboxST system does not match the SNMP Community configured in the switch.
Telnet into the switch and modify the SNMP Community setting in the ToolboxST system
to match the SNMP Community configured for the switch.
34 GEI-100693E
For public disclosure
Note Some Allied Telesis switch models do not accept special characters such as the @
symbol, so these switches cannot use the standard GeS@lem9ro SNMP community name.
This is a common configuration error where all of the switches are configured with the
default community name, while certain switches are using a different community name.