Configuring an NOE with TFE Private MIB
Original instructions
Introduction
A MIB, a Management Information Base, is an element used in network management. Network management services are based on the need to monitor and manage:
Each MIB contains a finite number of objects. Manage your MIB with a management station running an SNMP management application. The management application uses GETs and SETs to retrieve system information and to set system environment variables.
Schneider Private MIB
Schneider Electric obtained a Private Enterprise Number (PEN) from the Internet Assigned Numbers Authority (IANA). That number represents a subtree in the SNMP MIB, a number that is a unique identifier used for Groupe Schneider.
The object identifier for the root of the Groupe Schneider subtree is 1.3.6.1.4.1.3833 and represents a path to the subtree as follows:
iso(1)
org(3)
dod(6)
internet(1)
private(4)
enterprise(1)
GroupeSchneider(3833)
Transparent_Factory_Ethernet(1)
Under the GroupeSchneider private MIB is a Transparent Factory Ethernet (TFE) private MIB, Transparent_Factory_Ethernet(1).
TFE Private MIB
The Transparent Factory SNMP-embedded component controls the Schneider private MIB function. The Schneider private MIB, and associated services, perform Network Management on all system components. The Transparent Factory private MIB provides the data to manage the main Transparent Factory communication services for all the communication components of the Transparent Factory architecture (ETYs, NOEs, third party toolkit, ENTs, M1Es). The Transparent Factory private MIB does not define the specific management applications and policies.
The diagram following illustrates the Schneider Electric (Groupe_Schneider (3833)) private enterprise MIB subtree.
The Groupe_Schneider (3833) subtree is the root of Groupe Schneider's private MIB in the Structure of Management Information (SMI) used by SNMP and defined in RFC-1155, which is a specification that defines the structure and identification of management information for TCP/IP-based networks.
Transparent Factory Ethernet Subtree
The Transparent_Factory_Ethernet (1) subtree defines groups that support the Transparent Factory Ethernet services and devices.
Service
Subtree Definition
Switch(1)
brand of switches labeled: ConneXium switches private MIB
Port502_Messaging(2)
objects for managing explicit client/server communications supporting applications, such as HMI, SCADA, or programming tools
I/O_Scanning(3)
objects for managing I/O device communications that use the I/O Scanner mechanism with the MB/TCP protocol
Global_Data(4)
objects for managing the application coordination service using a publish/subscribe protocol
Web(5)
objects for managing the activity of the embedded Web servers
Address_Server(6)
objects for managing the activity of the BOOTP and (or) DHCP servers
Equipment_Profiles(7)
objects for each type of device in Transparent Factory Ethernet's product portfolio
timeManagement(8)
objects for managing the UTC time stamp service
email(9)
objects for managing the mail service
Device subtrees, or groups, will be defined for the following devices:
As devices are added to Schneider's catalog, Schneider's private MIB will be extended in the following manner:
When a new device is created, a corresponding object description is created in the ASN.1 format. The ASN.1 file(s) are then given to producers of SNMP manager software for inclusion in their products.
Port502 Messaging Subtree
The Port502_Messaging (2) subtree, or group, provides connection management and data flow services. The following list describes the function of each object.
Service
Indicates . . .
port502Status(1)
status of the service (idle, operational)
port502SupportedProtocol(2)
supported protocols (MODBUS, Xway)
port502IpSecurity(3):
status of the Port502 IP Security service (enabled/disabled)
port502MaxConn(4)
maximum number of TCP connections supported by the Port502 entity
port502LocalConn(5)
TCP connection number currently opened by the local Port502 entity
port502RemConn(6)
TCP connection number currently opened by the remote entity to the local Port502 entity
port502IpSecurityTable(7)
a table containing the number of unsuccessful TCP connection open tries from a remote TCP entity
port502ConnTable(8)
a table containing Port502 TCP specific information (MsgIn, MsgOut)
port502MsgIn(9)
total number of Port502 messages received from the network
port502MsgOut(10)
total number of Port502 messages sent from the network
port502MsgOutErr(11)
total number of error messages built by the Port502 messaging entity and sent to the network
port502AddStackStat(12)
the support of additional port502 stack statistics:
  • 1 - disabled
  • 2 - enabled
port502AddStackStatTable(13)
additional stack statistics for Port502 (optional)
I/O Scanning Subtree
The I/O_Scanning (3) subtree, or group, contains the objects related to I/O scanning device management and associated MODBUS communications on Port502.
Service
Indicates . . .
ioScanStatus(1)
global status of the I/O scanning service:
  • 1 - idle
  • 2 - operational
  • 3 - stopped
ioScanMaxDevice(2)
maximum number of devices supported by the I/O scanning entity
ioScanPolledDevice(3)
number of devices currently polled by the I/O scanning entity
ioScanTransSend(4)
total number of transactions sent by the I/O scanning entity
ioScanGlbHealth(5)
global status of health for the I/O scanning service:
  • 2 - OK: Every remote I/O device is responding
  • 4- Warning: At least one remote I/O device is not responding
ioScanDeviceTable(6)
a table containing information on each remote devices polled by the I/O scanning entity
Global Data Subtree
The Global_Data (4) subtree, or group, contains the objects related to the Global Data service.
Service
Indicates . . .
glbDataStatus(1)
global status of the Global Data service:
  • 1 - idle
  • 2 - operational
  • 3 - stopped
glbDataMaxPub(2)
maximum number of published variables configured by the Global Data entity
glbDataMaxSub(3)
maximum number of subscribed variables configured by the Global Data entity
glbDataPub(4)
total number of publications sent to the network
glbDataSub(5)
total number of subscriptions received from the network
glbDataPubErr(6)
total number of publication errors detected by the local entity
glbDataSubErr(7)
total number of subscription errors detected by the local entity
glbDataGlbSubHealth(8)
global status of health for the Global Data subscribed variables:
  • 2 - OK: The health status of all subscribed variables is OK
  • 4 - Warning: At least one subscribed variable has a health fault
glbDataPubTable(9)
a table containing information on each published variable (the number of publications, the source IP address, the number of errors)
glbDataSubTable(10)
a table containing information on each subscribed variable (the number of subscriptions, the source IP address, the number of errors, Health)
Web Subtree
The Web (5) subtree, or group, contains the objects related to the Web server service.
Service
Indicates . . .
webStatus(1)
global status of the Web service:
  • 1 - idle
  • 2 - operational
webPassword (2)
switch to enable or disable the use of Web passwords:
  • 1 - disabled
  • 2 - enabled
webSuccessfullAccess (3)
total number of successful accesses to the Web site
webFailedAttempts (4)
total number of unsuccessful accesses to the Web site
Address Server Subtree
The Address_Server (6) subtree, or group, contains the objects related to the Address Server service. The Address Server can be either a BOOTP server or a DHCP server.
Service
Indicates . . .
addressServerStatus(1)
global status of the address server service:
  • 1 - idle
  • 2 - operational
Equipment Profile Subtree
The Equipment_Profiles (7) subtree contains a set of common objects.
Service
Indicates . . .
profileProductName(1)
the commercial name of the communication product in a string form (for example, 140 NOE 771 11)
profileVersion(2)
the software version of the communication product in a string form (for example, Vx.y or V1.1)
profileCommunicationServices(3)
the communication services supported by the profile (Port502Messaging, I/O scanning Messaging, Global Data, Web, and Address Server)
profileGlobalStatus(4)
the global status of the communication module:
  • 1 - NOK
  • 2 - OK
profileConfigMode(5)
the IP configuration mode of the communication module:
  • 1 - Local: The IP configuration is created locally
  • 2 - dhcpServed: The IP configuration is created by a remote DHCP server
profileRoleName(6)
rthe ole name for the IP address management if it exists (empty string if there is none)
profileBandwidthMgt(7)
the status of Bandwidth Management:
  • 1 - disabled
  • 2 - enabled
profileBandwidthDistTable(8)
the CPU time distribution between Global Data, Port502 Messaging, I/O scanning
profileLedDisplayTable(9)
a table giving the name and the state of each module’s LEDs
profileSlot(10)
the position of the communication module inside the rack if there is one. If there is no rack, the profileSlot value will be zero
profileCPUType(11)
the host for which that communication module is a part when a CPU type exists (if there is no host, the string is empty)
profileTrapTableEntriesMax(12)
the maximum numbers of entries in the Trap Table (equal to the number of possible remote managers)
profileTrapTable(13)
a table allowing you to enable or disable the private traps for each of the communication services
profileSpecificId(14)
a unique Profile Specific Identification inside the equipmentProfile object of the Schneider Transparent Factory MIB (for example, the PLC Premium family is 100)
profileIpAddress(15)
the IP address of the SNMP agent
profileIpNetMask(16)
the subnet mask associated with the IP address of the SNMP agent (the value of the mask is an IP address with all the network bits set to 1 and all the host bits set to 0)
profileIpGateway(17)
the default Gateway IP address of the SNMP agent
profileMacAddress(18)
the Ethernet media-dependent address of the SNMP agent
NTP Subtree
The NTP (1) subtree contains a set of common objects.
Service
Indicates . . .
ntpStatus(1)
the status of NTP service (not server):
  1. 1 = Idle
    no configuration
  2. 2 = Operational
ntpSrvAddr(2)
the IP address of NTP server in dot notation format
ntpLnkSrvStatus(3)
the status of link between module and NTP server:
  1. 1 = NOK (module can not reach NTP server)
  2. 2 = OK
ntpReqCnt(4)
the number of requests sent to NTP server
ntpRespCnt(5)
the number of responses received from NTP server
ntpErrCnt(6)
the total number of communication errors
ntpDate(7)
date of the day
ntpTime(8)
time of the day
ntpTimeZone(9)
current time zone
ntpDSTStatus(10)
Daylight Savings Time status:
  1. 1 = ON (Daylight Savings Time)
  2. 2 = OFF (Standard Time)
ntpLastErr(11)
Last error code generated by system
SMTP Subtree
The SMTP (1) subtree contains a set of common objects.
Service
Indicates . . .
emailIndex(1)
the index value in the email service table
smtpStatus(2)
the status of SMTP service (not server):
  • 1 = Idle (no configuration)
  • 2 = operational
smtpSrvAddr(3)
the IP address of SMTP server in dot notation format
smtpMailSentCnt(4)
the total number of emails sent to the network and successfully acknowledged by the server
smtpErrCnt(5)
the total number of email messages that could not be sent to the network or that have been sent but not acknowledged by the server
smtpLastErr(6)
the error code of the last error that occurred while trying to send an email message to the network
smtpLastMailElapsedTime(7)
the number of elapsed seconds since last successful email was sent to the server
smtpLnkSrvStatus(8)
the status of link with SMTP server:
  1. 1 = NOK (not OK), link is down; module failed to contact SMTP server
  2. 2 = OK
smtpSrvChkFailCnt(9)
the number of times the link to SMTP server is detected as ‘down.’
See the Electronic Mail Notification Service subtree table.
NOTE: A diagram of the Schneider Electric private enterprise MIB subtree appears in Simple Network Management Service (SNMP).
Private Traps and MIB Files
Traps are used to signal status changes to the manager. Using traps helps to avoid adding traffic.
The status changes signaled by the trap are for the:
The following list describes the characteristics of private traps, which means that they can:
Private traps are described in the MIB ASN.1 description, which is contained in a .mib text file.
NTP Traps
  1. DST Change Trap: notifies the manager that the NTP server time has changed either from (a) standard time to daylight saving time or (b) daylight saving time to standard time
  2. NTP Status Change Trap: sent when the NTP component status changes (ntpStatus(1))
  3. Leap Second Trap: sent when leap seconds are inserted
SMTP Traps
  1. SMTP Status Change Trap: sent when SMTPStatus changes
  2. SMTP Link to Server Status Change: sent when tSMTPLnkSrvStatus changes. Trap is sent when service tries to send an email. Every 30 minutes a periodic test checks the connection to the SMTP server.