-
Notifications
You must be signed in to change notification settings - Fork 11
/
PTPBASE-MIB.txt
5710 lines (4744 loc) · 168 KB
/
PTPBASE-MIB.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
PTPBASE-MIB DEFINITIONS ::= BEGIN
IMPORTS
enterprises,
MODULE-IDENTITY,
OBJECT-TYPE,
NOTIFICATION-TYPE,
Counter32,
Counter64,
Gauge32,
Integer32,
Unsigned32
FROM SNMPv2-SMI
TruthValue,
DisplayString,
TEXTUAL-CONVENTION
FROM SNMPv2-TC
InterfaceIndexOrZero
FROM IF-MIB
InetAddress,
InetAddressType
FROM INET-ADDRESS-MIB
OBJECT-GROUP,
NOTIFICATION-GROUP,
MODULE-COMPLIANCE
FROM SNMPv2-CONF;
ptpbaseMIB MODULE-IDENTITY
LAST-UPDATED "201510272300Z" -- Oct 27, 2015 11:00:00 PM
ORGANIZATION "TICTOC Working Group, PTPd project"
CONTACT-INFO
"WG Email: [email protected]
Vinay Shankarkumar
Cisco Systems,
Email: [email protected]
Laurent Montini,
Cisco Systems,
Email: [email protected]
Tim Frost,
Symmetricom Inc.,
Email: [email protected]
Greg Dowd,
Symmetricom Inc.,
Email: [email protected]
Wojciech Owczarek
PTPd project,
Email: [email protected]"
DESCRIPTION
"The MIB module for PTP version 2 (IEEE Std. 1588(TM)-2008)
Overview of PTP version 2 (IEEE Std. 1588(TM)-2008)
[IEEE 1588-2008] defines a protocol enabling precise
synchronization of clocks in measurement and control systems
implemented with packet-based networks, the Precision Time
Protocol Version 2 (PTPv2). This MIB does not address the
earlier version IEEE Std. 1588(TM)-2002 (PTPv1). The protocol
is applicable to network elements communicating using IP. The
protocol enables heterogeneous systems that include clocks of
various inherent precision, resolution, and stability to
synchronize to a grandmaster clock.
The protocol supports system-wide synchronization accuracy in
the sub-microsecond range with minimal network and local clock
computing resources. [IEEE 1588-2008] uses UDP/IP or
Ethernet and can be adapted to other mappings. It includes
formal mechanisms for message extensions, higher sampling rates,
correction for asymmetry, a clock type to reduce error
accumulation in large topologies, and specifications on how to
incorporate the resulting additional data into the
synchronization protocol. The [IEEE 1588-2008] defines
conformance and management capability also.
MIB description
This MIB is to support the Precision Time Protocol version 2
(PTPv2, hereafter designated as PTP) features of network element
system devices, when using the default PTP profile described in
[IEEE 1588-2008], or the Telecom Profile described in
[G.8265.1], when running over the IP network layer.
This MIB is based on the TICTOC-PTPBASE-MIB from 2012, with
added enhancements such as GM address, Offset from Master as
string, Mean Path Delay as string, parent IP address, and a set
of PTP traps.
It is envisioned this MIB will complement other managed objects
to be defined to monitor, measure the performance of the PTP
devices and telecom clocks.
Some other PTP profiles have their own MIBs defined as part of
the profile, and this MIB is not intended to replace those MIBs.
Acronyms:
ARB Arbitrary Timescale
E2E End-to-End
EUI Extended Unique Identifier.
GPS Global Positioning System
IANA Internet Assigned Numbers Authority
IP Internet Protocol
MAC Media Access Control
according to [IEEE 802.3-2008]
NIST National Institute of Standards and Technology
NTP Network Time Protocol (see IETF [RFC 5905])
OUI Organizational Unique Identifier
(allocated by the IEEE)
P2P Peer-to-Peer
PTP Precision Time Protocol
TAI International Atomic Time
TC Transparent Clock
UDP User Datagram Protocol
UTC Coordinated Universal Time
References:
[IEEE 1588-2008] IEEE Standard for A Precision Clock
Synchronization Protocol for Networked Measurement and
Control Systems, IEEE Std. 1588(TM)-2008, 24 July 2008.
[G.8265.1] Precision Time Protocol Telecom Profile for
Frequency Synchronization, ITU-T Recommendation G.8265.1,
October 2010.
As defined in [IEEE 1588-2008]:
Accuracy:
The mean of the time or frequency error between the clock under
test and a perfect reference clock, over an ensemble of
measurements. Stability is a measure of how the mean varies
with respect to variables such as time, temperature, and so on,
while the precision is a measure of the deviation of the error
from the mean.
Atomic process:
A process is atomic if the values of all inputs to the process
are not permitted to change until all of the results of the
process are instantiated, and the outputs of the process are
not visible to other processes until the processing of each
output is complete.
Boundary clock:
A clock that has multiple Precision Time Protocol (PTP) ports in
a domain and maintains the timescale used in the domain. It
may serve as the source of time, i.e., be a master clock, and
may synchronize to another clock, i.e., be a slave clock.
Boundary node clock:
A clock that has multiple Precision Time Protocol(PTP) ports in
a domain and maintains the timescale used in the domain. It
differs from a boundary clock in that the clock roles can
change.
Clock:
A node participating in the Precision Time Protocol (PTP) that
is capable of providing a measurement of the passage of time
since a defined epoch.
Domain:
A logical grouping of clocks that synchronize to each other
using the protocol, but that are not necessarily synchronized
to clocks in another domain.
End-to-end transparent clock:
A transparent clock that supports the use of the end-to-end
delay measurement mechanism between slave clocks and the master
clock. Each node must measure the residence time of PTP event
messages and accumulate it in Correction Field.
Epoch:
The origin of a timescale.
Event:
An abstraction of the mechanism by which signals or conditions
are generated and represented.
Foreign master:
An ordinary or boundary clock sending Announce messages to
another clock that is not the current master recognized by the
other clock.
Grandmaster clock:
Within a domain, a clock that is the ultimate source of time
for clock synchronization using the protocol.
Holdover:
A clock previously synchronized/syntonized to another clock
(normally a primary reference or a master clock) but now
free-running based on its own internal oscillator, whose
frequency is being adjusted using data acquired while it had
been synchronized/syntonized to the other clock. It is said to
be in holdover or in the holdover mode, as long as it is within
its accuracy requirements.
Link:
A network segment between two Precision Time Protocol ports
supporting the peer delay mechanism of this standard. The peer
delay mechanism is designed to measure the propagation time
over such a link.
Management node:
A device that configures and monitors clocks.
Master clock:
In the context of a single Precision Time Protocol
communication path, a clock that is the source of time to which
all other clocks on that path synchronize.
Message timestamp point:
A point within a Precision Time Protocol event message serving
as a reference point in the message. A timestamp is defined by
the instant a message timestamp point passes the reference
plane of a clock.
Multicast communication:
A communication model in which each Precision Time Protocol
message sent from any PTP port is capable of being received and
processed by all PTP ports on the same PTP communication path.
Node:
A device that can issue or receive Precision Time Protocol
communications on a network.
One-step clock:
A clock that provides time information using a single event
message.
On-pass support:
Indicates that each node in the synchronization chain from
master to slave can support IEEE-1588.
Ordinary clock:
A clock that has a single Precision Time Protocol port in a
domain and maintains the timescale used in the domain. It may
serve as a source of time, i.e., be a master clock, or may
synchronize to another clock, i.e., be a slave clock.
Parent clock:
The master clock to which a clock is synchronized.
Peer-to-peer transparent clock:
A transparent clock that, in addition to providing Precision
Time Protocol event transit time information, also provides
corrections for the propagation delay of the link connected to
the port receiving the PTP event message. In the presence of
peer-to-peer transparent clocks, delay measurements between
slave clocks and the master clock are performed using the
peer-to-peer delay measurement mechanism.
Phase change rate:
The observed rate of change in the measured time with respect
to the reference time. The phase change rate is equal to the
fractional frequency offset between the measured frequency and
the reference frequency.
PortNumber:
An index identifying a specific Precision Time Protocol port on
a PTP node.
Primary reference:
A source of time and or frequency that is traceable to
international standards.
Profile:
The set of allowed Precision Time Protocol features applicable
to a device.
Precision Time Protocol communication:
Information used in the operation of the protocol, transmitted
in a PTP message over a PTP communication path.
Precision Time Protocol communication path:
The signaling path portion of a particular network enabling
direct communication among ordinary and boundary clocks.
Precision Time Protocol node:
PTP ordinary, boundary, or transparent clock or a device that
generates or parses PTP messages.
Precision Time Protocol port:
A logical access point of a clock for PTP communications to the
communications network.
Recognized standard time source:
A recognized standard time source is a source external to
Precision Time Protocol that provides time and/or frequency as
appropriate that is traceable to the international standards
laboratories maintaining clocks that form the basis for the
International Atomic Time and Universal Coordinated Time
timescales. Examples of these are GPS, NTP, and NIST
timeservers.
Requestor:
The port implementing the peer-to-peer delay mechanism that
initiates the mechanism by sending a Pdelay_Req message.
Responder:
The port responding to the receipt of a Pdelay_Req message as
part of the operation of the peer-to-peer delay mechanism.
Synchronized clocks:
Two clocks are synchronized to a specified uncertainty if they
have the same epoch and their measurements of the time of a
single event at an arbitrary time differ by no more than that
uncertainty.
Syntonized clocks:
Two clocks are syntonized if the duration of the second is the
same on both, which means the time as measured by each advances
at the same rate. They may or may not share the same epoch.
Timeout:
A mechanism for terminating requested activity that, at least
from the requester's perspective, does not complete within the
specified time.
Timescale:
A linear measure of time from an epoch.
Traceability:
A property of the result of a measurement or the value of a
standard whereby it can be related to stated references,
usually national or international standards, through an
unbroken chain of comparisons all having stated uncertainties.
Translation device:
A boundary clock or, in some cases, a transparent clock that
translates the protocol messages between regions implementing
different transport and messaging protocols, between different
versions of [IEEE 1588-2008], or different PTP profiles.
Transparent clock:
A device that measures the time taken for a Precision Time
Protocol event message to transit the device and provides this
information to clocks receiving this PTP event message.
Two-step clock:
A clock that provides time information using the combination of
an event message and a subsequent general message.
The below table specifies the object formats of the various
textual conventions used.
Data type mapping Textual Convention SYNTAX
------------------- ------------------ ---------------------
5.3.2 TimeInterval ClockTimeInterval OCTET STRING(SIZE(1..255))
5.3.3 Timestamp ClockTimestamp OCTET STRING(SIZE(6))
5.3.4 ClockIdentity ClockIdentity OCTET STRING(SIZE(1..255))
5.3.5 PortIdentity ClockPortNumber INTEGER(1..65535)
5.3.7 ClockQuality ClockQualityClassType
Simple master-slave hierarchy, section 6.6.2.4 [IEEE 1588-2008]:
+---------------+
| Ordinary |
| Clock -1 |
| (GrandMaster) |
+-------M-------+
|
1
|
+---------------S-----------------+
| Boundary |
| Clock -1 |
+-----M---------------------M-----+
| |
2 3
| |
+-----S-----+ +------------S-------------+
| Ordinary | | Boundary |
| Clock -2 | | Clock -2 |
+-----------+ +-----M--------------M-----+
| |
4 5
| |
+-----S-----+ +-----S-----+
| Ordinary | | Ordinary |
| Clock -3 | | Clock -4 |
+-----------+ +-----------+
Grandmaster
Boundary Clock(0-N) Ordinary Clocks(0-N)
Ordinary Clocks(0-N)
Relationship cardinality:
PTP system 1 : N PTP Clocks
PTP Clock 1 : 1 Domain
PTP Clock 1 : N PTP Ports
PTP Ports N : M Physical Ports (interface in IF-MIB)
Transparent clock diagram, section 6.7.1.3 of [IEEE 1588-2008]:
+-----------------------------+
| Boundary clock - 1 |
+-----------------------------+
| |
| |
+-- A --+ B
| |
+----------------------+ |
| Ordinary clock | |
+----------------------+ |
+----------------------+
+----------------------+ | End-to-end |
| Ordinary clock 1-1 |----------| transparent clock- |
+----------------------+ | 1 - 1 |
+----------------------+
|
C
|
+----------------------+
+----------------------+ | End-to-end |
| Ordinary clock 1-2 |----------| transparent clock- |
+----------------------+ | 1 - 2 |
+----------------------+
The MIB refers to the sections of [IEEE 1588-2008]."
-- revision log
-- ::= { mib-2 XXX }
-- 1.3.6.1.4.1.46649.1.1
::= { enterprises 46649 1 1 }
-- PTPd Private Enterprise Number (PEN)
ClockDomainType ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"The Domain is identified by an integer, the domainNumber, in
the range of 0 to 255. An integer value that is used to assign
each PTP device to a particular domain. The following values
define the valid domains.
Value Definition
--------- -------------------
0 Default domain
1 Alternate domain 1
2 Alternate domain 2
3 Alternate domain 3
4 - 127 User-defined domains
128 - 255 Reserved"
REFERENCE
"Section 7.1 Domains, Table 2 of [IEEE 1588-2008]"
SYNTAX Unsigned32 (0..255)
ClockIdentity ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The clock Identity is an 8-octet array and will be presented in
the form of a character array. The value of the
ClockIdentity should be taken from the IEEE EUI-64 individual
assigned numbers as indicated in Section 7.5.2.2.2 of
[IEEE 1588-2008]. The EUI-64 address is divided into the
following fields:
OUI bytes (0-2)
Extension identifier bytes (3-7)
The clock identifier can be constructed from existing EUI-48
assignments and here is an abbreviated example extracted from
section 7.5.2.2.2 [IEEE 1588-2008].
Company EUI-48 = 0xACDE4823456716
EUI-64 = ACDE48FFFE23456716
It is important to note the IEEE Registration Authority has
deprecated the use of MAC-48 in any new design."
REFERENCE
"Section 7.5.2.2.1 of [IEEE 1588-2008]"
SYNTAX OCTET STRING (SIZE (1..255))
ClockIntervalBase2 ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"The interval included in message types Announce, Sync,
Delay_Req, and Pdelay_Req as indicated in section 7.7.2.1 of
[IEEE 1588-2008].
The mean time interval between successive messages shall be
represented as the logarithm to the base 2 of this time
interval measured in seconds on the local clock of the device
sending the message. The values of these logarithmic attributes
shall be selected from integers in the range -128 to 127 subject
to further limits established in an applicable PTP profile."
REFERENCE
"Section 7.7.2.1 General interval specification of
[IEEE 1588-2008]"
SYNTAX Integer32 (-128..127)
ClockMechanismType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The clock type based on whether End to End or peer to peer
mechanisms are used. The mechanism used to calculate the Mean
Path Delay as indicated in Table 9 of [IEEE 1588-2008].
Delay mechanism Value(hex) Specification
--------------- ---------- -------------
E2E 01 The port is configured to use the
delay request-response mechanism.
P2P 02 The port is configured to use the
peer delay mechanism.
DISABLED FE The port does not implement the
delay mechanism."
REFERENCE
"Sections 8.2.5.4.4, 6.6.4, 7.4.2 of [IEEE 1588-2008]."
SYNTAX INTEGER {
e2e(1),
p2p(2),
disabled(254) }
ClockInstanceType ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"The instance of the Clock of a given clock type in a given
domain."
SYNTAX Unsigned32 (0..255)
ClockPortNumber ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"An index identifying a specific Precision Time Protocol (PTP)
port on a PTP node."
REFERENCE
"Sections 7.5.2.3 and 5.3.5 of [IEEE 1588-2008]"
SYNTAX Unsigned32 (0..65535)
ClockPortState ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This is the value of the current state of the protocol engine
associated with this port.
Port state Value Description
-----------------------------------------------------------
initializing 1 In this state a port initializes
its data sets, hardware, and
communication facilities.
faulty 2 The fault state of the protocol.
disabled 3 The port shall not place any
messages on its communication path.
listening 4 The port is waiting for the
announceReceiptTimeout to expire or
to receive an Announce message from
a master.
preMaster 5 The port shall behave in all respects
as though it were in the MASTER state
except that it shall not place any
messages on its communication path
except for Pdelay_Req, Pdelay_Resp,
Pdelay_Resp_Follow_Up, signaling, or
management messages.
master 6 The port is behaving as a master port.
passive 7 The port shall not place any messages
on its communication path except for
Pdelay_Req, Pdelay_Resp,
Pdelay_Resp_Follow_Up, or signaling
messages, or management messages that
are a required response to another
management message
uncalibrated 8 The local port is preparing to
synchronize to the master port.
slave 9 The port is synchronizing to the
selected master port."
REFERENCE
"Section 8.2.5.3.1 portState and 9.2.5 of
[IEEE 1588-2008]"
SYNTAX INTEGER {
initializing(1),
faulty(2),
disabled(3),
listening(4),
preMaster(5),
master(6),
passive(7),
uncalibrated(8),
slave(9) }
ClockProfileType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Clock Profile used. A profile is the set of allowed Precision
Time Protocol (PTP) features applicable to a device."
REFERENCE
"Section 3.1.30 and 19.3 PTP profiles of
[IEEE 1588-2008]"
SYNTAX INTEGER {
default(1),
telecom(2),
vendorspecific(3) }
ClockQualityAccuracyType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The ClockQuality as specified in section 5.3.7, 7.6.2.5 and
Table 6 of [IEEE 1588-2008].
The following values are not represented in the enumerated
values.
0x01-0x1F Reserved
0x32-0x7F Reserved
It is important to note that section 7.1.1 RFC2578 allows for
gaps and enumerate values to start with zero when indicated by
the protocol."
REFERENCE
"Section 5.3.7, 7.6.2.5 and Table 6 of
[IEEE 1588-2008]"
SYNTAX INTEGER {
reserved00(1), -- 0
nanoSecond25(32), -- 0x20
nanoSecond100(33), -- 0x21
nanoSecond250(34), -- 0x22
microSec1(35), -- 0x23
microSec2dot5(36), -- 0x24
microSec10(37), -- 0x25
microSec25(38), -- 0x26
microSec100(39), -- 0x27
microSec250(40), -- 0x28
milliSec1(41), -- 0x29
milliSec2dot5(42), -- 0x2A
milliSec10(43), -- 0x2B
milliSec25(44), -- 0x2C
milliSec100(45), -- 0x2D
milliSec250(46), -- 0x2E
second1(47), -- 0x2F
second10(48), -- 0x30
secondGreater10(49), -- 0x31
unknown(254), -- 0xFE
reserved255(255) -- 0xFF
}
ClockQualityClassType ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"The ClockQuality as specified in section 5.3.7, 7.6.2.4 and
Table 5 of [IEEE 1588-2008].
Value Description
-------- ------------------------------------------------
0 Reserved to enable compatibility with future
versions.
1-5 Reserved
6 Shall designate a clock that is synchronized
to a primary reference time source. The
timescale distributed shall be PTP. A
clockClass 6 clock shall not be a slave to
another clock in the domain.
7 Shall designate a clock that has previously
been designated as clockClass 6 but that has
lost the ability to synchronize to a primary
reference time source and is in holdover mode
and within holdover specifications. The
timescale distributed shall be PTP. A
clockClass 7 clock shall not be a slave to
another clock in the domain.
8 Reserved.
9-10 Reserved to enable compatibility with future
versions.
11-12 Reserved.
13 Shall designate a clock that is synchronized
to an application-specific source of time.
The timescale distributed shall be ARB. A
clockClass 13 clock shall not be a slave to
another clock in the domain.
14 Shall designate a clock that has previously
been designated as clockClass 13 but that
has lost the ability to synchronize to an
application-specific source of time and is
in holdover mode and within holdover
specifications. The timescale distributed
shall be ARB. A clockClass 14 clock shall
not be a slave to another clock in the domain.
15-51 Reserved.
52 Degradation alternative A for a clock of
clockClass 7 that is not within holdover
specification. A clock of clockClass 52
shall not be a slave to another clock in
the domain.
53-57 Reserved.
58 Degradation alternative A for a clock of
clockClass 14 that is not within holdover
specification. A clock of clockClass 58 shall
not be a slave to another clock in the domain.
59-67 Reserved.
68-122 For use by alternate PTP profiles.
123-127 Reserved.
128-132 Reserved.
133-170 For use by alternate PTP profiles.
171-186 Reserved.
187 Degradation alternative B for a clock of
clockClass 7 that is not within holdover
specification. A clock of clockClass 187 may
be a slave to another clock in the domain.
188-192 Reserved.
193 Degradation alternative B for a clock of
clockClass 14 that is not within holdover
specification. A clock of clockClass 193 may
be a slave to another clock in the domain.
194-215 Reserved.
216-232 For use by alternate PTP profiles.
233-247 Reserved.
248 Default. This clockClass shall be used if
none of the other clockClass definitions apply.
249-250 Reserved.
251 Reserved for version 1 compatibility; see Clause 18.
252-254 Reserved.
255 Shall be the clockClass of a slave-only clock; see
9.2.2."
REFERENCE
"Section 5.3.7, 7.6.2.4 and Table 5 of
[IEEE 1588-2008]."
SYNTAX Unsigned32 (0..255)
ClockRoleType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The Clock Role. The protocol generates a Master Slave
relationship among the clocks in the system.
Clock Role Value Description
--------------------------------------------------------------
Master clock 1 A clock that is the source of
time to which all other clocks on
that path synchronize.
Slave clock 2 A clock which synchronizes to
another clock (master)."
SYNTAX INTEGER {
master(1),
slave(2) }
ClockStateType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The clock state returned by PTP engine.
Clock State Value Description
--------------------------------------------------------------
Freerun state 1 Applies to a slave device that is not
locked to a master. This is the initial
state a slave starts out with when it
is not getting any PTP packets from the
master or because of some other input
error (erroneous packets, etc).
Holdover state 2 In this state the slave device is
locked to a master but communication
with the master is lost or the
timestamps in the ptp packets are
incorrect. But since the slave was
locked to the master, it can run with
the same accuracy for sometime. The
slave can continue to operate in this
state for some time. If communication
with the master is not restored for a
while, the device is moved to the
FREERUN state.
Acquiring state 3 The slave device is receiving packets
from a master and is trying to acquire
a lock.
Freq_locked state 4 Slave device is locked to the Master
with respect to frequency, but not phase
aligned
Phase_aligned state 5 Locked to the master with respect to
frequency and phase."
SYNTAX INTEGER {
freerun(1),
holdover(2),
acquiring(3),
frequencyLocked(4),
phaseAligned(5) }
ClockTimeSourceType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The ClockQuality as specified in section 5.3.7, 7.6.2.6 and
Table 7 of [IEEE 1588-2008].
The following values are not represented in the enumerated
values.
0xF0-0xFE For use by alternate PTP profiles
0xFF Reserved
It is important to note that section 7.1.1 RFC2578 allows for
gaps and enumerate values to start with zero when indicated by
the protocol."
REFERENCE
"Section 5.3.7, 7.6.2.6 and Table 7 of
[IEEE 1588-2008]."
SYNTAX INTEGER {
atomicClock(16), -- 0x10
gps(32), -- 0x20
terrestrialRadio(48), -- 0x22
ptp(64), -- 0x40
ntp(80), -- 0x50
handSet(96), -- 0x60
other(144), -- 0x90
internalOsillator(160) -- 0xA0
}
ClockTimeInterval ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual convention corresponds to the TimeInterval
structure indicated in section 5.3.2 of [IEEE 1588-2008].
It will be presented in the form of a character array.
The TimeInterval type represents time intervals.
struct TimeInterval
{
Integer64 scaledNanoseconds;
};
The scaledNanoseconds member is the time interval expressed in
units of nanoseconds and multiplied by 2**16.
Positive or negative time intervals outside the maximum range
of this data type shall be encoded as the largest positive and
negative values of the data type, respectively.
For example, 2.5 ns is expressed as 0000 0000 0002 8000 in
Base16."
REFERENCE
"Section 5.3.2 and setion 7.7.2.1 Timer interval
specification of [IEEE 1588-2008]"
SYNTAX OCTET STRING (SIZE (1..255))
ClockTxModeType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Transmission mode.
unicast. Using unicast communication channel.
multicast. Using Multicast communication channel.
multicast-mix. Using multicast-unicast communication channel"
SYNTAX INTEGER {
unicast(1),
multicast(2),
multicastmix(3) }
ClockType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The clock types as defined in the MIB module description."
REFERENCE
"Section 6.5.1 of [IEEE 1588-2008]."
SYNTAX INTEGER {
ordinaryClock(1),
boundaryClock(2),
transparentClock(3),
boundaryNode(4) }
PtpdAlarmType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Alarm identifier (type) as used by PTPd"
REFERENCE
"PTPd 2.3.2"
SYNTAX INTEGER {
portState(0),
ofmThreshold(1),
ofmSeconds(2),
clockStep(3),
noSync(4),
noDelay(5),
masterChange(6),
networkFault(7),
fastAdj(8),
timePropertiesChange(9),
domainMismatch(10) }
PtpdAlarmState ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Alarm state as used by PTPd"
REFERENCE
"PTPd 2.3.2"
SYNTAX INTEGER {
unset(0),
set(1),
cleared(2) }
ptpbaseMIBNotifs OBJECT IDENTIFIER
-- 1.3.6.1.4.1.46649.1.1.0
::= { ptpbaseMIB 0 }
ptpBasePortUnexpectedState NOTIFICATION-TYPE
OBJECTS {
ptpbaseClockPortRunningState}
STATUS current
DESCRIPTION
"Alarm: port has gone into a state other than expected in current configuration."
-- 1.3.6.1.4.1.46649.1.1.0.1
::= { ptpbaseMIBNotifs 1 }
ptpBasePortExpectedState NOTIFICATION-TYPE
OBJECTS {
ptpbaseClockPortRunningState}
STATUS current
DESCRIPTION
"Alarm cleared: port has returned to expected state."
-- 1.3.6.1.4.1.46649.1.1.0.2
::= { ptpbaseMIBNotifs 2 }
ptpBaseSlaveOfmThresholdExceeded NOTIFICATION-TYPE
OBJECTS {
ptpbaseClockCurrentDSOffsetFromMaster,
ptpbaseClockCurrentDSOffsetFromMasterString,
ptpbaseClockCurrentDSOffsetFromMasterThresholdNs}
STATUS current
DESCRIPTION
"Alarm: slave Offset From Master has exceeded defined threshold."
-- 1.3.6.1.4.1.46649.1.1.0.3
::= { ptpbaseMIBNotifs 3 }
ptpBaseSlaveOfmThresholdAcceptable NOTIFICATION-TYPE
OBJECTS {
ptpbaseClockCurrentDSOffsetFromMaster,
ptpbaseClockCurrentDSOffsetFromMasterString,
ptpbaseClockCurrentDSOffsetFromMasterThresholdNs}
STATUS current
DESCRIPTION
"Alarm cleared: slave Offset From Master has returned to a value below threshold."
-- 1.3.6.1.4.1.46649.1.1.0.4
::= { ptpbaseMIBNotifs 4 }
ptpBaseslaveClockStep NOTIFICATION-TYPE
OBJECTS {
ptpbaseClockCurrentDSOffsetFromMaster,
ptpbaseClockCurrentDSOffsetFromMasterString}
STATUS current
DESCRIPTION
"Event: Clock has been stepped"
-- 1.3.6.1.4.1.46649.1.1.0.5
::= { ptpbaseMIBNotifs 5 }
ptpBaseSlaveNoSync NOTIFICATION-TYPE
STATUS current
DESCRIPTION
"Alarm: PTP slave stopped receiving Sync messages"
-- 1.3.6.1.4.1.46649.1.1.0.6
::= { ptpbaseMIBNotifs 6 }
ptpBaseSlaveReceivingSync NOTIFICATION-TYPE