TP5000 - SNMP - UG - 098 00385 000 Rev A

TimeProvider 5000 SNMP Agent
User’s Guide
Revision A –September, 2011
Part Number 098-00385-000
Symmetricom, Inc.
2300 Orchard Parkway
San Jose, CA 95131-1017
U.S.A.
http://www.symmetricom.com
Copyright © 2011 Symmetricom, Inc.

All rights reserved. Printed in U.S.A.
All product names, service marks, trademarks, and registered trademarks

used in this document are the property of their respective owners.
Table of Contents
Purpose of This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Structure of This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Conventions Used in This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Warnings, Cautions, Recommendations, and Notes . . . . . . . . . . . . . . . . . . . .12
Related Documents and Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Where to Find Answers to Product and Document Questions . . . . . . . . . . . . .14
What’s New In This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
User’s Guide Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Chapter 1 Overview
SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Components of SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
SNMP Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
SNMP Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
SNMP Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
SNMP Get. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
SNMP Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
SNMP Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
MIBs and RFCs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
Public MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Private MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Supported Versions of SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Chapter 2 Public MIB Details for TP 5000

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
Hardware Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Entity Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Interface Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Public MIBs For TP 5000 SNMP Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
IF MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
IP MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
ICMP MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Entity MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
098-00385-000 Revision A –Draft 2 - September, 2011 TimeProvider 5000 SNMP Agent User’s Guide 3
Table of Contents
Chapter 3 symmCommonModelV1 MIB Description

Set and Retrieve PTP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Retrieve PTP Status (ptpv2Status) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
Set PTP Parameters (ptpv2Config) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
Set and Retrieve NTP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
ituPtpv2 Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Set and Retrieve Parameters for Physical Signals . . . . . . . . . . . . . . . . . . . . . .61
Set and Retrieve GNSS Port Parameters. . . . . . . . . . . . . . . . . . . . . . . . .62
symmE1T1 MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Set and Retrieve PPS-TOD Port Parameters . . . . . . . . . . . . . . . . . . . . . .75
Set and Retrieve 10 MHz Port Parameters. . . . . . . . . . . . . . . . . . . . . . . .77
Set and Retrieve 1PPS Port Parameters . . . . . . . . . . . . . . . . . . . . . . . . .78
Set and Retrieve Output Generation Parameters (symmOutGen) . . . . . .79
Set and Retrieve DTI Port Parameters (symmDTI) . . . . . . . . . . . . . . . . .81
Set and Retrieve SyncE Output Port Parameters (symmSyncE) . . . . . . .82
Set and Retrieve Clock Parameters (symmClock) . . . . . . . . . . . . . . . . . . . . . .85
Set and Retrieve Date and Time (symmDateAndTime) . . . . . . . . . . . . . .85
Set and Retrieve Network Parameters (symmNetwork) . . . . . . . . . . . . . . . . . .88
Set and Retrieve Ethernet Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . .88
Physical Entity Extension MIB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
Interface Extentsion MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Device Dependent MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
Chapter 4 TP5000e MIB Description

Retrieve System Status Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106
Retrieve LED Status Information (tp5000eLedTable) . . . . . . . . . . . . . . .107
Retrieve Hardware Status Information (tp5000eHWStatusTable) . . . . .108
Retrieve Module Up Time Information (tp5000eModUpTimeTalbe) . . . .110
Retrieve Module Warm-up Status Info (tp5000eModWarmUpTable) . . .111
Retrieve Module Operating Status Info (tp5000eModStatusTable) . . . .112
Retrieve Alarm and Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
Retrieve List of Active Alarms (tp5000eActAlarmTable) . . . . . . . . . . . . .115
Retrieve List of Active Events (tp5000eActEventTable) . . . . . . . . . . . . .116
Retrieve Alarm Configuration Information. . . . . . . . . . . . . . . . . . . . . . . .117
4 TimeProvider 5000 SNMP Agent User’s Guide 098-00385-000 Revision A –Draft 2 - September, 2011
Table of Contents
Retrieve Global Configuration Information . . . . . . . . . . . . . . . . . . . . . . . . . . .118

Retrieve Log File Info (tp5000eLogFileConfigTable) . . . . . . . . . . . . . . .120
Retrieve Remote Syslog Info (tp5000eRemoteSyslogTable) . . . . . . . . .121
Retrieve Redundancy Info for IOC Modules (tp5000eRedundTable) . . .122
Retrieve Firmware Image Information (tp5000eImageTable) . . . . . . . . .123
Reboot a Specified Module (tp5000eRebootTable) . . . . . . . . . . . . . . . .124
Retrieve Radius Auth. Server Info (tp5000eAuthRADIUSTable) . . . . . .124
Retrieve Packet Service Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Retrieve Packet Service Infor on IOC (tp5000ePacketServiceTable). . .126
Retrieve SSM Network Selection Info (tp5000eSSMOptionTable) . . . . .127
Retrieve Reference Selection Status Information . . . . . . . . . . . . . . . . . . . . . .128
Retrieve Reference Input Status Info (tp5000eInputPQLEntry) . . . . . . .128
Retrieve Reference Selection Configuration Information . . . . . . . . . . . . . . . .129
Retrieve Reference Configuration Info (tp5000eRefConfigTable) . . . . .130
Retrieve Clock Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
Retrieve Clock Status Information (tp5000eClockStatus). . . . . . . . . . . .132
Retrieve Clock Configuration Information (tp5000eClockConfig) . . . . . .133
Retrieve Hardware Hierarchy Information. . . . . . . . . . . . . . . . . . . . . . . . . . . .134
Retrieve Physical Hierarchy Information - Individual -level
(tp5000elfTable) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135
Retrieve Physical Hierarchy Information - Module-level
(tp5000eEntPhysicalEntryTable) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
Retrieve VLAN Configuration Information . . . . . . . . . . . . . . . . . . . . . . . . . . . .138
Retrieve Non-fixed VLAN Info (tp5000eVlanNonfixedVlanTable). . . . . .138
Retrieve Fixed VLAN Information (tp5000eVlanFixedVlanTable). . . . . .143
Retrieve VLAN Mode Information (tp5000eVlanModeTable) . . . . . . . . .145
Retrieve Alarm Notification Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
Retrieve Definitions in the Traps (tp5000eNotifyModuleID) . . . . . . . . . .147
Chapter 5 TP5000 MIB Description

Retrieving PTP Client Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
Retrieve PTP Client Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
Retrieve IOC Node PTP Client Status . . . . . . . . . . . . . . . . . . . . . . . . . .152
Retrieve IOC Client Clock Descriptions . . . . . . . . . . . . . . . . . . . . . . . . .154
Retrieve IOC PTP Client Null Management Info. . . . . . . . . . . . . . . . . . .155
Retrieve Acceptable Master Info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
Managing PTP Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
Configure Acceptable Master Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
Upgrade Client Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
Reboot Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
Table of Contents
Administering SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161

Manage SNMP Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163
Set SNMP Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165
Manage SNMP Trap Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167
Manage SNMPv2 Community Table. . . . . . . . . . . . . . . . . . . . . . . . . . . .169
Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171
Tables
1-1 SNMP Security Models and Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
2-1 Hardware Hierarchy for TP 5000 System . . . . . . . . . . . . . . . . . . . . . . . . . .25
2-2 Parameters for Entity Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
2-3 ifTable Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
2-4 IP MIB Scalars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
2-5 ipAddrTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
2-6 ipRouteTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
2-7 ipNetToMediaTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
2-8 icmp MIB Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
2-9 Entity MIB Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
2-10 entityMIBObjects Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
2-11 entPhysicalTable Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
2-12 entLogicalTable Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
2-13 entLogicalTable Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
2-14 entAliasMappingTablle Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
2-15 entPhysicalContainsTable Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
2-16 entGeneral Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
2-17 entMIBTraps Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
3-1 symmCommonModelV1 MIB Descriptions . . . . . . . . . . . . . . . . . . . . . . . . .43
3-2 symmPacketService Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
3-3 symmPtpv2 Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
3-4 ptpv2Status MIB Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
3-5 ptpv2StatusTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
3-6 ptpv2ClientDataTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
3-7 ptpv2Config MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
3-8 ptpv2CommonTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
3-9 ptpv2UnicastTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
3-10 ptpv2MulticastTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
3-11 symmNTP MIB Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
3-12 ntpStatus Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
3-13 ntpConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
3-14 symmPhysicalSignal Ojbect Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
3-15 symmGNSS Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
3-16 gnssStatus Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
3-17 gnssPortStatusTable Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
3-18 gnssSatTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
3-19 gnssPresentPosEntry Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
3-20 gnssConfig MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
3-21 gnssConfigurationTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
3-22 gnssPosSettingTable MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
3-23 gnssPosSettingEntry Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
List of Tables
3-24 symmE1T1 MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68

3-25 e1T1Input MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
3-26 e1T1InputStatus Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
3-27 e1T1InputConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
3-28 e1T1Output Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
3-29 e1T1OutputStatus MIB Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
3-30 e1T1OutputConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
3-31 symmPPSTOD MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
3-32 ppstodInput Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
3-33 ppstodInputConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
3-34 ppstodOutput MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
3-35 symmCommon10M Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77
3-36 symmPPS Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
3-37 symmOutGen Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
3-38 outGenConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
3-39 symmDTI Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81
3-40 symmSyncE Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
3-41 syncEStatus Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
3-42 syncEConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84
3-43 symmClock MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
3-44 symmDateAndTime Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
3-45 dateAndTimeStatus Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86
3-46 symmDateAndTimeTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . .86
3-47 dateAndTimeConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87
3-48 symmNetwork Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88
3-49 symmCommonNetwork Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . .88
3-50 networkEthStatus Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89
3-51 networkEthConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90
3-52 networkIPConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91
3-53 networkIPv4ConfigTable Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . .91
3-54 networkIPv4StaticRouteTable Object Details . . . . . . . . . . . . . . . . . . . . . . .94
3-55 networkFirewallTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
3-56 symmEntPhysicalExtension Object Details . . . . . . . . . . . . . . . . . . . . . . . . .97
3-57 symmEntityPhysicalExt Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
3-58 (entPhysicalExtTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
3-59 symmInterfaceExtension Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . .99
3-60 interfaceExtTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
3-61 symmDeviceDeptendent Object Details . . . . . . . . . . . . . . . . . . . . . . . . . .101
4-1 tp5000e MIB Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
4-2 tp5000eSystemStatus Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106
4-3 tp5000eLedTable Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
4-4 tp5000eHWStatusTable Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108
4-5 tp5000eModUpTimeTable Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . 110
List of Tables
4-6 tp5000eModWarmUpTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . 111

4-7 tp5000eModStatusTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
4-8 tp5000eAlarmAndEvent Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
4-9 tp5000eActAlarmTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
4-10 tp5000eActEventTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
4-11 tp5000eAlarmConfigTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . 117
4-12 tp5000eGlobalConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
4-13 tp5000eLogFileConfigTable Object Details . . . . . . . . . . . . . . . . . . . . . . . .120
4-14 tp5000eRemoteSyslogTable Object Details. . . . . . . . . . . . . . . . . . . . . . . .121
4-15 tp5000eRedundTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122
4-16 tp5000eImageTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123
4-17 tp5000eRebootTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
4-18 tp5000eAuthRADIUSTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . .124
4-19 tp5000eGlobalService Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
4-20 tp5000ePacketServiceTable Object Details . . . . . . . . . . . . . . . . . . . . . . . .126
4-21 tp5000eSSMOptionTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . .127
4-22 tp5000eReferenceStatus Object Details . . . . . . . . . . . . . . . . . . . . . . . . . .128
4-23 tp5000eInputPQLTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . .128
4-24 tp5000eRefConfig Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
4-25 tp5000eRefConfigTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . .130
4-26 tp5000eClock Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
4-27 tp5000eClockStatus Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132
4-28 tp5000eClockConfig Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133
4-29 tp5000eHardwareHierarchy Object Details . . . . . . . . . . . . . . . . . . . . . . . .134
4-30 tp5000eIfTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135
4-31 tp5000eEntPhysicalTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . .136
4-32 tp5000eVlanConfiguration Object Details . . . . . . . . . . . . . . . . . . . . . . . . .138
4-33 tp5000eNonfixedVlanTable Object Details. . . . . . . . . . . . . . . . . . . . . . . . .138
4-34 tp5000eFixedVlanTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . .143
4-35 tp5000eVlanModeTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . .145
4-36 tp5000eAlarmNofication Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . .146
4-37 tp5000eNotifyElements Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . .147
5-1 tp5000 MIB Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
5-2 ptpClientManagement Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
5-3 ptpNodeInfo Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
5-4 ptpNodeTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
5-5 ioc11NodeStatusTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
5-6 ioc11NodeStatusTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
5-7 ioc11NodeClockDescTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . .154
5-8 ioc12NodeClockDescTable Object Details. . . . . . . . . . . . . . . . . . . . . . . . .154
5-9 ioc11NodeNullMgmtTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . .155
5-10 ioc12NodeNullMgmtTable Object Details. . . . . . . . . . . . . . . . . . . . . . . . . .155
5-11 accMasterTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
List of Tables
5-12 ptpNodeControl Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157

5-13 accMasterSetupTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
5-14 upgradeClientFirmwareTable Object Details . . . . . . . . . . . . . . . . . . . . . . .159
5-15 rebootClientTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
5-16 accMasterEntry Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161
5-17 snmpUserTable Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163
5-18 snmpUserTable Object Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165
5-19 trapUserTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167
5-20 snmpv2CommunityTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . .169
5-21 rebootClientEntry Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171
How to Use This Guide
This section describes the format, layout, and purpose of this guide.
In This Preface
 Purpose of This Guide
 Structure of This Guide
 Conventions Used in This Guide
Purpose of This Guide
The TP 5000 SNMP Agent User Guide provides information about Symmetricom’s
TP 5000 SNMP Agent. The information contained in this user guide includes the TP
5000 SNMP Agent’s features, functionality, setup and object descriptions.
Structure of This Guide
This user guide contains the following chapters and appendixes:
Chapter, Title Description
Chapter 1, Overview Provides an overview of the TP 5000 SNMP

agent.
Chapter 2, Setting Up TP 5000 SNMP Agent Contains information about setting up the TP
5000 SNMP Agent
Chapter 2, Public MIB Details for TP 5000 Contains information about the Public MIBs
used with the TP 5000
Chapter 3, symmCommonModelV1 MIB Describes the details of the MIB modules in
Description the symmetricomCommonModelV1 MIB
Chapter 4, TP5000e MIB Description Describes the details of the tp5000e MIB
Chapter 5, TP5000 MIB Description Describes the details of the tp5000 MIB
Conventions Used in This Guide
This guide uses the following conventions:
 Acronyms and Abbreviations – Terms are spelled out the first time they appear
in text. Thereafter, only the acronym or abbreviation is used.
Warnings, Cautions, Recommendations, and Notes
 Revision Control – The title page lists the printing date and versions of the
product this guide describes.
 Typographical Conventions – This guide uses the typographical conventions
described in the table below.
When text appears

... it means:
this way...
Symmetricom Product Document The title of a document.
CRITICAL An operating mode, alarm state, status, or chassis

label.
Select File, Open... Click the Open option on the File menu.
Press Enter A named keyboard key.

Press; The key name is shown as it appears on the
keyboard. An explanation of the key’s acronym or
function immediately follows the first reference to
the key, if required.
Username: Text in a source file or a system prompt or other text

that appears on a screen.
ping A command you enter at a system prompt or text

status you enter in response to a program prompt. You
must enter commands for case-sensitive operating
systems exactly as shown.
qualified personnel A word or term being emphasized.
Symmetricom does not A word or term given special emphasis.

recommend...
Warnings, Cautions, Recommendations, and Notes
Warnings, Cautions, Recommendations, and Notes attract attention to essential or

critical information in this guide. The types of information included in each are
explained in the following examples.
Warning: To avoid serious personal injury or death, do not disregard

warnings. All warnings use this symbol. Warnings are installation,
operation, or maintenance procedures, practices, or statements, that
if not strictly observed, may result in serious personal injury or even
death.
Related Documents and Information
Caution: To avoid personal injury, do not disregard cautions. All

cautions use this symbol. Cautions are installation, operation, or
maintenance procedures, practices, conditions, or statements, that if
not strictly observed, may result in damage to, or destruction of, the
equipment. Cautions are also used to indicate a long-term health
hazard.
ESD Caution: To avoid personal injury and electrostatic discharge

(ESD) damage to equipment, do not disregard ESD cautions. All ESD
cautions use this symbol. ESD cautions are installation, operation, or
maintenance procedures, practices, conditions, or statements that if
not strictly observed, may result in possible personal injury,
electrostatic discharge damage to, or destruction of, static-sensitive
components of the equipment.
Electrical Shock Caution: To avoid electrical shock and possible

personal injury, do not disregard electrical shock cautions. All
electrical shock cautions use this symbol. Electrical shock cautions
are practices, procedures, or statements, that if not strictly observed,
may result in possible personal injury, electrical shock damage to, or
destruction of components of the equipment.
Recommendation: All recommendations use this symbol.

Recommendations indicate manufacturer-tested methods or known
functionality. Recommendations contain installation, operation, or
maintenance procedures, practices, conditions, or statements, that
provide important information for optimum performance results.
Note: All notes use this symbol. Notes contain installation, operation,
or maintenance procedures, practices, conditions, or statements, that
alert you to important information, which may make your task easier
or increase your understanding.
Related Documents and Information
See your Symmetricom representative or sales office for a complete list of available
documentation.
Where to Find Answers to Product and Document Questions
Where to Find Answers to Product and Document

Questions
For additional information about the products described in this guide, please contact
your Symmetricom representative or your local sales office. You can also contact us
on the web at www.symmetricom.com.
What’s New In This Guide
This is the first release of the TP 5000 SNMP Agent User’s Guide.
User’s Guide Updates
When this manual is updated the updated version will be available for downloading
from Symmetricom’s Web site. After downloading, you can view the manual on a
computer or print it using Adobe Acrobat Reader.
Manual updates are available by logging in to Telecom Solutions Support at:

http://www.symmetricom.com/support/online-support//
Note: If you are downloading a manual for the first time, you will need
to register with Symmetricom. If you are currently registered, login
and download the manual update.
Chapter 1 Overview
This chapter provides introductory information about .
In This Chapter
 Components of SNMP
 SNMP Operations
 MIBs and RFCs
 Supported Versions of SNMP
SNMP
Simple Network Management Protocol (SNMP) is an application-layer protocol that

provides a message format for communication between SNMP managers and
agents. SNMP provides a standardized framework and a common language that is
used for monitoring and managing devices in a network.
Components of SNMP
The SNMP framework is made up of three parts:
 SNMP Manager
 SNMP Agent
 MIB
SNMP Manager
The SNMP manager is a system that controls and monitors the activities of network
hosts using SNMP. The most common managing system is a network managment
system (NMS). The term NMS can be applied either to a dedicated device used for
network management or to the applications used on such a device.
SNMP Agent
The SNMP agent is the software component within a managed device that
maintains the data for the device and reports this data, as needed, to managing
systems. The agent resides on the TP 5000 main shelf. The relationship between
the manager and the agent must be defined to enable the SNMP agent.
Chapter 1 Overview
SNMP Operations
MIB
A MIB is a virtual information storage area for network management information and
consists of collections of managed objects. Within a MIB are collections of related
objects defined in MIB modules. MIB modules are written in the SNMP MIB module
language, as defined in STD 58, RFC 2578, RFC 2579, and RFC 2580 (see the
“MIBs and RFCs” section for an explanation of RFC and STD documents).
Individual MIB modules are also referred to as MIBs; for example, the Interfaces
Group MIB (IF-MIB) is a MIB module within the MIB on your system.
An SNMP agent contains MIB variables whose values the SNMP manager can
request or change through Get or Set operations. A manager can get a value from
an agent or store a value in that agent. The agent gathers data from the MIB, the
repository for information about device parameters and network data. The agent
can also respond to manager requests to get or set data.
An SNMP manager and sends an agent requests to get and set MIB values. The
agent responds to these requests. The agent can also send the manager
unsolicited notifications (traps or informs), independent of this interaction, to notify
the manager about network conditions.
SNMP Operations
SNMP applications perform the following operations to retrieve data, modify SNMP
object variables, and send notifications:
 Get
 Set
 Send notifications
SNMP Get
The SNMP get operation is performed by an NMS to retrieve SNMP object
variables. There are two types of get operations:
1. get — Retrieves the exact object instance from the SNMP agent.
2. getNext — Retrieves the next object variable, which is a lexicographical

successor to the specified variable.
SNMP Set
The SNMP set operation is performed by an NMS to modify the value of an object
variable.
Chapter 1 Overview
MIBs and RFCs
SNMP Notifications
A key feature of SNMP is its capability to generate unsolicited notifications from an
SNMP agent. Unsolicited (asynchronous) notifications can be generated as traps or
inform requests (informs). Traps are messages alerting the SNMP manager to a
condition on the network. Informs are traps that include a request for confirmation of
receipt from the SNMP manager. Notifications can indicate improper user
authentication, restarts, the closing of a connection, loss of connection to a neighbor
router, or other significant events.
Traps are less reliable than informs because the receiver does not send an
acknowledgment when it receives a trap. The sender does not know if the trap was
received. An SNMP manager that receives an inform acknowledges the message
with an SNMP response protocol data unit (PDU). If the sender never receives a
response, the inform can be sent again. Informs are therefore more likely to reach
their intended destination.
Traps are often preferred even though they are less reliable because informs
consume more resources in the router and in the network. Unlike a trap, which is
discarded as soon as it is sent, an inform must be held in memory until a response
is received or the request times out. Also, traps are sent only once, whereas an
inform may be resent several times. The retries increase traffic and contribute to
higher overhead on the network. Use of traps and informs requires a trade-off
between reliability and resources. If it is important that the SNMP manager receives
every notification, use informs, but if traffic volume or memory usage are concerns
and receipt of every notification is not required, use traps.
MIBs and RFCs
MIB modules typically are defined in Request For Comment (RFC) documents
submitted to the Internet Engineering Task Force (IETF), an international standards
body. RFCs are written by individuals or groups for consideration by the Internet
Society and the Internet community as a whole, usually with the intention of
establishing a recommended Internet standard. Before being given RFC status,
recommendations are published as Internet Draft (I-D) documents. RFCs that have
become recommended standards are also labeled as standards (STD) documents.
You can learn about the standards process and the activities of the IETF at the
Internet Society website at http://www.isoc.org. You can read the full text of all
RFCs, I-Ds, and STDs referenced in this document at the IETF website at
http://www.ietf.org.
The entire MIB structure used for the TP 5000 SNMP agent is composed of the
existing tp5000 MIB (with two new tables), and the new MIB structure. The new
structure consists of several public MIBs, the symmCommon MIBs, the tp5000e
MIB, and the framework which ties all of them together. Figure 1-2 shows a
functional representation of the MIB structure for the TP 5000 SNMP agent.
Chapter 1 Overview
MIBs and RFCs
Public MIBs
The Symmetricom implementation of SNMP uses the definitions of MIB II variables
described in RFC 1213 and definitions of SNMP traps described in RFC 1215.
Symmetricom provides its own private MIB extensions with every system that is
licensed for the SNMP option. Symmetricom private MIBs comply with the
guidelines described in the relevant RFCs unless otherwise noted in the
documentation.
Figure 1-1 shows the Public MIBs used with the TP 5000 SNMP agent. See Public
MIBs For TP 5000 SNMP Agent, on page 30 for the functions and details of these
objects.
Figure 1-1. Hierarchy of Public MIBs for Used With TimeProvider 5000
Private MIBs
symmCommonModelV1
The new Private MIB, symmCommonModelv1 Private MIB and its MIB modules, is
rooted in the Symmetricom directory. Figure 1-2 shows the top level objects for the
symmCommonModelV1 Private MIB module. See Table 3-1 for the functions and
details of these objects.
TP 5000e MIB
The tp5000e MIB module is part of the symmCommonModelV1 MIB, but it is
described in its own separate chapter. See TP5000e MIB Description, on page 103.
Figure 1-3 shows the top level hierarchy for the tp5000e MIB.
Chapter 1 Overview
MIBs and RFCs
TP 5000 MIB
The original MIB for the TP5000, tp5000, is kept to maintain full backward
compatibility with TP5000 release v1.2. Most of the functions in the tp5000 MIB are
already duplicated in the new private MIB modules. The tp5000 MIB is only used for
a few remaining functions: alarm management, PTP client management, and SNMP
administration. The tp5000 MIB will be deprecated when these remaining functions
are implemented in the new MIBs. See TP5000 MIB Description, on page 149 for
details.
Figure 1-2. Hierarchy of Symmetricom Private MIBs for TimeProvider 5000
Chapter 1 Overview
Supported Versions of SNMP
Figure 1-3. Top Level Hierarchy of tp5000e Private MIB
The TP 5000 device firmware supports the following versions of SNMP:
 SNMPv2c — The community string-based Administrative Framework for

SNMPv2. SNMPv2c (the “c” is for “community”) is an experimental Internet
protocol defined in RFC 1901, RFC 1905, and RFC 1906. SNMPv2c is an update
of the protocol operations and data types of SNMPv2p (SNMPv2 Classic) and
uses the community-based security model of SNMPv1.
 SNMPv3 — Version 3 of SNMP, this is an interoperable standards-based
protocol defined in RFCs 3413 to 3415. SNMPv3 provides secure access to
devices by authenticating and encrypting packets over the network.
The security features provided in SNMPv3 are as follows:

– Message integrity—Ensuring that a packet has not been tampered with in transit.
– Authentication—Determining that the message is from a valid source.
– Encryption—Scrambling the contents of a packet to prevent it from being learned
by an unauthorized source.
SNMPv2c uses a community-based form of security. The community of SNMP

managers able to access the agent MIB is defined by a community string.
Chapter 1 Overview
SNMPv2c support includes a detailed error message reporting to management

stations. The SNMPv2c improved error handling support includes expanded error
codes that distinguish different types of errors. The following three types of
exceptions are also reported: no such object, no such instance, and end of MIB
view.
SNMPv3 is a security model in which an authentication strategy is set up for a user
and the group in which the user resides. A security level is the permitted level of
security within a security model. A combination of a security model and a security
level determines which security mechanism is employed when handling an SNMP
packet.
Two security models are available: SNMPv2c and SNMPv3. Table 1 lists the
combinations of security models and levels and their meanings.
Table 1-1. SNMP Security Models and Levels
Model Level Authentication Encryption Description
v2 noAuthNoPriv Community string No Uses a community string

match for authentication.
v3 noAuthNoPriv Username No Uses a username match for

authentication.
v3 authNoPriv Message Digest 5 No Provides authentication based

(MD5) or Secure on the HMAC-MD5 or
Hash Algorithm HMAC-SHA algorithms.
(SHA)
v3 authPriv MD5 or SHA Data Encryption Provides authentication based

Standard (DES) on the HMAC-MD5 or
or HMAC-SHA algorithms.
Advanced Provides DES 56-bit
Encryption encryption in addition to
System (AES) authentication based on the
CBC-DES (DES-56) standard.
Or provides AES 128-bit,
192-bit, 256-bit encryption.
You must configure an SNMP agent to use the version of SNMP supported by the
management station. An agent can communicate with multiple managers, however,
so you can configure the agentsoftware to support communications with one
management station using the SNMPv1 protocol, one using the SNMPv2c protocol,
and another using SMNPv3.
SNMPv3 supports RFCs 1901 to 1908, 2104, 2206, 2213, 2214, and 2271 to 2275.
For additional information about SNMPv3, see RFC 2570, Introduction to Version 3
of the Internet-standard Network Management Framework (this is not a standards
document).
Chapter 1 Overview
This chapter describes the data types used with the public and Private MIBs for the
TP 5000.
In This Chapter
 Overview
 Hardware Hierarchy
 Entity Table
 Interface Table
 Public MIBs For TP 5000 SNMP Agent
Overview
A Network Management System (NMS) accesses the TP 5000 system configuration

and status parameters through two public MIBs: the Entity MIB and the Interface
MIB. The Entity MIB provides a way for the NMS to know about the physical
makeup of the system. The Interface MIB allows the NMS to locate the parameters
for any port, physical or virtual, in the system.
The system external interfaces are also accessed through public MIBs. These
external interfaces include:
 Physical structure of the system.

 Physical ports and network interfaces
 IP addresses
 Some Ethernet port statistics
Figure 2-1 shows the public MIB used with the TP 5000 SNMP agent.
Hardware Hierarchy
Figure 2-1. Publlic MIBs Used In TP 5000
Hardware Hierarchy
The TP 5000 is a system that, at minimum, consists of a main shelf with several
types of modules. Each of the three module types, IMC, IOC, I/O, has several
variations. The TP 5000 system can also include up to 10 expansion shelves, either
E1 or Ethernet.
The TP 5000 system uses a single SNMP agent to support the multiple modules
and chasses. The TP 5000 is effectively the “overall” physical entity which houses
separate entities (chasses, modules, and ports). It is necessary to define the
relationships of the entities within the overall TP 5000 system.The SNMP agent
must be able to manage the multiple entities (physical and logical) within the single
physcial entity.
Figure 2-2 shows the hierarchy of the hardware within a TP 5000 system.
Table 2-1 describes the hierarchy of the of the hardware within a TP 5000 system
Hardware Hierarchy
Figure 2-2. Diagram of TP 5000 Hardware Hierarchy
Table 2-1. Hardware Hierarchy for TP 5000 System
Item Description Details
Stack The whole system consisting The stack is a main shelf and any expansion
of one or more chasses. shelves.
A stack can have up to 10 expansion shelves.

Chassis A shelf, piece of equipment. A main shelf or an expansion shelf.
A chassis has one or more modules

Module A module or plug-in card in The main shelf has four modules:
a chassis. IMC, IOC1, IOC2, and I/O.
An expansion shelf has only one module:

either an E1/1PPS+TOD expansion module
or an Ethernet expansion module.
A module can have zero or more physical

ports (interfaces).
Port A physical connector Some physical ports only have one interface;
such as the physical signals GNSS, 10 MHz,
or 1PPS+TOD
Some ports have multiple interfaces. An IOC

or Ethernet port can have a physical interface
(SyncE) and multiple virtual interfaces (IP
and VLAN)
Entity Table
Entity Table
The entity table includes details about the entities (chasses and modules) in a TP
5000 system. Information about an entity is available only if that entity is defined in
the entity table. The entity table accommodates the maximum size of a TP 5000
system. Removing an entity, such as the IOC2 module from the main shelf, does not
change the index value for this table. Figure 2-3 shows the organization of the table
of entities.
An entity index value represents a specific physical entity in the table. An entity
index value is characterized by the parameters of Stack ID, Chassis ID, Module ID
and part number index. However, the TP5000 SNMP agent uses the assumption
that an NMS can identify a TP5000 system with the IP address of the system
management port, or other unique parameter, so the stack ID is not used. The Stack
ID value is always 0. Table 2-2 describes these parameters.
Note: A number of the product's SNMP tables use the

entPhysicalIndex as an index.
Figure 2-3. Organization of Table of Entitiies
Entity Table
Table 2-2. Parameters for Entity Table
Parameter Description
Stack ID Stack ID typically identifies the system to a Network Management System
(NMS). TP5000 SNMP uses the assumption that an NMS can identify a TP5000
system with the IP address of the system management port, or other unique
parameter, so the stack ID is not used. The Stack ID value is always 0.
Chassis ID The Chassis ID identifies the specific chassis in the stack.
Range = 1 to 11
Main shelf = 1, Expansion 0 = 2, Expansion 1 = 3, Expansion 2 = 4
Expansion 3 = 5, Expansion 4 = 6, Expansion 5 = 7, Expansion 6 = 8
Expansion 7 = 9, Expansion 8 = 10, Expansion 9 = 11
Module ID The Module ID identifies the specific module in a chassis.
Main Shelf: Expansion Shelf:
Range = 2 to 5 Range = 6 to 15
IMC = 2, IOC1 = 3, IOC2 = 4, I/O = 5 Exp0=6 - Exp9=15
Part Number This is an index that maps to the part number of the module.
Index
Module type and part number together uniquely identifies available physical
ports for that module. For IMC there are currently 4 P/N index values. For IOC
there are 2. For I/O there are 4. For expansion shelves there are 2, one for
Ethernet module and one for E1 module.
See Figure 2-4 and Figure 2-5 and for an example of an entityTable for the TP5000.
Figure 2-4. Example of EntityTable for TP5000 System (Partial - 1 of 2)
Interface Table
Figure 2-5. Example of EntityTable for TP5000 System (Partial 2 of 2)
Interface Table
The Interface Table is a mapping between the ifTable in the Public MIBs and
individual interfaces (physical and virtual) in the system.The Interface Table is
dynamic; it changes with the removal or addition of a module in the system. If a
main shelf module or an expansion shelf is removed or added, the Interface Table
will update accordingly. Figure 2-3 shows the organization of the interface table.
The parameter that allows an NMS to locate a port/interface is called the Interface
Index (ifIndex). The interface index is for the external user. Ports/interfaces that are
not meant for external use are not assigned an interface index. The expansion
connector on the IMC module, for example, is considered an internal interface and
is not assigned an interface index.
The ifIndex is used to uniquely identify all interfaces in the system. An interface can
be a physical port or a virtual interface (VLAN interface). A TP 5000 system can
have up 500 VLANs per IOC port and one VLAN per expansion shelf Ethernet port.
Each packet timing physical port on the main shelf can support multiple VLANs, with
vlan-id values that ranges from 1 to 4094.
Note: Many of the product's SNMP tables use ifIndex as an

index.
See Figure 2-7 and for an example of an ifTable for the TP5000.
Interface Table
Figure 2-6. Organization of IF Table
Figure 2-7. Example of ifTable
Public MIBs For TP 5000 SNMP Agent
IF MIB
Note: The OID values indicated are relative to the MIB directory
“mgmt”, which is: 1.3.6.1.2.
Table 2-3. ifTable Parameters
Used with
OID Object Name Description
TP50000?
1.2.2.1.1 ifIndex This is a unique value for each interface in Yes

the system
1.2.2.1.2 ifDescr Textual description Yes
1.2.2.1.3 ifType From a long list of types, like ds1(18), e1(19), Yes
fastEther(62), fastEtherFX(69),
gigabitEthernet(117), l2vlan(135),
l3ipvlan(136),
1.2.2.1.5 ifSpeed Estimated speed in bits per second Yes
1.2.2.1.6 ifPhysAddress MAC or 00000000 Yes
1.2.2.1.7 ifAdminStatus Desired state of interface {up | down | testing, Yes

etc.}
1.2.2.1.8 ifOperStatus Current state of interface {up | down | testing, Yes

etc.}
1.2.2.1.9 ifLastChange sysUpTime when the interface entered its Yes

current state
1.2.2.1.10 ifInOctets Total number of bytes received Yes
1.2.2.1.11 ifInUcastPkts Number of unicast packets received and Yes

delivered to a higher layer protocol
1.2.2.1.12 ifInNUcastPkts Number of non-unicast (e.g. multicast) Yes

packets delivered to higher layer protocol
1.2.2.1.13 ifInDiscards Number of incoming packets dropped not No

due to error
1.2.2.1.14 ifInErrors Number of incoming packets with error Yes
1.2.2.1.15 ifInUnkonwnProtos Number of packets dropped due to No

unsupported protocol
Table 2-3. ifTable Parameters
Used with
TP50000?
1.2.2.1.16 ifOutOcts Total number of transmitted bytes Yes
1.2.2.1.17 ifOutUcastPkts Total number of unicast packets that were Yes

requested to be transmitted
1.2.2.1.18 ifOutNUcastPkts Total number of non-unicast (like multicast) No

packets that were requested to be
transmitted
1.2.2.1.19 ifOutDiscards Number of outbound packets dropped not No

due to error
1.2.2.1.20 ifOutErrors Number of outbound packets dropped due to No

error
1.2.2.1.21 ifOutQLen Length of output packet queue (in packets) No
1.2.2.1.22 ifSpecific No
Note: interfaceExtTable extends this table.
IP MIB
This MIB is only used with the IMC management port.
Table 2-4. IP MIB Scalars
1.4.1 ipForwarding Is this entity an IP gateway {forward |

not-forward}
1.4.2 ipDefaultTTL If TTL is not supplied by transport layer

protocol
1.4.3 ipInReceives Total number of datagrams received
1.4.4 ipInHdrErrors Number of datagrams dropped due to errors

in headers
1.4.5 ipInAddrErrors Number of datagrams dropped due to errors

in IP addr
Table 2-4. IP MIB Scalars
1.4.6 ipForwDatagrams Number of forwarded datagrams
1.4.7 ipInUnknownProtos Number of datagrams dropped due to

unsupported protocol
1.4.8 ipInDiscards Number of datagrams dropped not due to

errors
1.4.9 ipInDelivers Total number of input datagrams delivered

successfully
1.4.10 ipOutRequests Total number of datagrams that were

requested to be transmitted
1.4.11 ipOutDiscards Number of output datagrams dropped not

due to errors
1.4.12 ipOutNoRoutes Number of output datagrams dropped due

to no route
1.4.13 ipReasmTimeOut Max number of seconds which received

fragments had to wait for reassembly
1.4.14 ipReasmReqds Number of fragments received that needs

reassembly
1.4.15 ipReasmOKs Number of datagrams reassembled
1.4.16 ipReasmFails Number of failed datagram reassembly
1.4.17 ipFragOKs Number of datagrams fragmented
1.4.18 ipFragFails Number of datagrams that did not fragment

successfully
1.4.19 ipFragCreates Number of datagram fragments generated
1.4.20 ipAddrTable The table of addressing information

relevant to this entity's IPv4 addresses.
1.4.21 ipRouteTable The entity's IP Routing table.
1.4.22 ipNetToMediaTable The IPv4 Address Translation table used for

mapping from IPv4 addresses to physical
addresses.
1.4.23 ipRoutingDiscards The number of routing entries which were

chosen to be discarded even though they
are valid. One possible reason for
discarding such an entry could be to free-up
buffer space for other routing entries.
ipAddrTable
Table 2-5. ipAddrTable
Used with
TP5000?
1.4.20.1 ipAddrEntry The addressing information for one of this Yes

entity's IPv4 addresses.
1.4.20.1.1 ipAdEntAddr IP address of this entry (row) Yes
1.4.20.1.2 ipAdEntIfIndex Identifies the same interface as the ifIndex Yes
1.4.20.1.3 ipAdEntNetMask Subnet mask associated with the IP Yes

address of this entry
1.4.20.1.4 ipAdEntBcastAddr The value of the least significant bit in IP Yes

broadcast address
1.4.20.1.5 ipAdEntReasmMaxSize The max size of the datagram that can be No

reassembled
ipRouteTable
Table 2-6. ipRouteTable
Used with
TP5000?
1.4.21.1 ipRouteEntry A route to a particular destination. Yes
1.4.21.1.1 ipRouteDest Destination IP address for this route Yes
1.4.21.1.2 ipRouteIfIndex Identifies the same interface as the ifIndex Yes
1.4.21.1.3 ipRouteMetric1 Indicate the primary routing metric for this Yes
route (determined by route's ipRouteProto
value)
1.4.21.1.4 ipRouteMetric2 Indicate an alternate routing metric Yes
1.4.21.1.5 ipRouteMetric3 Indicate an alternate routing metric No
1.4.21.1.7 ipRouteNextHop IP address of next hop Yes
1.4.21.1.8 ipRoutetype {other | invalid | direct | indirect} Yes
Table 2-6. ipRouteTable (Continued)
Used with
TP5000?
1.4.21.1.9 ipRouteProto Routing protocol {other | local | netmgmt | Yes

etc.}
1.4.21.1.10 ipRouteAge Time (in seconds) since route was No

validated or updated
1.4.21.1.11 ipRouteMask Yes
1.4.21.1.13 ipRouteInfo No
ipNetToMediaTable
Table 2-7. ipNetToMediaTable
Used with
TP5000?
1.4.22.1 ipNetToMediaEntry Each entry contains one IpAddress to Yes

physical' address
equivalence.
1.4.22.1.1 ipNetToMedia IfIndex Identifies the same interface as the Yes

ifIndex
1.4.22.1.2 ipNetToMedia Media dependent physical address Yes

IfPhysAddress
1.4.22.1.3 ipNetToMedia NetAddress IP address corresponding to the Yes

physical address
1.4.22.1.4 ipNetToMediaType Type of mapping {other | invalid | Yes

dynamic | static}
ICMP MIB
This node is only with the IMC management port.
Table 2-8. icmp MIB Parameters
1.5.1 icmpInMsgs Total number of ICMP message received
1.5.2 icmpInErrors Number of ICMP message with errors
1.5.3 icmpInDest Number of ICMP destination unreachable

Unreachable messages received
1.5.4 icmpInTimeExcds Number of ICMP time exceeded

messages received
1.5.5 icmpInParmProbs Number of ICMP parameter problem

messages received
1.5.6 icmpInSrcQuenchs Number of ICMP source quench

messages received
1.5.7 icmpinRedirects Number of ICMP redirect messages

received
1.5.8 icmpInEchos Number of ICMP echo (request)

messages received
1.5.9 icmpInEchos Reps Number of ICMP echo reply messages

received
1.5.10 icmpInTimestamps Number of ICMP timestamp (request)

messages received
1.5.11 icmpinTimestampRep Number of ICMP timestamp reply

s messages received
1.5.12 icmpinAddrMasks Number of ICMP address mask request

messages received
1.5.13 icmpinAddrMasksRep Number of ICMP address mask reply

s messages received
1.5.14 icmpOutMsgs Total number of ICMP messages

attempted to send
1.5.15 icmpOutErrors Number of ICMP messages not sent not

due to error
1.5.16 icmpOutDest Number of ICMP destination unreachable

Unreachable messages sent
1.5.17 icmpOutTimeExcds Number of ICMP time exceeded

messages sent
Table 2-8. icmp MIB Parameters
1.5.18 OutParmProbs Number of ICMP parameter problem

messages sent
1.5.19 OutSrcQuenchs Number of ICMP source quench

messages sent
1.5.20 OutRedirects Number of ICMP redirect messages sent
1.5.21 OutEchos Number of ICMP echo (request)

messages sent
1.5.22 OutEchosReps Number of ICMP echo reply messages

sent
1.5.23 OutTimestamps Number of ICMP timestamp (request)

messages sent
1.5.24 OutTimestamp Reps Number of ICMP timestamp reply

messages sent
1.5.25 OutAddrMasks Number of ICMP address mask request

messages sent
1.5.26 OutAddrMaskReps Number of ICMP address mask reply

messages sent
Entity MIB
Table 2-9. Entity MIB Parameters
1.47.1 entityMIBObjects
1.47.2 entityMIBTraps
1.47.3 entityConformance
Table 2-10. entityMIBObjects Parameters
1.47.1.1 entityPhysical
1.47.1.2 entityLogical
1.47.1.3 entityMapping
1.47.1.4 entityGeneral
entPhysicalTable
Table 2-11. entPhysicalTable Parameters
Used with
TP5000?
1.47.1.1.1 entPhysicalTable This table contains one row per Yes

physical entity. There is always at
least one row for an 'overall' physical
entity.
1.47.1.1.1.1 entPhysicalEntry Information about a particular Yes

physical entity.
1.47.1.1.1.1.1 entPhysicalIndex Index for this entry Yes
1.47.1.1.1.1.2 entPhysicalDescrp Textual description Yes
1.47.1.1.1.1.3 entPhysical VendorType Vendor-specific hardware type (not Yes

MIB-II sysObjctID)
Table 2-11. entPhysicalTable Parameters (Continued)
Used with
TP5000?
1.47.1.1.1.1.4 entPhysical ContainedIn entPhysicalIndex for next level up Yes
1.47.1.1.1.1.5 entPhysicalClass HW type {other | chassis | backplane Yes

| container | etc.}
1.47.1.1.1.1.6 entPhysicalParentRelPos Relative position of this child relative Yes

to its siblings
1.47.1.1.1.1.7 entPhysicalName Textual name Yes
1.47.1.1.1.1.8 entPhysicalHardwareRev Vendor-specific HW version Yes
1.47.1.1.1.1.9 entPhysicalFirmwareRev Vendor-specific firmware version Yes
1.47.1.1.1.1.10 entPhysical SoftwareRev Vendor-specific software version Yes
1.47.1.1.1.1.11 entPhysical SerialNum Vendor-specific serial number Yes
1.47.1.1.1.1.12 entPhysicalMfgName Manufacturer for this physical Yes

component
1.47.1.1.1.1.13 entPhysical ModelName Vendor-specific model name Yes
1.47.1.1.1.1.14 entPhysicalAlias Alias assigned by NMS Yes
1.47.1.1.1.1.15 entPhysicalAssetID User-assigned asset tracking ID Yes
1.47.1.1.1.1.16 entPhysicalIsRFU Is this entity a field-replaceable Yes

entity?
Note: entPhysicalExtTable extends this table.
entLogicalTable
Table 2-12. entLogicalTable Parameters
Used with
TP5000?
1.47.1.2 entLogicalTable This table contains one row per No

logical entity. For agents which
implement more than one naming
scope, at least one entry must exist.
Agents which instantiate all MIB
objects within a single naming scope
are not required to implement this
table.
1.47.1.2.1 entLogicalEntry Information about a particular logical No

entity. Entities may be managed by
this agent or other SNMP agents
(possibly) in the same chassis.
1.47.1.2.1.1 entLogicalIndex Uniquely identifies the logical entity No
1.47.1.2.1.2 entLogicalDescrp Textual description of logical entity No
1.47.1.2.1.3 entLogicalType Object Identifier name of node in SMI No

naming hierarchy. E.g., mib-2,
dot1dBridge, etc.
1.47.1.2.1.4 entLogicalCommunity SNMPv1 or SNMPv2 community No

string
1.47.1.2.1.5 entLogicalAddress Transport service address by which No

the entity receives NMS traffic
1.47.1.2.1.6 entLogicalDomain Kind of transport service by which No

logical entity receives NMS traffic
1.47.1.2.1.7 entLogicalContextEngineID contextEngineID that can be used to No

send SNMP message
1.47.1.2.1.8 entLogicalContextName contextName that can be used to No

send SNMP message
entLPMappingTable
Table 2-13. entLogicalTable Parameters
Used with
TP5000?
1.47.1.3.1.1.1 entLPPhysicalIndex Index value of a particular No

entPhysicalEntry associated with the
indicated entLogicalEntity
entAliasMappingTable
Table 2-14. entAliasMappingTablle Parameters
Used with
TP5000?
1.47.1.3.2.1.1 entAliasLogcalIndexOrZero No
1.47.1.3.2.1.2 entAliasMapping Identifier No
entPhysicalContainsTable
Table 2-15. entPhysicalContainsTable Parameters
Used with
TP5000?
1.47.1.3.3.1 entPhysicalContainsEntry A table which exposes the

container/containee relationships
between physical entities.
1.47.1.3.3.1.1 entPhysicalChild Index Value of entPhysicalIndex for the No

contained physical entity
entGeneral
Table 2-16. entGeneral Parameters
Used with
TP5000?
1.47.1.4.1 LastChangeTime Value of sysUpTime at the time a Yes

conceptual row is created or modified
in the following tables:
entPhysicalTable, entLogicalTable,
entLPMappingTable,
entPhysicalContainsTable
entMIBTraps
Table 2-17. entMIBTraps Parameters
Used with
TP5000?
ConfigChange A trap when entLastChangeTime No

changes
This chapter describes the structural design of the TP5000e MIB.
In This Chapter
The symmCommonModelv1 Private MIB is rooted in the Symmetricom directory, as

shown below.
private > enterprise >symmetricom > symmNetworkManagement

>symmSnmpManagement > symmCommonModelV1
Table 3-1 show the top level objects for the symmCommonModelv1 Private MIB
module and their respective functions. See for the functions and details of these
objects.
Note: All Object ID (OID) numbers described in this chapter are

relative to the OID of the symmCommonModelv1 Private MIB
itself, which is: 1.3.6.1.4.1.9070.1.2.5.
Table 3-1. symmCommonModelV1 MIB Descriptions
1 symmPacketService
2 symmPhysicalSignal
3 symmClock
4 symmNetwork
5 symmEntPhysicalExtension
6 symmInterfaceExtension
7 symmDeviceDependent
Set and Retrieve PTP Parameters
Table 3-2. symmPacketService Object Details
OID Object Name Access Description
1.1 symmPtpv2 n/a This is the Symmetricom PTPv2 MIB. It

has two main nodes: PTPv2 status and
PTPv2 configuration.
1.2 symmNTP n/a This is the Symmetricom NTP MIB. It has
two main nodes: NTP status and NTP
configuration.
1.3 ituPtpv2 n/a This is a place holder for an ITU

approved PTP MIB.
Table 3-3. symmPtpv2 Object Details
1.1.1 ptpv2Status n/a This node is for PTPv2 status. It has

two tables: a PTP status table and a
PTP client data table.
1.1.2 ptpv2Config n/a This node is for PTP port

configuration. It has three tables:
Common parameter table, Unicast
table, and multicast table.
1.1.3 ptpv2Conformance n/a This node will be completed later.
Retrieve PTP Status (ptpv2Status)
Table 3-4. ptpv2Status MIB Details
1.1.1.1 ptpv2StatusTable n/a The PTP status table. This table

provides status for the PTP
grandmaster operation.
1.1.1.2 ptpv2ClientDataTable n/a PTP client data table contains

raw data for PTP clients
Retrieve PTP Status Information (ptpv2StatusTable)
Table 3-5. ptpv2StatusTable Object Details
1.1.1.1.1 ptpv2StatusEntry n/a An entry of the PTPv2 status table.

Table index is ifIndex (port and
interface index).
1.1.1.1.1.1 ptpv2StatusIndex n/a This is a local index that is not

accessible. Range is 1 - 1000.
1.1.1.1.1.2 ptpv2StatusPortEnable read-only PTP port state control used to

enable or disable PTP service.
Values can be enable (1) or disable
(2).
1.1.1.1.1.3 ptpv2StatusClockID read-only Clock ID uniquely identifies a PTP

clock at a PTP port. It is a 64-bit
identifier. In TP5K system each
physical PTP port supports one PTP
clock.
Table 3-5. ptpv2StatusTable Object Details (Continued)
1.1.1.1.1.4 ptpv2StatusProfile read-only PTP profile supported by the

specified PTP port. TP5K system
supports the following profiles:
(1) Telecom-2008,
(2) Default,
(3) and Hybrid,
(4) ITU G.8265.1,
(5) Ethernet-default.
The user guide has descriptions
different profiles and the values of
the PTP attributes for each profile.
1.1.1.1.1.5 ptpv2StatusClockClass read-only PTP clock class is a quality level

indication for a PTP clock. Table 5 in
IEEE 1588 v2 defines clock classes
for general use. ITU G.8265.1
provides a mapping between PTP
clock class and synchronization
clock quality level for the ITU
telecom profile.
1.1.1.1.1.6 ptpv2StatusClockAccuracy read-only PTP clock accuracy is the expected

clock accuracy when the PTP clock
is used as a grandmaster. It is used
as a selection criterion in the best
master clock (BMC) algorithm.
1.1.1.1.1.7 ptpv2StatusTimescale read-only PTP timescale used by the PTP

clock. It can be ARB (2) or PTP (3).
If timescale is PTP, the epoch is 1
January 1970 00:00:00 TAI, which is
31 December 1969
23:59:51.999918 UTC.
1.1.1.1.1.8 ptpv2StatusNumClient read-only Number of PTP clients connected to

a PTP port. It value is 0 - 1000.
1.1.1.1.1.9 ptpv2StatusClientLoad read-only Percentage of PTP client load on a

PTP port. This is the percentage of
connected client relative to the
maximum number of clients that the
port can support.
Retrieve PTP Client Status Information (ptpv2ClientDataTable)
Table 3-6. ptpv2ClientDataTable Object Details
1.1.1.2.1 ptpv2ClientDataEntry n/a An entry to the client data table. Table

index is the local index.
1.1.1.2.1.1 ptpv2ClientDataIndex n/a Client data index is a local index. This

local index is also called client number.
1.1.1.2.1.2 ptpv2ClientData read-only Sync interval Client Data is a string of

raw data for the entry. It contains the
following PTP client information:
1.Module ID (where the client is
physically connected)
2.Port ID (where the client is physically
connected)
3.Client IP address
4.VLAN ID
5.VLAN priority
6.Client Clock ID
7.Client mode (Clients in TP5K client
list are either dynamic or static.
Dynamic clients are regular clients
that negotiate with GM, and they
can come and go from the client list.
TP5K also support 10 or 16 static
clients that are always on the client
list and the GM will always send
PTP packets to them whether they
respond or not.)
8.Announce interval
9.Sync Interval
10.Delay response interval
Set PTP Parameters (ptpv2Config)
Table 3-7. ptpv2Config MIB Details
1.1.2.1 ptpv2CommonTable n/a The PTP common parameter table

has PTP parameters that are not
specific to the unicast or multicast
addressing mode.
1.1.2.2 ptpv2UnicastTable n/a The PTP unicast configuration table

for PTP attributes that are specific to
unicast. In TP5K 2.0, only the main
shelf supports unicast.
1.1.2.3 ptpv2MulticastTable n/a The PTP multicast table for PTP

attributes that are specific to
multicast. In TP5K 2.0, main shelf
and expansion shelves all support
multicast.
Set PTP Common Parameters (ptpv2CommonTable)
Table 3-8. ptpv2CommonTable Object Details
1.1.2.1.1 ptpv2CommonEntry n/a An entry of the PTP common parameter

table. Table index is ifIndex (port and
interface index).
1.1.2.1.1.1 ptpv2CommonIndex n/a This is a local index of the PTP common

parameter table.
1.1.2.1.1.2 ptpv2Profile read-write Select a PTP profile for the specified

PTP port. TP5K system supports four
five IPv4 "profiles":
(1)ITU G.8265.1,
(2)Default,
(3)Telecom-2008, and
(4)Multicast-hybrid, and
(5)Ethernet-default.
The user guide has descriptions
different profiles and the values of the
PTP attributes for each profile.
1.1.2.1.1.3 ptpv2ClockID read-write Clock ID uniquely identifies a PTP clock

at a PTP port. It is a 64-bit identifier, and
its format is xx:xx:xx:xx:xx:xx:xx:xx. In
TP5K system each physical PTP port
supports one PTP clock.
1.1.2.1.1.4 ptpv2Priority1 read-write Attribute Priority1 for the specified PTP

port. It is used in BMC algorithm as a
selection criterion. Its range is 0-255,
unless restricted by a PTP profile.
Default value is 128.
1.1.2.1.1.5 ptpv2Priority2 read-write Attribute Priority2 for the specified PTP

port. It is used in BMC algorithm as a
selection criterion. Its range is 0-255,
unless restricted by a PTP profile.
Table 3-8. ptpv2CommonTable Object Details (Continued)
1.1.2.1.1.6 ptpv2Domain read-write The PTP domain of the specified PTP

port. PTP domain is a logical grouping of
PTP clocks. All the PTP clocks in the
same domain are synchronized to each
other using the PTP protocol. The range
of the PTP domain is 0-255. Default
value is 0. For ITU telecom profile, range
is 4-23 and default is 4.
1.1.2.1.1.7 ptpv2DSCPState read-write Differentiated service code point (DSCP)

state for the specified PTP port. It can be
either enable (1) or disable (2). Default
value is disable. If DSCP state is enable,
the QoS field will have a configured
DSCP value.
1.1.2.1.1.8 ptpv2DSCPValue read-write DSCP value for PTP packets leaving

this port. Value range is 0-63, and
default value is 0.
1.1.2.1.1.9 ptpv2State read-write PTP packet service state for the

specified PTP port. It can be either
enable (1) or disable (2). Default value is
enable. When PTP is disabled at a port,
it does not transmit or respond to PTP
packets, and all alarms associated with
PTP for this port are cleared.
1.1.2.1.1.10 ptpv2MaxClient read-write The maximum number of PTP clients

that are allowed to be connected to this
PTP port. Range is 1-10. Maximum
value is 500 if other IOC port is also
running PTP..
1.1.2.1.1.11 ptpv2AnnounceLimit read-write The minimum PTP Announce message

transmission interval (inverse of the
maximum PTP Announce message
transmission rate) that the port will
accept. This is the exponent of 2, and
the value range is -4 to +4. default is -3.
If AnnounceLimit = -4, the minimum
Announce message transmission
interval is = 2^(-4) = 0.0625 seconds, or
the maximum message transmission
rate is 16 messages per second.
1.1.2.1.1.12 ptpv2SyncLimit read-write The minimum PTP Sync message

interval (inverse of the maximum PTP
Sync message transmission rate) that
the port will accept. This is the exponent
of 2, and the value range is -7 to +7 and
default is -7. If SyncLimit = -4, the
minimum Sync message transmission
interval is = 2^(-4) = 0.0625 seconds, or
the maximum message transmission
rate is 16 messages per second.
1.1.2.1.1.13 ptpv2DelayLimit read-write The minimum PTP Delay_Req message

transmission interval that the port will
accept (inverse of the maximum PTP
Delay_Req message transmission rate).
This is the exponent of 2, and the value
range is -7 to +7 and default is -7. If
SyncLimit = -4, the minimum Delay_Req
message transmission interval is =
2^(-4) = 0.0625 seconds, or the
maximum message transmission rate is
16 messages per second.
1.1.2.1.1.14 ptpv2TwoStep read-write PTP two-step clock enable. Its value can
be enable (1) or disable (2). Default
value is disable. If it is disabled, the
system will use PTP one-step clock.
1.1.2.1.1.15 ptpv2MgmtAddrMode read-write The addressing mode for the PTP

management communication between a
PTP grandmaster port and PTP clients.
It can be either unicast (1) or multicast
(2). Default is unicast.
1.1.2.1.1.16 ptpv2TTL read-write IP header time-to-live (TTL) field for the

PTP packets. Range is 1-255. Default
value is 64.
1.1.2.1.1.17 ptpv2AlternateGM read-write PTP alternate master enable state for

the specified PTP port. It can be enable
(1) or disable (2). Default is disable.
When it is disabled, the port is always a
master and does not use BMC.
1.1.2.1.1.18 ptpv2TimeScale read-write PTP timescale to be used by the PTP

clock. It can be Auto (1), ARB (2), or
PTP (3). Auto means selecting PTP or
ARB depending on the reference mode.
If timescale is PTP, the epoch is 1
January 1970 00:00:00 TAI, which is 31
December 1969 23:59:51.999918 UTC.
1.1.2.1.1.19 ptpv2Dither read-write PTP dither state. It can either enable (1)
or disable (2). Default is disable.
Dithering is used to randomize packet
transmission time to improve
performance.
Set PTP Unicast Parameters (ptpv2UnicastTable)
Table 3-9. ptpv2UnicastTable Object Details
1.1.2.2.1 ptpv2UnicastEntry n/a An entry to the PTP unicast

configuration table. Table index is
ifIndex. The unicast table has two
attributes: unicast negotiation state and
unicast lease duration limit.
1.1.2.2.1.1 ptpv2UnicastIndex n/a Local index of the PTP unicast

configuration table.
1.1.2.2.1.2 ptpv2UnicastNeg read-write Unicast negotiation state for the

specified port. Its value can be enable
(1) or disable (2).
1.1.2.2.1.3 ptpv2UnicastLeaseDurLimit read-write Unicast least duration limit (in seconds)

is the maximum unicast lease duration
request that the grandmaster will
accept. Its range is 10 - 1000 seconds.
Default value is 300 seconds.
Set PTP Multicast Parameters (ptpv2MulticastTable)
Table 3-10. ptpv2MulticastTable Object Details
1.1.2.3.1 ptpv2MulticastEntry n/a An entry to the PTP multicast

ifIndex. The multicast table has 6
multicast attributes.
1.1.2.3.1.1 ptpv2MulticastIndex n/a Local index of the PTP multicast

1.1.2.3.1.2 ptpv2MulticastAnnounceInt read-write PTP multicast Announce message

maximum PTP multicast Announce
message transmission rate). This is
the exponent of 2, and the value range
is -4 to +4. Default value is 1 (which
means 2 seconds). If the value of the
multicast Announce transmission
interval is -4, the message
transmission interval is = 2^(-4) =
0.0625 seconds, or the message
transmission rate is 16 messages per
second.
1.1.2.3.1.3 ptpv2MulticastSyncInt read-write PTP multicast Sync message

maximum PTP multicast Sync
is -7 to +7. Default value is -1 (i.e. 0.5
second). If the value of the multicast
Sync transmission interval is -4, the
2^(-4) = 0.0625 seconds, or the
message transmission rate is 16
messages per second.
Table 3-10. ptpv2MulticastTable Object Details (Continued)
1.1.2.3.1.4 ptpv2MulticastDelayInt read-write PTP multicast Delay_Req message

maximum PTP multicast Delay_Req
is -7 to +7, default value is -7 If the
value of the multicast Delay_Req
transmission interval is -4, the
2^(-4) = 0.0625 seconds, or the
message transmission rate is 16
messages per second.
1.1.2.3.1.5 ptpv2MulticastAnnoTimeout read-write Multicast Announce Receipt Timeout.

Its range is 2 - 10 and its unit is
number of intervals. Default value is 3
(intervals). It is the number of
Announce intervals that has to pass
without receiving an Announce
message before the PTP port declares
Announce_Receipt_Timeout_Expires.
If the timeout value is 2 and the
multicast announce interval is 4
seconds, then the multicast announce
receipt timeout value is 2*4 = 8
seconds.
1.1.2.3.1.6 ptpv2MulticastVlanID read-write Multicast VLAN ID of the specified

port. Each port only supports one
VLAN. Range is 0 - 4094. Default
value is 0.
1.1.2.3.1.7 ptpv2MulticastClientTimeout read-write Multicast client timeout. Range is 10 -

3600 seconds. Default value is 300
seconds. TP5000 maintains a list of
active PTP clients. If the grandmaster
does not receive Delay_Req message
from a client for more than this timeout
value, the client is removed from the
TP5000 client list.
Set and Retrieve NTP Parameters
Table 3-11. symmNTP MIB Details
1.2.1 ntpStatus This node is for NTP status. It has one

status table.
1.2.2 ntpConfig This node is for NTP attribute

configuration. It has a configuration
table
1.2.3 ntpConformance
Set and Retrieve NTP Status (ntpStatus)
Table 3-12. ntpStatus Object Details
1.2.1.1 ntpCommonStatusTable The NTP status table. It provides status

for the NTP server operation. There are
7 status parameters.
1.2.1.1.1 ntpCommonStatusEntry An entry of the NTP status table. Table

index is ifIndex (port and interface
index).
1.2.1.1.1.1 ntpStatusIndex n/a Local index of the NTP common status

table.
1.2.1.1.1.2 ntpStatusEnable read-only The NTP enable status for the specified
NTP port. It can be enable (1) or disable
(2). When NTP is disabled at a port, it
does not transmit or respond to NTP
packets, and all alarms associated with
NTP for this port are cleared.
1.2.1.1.1.3 ntpStatusMode read-only The NTP operational mode. It can

server or client. Currently only the
server mode is supported.
Table 3-12. ntpStatus Object Details
1.2.1.1.1.4 ntpStatusLeapStatus read-only The NTP leap second status. Possible

values are:
 no warning,
 leap insertion,
 leap deletion,
 not in sync.
1.2.1.1.1.5 ntpStatusStratumLevel read-only The stratum level of the reference for

the NTP clock at the specified port. Its
range is 1-4. Only stratum level
1(PRC/PRS) is supported.
1.2.1.1.1.6 ntpStatusDispersion read-only Root dispersion. Hardcoded to be 0.
1.2.1.1.1.7 ntpStatusPacketLoad read-only NTP packet response load. It is range is

1-100 in unit of %.
1.2.1.1.1.8 ntpStatusVersion read-only NTP protocol version. Only version 4 is

supported.
Set and Retrieve NTP Parameters (ntpConfig)
Table 3-13. ntpConfig Object Details
1.2.2.1 ntpCommonConfigTable The NTP server configuration table.
1.2.2.1.1 ntpCommonConfigEntry An entry of the NTP server

ifIndex (port and interface index).
1.2.2.1.1.1 ntpCommonIndex n/a Local index of the NTP common

parameter configuration table
1.2.2.1.1.2 ntpCommonState read-writ The NTP service enable state for the
e specified port. It can be enable (1) or
disable (2). Default value is enable.
When NTP is disabled at a port, it does
not transmit or respond to NTP
packets, and all alarms associated
with NTP for this port are cleared.
1.2.2.1.1.3 ntpCommonTTL read-writ IP header time-to-live (TTL) field for

e the NTP packets. Range is 1-255.
Table 3-13. ntpConfig Object Details
1.2.2.1.1.4 ntpCommonDSCP read-writ Differentiated service code point

e (DSCP) state for the specified NTP
port. It can be either enable (1) or
disable (2). Default value is disable. If
DSCP state is enable, the QoS field
will have a configured DSCP value.
1.2.2.1.1.5 ntpCommonDSCPValue read-writ DSCP value for PTP packets leaving

e this port. Range is 0-63, and default
value is 0.
1.2.2.1.1.6 ntpCommonVlanId read-writ The VLAN ID associated with the NTP

e service at this port. Each port only
supports one NTP VLAN.
ituPtpv2 Object Details

This is a place holder for an ITU approved PTP MIB.
Set and Retrieve Parameters for Physical Signals
Table 3-14. symmPhysicalSignal Ojbect Details
2.1 symmGNSS This is the Symmetricom common MIB for

GNSS/GPS. This MIB has two main nodes:
gnssStatus and gnssConfig. The gnssStatus
node has a port status table, a satellite
table, and a scalar for GNSS current
position mode. The gnssConfig node has a
configuration table, position setting table,
and a present position table.
2.2 symmE1T1 This is the Symmetricom Common MIB for

the configuration and status monitoring of
E1/T1 ports in the system. It is one of the
MIBs under the symmPhysicalSignal node.
This MIB is organized into two main nodes:
input and output. Each node is further has
two tables, one for status and one for
configuration.
2.3 symmPPSTOD Symmetricom Common PPS/TOD

input/output status and configuration
2.4 symmCommon10M
2.5 symmPPS
2.6 symmOutGen This is the Symmetricom Common MIB for

output generation. It specifies output port
behavior (on | squelch | AIS) when the
system clock state is not Normal Tracking.
TP5K defines five clock states: warm-up,
free-run, fast track, normal track, and
holdover.
2.7 symmDti
2.8 symmSyncE This is the Symmetricom Common MIB for

SyncE. It has two main nodes: SyncE status
and SyncE configuration.
Set and Retrieve GNSS Port Parameters
Table 3-15. symmGNSS Object Details
2.1.1 gnssStatus This is the GNSS Status node.
2.1.2 gnssConfig This is the GNSS configuration node.
2.1.3 gnssConformance
Retrieve GNSS Status
Table 3-16. gnssStatus Object Details
2.1.1.1 gnssPortStatusTable GNSS port status table. It contains

port name and the current GNSS
receiver mode for the specified port.
2.1.1.2 gnssSatTable GNSS satellite table. This table lists

information about the satellites being
tracked by the GNSS receiver.
2.1.1.3 gnssCurrentPositionMode Current position table. This table

shows the position of the GNSS
receiver antenna. In the automatic
mode, the position is calculated by
the GNSS receiver. In the manual
mode, the position is the manually
entered position in
gnssPosSettingTable.
2.1.1.4 gnssPresentPosTable
Retrieve GNSS Port Status (gnssPortStatusTable)
Table 3-17. gnssPortStatusTable Object Details
2.1.1.1.1 gnssPortStatusEntry n/a An entry of the GNSS port status

table. Table index is ifIndex.
2.1.1.1.1.1 gnssPortStatusIndex n/a Local index of the GNSS port status

table.
2.1.1.1.1.2 gnssPortStatusPortName n/a The name of the specified GNSS

port. In TP5000 system there can be
one or two GNSS ports. One of them
is always called GPS, and the
additional one (if present) is called
either GPS or GNSS. A port called
GNSS indicates that it may be
non-GPS or a multi-mode GNSS
receiver port.
2.1.1.1.1.3 gnssPortCurrentGNSS n/a This value indicates whether the

specified GNSS port is used. Its value
is Yes (1) or No (2). If it is No, the port
is considered absent in the system.
2.1.1.1.1.4 gnssPortCurrentPosMode n/a Current position mode of the GNSS

receiver. It can be surveying (1),
position hold (2), or manual (3)
Retrieve GNSS Tracked Satellites (gnssSatTable)
Table 3-18. gnssSatTable Object Details
2.1.1.2.1 gnssSatEntry n/a An entry of the GNSS satellite tracking

table. Table index is local index
gnssSatIndex.
2.1.1.2.1.1 gnssSatIndex n/a This is the local index of the table of

the GNSS satellite being tracked.
2.1.1.2.1.2 gnssSatNum read-only GNSS satellite number. This is the

identification number of the GNSS
satellite being tracked. This
information is obtained from the GNSS
satellite ephemeris or almanac.
2.1.1.2.1.3 gnssSatSNR read-only Signal-to-Noise Ratio. This is the

GNSS signal to noise ratio measured
by the GNSS receiver.
2.1.1.2.1.4 gnssSatHealth read-only GNSS satellite health state. It can be

healthy (1) or unhealthy (2). This data
is obtained from the GNSS receiver.
2.1.1.2.1.5 gnssSatAzimuth read-only GNSS satellite azimuthal angle

clockwise from true north. Range of
the azimuth is 0 to 360 degrees.
2.1.1.2.1.6 gnssSatElevation read-only GNSS satellite elevation angle relative

to the horizon. Range of the elevation
angle is 0 to 90 degrees.
2.1.1.2.1.7 gnssSatPortName read-only The GNSS port name. This is defined

in gnssConfigTable
Retrieve Present Position of GNSS Satellites (gnssPresentPosTable)
Table 3-19. gnssPresentPosEntry Object Details
2.1.1.3.1 gnssPresentPosEntry n/a An entry of the present position table.

Table index is the ifIndex.
2.1.1.3.1.1 gnssPresentPosIndex n/a Local index that corresponds to the

ifIndex. For TP5K there are up to two
GNSS port entries.
2.1.1.3.1.2 gnssPresentPosLat read-only Latitude of the GNSS receiver antenna

position for the specified GNSS port.
Its format is Ndd:mm:ss.ss or
Sdd:mm:ss.ss.
2.1.1.3.1.3 gnssPresentPosLong read-only Longitude of the GNSS receiver

antenna position for the specified
GNSS port. Its format is
Eddd:mm:ss.ss or Wddd:mm:ss.ss.
2.1.1.3.1.4 gnssPresentPosHeight read-only Altitude (height) in meters of the

GNSS receiver antenna position for
the specified GNSS port. Its format is
+/-hhhh.h.
Set and Retrieve GNSS Configuration Data (gnssConfig)
Table 3-20. gnssConfig MIB Details
2.1.2.1 gnssConfigurationTable n/a GNSS configuration table
2.1.2.2 gnssPosSettingTable n/a This table is used to manually set the

GNSS receiver antenna position for
the specified GNSS port.
Set and Retrieve GNSS Parameters (gnssConfigurationTable)
Table 3-21. gnssConfigurationTable Object Details
2.1.2.1.1 gnssConfigurationEntry An entry of the GNSS configuration

table. Table index is ifIndex
2.1.2.1.1.1 gnssConfigurationIndex n/a Local index of the GNSS port

configuration table
2.1.2.1.1.2 gnssConfigurationPortName read-write Name of the specified GNSS port.

For TP5000 currently there are two
names for a GNSS port: GPS or
GNSS. Use the name on the
equipment front panel.
2.1.2.1.1.3 gnssConfigurationTrackMode read-write GNSS receiver mode. This

depends on the GNSS receiver.
For the VCOM receiver, there are
four modes: beidou (1), gps (2),
priorityBeidou (4) which is
automatic with GPS priority, and
priorityGps (5) which is automatic
with Beidou priority.
2.1.2.1.1.4 gnssConfigurationPosMode read-write GNSS receiver position survey

mode. It can be either automatic
(1) or manual (2). When the
position survey mode is manual, ,
the user entered position is used
for position hold.
2.1.2.1.5 gnssConfigurationElevMask read-write GNSS elevation mask. The range

is 5 to 45 degrees. This value is
actually the lower limit of the
elevation mask. The upper limit 90
degrees. If the elevation mask is
set to 5 degrees, the elevation
coverage is from 5 to 90 degrees. If
the elevation mask is set to 30
degrees, the elevation coverage is
from 30 to 90 degrees.
2.1.2.1.6 gnssConfigurationCableDelay read-write GNSS antenna cable delay

compensation in nanoseconds.
Range is 0 to 999,999
nanoseconds. This value should be
as close to the actual antenna
cable delay as possible. Residual
error will directly affect the
time/phase accuracy.
Set GNSS Antenna Position Manually (gnssPosSettingTable)
Table 3-22. gnssPosSettingTable MIB Details
2.1.2.2.1 gnssPosSettingEntry An entry of the GNSS position setting

table. Table index is ifIndex.
Table 3-23. gnssPosSettingEntry Object Details
2.1.2.2.1.1 gnssPosSettingIndex n/a Local index that corresponds to the

ifIndex. For TP5K there are up to two
GNSS port entries.
2.1.2.2.1.2 gnssPosSettingLat read-writ Manual setting for the latitude of the

e GNSS receiver antenna for the
specified GNSS port.
2.1.2.2.1.3 gnssPosSettingLong read-writ Manual setting for the longitude of the

2.1.2.2.1.4 gnssPosSettingHeight read-writ Manual setting for the height of the

symmE1T1 MIB Details
Table 3-24. symmE1T1 MIB Details
2.2.1 e1T1Input This is the input node for the

symmE1T1 MIB. It contains two
sub-nodes: status and configuration.
Each sub-node has a table.
Note: unlike CLI, MIB user can
access IO module ports only if the IO
module is physically present in the
system.
2.2.2 e1T1Output
2.2.3 e1T1Conformance
Set and Retrieve E1/T1 Input Port Data
Table 3-25. e1T1Input MIB Details
2.2.1.1 e1T1InputStatus Status node for E1/T1 input ports.
2.2.1.2 e1T1InputConfig Configuration node for E1/T1 input

ports
Retrieve Status of E1/T1 Input Ports (e1T1InputStatus)
Table 3-26. e1T1InputStatus Object Details
2.2.1.1.1 e1T1InputStatusTable This table contains status information

for each E1/T1 input port.
2.2.1.1.1.1 e1T1InputStatusEntry An entry of the e1T1InputStatusTable.

Table index is ifIndex (port/interface
index). Each entry has three
parameters for the specified E1/T1
input port:
1.Port enable status (enable or
disable)
2.Current value of the incoming SSM
3.Port status
2.2.1.1.1.1.1 e1T1InputStatusIndex n/a Local index of the E1/T1 input status

table
2.2.1.1.1.1.3 e1T1InputPQLCurValueV1 R The current PQL value of the

incoming SSM on this input port.
2.2.1.1.1.1.4 e1T1InputPortStatusV1 R The port status of the specified input

E1/T1 input port. Possible values are
on (1) and off (2). When the input port
state is enable, port status becomes
on. When input port state is disable,
input port status is off.
Set E1/T1 Input Port Parameters (e1T1InputConfig)
Table 3-27. e1T1InputConfig Object Details
2.2.1.2.1 e1T1InputConfigTable
2.2.1.2.1.1 e1T1InputConfigEntry
2.2.1.2.1.1.1 e1T1InputConfigIndex n/a Local index of the E1/T1 input

2.2.1.2.1.1.2 e1T1InputFrameTypeV1 read-write E1 or T1 input frame type. Supported

frame types include:
1.Freq1544khz (1)
2.Freq2048khz (2)
3.CCS (3)
4.CAS (4)
5.D4 (5)
6.ESF (6)
Default frame type is 2048 kHz
2.2.1.2.1.1.3 e1T1InputCRCStateV1 read-write CRC enable state can be enable (1)

or disable (2). Disabling the CRC
means the CRC in the SSM is not
used.
2.2.1.2.1.1.4 e1T1InputSSMStateV1 read-write SSM enable state. It can be enable

(1) or disable (2). Disabling the SSM
means the incoming SSM is not
used, and the forced (default) PQL
value for this input port will be used
during the reference selection.
SSM is supported for only three
frame types: EFS, CAS with CRC4,
and CCA with CRC4. SSM should
not be enabled for other frame types.
If SSM is enabled for an input port,
but the frame type does not support
SSM or is not sending a valid SSM,
then this input will be disqualified
and the input PQL will be set to
"invalid". The system will go into
holdover no other qualified reference
is available.
Table 3-27. e1T1InputConfig Object Details (Continued)
2.2.1.2.1.1.5 e1T1InputSSMBitV1 read-write SSM Bit position. The value range is

4 to 8. This parameter is only used
for frame types CCS, or CAS.
2.2.1.2.1.1.6 e1T1InputPQLValueV1 read-write The user assigned PQL value for the
specified input. This PQL value is
used when the SSM state is
disabled. The range for the user
assigned PQL value is 1 to 9.
2.2.1.2.1.1.7 e1T1InputZeroSupprV1 read-write The number indicates whether zero

suppression (ZS) on the input port is
enabled or disabled. Valid values are
on (1) or off (2).
Not used for TP5K.
Set and Retrieve E1/T1 Output Port Data
Table 3-28. e1T1Output Object Details
2.2.2.1 e1T1OutputStatus
2.2.2.2 e1T1OutputConfig
Retrieve E1/T1 Output Port Status (e1T1OutputStatus)
Table 3-29. e1T1OutputStatus MIB Details
2.2.2.1.1 e1T1OutputStatusTable
2.2.2.1.1.1 e1T1OuputStatusEntry
2.2.1.1.1.1.1 e1T1OutputStatusIndex n/a Local index of the E1/T1 output

status table
2.2.1.1.1.1.2 e1T1OutputPortStatusV1 R The port status of the specified

E1/T1 output port. Possible values
are on (1) and off (2). "On" means
there is signal on the port. For
E1/T1 output port it means the
system is in normal tracking mode.
"Off" means there is no signal on
the port. For E1/T1 output port it
means the output is squelched
during some clock states.
2.2.1.1.1.1.3 e1T1OutputPQLCurValueV1 R The PQL value for the specified

E1/T1 output port.
Set E1/T1 Output Port Parameters (e1T1OutputConfig)
Table 3-30. e1T1OutputConfig Object Details
2.2.2.2.1 e1T1OutputConfigTable
2.2.2.2.1.1 e1T1OutputConfigEntry An entry of the

e1T1OutputConfigTable. Table index
is ifIndex (port/interface index). Each
entry has the configuration
parameters for the specified E1/T1
output port:
1.Port enable state
2.Frame type
3.CRC enable state
4.SSM enable state
5.SSM bit position
6.Zero suppression on/off state (from
SSU, not used in TP5K)
7.Output port cable length (from
SSU, not used in TP5K)
2.2.2.2.1.1.1 e1T1OutputConfigIndex n/a Local index of the E1/T1 output

2.2.2.2.1.1.2 e1T1OutputStateV1 read-write E1/T1 output port enable state. Its

value can be enable (1) or disable
(2). Disabling an output port means
no output is generated for that port.
2.2.2.2.1.1.3 e1T1OutputFrameTypeV1 read-write E1 or T1 output frame type.

Supported frame types include:
1.Freq1544khz (1)
2.Freq2048khz (2)
3.CCS (3)
4.CAS (4)
5.D4 (5)
6.ESF (6)
Default frame type is 2048 kHz.
2.2.2.2.1.1.4 e1T1OutputCRCStateV1 read-write CRC enable state can be enable (1)

or disable (2).
Disabling the CRC means that no
CRC is generated for the SSM.
Table 3-30. e1T1OutputConfig Object Details (Continued)
2.2.2.2.1.1.5 e1T1OutputSSMStateV1 read-write SSM enable state. It can be enable

(1) or disable (2). Disabling the
output SSM means that no SSM is
generated for the specified output
port.
2.2.2.2.1.1.6 e1T1OutputSSMBitV1 read-write SSM Bit position. The value range is

4 to 8. This parameter is only used
for frame types ESF, CCS, or CAS.
2.2.2.2.1.1.7 e1T1OutputZeroSupprV1 read-write The number indicates whether zero

suppression (ZS) on the output port
is enabled or disabled. Valid values
are on (1) or off (2).
Not used for TP5K.
2.2.2.2.1.1.8 e1T1OutputLengthV1 read-write Output cable length. This field is not

used in TP5K.
Set and Retrieve PPS-TOD Port Parameters
Table 3-31. symmPPSTOD MIB Details
2.3.1 ppstodInput n/a
2.3.2 ppstodOutput n/a
2.3.3 ppstodConformance n/a
Set and Retrieve PPS-TOD Input Port Data (ppstodInput)
Table 3-32. ppstodInput Object Details
2.3.1.1 ppstodInputStatus n/a Placeholder for PPS/TOD status
2.3.1.2 ppstodInputConfig n/a The PPS/TOD configuration table
Set PPS-TOD Input Port Parameters (ppstodInputConfig)
Table 3-33. ppstodInputConfig Object Details
2.3.1.2.1 ppstodInputTable n/a The pps-tod configuration

table.
2.3.1.2.1.1 ppstodInputEntry n/a The entry of pps-tod table.
2.3.1.2.1.1.5 ppstodInputCableDelay read-write The input cable delay value.

The valid setting is 0-999999.
Set and Retrieve PPS-TOD Output Parameters (ppstodOutput)
Table 3-34. ppstodOutput MIB Details
2.3.2.1 ppstodOutputStatus Placeholder for PPS/TOD output

status.
2.3.2.2 ppstodOutputConfig Placeholder for PPS/TOD output

config.
Set and Retrieve 10 MHz Port Parameters

Placeholder for future implementation.
Table 3-35. symmCommon10M Object Details
2.4.1 tenMInput n/a
2.4.2 tenMOutput n/a
2.4.3 tenMInOutConformance n/a
Set and Retrieve 1PPS Port Parameters

Table 3-36. symmPPS Object Details
2.5.1 ppsInput n/a
2.5.2 ppsOutput n/a
2.5.3 ppsConformance n/a
Set and Retrieve Output Generation Parameters

(symmOutGen)
Table 3-37. symmOutGen Object Details
2.6.1 outGenStatus n/a
2.6.2 outGenConfig n/a
2.6.3 outGenConformance n/a
Set Output Generation Parameters (outGenConfig)
Table 3-38. outGenConfig Object Details
2.6.2.1 outGenConfigTable n/a Output generation configuration table.

Each table entry specifies port
behavior for each of the four clock
states. Only ports with the following
physical signals are affected by this
output generation table: E1/T1,
1PPS+TOD, 1PPS, and 10 MHz.
Ethernet port signals (PTP, NTP,
SyncE) use quality level parameters to
indicate usability.
2.6.2.1.1 outGenConfigEntry n/a An entry of the output generation

ifIndex.
2.6.2.1.1.1 outGenConfigIndex n/a Local index of the output generation

2.6.2.1.1.2 outGenConfigWarmup read-write Output behavior during clock warm-up

state for the specified port. Values can
be on (1), squelch (2), or AIS (3).
2.6.2.1.1.3 outGenConfigFreerun read-write Output behavior during clock free-run

Table 3-38. outGenConfig Object Details
2.6.2.1.1.4 outGenConfigHoldover read-write Output behavior during clock holdover

2.6.2.1.1.5 outGenConfigFasttrack read-write Output behavior during clock fast-track

Set and Retrieve DTI Port Parameters (symmDTI)

Table 3-39. symmDTI Object Details
2.7.1 dtiStatus n/a
2.7.2 dtiConfig n/a
2.7.3 dtiConformance n/a
Set and Retrieve SyncE Output Port Parameters (symmSyncE)
Table 3-40. symmSyncE Object Details
2.8.1 syncEStatus n/a This is the SyncE status node
2.8.2 syncEConfig n/a This is the SyncE configuration

node
2.8.3 syncEConformance n/a
Retrieve SyncE Port Status (syncEStatus)
Table 3-41. syncEStatus Object Details
2.8.1.1 syncEOutputStatusTable n/a SyncE output status table. It

monitors whether ESMC and QL
are enabled or disabled. SyncE
"output" indicates that the port is
intended as a SyncE clock master
port.
2.8.1.1.1 syncEOutputStatusEntry n/a An entry of the SyncE output status

table. Table index is ifIndex (port
and interface index).
2.8.1.1.1.1 synEOutputStatusIndex n/a Local index of the SyncE output

status table.
2.8.1.1.1.2 syncEOutputEsmcStatus read-only SyncE output port ESMC state. It

can be enable (1) or disable (2). If
ESMC state is disabled, ESMC is
not used.
Table 3-41. syncEStatus Object Details
2.8.1.1.1.3 syncEOutputStatusRxQL read-only Received QL value. This is the

SSM value in the incoming ESMC.
Its value can be actual or "n/a". In
the asynchronous mode the SSM
value is "n/a"
2.8.1.1.1.4 syncEOutputStatusTxQL read-only Transmitted QL value. This is the

SSM value in the outgoing ESMC.
Its value can be actual or "n/a". In
the asynchronous mode the SSM
value is "n/a".
2.8.1.1.1.5 syncEOutputStatusEthMode read-only Ethernet mode can be synchronous

(1) or asynchronous (2).
Asynchronous means the port is
not operating as a SyncE port.
TP5K always operates in the
synchronous mode with optical
SFP. Whenever an electrical SFP is
detected at an Ethernet port, the
port is automatically put into
asynchronous mode.
Set SyncE Port Parameters (syncEConfig)
Table 3-42. syncEConfig Object Details
2.8.2.1 syncEOutputConfigTable n/a SyncE output port configuration

table.
2.8.2.1.1 syncEOutputConfigEntry n/a An entry of the SyncE output

IfIndex (port and interface index).
2.8.2.1.1.1 syncEOutputConfigIndex n/a Local index of the SyncE output

2.8.2.1.1.2 syncEOutputEsmcState read-write SyncE output port ESMC state. It

can be either enable (1) or disable
(2). If ESMC is disabled, ESMC
messages are not sent.
2.8.2.1.1.3 syncEOutputQLState read-write SyncE output port QL state. It can

either enable (1) or disable (2).
2.8.2.1.1.4 syncEOutputQLMode read-write SyncE output port output QL mode.

It can be unidirectional or
bidirectional. In the unidirectional
mode, the outgoing QL value is
independent of the incoming QL
value. In the bidirectional mode, the
outgoing QL value is changed to
DNU if it is the same as the
incoming QL value.
Set and Retrieve Clock Parameters (symmClock)
Table 3-43. symmClock MIB Details
3.1 symmDateAndTime n/a This is the Symmetricom Common

MIB for clock date and time. It has
a status node and a configuration
node.
Set and Retrieve Date and Time (symmDateAndTime)
Table 3-44. symmDateAndTime Object Details
3.1.1 dateAndTimeStatus n/a This is the date and time status

node.
3.1.2 dateAndTimeConfig n/a This is the date and time

configuration node for the specified
hardware module.
3.1.3 dateAndTimeConformance n/a
Retrieve Date and Time Info (dateAndTimeStatus)
Table 3-45. dateAndTimeStatus Object Details
3.1.1.1 symmDateAndTimeTable n/a Date and Time Status Table for

the specified hardware module.
3.1.1.2 symmCurrentDateTime read-only Current UTC date and time
3.1.1.3 symmLeapPendingAndLeapSecond read-only Leap pending information and

leap second.
Retrieve Date and Time Status (symmDateAndTimeTable)
Table 3-46. symmDateAndTimeTable Object Details
3.1.1.1.1 symmDateAndTimeEntry An entry of the date and time status

table. Table index is
entPhysicalIndex (hardware
module index). For TP5K modules
with date and time information are:
IMC.
3.1.1.1.1.1 symmDateAndTimeInfo The clock information for the

specified module.
Set Date and Time Parameters (dateAndTimeConfig)
Table 3-47. dateAndTimeConfig Object Details
3.1.2.1 symmLeapSecondConfig The accumulated leap seconds

between TAI and UTC (in seconds).
3.1.2.2 symmDateTimeConfig The date and time of IMC module.

Format is
YYYY-MM-DD,HH:MM:SS.
Manually entered date and time will
not be accepted when the system is
GNSS mode.
Set and Retrieve Network Parameters (symmNetwork)
Table 3-48. symmNetwork Object Details
4.1 symmCommonNetwork This is the Symmetricom Common MIB for

Ethernet and IP configuration and status. It
has three main nodes:
1.Ethernet configuration
2.IP configuration and status (including
routing and firewall)
3.VLAN configuration
Set and Retrieve Ethernet Parameters
Table 3-49. symmCommonNetwork Object Details
4.1.1 networkEthStatus n/a
4.1.2 networkEthConfig n/a
4.1.3 networkIpConfig n/a
4.1.4. networkVlanConfig n/a
4.1.5 networkConformance n/a
Retrieve Ethernet Network Status (networkEthStatus
Table 3-50. networkEthStatus Object Details
4.1.1.1 networkEthLinkTable n/a Ethernet port link status
4.1.1.1.1 networkEthLinkEntry n/a An entry of the Ethernet port link

status table.
4.1.1.1.1.1 networkEthLinkIndex n/a Local index of the Ethernet port link

table
4.1.1.1.1.2 networkEthLinkSpeed read-only Ethernet port autonegotiation

speed. The defined speeds are
100M, 1000M, or none.
4.1.1.1.1.3 networkEthLinkStatus read-only Ethernet port status, UP or DOWN.
Set Network Ethernet Auto Negotiation Parameters (networkEthConfig)
Table 3-51. networkEthConfig Object Details
4.1.2.1 networkEthAutoNegTable n/a Ethernet port auto-negotiation table

for common network
4.1.2.1.1 networkEthAutoNegEntry n/a An entry of Ethernet port

auto-negotiation table. Table index
is ifIndex (port/interface index).
4.1.2.1.1.1 networkEthAutoNegIndex n/a Local index of the Ethernet port

auto-negotiation table.
4.1.2.1.1.2 networkEthAutoNegState read-write Ethernet port auto-negotiation state

can be enable (1) or disable (2).
4.1.2.1.1.3 networkEthAutoNegSpeed read-write Advertised speed for Ethernet port

auto-negotiation. Its value can be
100M, 1000M, or All.
Set Network IP Parameters (networkIPConfig)
Table 3-52. networkIPConfig Object Details
4.1.3.1 networkIpv4ConfigTable Ethernet port auto-negotiation table for

common network
4.1.3.2 networkIPv4StaticRouteTable The static route table is dynamic; its

number of entries is not fixed. It is
used to read or create a static route for
the specified interface.
4.1.3.3 networkFirewallTable This is the firewall configuration table

for TP5000 external management port
on the main shelf IMC module
4.1.3.4 networkIPv6Config This is a place holder table for IPv6

port configuration
Set Network IPv4 Parameters (networkIPv4ConfigTable)
Table 3-53. networkIPv4ConfigTable Object Details
4.1.3.1.1 networkIPv4ConfigEntry An entry of the IPv4 static route

table. Table index is a double index:
ifIndex and the local index
networkIPv4StaticRouteIndex.
4.1.3.1.1.1 networkIPv4ConfigIndex n/a Local index of the IPv4

Configuration table.
4.1.3.1.1.2 networkIPv4AddressOrigin read-write The origin of this IPv4 address can

be one of the following:
 manual(2) indicates that the

address was manually
configured to a specified
address, e.g., by user
configuration.
 dhcp(4) indicates an address
that was assigned to this
system by a DHCP server.
 linklayer(5) indicates an
address created by IPv6
stateless auto-configuration.
 random(r6) indicates an
address chosen by the system
at random, e.g., an IPv4
address within 169.254/16, or
an RFC 3041 privacy address
See existing object description
4.1.3.1.1.3 networkIPv4Address read-write The IP address to which this entry's

addressing information pertains.
Implementers need to be aware

that if the size ipAddressAddr
exceeds 116 octets, then OIDS of
instances of columns in this row will
have more than 128 sub-identifiers
and cannot be accessed using
SNMPv1, SNMPv2c, or SNMPv3
4.1.3.1.1.4 networkIPv4DefaultRouteAddr read-write The IP address of the default router

represented by this row. The
address type of this object is
specified in symmIPAddressType.
Implementers need to be aware

that if the size of
ipDefaultRouterAddress exceeds
115 octets, then OIDS of instances
of columns in this row will have
more than 128 sub-identifiers and
cannot be accessed using
SNMPv1, SNMPv2c, or SNMPv3.
4.1.3.2.1.5 networkIPv4SubnetMask read-write The mask of an IPv4 interface. The

address format is : xxx.xxx.xxx.xxx.
4.1.3.1.1.6 networkIPv4PortState read-write The IP interface state can be

Enable (1) or Disable (2)
Set Network IPv4 Static Route Table Parameters (networkIPv4StaticRouteTable)
Table 3-54. networkIPv4StaticRouteTable Object Details
4.1.3.2.1 networkIPv4StaticRouteEntry n/a An entry of the IPv4 static route

table. Table index is a double
index: ifIndex and the local
index
networkIPv4StaticRouteIndex.
4.1.3.2.1.1 networkIPv4StaticRouteIndex n/a Local index of the static route

table.
4.1.3.2.1.2 networkIPv4StaticRouteIfIndex read-write IfIndex of the static route table.
4.1.3.2.1.3 networkIPv4StaticDestAddr read-write The destination IP address of

this route. An entry with a value
of 0.0.0.0 is considered a
default route. Multiple routes to
a single destination can appear
in the table, but access to such
multiple entries is dependent on
the table-access mechanisms
defined by the network
management protocol in use.
Table 3-54. (Continued)networkIPv4StaticRouteTable Object Details
4.1.3.2.1.4 networkIPv4StaticRouteMask read-write Indicate the mask to be

logical-ANDed with the
destination address before
being compared to the value in
the ipRouteDest field. For
those systems that do not
support arbitrary subnet masks,
an agent constructs the value of
the ipRouteMask by
determining whether the value
of the correspondent
ipRouteDest field belong to a
class-A, B, or C network, and
then using one of:
mask network
255.0.0.0 class-A
255.255.0.0 class-B
255.255.255.0 class-C
If the value of the ipRouteDest

is 0.0.0.0 (a default route), then
the mask value is also 0.0.0.0.
It should be noted that all IP
routing subsystems implicitly
use this mechanism.
4.1.3.2.1.5 networkIPv4StaticRouteNextHop read-write The IP address of the next hop

of this route. (In the case of a
route bound to an interface
which is realized via a
broadcast media, the value of
this field is the agent's IP
address on that interface.
4.1.3.2.1.6 networkIPv4StaticRouteMetric1 read-write The primary routing metric for

this route. The semantics of
this metric are determined by
the routing-protocol specified in
the route's ipRouteProto value.
If this metric is not used, its
value should be set to -1
Table 3-54. (Continued)networkIPv4StaticRouteTable Object Details
4.1.3.2.1.7 networkIPv4StaticRouteRowStatus read-write The row status of the IPv4 static

route table is used to control
row action. It has six defined
action values:
active(1)', which indicates that
the conceptual row is available
for use by the managed device;
notInService(2)', which
indicates that the conceptual
row exists in the agent, but it is
unavailable for use by the
managed device;
notReady(3)', which indicates

that the conceptual row exists
in the agent, but it does not
have all information necessary
for the row to be available for
use by the managed device;
createAndGo(4)', which is
supplied by a management
station wishing to create a new
instance of a conceptual row
and to have its status
automatically set to active,
making it available for use by
the managed device;
createAndWait(5)', which is
station wishing to create a new
instance of a conceptual row
(but not make it available for
use by managed device); and,
destroy(6)', which is supplied by

a management station wishing
to delete all of the instances
associated with an existing
conceptual row.
Physical Entity Extension MIB
Set Network Firewall Parameters (networkFirewallTable)
Table 3-55. networkFirewallTable Object Details
4.1.3.3.1 networkFirewallEntry n/a An entry of the network firewall

table. Table index is a double index:
ifIndex and the local index
4.1.3.3.1.1 networkFirewallIndex n/a Local index of the port Firewall

table.
4.1.3.3.1.2 networkFirewallICMP read-write Firewall control for ICMP. Value is

Allow (1) or Block (2).
4.1.3.3.1.3 networkFirewallTelnet read-write Firewall control for Telnet. Value is

4.1.3.3.1.4 networkFirewallSSH read-write Firewall control for SSH. Value is

4.1.3.3.1.5 networkFirewallSFTP read-write Firewall control for SFTP. Value is

4.1.3.3.1.6 networkFirewallFTP read-write Firewall control for SNMP. Value is

4.1.3.3.1.7 networkFirewallFTP read-write Firewall control for FTP. Value is

Table 3-56. symmEntPhysicalExtension Object Details
5.1 symmEntityPhysicalExt n/a Physical entity extension from public

ENTITY-MIB (RFC2737). This extension
contains additional information for the
module entry in the ENTITY-MIB.
Table 3-57. symmEntityPhysicalExt Object Details
5.1.1 entPhysticalExtTable n/a An entry of the physical entity

extension table. Each entry is for a
module entry in the ENTITY-MIB
5.1.2 entPhysicalExtConformance n/a This subtree contains conformance

statements for the
symmEntityPhysicalExt MIB
Table 3-58. (entPhysicalExtTable Object Details
5.1.1.1.1 entPhysInService n/a A DateAndTime string containing

information about in-service time
for the module
5.1.1.1.2 entPhyCLEINum n/a The current CLEI number, if one

is assigned
5.1.1.1.3 entPhyFPGAVersion n/a The current FPGA version
5.1.1.1.4 entPhySlot n/a Position of the module in a

chassis
5.1.1.1.5 entPhyCompatiHW n/a The hardware compatibility value
5.1.1.1.6 entPhyCompatiSW n/a The software compatibility value
5.1.1.1.7 entPhyCompatiMtoM n/a The module-to-module

compatibility value
Interface Extentsion MIB
Table 3-59. symmInterfaceExtension Object Details
6.1 symmInterfaceExt n/a Symmetricom Common interface

extension MIB. This extension
contains additional information for
the interface entry in the public
"SNMP MIB-2 Interfaces".
6.1.1 interfaceExtTable n/a Common public interface

extension table.
6.1.2 interfaceExtConformance n/a This subtree contains

conformance statements for the
symmInterfaceExt MIB.
Table 3-60. interfaceExtTable Object Details
6.1.1.1.1 interfaceExtType read-only Description of interface type.

Currently supported interface
types include: E1, T1, DTI, IP,
VLAN, PPS, PPS-TOD, 10M,
Ethernet, GPS, GNSS,
6.1.1.1.2 interfaceExtLayer read-only Description of interface layer in

protocol
6.1.1.1.3 interfaceExtEntityIndex read-only The entity index (module

entPhysicalIndex) associated
with the current interface.
Table 3-60. interfaceExtTable Object Details
6.1.1.1.4 interfaceExtLocalIndex read-only The local interface index for

reference
6.1.1.1.5 interfaceExtSignalDirection read-only Interface clock signal direction. It

can be input (1), output (2), both
(3), or none (4). None means the
interface is disabled. Only
Ethernet and VLAN interfaces
can be "both".
Device Dependent MIBs
Table 3-61. symmDeviceDeptendent Object Details
7.1 tp5000e This MIB is described in

Chapter 4, TP5000e MIB Description.
This chapter describes the structural design of the TP5000e MIB.
In This Chapter
The tp5000e Private MIB is rooted in symmDeviceDependent object of the

Symmetricom directory, as shown below.

>symmSnmpManagement > symmCommonModelV1
>symmDeviceDependent
Figure 4-1 shows the top level objects for the tp5000e Private MIB module and their
respective functions. See Table 4-1 for the functions and details of these objects.

relative to the OID of the symmCommonModelv1 Private MIB
itself, which is: 1.3.6.1.4.1.9070.1.2.5.
Figure 4-1. Hierarchy of tp5000e MIB - Top Level
Table 4-1. tp5000e MIB Details
7.1.1 tp5000eSystemStatus n/a This is the node for TP5000E system

status. It has 5 status tables that are
specific to TP5000E module
hardware:
1.Tp5000e LED status table
2.Tp5000e hardware status table
3.Tp5000e module up-time table
4.Tp5000e module warm-up status
table
5.Tp5000e module status table
7.1.2 tp5000eAlarmAndEvent n/a This is the node for alarms and events
reported by TP5000E system. It has 3
tables: active alarms, active events,
and configuration table for alarms and
events.
7.1.3 tp5000eGlobalConfig n/a This is the node for global

configuration. These objects are
general purpose and are used by the
entire system rather than one specific
function or MIB. It has the following
tables and scalars:
 Log file configuration table
 Remote syslog table
 IOC port redundancy table
 Firmware image table
 System configuration
backup/restore table
 Reboot table
 RADIUS authentication table
 System asset number
 IP address set for intra-
communication
 RADIUS authentication enable
state
7.1.4 tp5000eGlobalService n/a This node contains packet service

selection table. It also contains
scalars for some functions related to
PTP clients.
7.1.5 tp5000ePtpClientMgmt n/a This is a place holder for the

PTPClientManagement node that is
still in the tp5000 MIB.
Table 4-1. tp5000e MIB Details
7.1.6 tp5000eReferenceStatus n/a This node is for reference selection

status for the TP5000E system. It has
one table (input PQL table)
7.1.7 tp5000eRefConfig n/a Node for reference selection

configuration. It has 2 scalars and 1
table.
7.1.8 tp5000eClock n/a This node contains parameters that

are specific to the TP5000E main
shelf and expansion shelf clocks.
7.1.9 tp5000eHardwareHierarchy n/a This node is for the physical

architecture of the system, from
system (stack), shelf (chassis),
container (module), to port and
interface. The physical architecture is
captured with two tables:
tp5000eEntPhysicalTable (module
level) and tp5000eIfTable (port and
interface level).
7.1.10 tp5000eVlanConfiguration n/a This node is for VLAN configuration.

There are 3 tables: non-fixed VLAN
table, fixed VLAN table, and VLAN
mode table.
7.1.11 tp5000eAlarmNofication n/a This node contains the information for

notifications (alarm traps and event
traps) in the TP5000E system
7.1.12 tp5000eConformance n/a This subtree contains conformance

statements for the
TP5000e MIB module.
Retrieve System Status Information
Table 4-2. tp5000eSystemStatus Details
7.1.1.1 tp5000eLedTable n/a This is a table of the front panel LED status
for a specific module. The module can be
IMC, IOC1, IOC2, or an expansion shelf.
7.1.1.2 tp5000eHWStatusTable n/a Table of hardware status for a specified

module (IMC, IOC1, IOC2, or an expansion
shelf). It includes power supply voltage and
other status information for the module
hardware.
7.1.1.3 tp5000eModUpTimeTable n/a Module up time for a specified module

(IMC, IOC2, IOC2, or an expansion shelf.)
7.1.1.4 tp5000eModWarmUpTable n/a Table of warm-up status for a specified

module (IMC, IOC1, IOC2, or an expansion
shelf).
7.1.1.5 tp5000eModStatusTable n/a Table of operating status for a specified

module in the system (IMC, IOC1, IOC2, or
an expansion shelf.)
Retrieve LED Status Information (tp5000eLedTable)
Table 4-3. tp5000eLedTable Details
7.1.1.1.1 tp5000eLedEntry n/a An entry of the LED table contains status for one of
the LEDs in a specified module. This table has a
double index: entPhysicalIndex and tp5000LEDID.
7.1.1.1.1.1 tp5000eLedID read-only LED ID are LED names on the module front panel.
Currently TP5000E system has 14 unique LED
names. Some LED names (ALM and MGMT) are
used on different module types.
IMC LED:
1) BT A (battery terminal A-bus power)
2) BT B (battery terminal B-bus power)
3) SYS (system health)
4) ALM (IMC alarm)
5) GNSS/GPS (GNSS/GPS status)
6) MGMT (Ethernet management port)
IOC LEDs:
7) ACT (active IOC)
8) Alarm (IOC alarm)
9) ETH1 (Ethernet port 1)
10) ETH2 (Ethernet port 2)
11)Holdover (IOC oscillator status)
Expansion shelf LEDs:

13) PWR A (A-bus power)
14) PWR B (B-bus power)
4) ALM (expansion shelf alarm)
6) MGMT (Ethernet management port)
12) REF (reference tracking status)
7.1.1.1.1.2 tp5000eLedStatus read-only LED status can be one of the following:

Off (0)
On (1)
Red (2)
Redblink (3)
Green (4)
Greenblink (5)
Amber (6)
Amberblink (7)
Retrieve Hardware Status Information

(tp5000eHWStatusTable)
Table 4-4. tp5000eHWStatusTable Details
7.1.1.2.1 tp5000eHWStatusEntry n/a An entry of hardware status table. The table

index is entPhysicalIndex.
7.1.1.2.1.1 tp5000eHWStatusIndex n/a Local index of the TP5000E hardware status

table.
Table 4-4. tp5000eHWStatusTable Details (Continued)
7.1.1.2.1.2 tp5000eHWStatusInfo read-only For each module the hardware status

information is DisplayString type and has a
list of hardware status (power supply
voltages, etc.).
Example for IMC:

-48V-A : ok
-48V-B : ok
+1.2V : 1.211V
+1.8V : 1.843V
+2.5V : 2.526V
+5.5V : 5.490V
VCXO : 2.526V
GPS Power : 5.464V
GPS Current : 24mA
GPS Antenna : ok
FPGA : ok
Example for an IOC:

+1.8V : 1.805V
10M EFC : 1.116V
20M EFC : 0.872V
25M EFC : 1.155V
24.5M EFC : 1.155V
24.7M EFC : 1.253V
OSC Current : 173mA
FPGA VCCint : 1.005V
FPGA VCCaux : 2.499V
FPGA Temp : 60C
FPGA Temp High : 61C
FPGA Temp Low : 54C
Example for an Ethernet explosion shelf:

+1.8V : 1.805V
12V : 12.116V
2.5V : 2.572V
1.2V : 1.17V
0.9V : 1.0V
1.0V : 1.1V
5V : 5.01V
1.1A:
1.5A:
2.5A:
1.1B:
1.5B:
Table 4-4. tp5000eHWStatusTable Details (Continued)
7.1.1.2.1.2 tp5000eHWStatusInfo read-only 2.5B:

Temperature : 54C
Example for an E1/TOD expansion shelf:

+1.8V : 1.805V
5 V : 5.016V
2.5 V : 2.520V
1.2 V : 1.1805V
TIM2.5 V : 2.505V
1.0V : 1.053V
TIM1.2V : 1.990V
Retrieve Module Up Time Information

(tp5000eModUpTimeTalbe)
Table 4-5. tp5000eModUpTimeTable Object Details
7.1.1.3.1 tp5000eModUpTimeEntry n/a An entry of the module up time table. The

table index is entPhysicalIndex.
7.1.1.3.1.1 tp5000eModUpTimeIndex n/a Local index of the module up time table.
7.1.1.3.1.2 tp5000eModuleUpTime read-only Module up time status for the module is a

DisplayString type. Example for the IMC:
IMC uptime: 7 days 2 hrs 18 mins
Retrieve Module Warm-up Status Information

(tp5000eModWarmUpTable)
Table 4-6. tp5000eModWarmUpTable Object Details
7.1.1.4.1 tp5000eModWarmUpEntry n/a An entry of the module warm-up status

table. The table index is
entPhysicalIndex.
7.1.1.4.1.1 tp5000eModWarmUpIndex n/a Local index of the module warm-up status

table.
7.1.1.4.1.2 tp5000eModWarmUpStatus read-only Module warm-up status for the module is

a DisplayString type. Example for an IOC:
IOC1 warmup status: complete (total

1651 secs)
Retrieve Module Operating Status Information

(tp5000eModStatusTable)
Table 4-7. tp5000eModStatusTable Object Details
7.1.1.5.1 tp5000eModStatusEntry n/a An entry of the module operating status table.

The table index is entPhysicalIndex.
Table 4-7. tp5000eModStatusTable Object Details (Continued)
7.1.1.5.1.1 tp5000eModStatusIndex n/a Local index of the module general status

table.
7.1.1.5.1.2 tp5000eModStatusInfo read-only A list of operating status parameters for the

module.
Example for the main shelf status information:

System name: TP5000
IMC time: 2010-03-08 20:33:30
IMC uptime: 7 days 2 hrs 18 mins
IOC1 warmup status: complete (total 1651 secs)
IOC1 state: active
IOC1 uptime: 7 days 2 hrs 18 mins
IOC2 warmup status: n/a
IOC2 state: card not present
IOC2 uptime: card not present
Reference mode: time
Current reference input: GPS
Phase offset: 0 ns
Clock status: normal track
PTP mode eth1: multicast grandmaster
PTP mode eth2: multicast grandmaster
Active alarms: 1
Exp connections: 1,3,6,9
Example for an Ethernet expansion shelf status

information:
Expansion shelf: PTP-SyncE
Shelf time: 2010-03-08 20:33:30
Shelf uptime: 7 days 2 hrs 18 mins
Phase Offset: 0 ns
Main Clock status: normal track
Shelf clock status: normal track
Combined Clock status: normal track
PTP mode: multicast grandmaster
SyncE output PQL: 2
Example of an E1/TOD expansion shelf status

information:
Expansion shelf: E1-TOD
shelf time : 2010-03-08 20:33:30
shelf uptime : 7 days 2 hrs 18 mins
Phase offset : 0 ns
Main clock status: normal track
Shelf clock status: normal track
Combined clock status: normal track
E1 output PQL: 2
Retrieve Alarm and Event Information
Table 4-8. tp5000eAlarmAndEvent Object Details
7.1.2.1 tp5000eActAlarmTable n/a List of alarms that are still active in the
TP5000E system.
7.1.2.2 tp5000eActEventTable n/a List of events that are still active in the
TP5000E system.
7.1.2.3 tp5000eActConfigTable n/a The alarm configuration table. Each

alarm is defined by five alarm
configuration parameters: alarm ID,
alarm severity level, delay time, enable
state, and a description
7.1.2.4 tp5000eNumofStandingAlarm read-only The total number of currently active

alarms in the TP5000E system,
including those generated by the
expansion shelves.
7.1.2.5 tp5000eMessageGenerate read-write This flag is used to generate all

TP5000E alarm and event messages
with this one action. The messages are
sent to the alarm and event logs. This
feature is used for testing purposes. For
a message that specifies a port, only
one message is generated instead of
generating a message for each possible
port.
This object is actually write-only, but

SNMP does not have a write-only.
Retrieve List of Active Alarms (tp5000eActAlarmTable)
Table 4-9. tp5000eActAlarmTable Object Details
7.1.2.1.1 tp5000eActAlarmEntry n/a Entry for one active alarm in the active
alarm table. The table index is the local
index.
7.1.2.1.1.1 tp5000eActAlarmIndex read-only The access (local) index of the active

alarm table. The range of the table
index is 1 to 500.
7.1.2.1.1.2 tp5000eActAlarmModID read-only Name of the hardware module that

generated this active alarm. In
TP5000E system, the module name
can be one of the following: SYS, IMC,
IOC1, IOC2, IO, Exp0, Exp1, ..., Exp9.
The module ID is only used to show the

module name of a physical entity, but it
is never used as an index. Indexing is
done using entPhysicalIndex.
7.1.2.1.1.3 tp5000eActAlarmID read-only The alarm ID uniquely identifies an

alarm type. All alarm IDs are listed and
described in the User Guide.
7.1.2.1.1.4 tp5000eActAlarmInternalIndex read-only A secondary index to further identify

alarm details. See User Guide
7.1.2.1.1.5 tp5000eActAlarmDateTime read-only The date and time stamp for this active
alarm. It is the time when the alarm was
reported.
7.1.2.1.1.6 tp5000eActAlarmSeverity read-only The alarm severity level can be one of

the following:
 critical(2) = critical condition
 major(3) = error condition
 minor (4) = warning condition
 event (5) = normal but significant
condition
7.1.2.1.1.7 tp5000eActAlarmDesc read-only A description for the alarm. For a

complete description of all alarms,
please see the User Guide.
Retrieve List of Active Events (tp5000eActEventTable)
Table 4-10. tp5000eActEventTable Object Details
7.1.2.2.1 tp5000eActEventEntry n/a An entry for one active event in the

active event table. The table index is
the local index.
7.1.2.2.1.1 tp5000eActEventIndex read-only The access (local) index of the active

event table. The range of the table
index is 1 to 500.
7.1.2.2.1.2 tp5000eActEventModID read-only The name of the hardware module

that reported the event. Module ID can
be one of the following: SYS, IMC,
IOC1, IOC2, or Exp0, Exp1, ..., Exp9.
The module ID is only used to show

the module name of a physical entity,
but it is never used as an index.
Indexing is done using entPhysical
Index.
7.1.2.2.1.3 tp5000eActEventID read-only The event ID uniquely identifies an

event type. All event IDs are listed and
described in the User Guide.
7.1.2.2.1.4 tp5000eActEventInternalIndex read-only See alarm second indes in Appendix

A of TP5000 User’s Guide.
7.1.2.2.1.5 tp5000eActEventDateTime read-only The date and time stamp for this
active event. It is the time when the
event was reported.
7.1.2.2.1.6 tp5000eActEventDesc read-only A description for the event. For a

complete description of all events,
please see the User Guide.
Retrieve Alarm Configuration Information
Table 4-11. tp5000eAlarmConfigTable Object Details
7.1.2.3.1 tp5000eAlarmConfigEntry n/a Entries of the alarm configuration table.

Table index is a local index.
7.1.2.3.1.1 tp5000eAlarmConfigIndex read-only The index of the alarm configuration table.

The range of the table index is 1 to 500.
7.1.2.3.1.2 tp5000eAlarmConfigAID read-only Alarm ID. The alarm definition for each
alarm ID is defined in the User Guide.
7.1.2.3.1.3 tp5000eAlarmLevelSetting read-only The alarm severity level can be one of the
following:
2 critical = critical condition

3 major = error condition
4 minor = warning condition
5 event = normal but significant condition
7.1.2.3.1.4 tp5000eAlarmSettingDelay read-only Alarm delay in seconds. The alarm is not

reported if the alarm condition disappears
before this delay time is up. The purpose
of the alarm delay to prevent reporting
intermittent conditions. The range of the
alarm delay is 0 to 84,600 seconds.
Default value is 0.
7.1.2.3.1.5 tp5000eEnableAlarmState read-only Alarm state control flag. The flag can be
enable (1) or disable (2). The default
value is enable. If an alarm is disabled,
the system will never report conditions
associated with this alarm.
7.1.2.3.1.6 tp5000eAlarmConfigDesc read-only Alarm description (from hard-coded alarm

definition table).
Retrieve Global Configuration Information
Table 4-12. tp5000eGlobalConfig Object Details
7.1.3.1 tp5000eLogFileConfigTable n/a The log file table is used to configure the
sizes of various log files. There are four
log files: alarm log, event log, command
log, and security log.
7.1.3.2 tp5000eRemoteSyslogTable n/a Remote syslog file control table. It is

used to configure a remote syslog server
to receive log messages from TP5000K
system. Only one remote syslog server
is supported at this time.
7.1.3.3 tp5000eRedundTable n/a The port redundancy table for IOC

modules. Currently, the system is
hard-coded for card redundancy. The
only redundancy selection is whether to
enable port redundancy within a module
(port bonding).
7.1.3.4 tp5000eImageTable n/a Firmware image information for the

selected module (IMC, IOC1, IOC2, or
an expansion shelf). In TP5000E each
module can store two firmware images.
the image that is selected as the active
image will be used when the module is
booted up next time. Two images are
used in upgrading or downgrading.
Image downloading is done through CLI
only.
7.1.3.5 tp5000eRebootTable n/a The action to reboot a specified module

(IMC, IOC1, IOC2, or an expansion
shelf).
7.1.3.6 tp5000eAuthRADIUSTable n/a This table contains IP addresses and

access keys for the Radius
authentication server. Radius enable
state is set in tp5000eRadiusState
outside of this table.
7.1.3.7 tp5000eAssetNum read-write User-assigned inventory asset number

for the system.
Table 4-12. tp5000eGlobalConfig Object Details
7.1.3.8 tp5000eIntraCommIPSet read-write Intra-communication IP set between

IMC, IOCs and expansion shelves. Value
can be class A (1), B (2), C (3). Their
ranges are:
A: IP address range 10.0.250.8 to
10.0.250.47
B: IP address range 172.16.250.8 to
172.16.250.47
C: IP address range 192.168.250.8 to
192.168.250.47
The selected address set cannot be

used for external Ethernet ports in this
TP5000 system. Therefore choose a set
that does not conflict with the external
network configuration.
After the value is changed, IMC and IOC

or expansion shelves will establish a new
connection in 1 to 2 minutes.
7.1.3.9 tp5000eRadiusState read-write The RADIUS state can be either enable

(1) or disable (2). Use
tp5000eAuthRadiusTable to configure
access to the Radius server.
Retrieve Log File Information (tp5000eLogFileConfigTable)
Table 4-13. tp5000eLogFileConfigTable Object Details
7.1.3.1.1 tp5000eLogFileConfigEntry n/a An entry of the log file configuration table.

Table index is the local index.
7.1.3.1.1.1 tp5000eLogFileConfigIndex read-only The local index of the log file configuration
table.
7.1.3.1.1.2 tp5000eLogFileTypeName read-only The log file name can be one of the
following: Alarm, Event, Command, or
Security.
All alarm measures go into the alarm log.

All event messages go into the event log.
All user-entered commands are recorded
in the command log, except those
commands related to user login and
logout. All user login and logout
commands are stored in the security log.
7.1.3.1.1.3 tp5000eLogFileBufferSize read-write The size for the specified log file. Log file
size is specified in unit of Kbytes. The
default and the maximum size is 100 KB
per log.
Retrieve Remote Syslog Information

(tp5000eRemoteSyslogTable)
Table 4-14. tp5000eRemoteSyslogTable Object Details
7.1.3.2.1 tp5000eRemoteSyslogEntry n/a An entry of the remote syslog file control

table.
7.1.3.2.1.1 tp5000eRemoteSyslogIndex read-only The local index of the remote syslog file
control table. At this time, only the index
value of 1 is supported.
7.1.3.2.1.2 tp5000eRemoteSyslogState read-write The remote syslog state control. The

setting can be either enable (1) or
disable (2). Once this is set to enable, all
TP5000E log messages (intended for
any of the four built-in logs) will be sent
to the remote syslog server.
7.1.3.2.1.3 tp5000eRemoteSyslogAddr read-write The IP address of the remote syslog

machine. The format is xxx.xxx.xxx.xxx
Retrieve Redundancy Information for IOC Modules

(tp5000eRedundTable)
Table 4-15. tp5000eRedundTable Object Details
7.1.3.3.1 tp5000eRedundEntry n/a An entry of the IOC port redundancy

table. Table index is module index.
7.1.3.3.1.1 tp5000eRedundModuleID read-only The module ID can be either IOC1 or

IOC2. The system is currently hard-coded
for card redundancy (if two IOC cards are
present, they are always configured as a
redundancy pair, with one active and one
on standby). Whichever module ID is
used to access this table, the
configuration will apply to both IOC cards.
In the future, when the two IOC cards can
be independent, configuration will only
apply to the current IOC module.
7.1.3.3.1.2 tp5000eRedundModState read-write Port redundancy state can be either

enable (1) or disable (2). When it is
enabled, the two Ethernet ports on the
specified IOC module will form a bonded
pair. When two ports are bonded, they
share the same IP address, but only one
port is active; the other port is in standby
mode.
7.1.3.3.1.3 tp5000eRedundActivePort read-write The port ID of the active port on an IOC

module. The active port ID is either eth1
(1) or eth2 (2). This object can be used to
set the desired port to be the active port;
the other port automatically becomes the
standby port.
Retrieve Firmware Image Information (tp5000eImageTable)
Table 4-16. tp5000eImageTable Object Details
7.1.3.4.1 tp5000eImageEntry n/a Entry of the firmware image table. Each entry
contains objects of each module-s image
information. The image table index is the
entPhysicalIndex.
7.1.3.4.1.1 tp5000eImageIndex n/a Local index of the firmware image table
7.1.3.4.1.2 tp5000eImageNextBoot read-write This field indicates whether the board will be
booted from this firmware image next time.
Values can be either "yes" or "no". Only one
of the images can be selected for next boot.
The field for the other image is automatically
updated accordingly.
7.1.3.4.1.3 tp5000eImageID read-only For each module there are up to two images.
The range of image ID is 1 and 2.
7.1.3.4.1.4 tp5000eImageCurrState read-only The current state of whether an image is

active or not. The value is either yes or no.
7.1.3.4.1.5 tp5000eImageInfoMsg read-only The information message for an image.
Reboot a Specified Module (tp5000eRebootTable)
Table 4-17. tp5000eRebootTable Object Details
7.1.3.5.1 tp5000eRebootEntry n/a An entry contains objects of the module’s

reboot information. The table index is
entPhysicalIndex.
7.1.3.5.1.1 to5000eRebootIndex n/a Local index of the module reboot table.
7.1.3.5.1.2 tp5000eRebootAction read-write The action to reboot the module. Value is either
apply (1) or nonapply (2).
The active firmware image is used when the

module is rebooted. Use tp5000eImageTable to
select the active image.
Retrieve Radius Authentication Server Information

(tp5000eAuthRADIUSTable)
Table 4-18. tp5000eAuthRADIUSTable Object Details
7.1.3.6.1 tp5000eAuthRADIUSEntry n/a An entry of the RADIUS table.
7.1.3.6.1.1 tp5000eAuthRADIUSIndex n/a A local index to the RADIUS table.
Currently, the system only supports

RADIUS index value of 1.
7.1.3.6.1.2 tp5000eServerRADIUSIPAddress read-write The RADIUS server’s IP address

format for IPv4 address.is
xxx.xxx.xxx.xxx
An IP address cannot be set up if
authRADIUS key value is none.
7.1.3.6.1.3 tp5000eAuthRADIUSKey read-write Authentication key for RADIUS

server access.
Retrieve Packet Service Information
Table 4-19. tp5000eGlobalService Object Details
7.1.4.1 tp5000ePacketServiceTable n/a This table defines packet service for

the specified Ethernet interface on
the IOC (main shelf). Currently, this
table only applies to the main shelf
IOC ports (Eth1 and Eth2); the
Ethernet expansion shelves are
currently fixed to provide “PTP
grandmaster over Ethernet”.
7.1.4.2 tp5000eSSMOptionTable n/a This is the table for selecting SSM

network option for a specified shelf
(IOC or expansion shelf). Main shelf
and expansion shelves can each
have its own selection of SSM
network options.
7.1.4.3 tp5000ePtpClientDataTableLock n/a The ptpClientDataTableLock will

control the internal semaphore to
lock or unlock the
ptpClientDataTable. The table must
be locked before it can be read.
When the ptpClientDataTable is
locked, the data in the table will not
change. The ptpClientDataTable can
be set up to be locked or to be
unlocked. When the locked signal is
issued, the internal semaphore will
be increased and start to lock the
ptpClientDataTable. When the
unlocked signal is issued, the
internal semaphore will be
decreased. When the semaphore
reaches zero (0), the
ptpClientDataTable will be unlocked.
Retrieve Packet Service Information on IOC

(tp5000ePacketServiceTable)
Table 4-20. tp5000ePacketServiceTable Object Details
7.1.4.1.1 tp5000ePacketServiceEntry n/a An entry of the packet service table.

Table index is ifIndex (index for
interfaces and ports). The system is
currently hard-coded for card
redundancy (if two IOC cards are
present, they are always configured as
a redundancy pair, with one active and
one on standby).
Regardless of which IOC card’s ifIndex

is used, the configuration will apply to
both IOC cards. In the future when the
two IOC cards can be independent,
configuration will only apply to the IOC
module with the current ifIndex.
7.1.4.1.1.1 tp5000ePacketServiceIndex n/a Local index of the packet service

selection table.
7.1.4.1.1.2 tp5000ePacketServiceMode read-write The packet service for this port. Value
can be PTP Grandmast (1), NTP server
(2), NTP probe (3), or PTP probe (4).
Note: packet service selection is done

for each port, and the two Ethernet ports
on the IOC can have different services.
7.1.4.1.1.3 tp5000ePtpv2ClientDisc read-write The clock ID of the PTP client that is to

be disconnected on this port. At this
time only clients in the main shelf PTP
client list can be disconnected.
Retrieve SSM Network Selection Information

(tp5000eSSMOptionTable)
Table 4-21. tp5000eSSMOptionTable Object Details
7.1.4.2.1 tp5000eSSMOptionEntry n/a An entry of the SSM option table. Table

index is entPhysicalIndex.
7.1.4.2.1.1 tp5000eSSMOptionIndex n/a Local index of the SSM option selection

table.
7.1.4.2.1.2 tp5000eSSMOption read-write Network option for SSM can be option 1 (1)
or option 2 (2). Option 1 is for E1-based
network. Option 2 is for DS1-based
network. ITU-T G.781 and G.8265.1
specifies different SSM (QL) values for
option 1 and option 2 networks.
Retrieve Reference Selection Status Information
Retrieve Reference Selection Status Information
Table 4-22. tp5000eReferenceStatus Object Details
7.1.6.1 tp5000eInputPQLTable n/a Status table for a specified reference input.

PQL (priority quality level) is reference quality
used internal by the TP5000E system. Input
SSM and other reference quality indicators
are first mapped to PQL, and further
processing is carried out using PQL.
7.1.6.2 tp5000eSymmMetrics n/a Place-holder for Symmetricom metrics

sub-tree.
Retrieve Reference Input Status Information

(tp5000eInputPQLEntry)
Table 4-23. tp5000eInputPQLTable Object Details
7.1.6.1.1 tp5000eInputPQLEntry n/a An entry of the reference input status

table. Index of the table is ifIndex.
7.1.6.1.1.1 tp5000eInputRefName read-only The name of the reference. Currently

supported references are GNSS, GPS,
1PPS+TOD1, 1PPS+TOD2, Span input 1,
and Span input 2.
7.1.6.1.1.2 tp5000eInputRefActualPQL read-only This PQL value either corresponds to the

actual SSM value in the reference (when
SSM is available) or the default PQL
value for the reference.
7.1.6.1.1.3 tp5000eInputRefQualified read-only This is the selection status for the

reference. Its value is one of the following:
disabled, disqualified, qualified, or
selected.
Retrieve Reference Selection Configuration Information
Table 4-24. tp5000eRefConfig Object Details
7.1.7.1 tp5000eRefTimingMode read-write The timing mode of the entire TP5000E

system, and it can be either time (1) or
frequency (2). Whether the system is in
time or frequency mode affects how time
and frequency references are used in
reference selection. A time reference
has both frequency and time-of-day
(TOD) information and can be used for
both time and frequency
synchronization.
Examples of time references are GNSS,
GPS, 1PPT+TOD, and PTP. A frequency
reference does not have TOD
information and can be used only for
frequency synchronization. Examples of
frequency references are 2048 kHz,
2048 kbps, 1544 kHz, 1544 kbps,
SyncE, and 10MHz.
7.1.7.2 tp5000eRefSelectionCriteria read-write Reference selection criteria applies to

the entire TP5000E system, and it can
be priority-based (2) of SSM-based (2).
Manual mode (1) is currently not
supported. References are assigned
priorities and PQL values, either by
default or by user input. PQL values
used to relate only to SSM values of
E1/T1/SyncE signals, but now PQl also
covers time signals such as GNSS,
GPS, and 1PPS+TOD.
For a mapping of currently supported
references, please see the User Guide.
7.1.7.3 tp5000eRefConfigTable n/a The reference configuration table is used

to configure reference selection
parameters for a specified reference
input. Configuration parameters include
reference name, reference enable state,
reference priority, reference PQL enable
state, and user-configured PQL value.
PQL is reference quality used internally
by the TP5000E system. Input SSM and
other reference quality indicators are first
mapped to PQL and further processing
is carried out using PQL.
Retrieve Reference Configuration Information

(tp5000eRefConfigTable)
Table 4-25. tp5000eRefConfigTable Object Details
7.1.7.3.1 tp5000eRefConfigEnt n/a An entry of the reference configuration table.

ry Table index is the ifIndex (port index).
7.1.7.3.1.1 tp5000eRefName read-only Name of the reference. Examples: GNSS,

GPS, E1, 1PPS+TOD
7.1.7.3.1.2 tp5000eRefState read-write Reference input state can be either enable (1)
or disable (2). Only enabled references are
used in reference selection.
7.1.7.3.1.3 tp5000eRefPriority read-write Priority value assigned to a reference. Its range

is 1 to 16. It is used as one of the selection
criteria for reference selection.
7.1.7.3.1.4 tp5000eRefPQLState read-write The PQL state of a reference can be either

enable (1) or disable (2). If PQL is enabled for a
reference, the actual PQL value that the
system uses either corresponds to the
reference SSM value (when SSM is available)
or is the default PQL value (when SSM is not
available). If the PQL is disabled, the actual
PQL value that the system uses matches the
user-configured reference PQL value
(tp5000eRefPQL).
7.1.7.3.1.5 tp5000eRefPQL read-write Configured reference PQL value.
Its range is 1 to 9, with 1 indicating the highest

quality level. this PQL value is used when the
reference PQL state is disabled, meaning
“don’t use the PQl that comes with the
reference but use this value.” This value, along
with disabling the PQL state, is used to override
the input PQL value.
Retrieve Clock Information
Table 4-26. tp5000eClock Object Details
7.1.8.1 tp5000eClockStatus n/a Clock status for a specified shelf.
7.1.8.2 tp5000eClockConfig n/a Clock configuration mode.
It only applies to the main system clock in the

main shelf IOC module. Clocks in expansion
shelves are “slave” clocks.
Retrieve Clock Status Information (tp5000eClockStatus)
Table 4-27. tp5000eClockStatus Object Details
7.1.8.1.1 tp5000eClockStatusTable n/a This table contains status information for

the clock in each shelf.
7.1.8.1.1.1 tp5000eClockStatusEntry n/a An entry in the Clock Status Table. Table

index is entPhysicalIndex (a shelf or
module).
7.1.8.1.1.1.1 tp5000eClockStatusIndex n/a Local index of the module clock status

table.
7.1.8.1.1.1.2 tp5000eServoControlStat read-only The clock servo status of clock module

us (IOC or expansion). This status is also
called clock status in CLI. For expansion
shelves, the clock status is the combined
status of the cascaded main shelf clock
and the expansion shelf clock. The clock
status can be one of the following:
(1) Warm-up
(2) Free-run
(3) Fast-track
(4) Normal track
(5) Holdover
(6) Bridging
(7) Fail
(8) Offline
(9) Extended holdover
(10) Local free-run
(11) Local holdover
7.1.8.1.1.1.3 tp5000ePhaseOffset read-only This is the phase offset in ns between the

reference output. This is applicable only
when the selected reference is a time
reference.
Retrieve Clock Configuration Information

(tp5000eClockConfig)
Table 4-28. tp5000eClockConfig Object Details
7.1.8.2.1 tp5000eBridgingTime read-write Bridging time in seconds. Bridging is a clock

state between normal tracking and holdover.
When all references are lost, the clock declares
that it is going into holdover after the bridging
time has elapsed. During bridging the clock
maintains its specification for tracking.
7.1.8.2.2 tp5000eAutoSync read-write The auto-sync state can be either enable (1) or
disable (2). Auto-sync allows IOC time and IMC
time to synchronize when IOC in time mode
passed warm-up. If auto-sync is disabled, an
alarm will be generated when IOC and IMC
times are not synchronized. Use tp5000eSync
to remove this alarm condition.
7.1.8.2.3 tp5000eSync read-write This object is used to force system time and
phase to synchronize to the selected reference
(synchronize between IMC and IOC). This
object is write-only, and the value must be
“now”.
Retrieve Hardware Hierarchy Information
Table 4-29. tp5000eHardwareHierarchy Object Details
7.1.9.1 tp5000eIfTable n/a This table describes physical hierarchy of

TP5000E system down to the individual
logical interface, which can be a physical
interface (like GPS port) or a virtual
interface (like VLANs at an Ethernet port).
7.1.9.2 tp5000eEntPhysicalTable n/a This table describes physical hierarchy of

TP5000K system down to the module
(container) level.
Retrieve Physical Hierarchy Information  Individual -level

tp5000elfTable)
Table 4-30. tp5000eIfTable Object Details
7.1.9.1.1 tp5000eIfEntry n/a An entry of the TP5000E interface table. Table

index is ifIndex.
7.1.9.1.1.1 tp5000eIfIndex read-only Local index of this table
7.1.9.1.1.2 tp5000eIfModuleID read-only Module ID is the name of the physical module.

Its value can be IMC (1), IOC1 (2), IOC2 (3),
IO (4), exp0, (5), ..., exp9 (14).
Module ID is only used to show the name of a

physical module. it is not used as an index or
sorting key.
7.1.9.1.1.3 tp5000eIfPortID read-write The current inventory port ID. The range
depends on the module ID and P/N index that
together uniquely identify port configuration for
each module.
Example: range for IOC port ID is {I,2}, and

range for E1 expansion shelf is {1 ... 28}.
7.1.9.1.1.4 tp5000eIfForeignIndex read-only The current interface index from ifTable. Each
local index is mapped to a corresponding
index in the ifTable.
Retrieve Physical Hierarchy Information  Module-level

(tp5000eEntPhysicalEntryTable)
Table 4-31. tp5000eEntPhysicalTable Object Details
7.1.9.2.1 tp5000eEntPhysicalEntry n/a An entry of the TP5000E physical

entity table. Each entry uniquely
identifies the connector
configuration (a module may have
multiple versions with different
connectors).
7.1.9.2.1.1 tp5000eEntPhysicalIndex read-only Local index of the TP5000E

physical entity table.
7.1.9.2.1.2 tp5000eEntPhysicalModuleID read-only Module ID is the name of the

physical module. Its value can be
IMC (1), IOC1 (2), IOC2 (3), IO (4),
exp0 (5), ..., exp9 (14).
module ID is only used to show the

name of a physical module. it is not
used as an index or sorting key.
7.1.9.2.1.3 tp5000eEntPhysicalStackID read-only Stack ID is the ID of the TP5000E

system that the current module
resides in. Stack ID is currently
hard-coded to 1, and NMS needs to
use other means (such as IP
address) to identify each TP5000E
system.
7.1.9.2.1.4 tp5000eEntPhysicalChassisID read-only Chassis ID is the equipment shelf

ID. In TP5000E system there is one
main shelf (chassis ID = 1) and up
to ten expansion shelves (chassis
ID range of 2 to 11).
Table 4-31. tp5000eEntPhysicalTable Object Details (Continued)
7.1.9.2.1.5 tp5000eEntPhysicalPartIndex read-only Part number index uniquely

identifies the connector
configuration of a given module
type. Currently there are four
versions of IMC, and the valid part
number index value for IMC are
IMC-1 (1), IMC-2 (2), IMC-3 (3), and
IMC-4 (4). IOC only has two
versions (Rb or Qz), and the valid
part number index values for IOC
are IOC-Rb (1) and IOC-Qz (2).
There are four versions of I/O
module and therefore the range of
the I/O module part number index is
{1...4}. Each type of expansion shelf
currently does not have multiple
versions, so their valid part number
index value is only 1 at this time.
7.1.9.2.1.6 tp5000eEntPhysicalTableIndex read-only Each entry (module) in this table is

mapped to an entity index in the
entityPhysicalTable in the
Entity-MIB.
Retrieve VLAN Configuration Information
Table 4-32. tp5000eVlanConfiguration Object Details
7.1.10.1 tp5000eNonfixedVlanTable n/a In the non-fixed VLAN table, VLANs can

be added or removed. As a VLAN is added
or removed, the table index is updated.
The non-fixed VLAN table can hold 484
VLANs (with IfIndex 17 to 500).
7.1.10.2 tp5000eFixedVlanTable n/a In the fixed VLAN table, VLANs are

pre-assigned to the VLAN table index.
They cannot be added or removed from
the table.
7.1.10.3 tp5000eVlanModeTable n/a VLAN mode table. The VLAN mode table
is used to enable or disable all VLANs in a
physical port.
Retrieve Non-fixed VLAN Information

(tp5000eVlanNonfixedVlanTable)
Table 4-33. tp5000eNonfixedVlanTable Object Details
7.1.10.1.1 tp5000eVlanNonfixedVlanEntry n/a An entry of the non-fixed VLAN

table. Table index is the local
index, but each entry uniquely
identifies a VLAN through the
IfIndex.
7.1.10.1.1.1 tp5000eNonfixedVlanIndex n/a Local index of the non-fixed

VLAN table.
7.1.10.1.1.2 tp5000eNonfixedVlanIfIndex read-only IfIndex of the current non-fixed

VLAN (17 to 500).
Table 4-33. tp5000eNonfixedVlanTable Object Details (Continued)
7.1.10.1.1.3 tp5000eNonfixedVlanModID read-change Module ID is the name of the

physical module (the inventory
module ID), in which the
current non-fixed VLAN is
defined. Module ID is the name
of the physical module. Its
value can be one of the
following: IMC (1), IOC1 (2),
IOC2 (3), IO (4), exp0 (5), ...,
exp9 (14).
Module ID is only used to show

the name of a physical module.
It is not used as an index or
sorting key.
7.1.10.1.1.4 tp5000eNonfixedVlanPortID read-change Physical port ID, where the

current non-fixed VLAN is
defined. The range depends on
the module ID and P/N index,
which together uniquely identify
port configuration for each
module. Example: range for
IOC port ID is {1, 2}, and range
for E1 expansion shelf is {1 ...
28}.
7.1.10.1.1.5 tp5000eNonfixedVlanID read-change The VLAN ID of the current

VLAN interface.
The range is 0~4094. If a VLAN

ID is set to 0, the associated
VLAN interface of this VLAN
index will be removed from the
internal VLAN table. THe
default VLAN ID of each VLAN
interface in the VLAN table is 0.
The VLAN ID can be set up
only once. The VLAN ID and
VLAN Priority must be
configured at the same time
when a VLAN interface row is
added. Once a VLAN ID is
defined, it cannot be modified.
To change it, set the VLAN ID
to 0 (deleting the VLAN from
the VLAN table) and create a
new VLAN row.
7.1.10.1.1.6 tp5000eNonfixedVlanPriority read-change The priority of the VLAN ID.

The range is 0 to 7. VLAN
priority and VLAN ID must be
configured at the same time
when a VLAN interface row is
added. Once a VLAN priority is
defined, it cannot be modified.
To change it, set the VLAN ID
to 0 (deleting the VLAN from
the VLAN table) and create a
new VLAN row.
7.1.10.1.1.7 tp5000eNonfixedVlanIPv4Addr read-change The IPv4 address to which this

entry’s addressing information
pertains.
Implementers need to be
aware that if the size of
ipAddressAddr exceeds 116
octets, OIDs of instances of
columns in this row will have
more than 128 sub-identifiers
and cannot be accessed using
SNMPv1, SNMPv2c, or
SNMPv3.
7.1.10.1.1.8 tp5000eNonfixedVlanNetmask read-change The mask of an IPv4 interface.

The address format is
xxx.xxx.xxx.xxx
7.1.10.1.1.9 tp5000eNonfixedVlanState read-change This is the state of an individual

non-fixed VLAN. Value can be
Enable (1) or Disable (2).
Setting an individual VLAN
state to Enable is not enough
for the VLAN to become active.
The physical VLAN mode must
also be set to Enable (see
tp5000eVlanModeTable).
7.1.10.1.1.10 tp5000eNonfixedVlanRowStatus read-change The row status of non-fixed

VLAN table is used to control
row actions. The status column
has six defined actions
(values):
 ‘active(1)’ indicates that the
conceptual row is available
for use by the managed
device;
 ‘nonInService(2)’ indicates
that the conceptual row
exists in the agent, but is
unavailable for use by the
managed device;
 ‘notReady(3)’ indicates that
the conceptual row exists
in the agent, but is missing
information necessary in
order to be available for
use by the managed
device;
 ‘createAndGo(4)’ is
station wishing to create a
new instance of a
conceptual row and to have
its status automatically set
to active, making it
available for use by the
managed device;
 ‘createAndWait(5)’ is
station wishing to create a
new instance of a
conceptual row (but not
make it available for use by
the managed device); and
 ‘destroy(6)’ is supplied by a
management station
wishing to delete all of the
instances associated with
an existing conceptual row.
Retrieve Fixed VLAN Information

(tp5000eVlanFixedVlanTable)
Table 4-34. tp5000eFixedVlanTable Object Details
7.1.10.2.1 tp5000eVlanFixedVlanEntry n/a An entry of the fixed VLAN table. Table

index is ifIndex and local index.
7.1.10.2.1.1 tp5000eFixedVlanIndex n/a Local index of the fixed VLAN table.
7.1.10.2.1.2 tp5000eFixedVlanID read-write The VLAN ID of the current VLAN

interface. The range if 0~4094.
If a VLAN ID is set to 0, the associated

VLAN interface of this VLAN index will
be removed from the internal VLAN
table. The default VLAN ID of each
VLAN interface in the VLAN table is 0.
The VLAN ID can be set up only once.

The VLAN ID and VLAN Priority must
be configured at the same time when a
VLAN interface row is added. Once a
VLAN ID is defined, it cannot be
modified. To change it, set the VLAN ID
to 0, deleting the VLAN from the VLAN
table, and create a new VLAN row.
7.1.10.2.1.3 tp5000eFixedVlanPriority read-write The priority of the VLAN ID. The range
is 0 to 7. VLAN priority and VLAN ID
must be configured at the same time
when a VLAN interface row is added.
Once a VLAN priority is defined, it
cannot be modified. To change it, set
the VLAN ID to 0 (deleting the VLAN
from the VLAN table), and create a
new VLAN row.
7.1.10.2.1.4 tp5000eFixedVlanIPv4Addr read-write The IPv4 address to which this entry’s

addressing information pertains.
Implementers needs to be aware that if

the size of ipAddressAddr exceeds 116
octets, OIDs of instance of columns in
this row will have more than 128
sub-identifiers and cannot be accessed
using SNMPv1, SNMPv2c, or
SNMPv3.
Table 4-34. tp5000eFixedVlanTable Object Details (Continued)
7.1.10.2.1.5 tp5000eFixedVlanNetmask n/a The mask of an IPv4 interface. The

address format is xxx.xxx.xxx.xxx
7.1.10.2.1.6 tp5000eFixedVlanGateway n/a The gateway of an IPv4 interface. The

address format is xxx.xxx.xxx.xxx
7.1.10.2.1.7 tp5000eFixedVlanState n/a This is the state of an individual fixed

VLAN. Value can be Enable (1) or
Disable (2). Setting an individual VLAN
state to Enable is not enough for the
VLAN to become active. The physical
port VLAN mode must also be set to
Enable (see tp5000eVlanModeTable).
Retrieve VLAN Mode Information (tp5000eVlanModeTable)
Table 4-35. tp5000eVlanModeTable Object Details
7.1.10.3.1 tp5000eVlanModeEntry n/a An entry of the VLAN mode table. Table

index is ifIndex (port and interface index)
and local index.
7.1.10.3.1.1 tp5000eVlanModeIndex n/a Local index of the VLAN mode table.
7.1.10.3.1.2 tp5000eVlanmodeModuleID n/a Module ID is the name of the physical

module (the inventory module ID) in
which the current VLAN is defined.
MOdule ID is the name of the physical
module. Its value can be one of the
following: IMC (1), IOC1 (2), IOC2 (3),
IO (4), exp0 (5), ..., exp9 (14).
Module ID is only used to show the

name of a physical module. It is not used
as an index or sorting key.
7.1.10.3.1.3 tp5000eVlanPortID n/a Physical port ID where the current VLAN

is defined.
7.1.10.3.1.4 tp5000eVlanModeValue n/a VLAN mode for the specified physical

port. Value can be Enable (1) or Disable
(2). This parameter can enable or
disable all VLANs in this physical port,
but setting the physical port VLAN mode
to ENable is not enough for an individual
VLAN to become active. That individual
VLAN must also be enabled (see
tp5000eVlanNonfixedVlanPortState and
tp5000eVlanFixedVlanPortState).
Retrieve Alarm Notification Information
Table 4-36. tp5000eAlarmNofication Object Details
7.1.11.1 tp5000eNotifyElements n/a Definitions (names) of the OIDs in the traps.
7.1.11.2 tp5000eTrapAlarm n/a TimeProvider5000 alarm trap for the current

notification.
It contains the OIDs and values for module

ID, event ID, notify index, severity, transient,
date and time, severity, descriptions, and
sequence number. OID names are defined in
tp5000eNotifyElements
7.1.11.3 tp5000eTrapEvent n/a TimeProvider 5000 event trap for the current
notification. It contains the OIDs and values
for module ID, event ID, notify index, severity,
transient, date and time, severity,
descriptions, and sequence number. OID
names are defined in
tp5000eNotifyElements.
7.1.11.4 tp5000eClientNotificatio n/a TimeProvider5000 PTP client trap for the

n current client notification. It contains the OID
and value for alarm ID, index, severity,
transient, date and time and descriptions,
client IP address, client clock ID, and
sequence number. OID names are defined in
tp5000eNotifyElements.
7.1.11.5 tp5000ePtpMgmtEvent n/a
Retrieve Definitions in the Traps (tp5000eNotifyModuleID)
Table 4-37. tp5000eNotifyElements Object Details
7.1.11.1.1 tp5000eNotifyModuleID read-only Module ID is the name of the physical

module that generated the notification.
7.1.11.1.2 tp5000eNotifyAlarmEventID read-only The alarm or event ID of the notification.
7.1.11.1.3 tp5000eNotifyIndex read-only Internal alarm index for a notification.
7.1.11.1.4 tp5000eNotifySeverity read-only Alarm severity:

0: clear alarm or event
2: critical alarm (set, if non-transient)
3: major alarm (set, if non-transient)
4: minor alarm (set, if non-transient)
5: report event (set, if non-transient)
7.1.11.1.5 tp5000eNotifyTransient read-only The transient state of an alarm or event.

It is either a state event (non-transient) or
a transient event (transient).
7.1.11.1.6 tp5000eNotifyDateTime read-only Date and time of the notification.
7.1.11.1.7 tp5000eNotifyDescription read-only Description of this alarm or event (from

the TP5000 internal alarm/event
definition table).
7.1.11.1.8 tp5000eNotifyClientAddr read-only The IPv4 address of TP5000’s PTP client

that generated the notification.
7.1.11.1.9 tp5000eNotifySequenceNum read-only The sequence number of a notification.

Each notification OID (tp5000TrapAlarm,
tp5000TrapEvent, and
tp5000ClientNotification) has an
independently incrementing sequence
number. These are reset when the IMC
is rebooted.
7.1.11.1.10 tp5000eNotifyClockID read-only Clock ID of the TP5000’s PTP client that

generated the notification.
This chapter describes the structural design of the tp5000 MIB.
In This Chapter
 Retrieving PTP Client Data
 Managing PTP Clients
 Administering SNMP
 Alarms and Events
The tp5000 Private MIB is rooted in symmTSD object of the Symmetricom directory,
as shown below.

>symmSnmpManagement > symmTSD
Table 5-1 shows the top level objects for the tp5000 Private MIB module and their
respective functions.

relative to the OID of the symmTSD Private MIB itself, which is:
1.3.6.1.4.1.9070.1.2.4.
Table 5-1. tp5000 MIB Details
6.1 inventory not used
6.2 status not used
6.3 configuration not used
6.4 ptpClientManagement
6.5 administration
6.6 alarmevent
6.7 tp5000Conformance not used
Retrieving PTP Client Data
Table 5-2. ptpClientManagement Object Details
6.4.1 ptpNodeInfo n/a
6.4.2 ptpNodeControl n/a
Table 5-3. ptpNodeInfo Object Details
6.4.1.1 ptpNodeTable n/a The PTP node table will define node
address (IP) and identifier (VLAN
ID). These will be used in querying
accMasterTable, NodeStatusTable,
nodeClockDescTable and
nodeNullMgmtTable.
6.4.1.2 ptpNodeReserved read-only This variable is designed to separate

tables.
6.4.1.3 ioc11NodeStatusTable n/a The ptp node status table. It will

provide the ptp node status info of
the client(slave) on ioc and port1.
The requested IP address and vlan
id of client node is pre-defined in
ptpNodeTable .
6.4.1.4 ioc11NodeStatusReserved read-only This variable is designed to separate

tables.
6.4.1.5 ioc12NodeStatusTable n/a
6.4.1.6 ioc12NodeStatusReserved read-only This variable is designed to separate

tables.
6.4.1.7 ioc11NodeClockDescTable n/a
Table 5-3. ptpNodeInfo Object Details
6.4.1.8 ioc11NodeClockDescReserved read-only This variable is designed to separate

tables.
6.4.1.9 ioc12NodeClockDescTable n/a The clock description table of ptp

node(client) on ioc and port2. The
requested IP address and vlan id of
client node is pre-defined in
ptpNodeTable .
6.4.1.10 ioc12NodeClockDescReserved read-only This variable is designed to separate

tables.
6.4.1.11 ioc11NodeNullMgmtTable n/a The null management table of ptp

node(client) on ioc and port1. The
ptpNodeTable .
6.4.1.12 ioc11NodeNullMgmtReserved read-only This variable is designed to separate

tables.
6.4.1.13 ioc12NodeNullMgmtTable n/a The null management table of ptp

node(client) on and port2. The
ptpNodeTable .
6.4.1.14 ioc12NodeNullMgmtReserved read-only This variable is designed to separate

tables.
6.4.1.15 accMasterTable n/a The ptp node acc-master table with

assigned IP.
6.4.1.16 accMasterReserved read-only This variable is designed to separate

tables.
6.4.1.17 singleClientDataInfoEth1 read-only This variable returns information on

a single client by using the IP
address set in ptpNodeTable.
6.4.1.18 singleClientDataInfoEth2 read-only This variable returns information on

a single client by using the IP
address set in ptpNodeTable.
6.4.1.19 lastReserved read-only This variable is designed to separate

tables.
Retrieve PTP Client Info
Table 5-4. ptpNodeTable Object Details
6.4.1.1.1 ptpNodeEntry n/a This is an entry in the ptp node table.
6.4.1.1.1.1 ptpNodeIndex n/a A unique value for each ptp node

entry.
6.4.1.1.1.2 ptpNodeModuleID read-only The module ID should be one of

ioc1(3) or ioc2(4). The value is
read-only
6.4.1.1.1.3 ptpNodePortID read-only Port ID (ethernet port ID) on board. It

should be one of eth1(1) or eth2(2).
6.4.1.1.1.4 ptpNodeIPAddr read-only The assigned IP address for ptp

node. This IP address will be applied
to ptpnodeACCMasterTable,
iocXXnodeStatusTable,
iocXXnodeClockDescTable,
iocXXnodeNullMGMTable. The format
should be xxx.xxx.xxx.xxx
6.4.1.1.1.5 ptpNodeVlanid read-only PTP node (client) VLAN ID. The valid
range should be 0~4094. This vlan id
will be applied to
ptpnodeACCMasterTable,
iocXXnodeStatusTable,
iocXXnodeClockDescTable,
iocXXnodeNullMGMTable. The value
should be 0 if no VLAN is being used.
Retrieve IOC Node PTP Client Status
Retrieve IOC1 - Node1 PTP Client Status
Table 5-5. ioc11NodeStatusTable Object Details
6.4.1.3.1 ioc11NodeStatusEntry n/a The ptp node status table on ioc and
port1.
6.4.1.3.1.1 ioc11NodeStatusIndex n/a The index of ptp node status table with
the assigned IP on ioc and port1.
6.4.1.3.1.2 ioc11NodeStatusName read-only The status name (status item

description) of the ptp client with the
assigned IP on ioc and port1.
6.4.1.3.1.3 ioc11NodeStatusValue read-only The status item value of the ptp client
with the assigned IP on ioc and port1.
6.4.1.3.1.4 ioc11NodeStatusId read-only The status item Id of the ptp client with
the assigned IP on ioc and port1. The
status id is 0 if there is no valid status
id.
Retrieve IOC1 - Node2 PTP Client Status
Table 5-6. ioc11NodeStatusTable Object Details
6.4.1.5.1 ioc12NodeStatusEntry n/a The ptp node status table on ioc and
port2.
6.4.1.5.1.1 ioc12NodeStatusIndex n/a The index of ptp node status table with
the assigned IP on ioc and port2.
6.4.1.5.1.2 ioc12NodeStatusName read-only The status name (status item

description) of the ptp client with the
assigned IP on ioc and port2
6.4.1.5.1.3 ioc12NodeStatusValue read-only The status item value of the ptp client
6.4.1.5.1.4 ioc12NodeStatusId read-only The status item Id of the ptp client with
the assigned IP on ioc and port1. The
status id is 0 if there is no valid status
id.
Retrieve IOC Client Clock Descriptions
Retrieve IOC1 - Node1 PTP Client Clock Description
Table 5-7. ioc11NodeClockDescTable Object Details
6.4.1.7.1 ioc11NodeClockDescEntry n/a The ptp node clock description table

on ioc and port1.
6.4.1.7.1.1 ioc11NodeClockDescIndex n/a The index of clock description table

6.4.1.7.1.2 ioc11NodeClockDescName read-only The clock description name of the ptp

client with the assigned IP on ioc and
port1.
6.4.1.7.1.3 ioc11NodeClockDescValue read-only The clock description value of the ptp

port1.
Retrieve IOC1 - Node2 PTP Client Clock Description
Table 5-8. ioc12NodeClockDescTable Object Details
6.4.1.9.1 ioc12NodeClockDescEntry n/a The ptp node clock description table

on ioc and port2.
6.4.1.9.1.1 ioc12NodeClockDescIndex n/a The index of clock description table

6.4.1.9.1.2 ioc12NodeClockDescName read-only The clock description name of the ptp

port2.
6.4.1.9.1.3 ioc12NodeClockDescValue read-only The clock description value of the ptp

port2.
Retrieve IOC PTP Client Null Management Info
Retrieve IOC1 - Node1 PTP Client Null Management Info
Table 5-9. ioc11NodeNullMgmtTable Object Details
6.4.1.11.1 ioc11NodeNullMgmtEntry n/a The ptp node null management table

on ioc and port1.
6.4.1.11.1.1 ioc11NodeNullMgmtIndex n/a The index of the null management

table with assigned IP on ioc and
port1.
6.4.1.11.1.2 ioc11NodeNullMgmtInfo read-only The null info of the ptp client with the
assigned IP on ioc and port1.
Retrieve IOC1 - Node1 PTP Client Null Management Info
Table 5-10. ioc12NodeNullMgmtTable Object Details
6.4.1.13.1 ioc12NodeNullMgmtEntry n/a The ptp node ack management table

on ioc and port2.
6.4.1.13.1.1 ioc12NodeNullMgmtIndex n/a The index of the null management

table with assigned IP on ioc and
port2.
6.4.1.13.1.2 ioc12NodeNullMgmtInfo read-only The null info of the ptp client with the
assigned IP on ioc and port2
Retrieve Acceptable Master Info
Table 5-11. accMasterTable Object Details
6.4.1.15.1 accMasterEntry n/a The ptp node acc-master table.
6.4.1.15.1.1 accMasterIndex n/a The index of ptp node acc-master

table.
6.4.1.15.1.2 accMasterModuleID read-only The module ID should be one of

read-only.
6.4.1.15.1.3 accMasterPortID read-only Port ID (ethernet port ID) on board. It

6.4.1.15.1.4 accPtpNodeIPAddr read-only The assigned IP address for ptp

node(client). This IP address is
pre-defined in ptpNodeTable in
same portID and moduleID row .
6.4.1.15.1.5 accPtpNodeVlanid read-only PTP node (client) vlan id. The valid
range should be 0~4094. This vlan
id is pre-defined in ptpNodeTable in
same portID and moduleID row.
6.4.1.15.1.6 accPtpNodeClockID read-only PTP node (client) Clock ID. The

valid format should be
xx:xx:xx:xx:xx:xx:xx:xx
6.4.1.15.1.7 accMaster1IPAddress read-only The address of the master1 in the

ptp client under the assigned IP.
6.4.1.15.1.8 accMaster1Priority1 read-only The ptp node master1's priority1

under the assigned IP.
6.4.1.15.1.9 accMaster2IPAdress read-only The address of the master2 in the

ptp client under the assigned IP.
6.4.1.15.1.10 accMaster2Priority1 read-only The ptp node master2's priority1

under the assigned IP.
Managing PTP Clients
Table 5-12. ptpNodeControl Object Details
6.4.2.1 accMasterSetupTable n/a The acceptable master table to setup

ptp client acceptable master.
6.4.2.2 upgradeClientFirmwareTable n/a The table will be used to upgrade the

ptp client firmware.
6.4.2.3 rebootClientTable n/a This table will be used to reboot a ptp

client.
Configure Acceptable Master Setup
Table 5-13. accMasterSetupTable Object Details
6.4.2.1.1 accMasterSetupEntry n/a This is an entry in the acceptable

master table.
6.4.2.1.1.1 accMasterSetupIndex n/a A unique value for each acceptable

master entry.
6.4.2.1.1.2 accMasterSetupModuleID read-only The module ID should be one of

ioc1(3) or ioc2(4).
6.4.2.1.1.3 accMasterSetupPortID read-only Port ID (ethernet port ID) on board. It

6.4.2.1.1.4 accMasterSetupCMD read-write Setup the acceptable master table by

the following command string
(write-only):
client-ip-address,vlanid,
gm1_ip_address,gm1_priority,gm2_ip
_address,gm2_priority
For example:
192.168.1.9,200,192.168.1.11,2,192.1
68.1.12,1
The vlanid range is 0~4095. Zero(0)

means no vlan id
Upgrade Client Firmware
Table 5-14. upgradeClientFirmwareTable Object Details
6.4.2.2.1 upgradeClientFirmwareEntry n/a This is an entry in the upgrade ptp

client firmware table.
6.4.2.2.1.1 upgradeClientFirmwareIndex n/a A unique value for each upgrade

client firmware entry.
6.4.2.2.1.2 upgradeClientFirmwareModuleID read-only The module ID should be one of

read-only.
6.4.2.2.1.3 upgradeClientFirmwarePortID read-only Port ID (ethernet port ID) on board.

It should be one of eth1(1) or
eth2(2).
6.4.2.2.1.4 upgradeClientFirmwareCMD read-only The ptp client upgrade server info.

This entry is write-only. The
server info format:
client-ip-address vlanid file-path
[sftp|ftp]:server-ip-address
user-name password
For example:
192.168.1.9 200
/tmp/client_firmware
sftp:192.168.1.20 user-1
my-password
The vlanid range is 0~4095.
Zero(0) means no vlan id
Reboot Clients
Table 5-15. rebootClientTable Object Details
6.4.2.3.1 rebootClientEntry n/a This is an entry in the reboot ptp

client table.
6.4.2.3.1.1 rebootClientIndex n/a A unique value for each reboot ptp

client entry.
6.4.2.3.1.2 rebootClientModuleID read-only The module ID should be one of

read-only.
Table 5-15. rebootClientTable Object Details
6.4.2.3.1.3 rebootClientPortID read-only Port ID (ethernet port ID) on board. It

6.4.2.3.1.4 rebootClientCMD read-only The reboot the specified ptp client.

This entry is write-only. The server
info format: client-ip-address,vlanid
For example: 192.168.1.9,2
The vlanid range is 0~4095. Zero(0)
means no vlan id
Administering SNMP
Administering SNMP
Table 5-16. accMasterEntry Object Details
6.5.1.15.1.1 trapVersion read-write Setup the trap version to SNMP

agent. The valid setting should be
v2c(1) and v3(2).
6.5.1.15.1.2 snmpV2State read-write Setup the trap version to SNMP

agent. The valid setting should be
v2c(1) and v3(2).
6.5.1.15.1.3 radius n/a not used
6.5.1.15.1.4 boardConfiguration n/a not used
6.5.1.15.1.5 reboot n/a not used
6.5.1.15.1.6 imageActive n/a not used
6.5.1.15.1.7 cliUserTable n/a not used
6.5.1.15.1.8 snmpUserTable n/a This table is used to display the valid

SNMP V3 user info. All SNMP V3
users except trap users should be
defined in this table. This table's row
only can be added or deleted. The
existing row can not be modified.
6.5.1.15.1.9 snmpManagerTable n/a This table is used to display SNMP

manager info, such as managerID,
EngineID, manager IP addresses,
etc. This table's row only can be
added or deleted. The existing row
can not be modified.
Administering SNMP
Table 5-16. accMasterEntry Object Details
6.5.1.15.1.10 trapUserTable n/a Trap/Notification user setup. The trap

user name should be only for SNMP
v3 notification. This table's row only
can be added or deleted. The existing
row can not be modified.
6.5.1.15.1.11 snmpv2CommunityTable n/a This table is used to display the valid

SNMPv2 community info. All
SNMPv2's community should be
defined
in this table. This table's row only can
be added or deleted. The existing row
can not be modified.
Administering SNMP
Manage SNMP Users
Table 5-17. snmpUserTable Object Details
6.5.8.1 snmpUserEntry n/a This is an entry in the SNMP V3 user

table. It contains username, user type,
and keys.
6.5.8.1.1 snmpUserIndex n/a A unique value for each user entry.

This value ranges should be from 1 to
10.
6.5.8.1.2 snmpUserName read-write SNMP V3 user name. The max length

of SNMP V3 user name is 20
characters. Only alphanumeric
characters and chars {- , _} are
acceptable. Leading characters can't
be (- or _).
6.5.8.1.3 snmpUserType read-write SNMP V3 User type is defined as the

follow types:
1--snmpNoauth,
2--snmpmd5,
3--snmpsha,
4--snmpmd5des,
5--snmpmd5aes,
6--snmpshades,
7--snmpshaaes
6.5.8.1.4 snmpAuthKey read-write SNMP V3 user authentication key.

Only chars {a-z,A-Z,0-9, ! ( ) - _ . ? ~ *
@ ^ + = : / %} are acceptable.
Minimum key length is 8 chars.
Administering SNMP
6.5.8.1.5 snmpPrivatekey read-write Private key of SNMP V3 user. Only

chars {a-z,A-Z,0-9, ! ( ) - _ . ? ~ * @ ^
+ = : / %} are acceptable. Minimum
key length is 8 chars.
6.5.8.1.6 snmpUserRowStatus read-write The row status of SNMP user table to

control row actions. It has the
following actions:
The status column has six defined

values:
active(1), which indicates that the

conceptual row is available for use by
the managed device;
notInService(2), which indicates that

the conceptual row exists in the agent,
but is unavailable for use by the
managed device (see NOTE below);
notReady(3), which indicates that the

conceptual row exists in the agent, but
is missing information necessary in
order to be available for use by the
managed device;
createAndGo(4), which is supplied by

a management station wishing to
create a new instance of a conceptual
row and to have its status
automatically set to active, making it
available for use by the managed
device;
createAndWait(5)', which is supplied

by a management station wishing to
create a new instance of a conceptual
row (but not make it available for use
by the managed device); and,
destroy(6)', which is supplied by a

management station wishing to delete
all of the instances associated with an
existing conceptual row.
Administering SNMP
Set SNMP Manager
6.5.9.1 snmpManagerEntry n/a This is an entry in the Manager table.
6.5.9.1.1 snmpManagerIndex n/a A unique value for each user entry.

5.
6.5.9.1.2 snmpManagerID read-write SNMP manager ID or name which is

used for SNMP v2 or v3 trap or
notification.
6.5.9.1.3 snmpManagerAddress read-write SNMP manager IP address. The

format should be xxx.xxx.xxx.xxx
Administering SNMP
6.5.9.1.4 snmpManagerEngineID read-write The SNMP management engineID.

The format should be
0xDDDDDDDDDDDDDDDD, and
minimum length is 14 and maximum
length is 32 (including 0x as prefix).
6.5.9.1.5 snmpManagerRowStatus read-write The row status of SNMP manager

table to control row actions. It has the
following actions:
The status column has six defined values:

conceptual row is available for use by the
managed device;
notInService(2), which indicates that the

conceptual row exists in the agent, but is
unavailable for use by the managed
device (see NOTE below);

missing information necessary in order to
be available for use by the managed
device;
createAndGo(4), which is supplied by a

management station wishing to create a
new instance of a conceptual row and to
have its status automatically set to active,
making it available for use by the managed
device;
createAndWait(5)', which is supplied by a

new instance of a conceptual row (but not
make it available for use by the managed
device); and,

management station wishing to delete all
of the instances associated with an
Administering SNMP
Manage SNMP Trap Users
Table 5-19. trapUserTable Object Details
6.5.10.1 trapUserEntry n/a Trap/Notification setup entry.
6.5.10.1.1 trapUserIndex n/a A unique value for trapTable entry.

10.
6.5.10.1.2 trapUserName read-write The trap user name. The max length
of trap user name is 20 characters.
Only alphanumeric characters and
chars {- , _} are acceptable. Leading
characters can't be (- or _).
6.5.10.1.3 trapUserType read-write Trap User type is defined as the

follow types:
1--snmpNoauth,
2--snmpmd5,
3--snmpsha,
4--snmpmd5des,
5--snmpmd5aes,
6--snmpshades,
7--snmpshaaes
6.5.10.1.4 trapAuthKey read-write Trap user authentication key. The max

length is 32 characters. Only chars
{a-z,A-Z,0-9, ! ( ) - _ . ? ~ * @ ^ + = : /
%} are acceptable. Minimum key
length is 8 chars.
Administering SNMP
Table 5-19. trapUserTable Object Details
6.5.10.1.5 trapPrivatekey read-write Trap user's private key. The max

length is 32 characters. Only chars
{a-z,A-Z,0-9, ! ( ) - _ . ? ~ * @ ^ + = : /
%} are acceptable. Minimum key
length is 8 chars.
6.5.10.1.6 trapUserRowStatus read-write Trap User Row Status to control row

actions. It has the following actions:
The status column has six defined values:

managed device;


device;

device;

device); and,

Administering SNMP
Manage SNMPv2 Community Table
Table 5-20. snmpv2CommunityTable Object Details
6.5.11.1 snmpv2CommunityEntry n/a This is an entry in the community

table.It contains community name and
access level.
6.5.11.1.1 snmpv2Index n/a A unique value for each user entry.

The range of index should be 1 to 10
6.5.11.1.2 snmpv2CommunityName read-write SNMPv2 community name. The max

length of v2-community is 20
characters. Only alphanumeric
characters and chars {- , _} are
acceptable. Leading characters can't
be (- or _).
Administering SNMP
Table 5-20. snmpv2CommunityTable Object Details
6.5.11.1.3 snmpv2AccessLevel read-write The number represents the access

level.
The snmpv2 access level:
read(1) (status group),

readWrite(2) (status, configuration
group).
6.5.11.1.4 snmpv2UserRowStatus read-write The row status of SNMP user table to

control row actions. The status column has
six defined values:

managed device;


device;

device;

device); and,

Alarms and Events
Alarms and Events
Table 5-21. rebootClientEntry Object Details
6.6.1 notifyElements n/a
6.6.2 tp5000TrapAlarm n/a TimeProvider 5000 alarm trap

object which specifies module ID,
alarm ID, Index, severity,
transient, date and time, severity
and descriptions, sequence
number.
6.6.3 tp5000TrapEvent n/a TimeProvider 5000 event trap

object which specifies module ID,
event ID, Index, severity,
transient, date and time, severity
and descriptions, sequence
number.
6.6.4 tp5000ClientNotification n/a TimeProvider 5000 client trap

object which specifies alarm ID,
index, severity, transient, date
and time and descriptions, client
ip address, sequence number.
6.6.5 tp5000MgmtEvent n/a TimeProvider 5000 client trap

object which specifies alarm ID,
index, severity, transient, date
and time and descriptions, client
clock Id, sequence number.
Alarms and Events

TP5000 - SNMP - UG - 098 00385 000 Rev A

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TP5000 - SNMP - UG - 098 00385 000 Rev A

Uploaded by

Copyright:

Available Formats

TimeProvider 5000 SNMP Agent

Copyright © 2011 Symmetricom, Inc.

All product names, service marks, trademarks, and registered trademarks

Purpose of This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Chapter 2 Public MIB Details for TP 5000

Chapter 3 symmCommonModelV1 MIB Description

Chapter 4 TP5000e MIB Description

Retrieve Global Configuration Information . . . . . . . . . . . . . . . . . . . . . . . . . . .118

Chapter 5 TP5000 MIB Description

Administering SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161

3-24 symmE1T1 MIB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68

4-6 tp5000eModWarmUpTable Object Details . . . . . . . . . . . . . . . . . . . . . . . . . 111

5-12 ptpNodeControl Object Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157

Purpose of This Guide

Structure of This Guide

This user guide contains the following chapters and appendixes:

Chapter, Title Description

Chapter 1, Overview Provides an overview of the TP 5000 SNMP

Conventions Used in This Guide

This guide uses the following conventions:

When text appears

Symmetricom Product Document The title of a document.

CRITICAL An operating mode, alarm state, status, or chassis

Press Enter A named keyboard key.

Username: Text in a source file or a system prompt or other text

ping A command you enter at a system prompt or text

qualified personnel A word or term being emphasized.

Symmetricom does not A word or term given special emphasis.

Warnings, Cautions, Recommendations, and Notes

Warnings, Cautions, Recommendations, and Notes attract attention to essential or

Warning: To avoid serious personal injury or death, do not disregard

Caution: To avoid personal injury, do not disregard cautions. All

ESD Caution: To avoid personal injury and electrostatic discharge

Electrical Shock Caution: To avoid electrical shock and possible

Recommendation: All recommendations use this symbol.

Related Documents and Information

Where to Find Answers to Product and Document

What’s New In This Guide

User’s Guide Updates

Manual updates are available by logging in to Telecom Solutions Support at:

This chapter provides introductory information about .

Simple Network Management Protocol (SNMP) is an application-layer protocol that

The SNMP framework is made up of three parts:

2. getNext — Retrieves the next object variable, which is a lexicographical

MIBs and RFCs

Figure 1-2. Hierarchy of Symmetricom Private MIBs for TimeProvider 5000

Figure 1-3. Top Level Hierarchy of tp5000e Private MIB

Supported Versions of SNMP

The TP 5000 device firmware supports the following versions of SNMP:

 SNMPv2c — The community string-based Administrative Framework for

The security features provided in SNMPv3 are as follows:

SNMPv2c uses a community-based form of security. The community of SNMP

SNMPv2c support includes a detailed error message reporting to management

Table 1-1. SNMP Security Models and Levels

Model Level Authentication Encryption Description

v2 noAuthNoPriv Community string No Uses a community string

v3 noAuthNoPriv Username No Uses a username match for

v3 authNoPriv Message Digest 5 No Provides authentication based

v3 authPriv MD5 or SHA Data Encryption Provides authentication based

A Network Management System (NMS) accesses the TP 5000 system configuration

 Physical structure of the system.

Figure 2-1. Publlic MIBs Used In TP 5000

Figure 2-2. Diagram of TP 5000 Hardware Hierarchy