ClockIdentityRepresents an IEEE 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, EUI-64. EUI-48 converts to EUI-64 as specified by IEEE. The conversion assigns values 255 and 254 to octets 3 and 4 respectively, where octet 0 is the most significant and octet 7 the least. For example, EUI-48 of AC:DE:48:23:45:67 would extend to AC:DE:48:FF:FE:23:45:67.Reference: 6.3.3.6 and 8.5.2.2.1 SIZE (8) · OCTET STRING · hint 1x:
Globally unique manufacturer-assigned clock identifier for the local clock. The identifier is based on an EUI-64. Reference: 14.2.1
ieee8021AsDefaultDSNumberPorts
1.3.111.2.802.1.1.20.1.1.2
Unsigned32 (0..255)
The number of PTP ports on the device. For an end station the value is 1. Reference: 14.2.2
ieee8021AsDefaultDSClockClass
1.3.111.2.802.1.1.20.1.1.3
IEEE8021ASClockClassValue6 = primarySync7 = primarySyncLost13 = applicationSpecificSync14 = applicationSpecficSyncLost52 = primarySyncAlternativeA58 = applicationSpecificAlternativeA187 = primarySyncAlternativeB193 = applicationSpecficAlternativeB248 = defaultClock255 = slaveOnlyClockClock Class Value from IEEE Std 1588-2008 7.6.2.4, with the following interpretation placed on the value:
6: A clock that is synchronized to a primary reference time source, 7: 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, 13: A clock that is synchronized to an application-specific source of time, 14: 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, 52: Degradation alternative A for a clock of clockClass 7 that is not within holdover specification, 58: Degradation alternative A for a clock of clockClass 14 that is not within holdover specification, 68..122: For use by alternate PTP profiles (68..122), 133..170: For use by alternate PTP profiles (133..170), 187: Degradation alternative B for a clock of clockClass 7 that is not within holdover specification, 193: Degradation alternative B for a clock of clockClass 14 that is not within holdover specification, 216..232: For use by alternate PTP profiles,
248: Default none of the other clockClass definitions apply,
255: A slave-only clock(255).Reference: 14.2.3 and IEEE Std 1588-2008 7.6.2.4 · Integer32
Denotes the traceability of the time or frequency of the local clock. The value shall be selected as follows: a) If the Default Parameter Data Set member gmCapable is TRUE, then clockClass is set to the value that reflects the combination of the LocalClock and ClockSource entities; else if the value that reflects the LocalClock and ClockSource entities is not specified or not known,clockClass is set to 248; b) If the Default Parameter Data Set member gmCapable is FALSE (see 8.6.2.1), clockClass is set to 255. Reference: 14.2.3
ieee8021AsDefaultDSClockAccuracy
1.3.111.2.802.1.1.20.1.1.4
IEEE8021ASClockAccuracyValue32 = timeAccurateTo25ns33 = timeAccurateTo100ns34 = timeAccurateTo250ns35 = timeAccurateTo1us36 = timeAccurateTo2dot5us37 = timeAccurateTo10us38 = timeAccurateTo25us39 = timeAccurateTo100us40 = timeAccurateTo250us41 = timeAccurateTo1ms42 = timeAccurateTo2dot5ms43 = timeAccurateTo10ms44 = timeAccurateTo25ms45 = timeAccurateTo100ms46 = timeAccurateTo250ms47 = timeAccurateTo1s48 = timeAccurateTo10s49 = timeAccurateToGT10s254 = timeAccurateToUnknownClock Accuracy Value from 8.6.2.3, with the following interpretation placed on the value:
32: The time is accurate to within 25 ns, 33: The time is accurate to within 100 ns, 34: The time is accurate to within 250 ns, 35: The time is accurate to within 1 us, 36: The time is accurate to within 2.5 us, 37: The time is accurate to within 10 us, 38: The time is accurate to within 25 us, 39: The time is accurate to within 100 us, 40: The time is accurate to within 250 us, 41: The time is accurate to within 1 ms, 42: The time is accurate to within 2.5 ms, 43: The time is accurate to within 10 ms, 44: The time is accurate to within 25 ms, 45: The time is accurate to within 100 ms, 46: The time is accurate to within 250 ms, 47: The time is accurate to within 1 s, 48: The time is accurate to within 10 s, 49: The time is accurate to within > 10 s, 254: Default indicating unknownReference: 8.6.2.3 · Integer32
Characterizes local clock for the purpose of the best master clock algorithm. The value shall be selected as follows: a) clockAccuracy is set to the value that reflects the combination of the LocalClock and ClockSource entities if specified or known; b) if the value that reflects the LocalClock and ClockSource entities is not specified or unknown, clockAccuracy is set to 254. Reference: 14.2.4
ieee8021AsDefaultDSOffsetScaledLogVariance
1.3.111.2.802.1.1.20.1.1.5
Unsigned32 (0..65535)
The offsetScaledLogVariance is scaled, offset representation of an estimate of the PTP variance. The PTP variance characterizes the precision and frequency stability of the ClockMaster. The PTP variance is the square of PTPDEV (see B.1.3.2). The value shall be selected as follows: a) offsetScaledLogVariance is set to the value that reflects the combination of the LocalClock and ClockSource entities; else b) if the value that reflects these entities is not specified or not known, offsetScaledLogVariance is set to 16640 (0x4100). This value corresponds to the value of PTPDEV for observation interval equal to the default Sync message transmission interval (i.e., observation interval of 0.125 s, see 11.5.2.3 and B.1.3.2).
A value of 65535 (0xFFFF) indicates value is too large to be represented or has not been computed. Reference: 14.2.5
ieee8021AsDefaultDSPriority1
1.3.111.2.802.1.1.20.1.1.6
Unsigned32 (0..255)
Most-significant priority declaration in the execution of the best master clock algorithm. Lower values take precedence. The value of priority1 shall be 255 for a time-aware system that is not grandmaster-capable. The value of priority1 shall be less than 255 for a time-aware system that is grandmaster-capable. The value 0 shall be reserved for future management use, i.e., the valueof priority1 shall be set to 0 only via management action, and shall not be specified as a default value by a user of this standard. In the absence of a default value set by a user of this standard, the default value shall be set as below: a) system type of network infrastructure time-aware system to value 246; b) portable time-aware system, 250; c) other time-aware systems, 248. Reference: 14.2.6
ieee8021AsDefaultDSPriority2
1.3.111.2.802.1.1.20.1.1.7
Unsigned32 (0..255)
Least-significant priority declaration in the execution of the best master clock algorithm. Lower values take precedence. The default value is 248 Reference: 14.2.7
ieee8021AsDefaultDSGmCapable
1.3.111.2.802.1.1.20.1.1.8
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The value is the offset between TAI and UTC, relative to the ClockMaster entity of this time-aware system. It is equal to the global variable sysCurrentUtcOffset (see 10.3.8.16). The value is in units of seconds. The initialization default value is selected as follows: a) the value is the value obtained from a primary reference if the value is known at the at the time of initialization, b) else the value is the current number ofleap seconds, see 8.2.3, when the time-aware system is designed. Reference: 14.2.9
ieee8021AsDefaultDSCurrentUTCOffsetValid
1.3.111.2.802.1.1.20.1.1.10
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
True (1) if ieee8021AsDefaultDSCurrentUTCOffset is known to be correct; false (2) otherwise. Reference: 14.2.10
ieee8021AsDefaultDSLeap59
1.3.111.2.802.1.1.20.1.1.11
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
A true (1) value indicates that the last minute of the current UTC day, relative to the ClockMaster entity of this time-aware system, will contain 59 seconds. It is equal to the global variable sysLeap59 (see 10.3.8.12).
The initialization value is selected as follows: a) Set to true (1) if the value is obtained from a primary reference if known at the at the time of initialization, else b) The value is set to false (2). Reference: 14.2.11
ieee8021AsDefaultDSLeap61
1.3.111.2.802.1.1.20.1.1.12
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
A true (1) value indicates that the last minute of the current UTC day, relative to the ClockMaster entity of this time-aware system, will contain 59 seconds. It is equal to the global variable sysLeap61 (see 10.3.8.11).
The initialization value is selected as follows: a) Set to true (1) if the value is obtained from a primary reference if known at the at the time of initialization, else b) The value is set to false (2). Reference: 14.2.12
ieee8021AsDefaultDSTimeTraceable
1.3.111.2.802.1.1.20.1.1.13
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The value is set to true (1) if the timescale and the value of Ieee8021AsCurrentUtcOffset, relative to the ClockMaster entity of this time-aware system, are traceable to a primary reference standard; otherwise the value is set to false (2). It is equal to the global variable sysTimeTraceable (see 10.3.8.14).
The initialization value is selected as follows: a) If the time and the value of currentUtcOffset are traceable to a primary reference standard at the time of initialization, the value is set to true (1), else b) The value is set to false (2). Reference: 14.2.13
ieee8021AsDefaultDSFrequencyTraceable
1.3.111.2.802.1.1.20.1.1.14
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The value is set to true (1) if the frequency determining the timescale of the ClockMaster Entity of this time- aware system is traceable to a primary reference standard; otherwise the value is set to false (2). It is equal to the global variable sysFrequencyTraceable (see 10.3.8.15).
The initialization value is selected as follows: a) If the frequency is traceable to a primary reference standard at the time of initialization, the value is set to true (1), else b) The value is set to false (2).. Reference: 14.2.14
ieee8021AsDefaultDSTimeSource
1.3.111.2.802.1.1.20.1.1.15
IEEE8021ASTimeSourceValue16 = atomicClock32 = gps48 = terrestrialRadio64 = ptp80 = ntp96 = handSet144 = other160 = internalOscillatorThe timeSource is an information only attribute indicating the type of source of time used by a ClockMaster, representing categories. For example, the GPS entry would include not only the GPS system of the U.S. Department of Defense but the European Galileo system and other present and future satellite-based timing systems.
In the absence of a default value set by a user of this standard, the default value of timeSource shall be OTHER. See 7.6.2.6 of IEEE Std 1588 - 2008 for more detailed description of timeSourceIndicates the source of time used by the grandmaster clock.
The following interpretation placed on the value:
16: Atomic Clock,
32: GPS,
48: Terrestrial Radio,
64: PTP,
80: NTP,
96: Hand Set,
144: Other,
160: Internal OscillatorReference: 8.6.2.7 and Table 8-3 · Integer32
The timeSource is an information-only attribute indicating the type of source of time used by a ClockMaster. The value is not used in the selection of the grandmaster. The values shall be as specified in Table 8-3. These represent categories. For example, the GPS entry would include not only the GPS system of the U.S. Department of Defense but the European Galileo system and other present and future satellite-based timing systems. All unused values in Table 8-3 are reserved.
The initialization value is selected as follows: a) If the timeSource (8.6.2.7 and Table 8-3), is known at the time of initialization, the value is derived from the table, else b) The value is set to INTERNAL_OSCILLATOR (160). Reference: 14.2.15
ieee8021AsCurrentDSStepsRemoved
1.3.111.2.802.1.1.20.1.2.1
Integer32 (-32768..32767)
The number of communication paths traversed between the local clock and the grandmaster clock (see Table 10.3.3).
For example, stepsRemoved for a slave clock on the same PTP communication path as the grandmaster clock will have a value of 1, indicating that a single path was traversed. Reference: 14.3.1
ieee8021AsCurrentDSOffsetFromMasterHs
1.3.111.2.802.1.1.20.1.2.2
Integer32 · 2**-16 ns * 2**64
The most significant 32 bits of the offset, signed 96 bit number in 2**-16 ns, an implementation-specific computation of the current value of the time difference between a master and a slave as computed by the slave.
This object MUST be read at the same time as ieee8021AsCurrentDSOffsetFromMasterMs, and ieee8021AsCurrentDSOffsetFromMasterLs, which represents middle and least significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.3.2
ieee8021AsCurrentDSOffsetFromMasterMs
1.3.111.2.802.1.1.20.1.2.3
Integer32 · 2**-16 ns * 2**32
The middle significant 32 bits of the offset, signed 96 bit number in 2**-16 ns, an implementation-specific computation of the current value of the time difference between a master and a slave as computed by the slave.
This object MUST be read at the same time as ieee8021AsCurrentDSOffsetFromMasterHs, and ieee8021AsCurrentDSOffsetFromMasterLs, which represents most (highest) and least significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.3.2
ieee8021AsCurrentDSOffsetFromMasterLs
1.3.111.2.802.1.1.20.1.2.4
Integer32 · 2**-16 ns
The least significant 32 bits of the offset, signed 96 bit number in 2**-16 ns, an implementation-specific computation of the current value of the time difference between a master and a slave as computed by the slave.
This object MUST be read at the same time as ieee8021AsCurrentDSOffsetFromMasterHs, and ieee8021AsCurrentDSOffsetFromMasterMs, which represents most (highest) and middle significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.3.2
ieee8021AsCurrentDSLastGmPhaseChangeHs
1.3.111.2.802.1.1.20.1.2.5
Integer32
The value (see 10.2.3.16) is the phase change that occurred on the most recent change in either grandmaster or gmTimeBaseIndicator (see 9.2.2.2).
This object MUST be read at the same time as ieee8021AsCurrentDSLastGmPhaseChangeMs, and ieee8021AsCurrentDSLastGmPhaseChangeLs, which represents middle and least significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.3.3
ieee8021AsCurrentDSLastGmPhaseChangeMs
1.3.111.2.802.1.1.20.1.2.6
Unsigned32
The value (see 10.2.3.16) is the phase change that occurred on the most recent change in either grandmaster or gmTimeBaseIndicator (see 9.2.2.2).
This object MUST be read at the same time as ieee8021AsCurrentDSLastGmPhaseChangeHs, and ieee8021AsCurrentDSLastGmPhaseChangeLs, which represents most and least significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.3.3
ieee8021AsCurrentDSLastGmPhaseChangeLs
1.3.111.2.802.1.1.20.1.2.7
Unsigned32
The value (see 10.2.3.16) is the phase change that occurred on the most recent change in either grandmaster or gmTimeBaseIndicator (see 9.2.2.2).
This object MUST be read at the same time as ieee8021AsCurrentDSLastGmPhaseChangeMs, and ieee8021AsCurrentDSLastGmPhaseChangeLs, which represents middle and least significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.3.3
ieee8021AsCurrentDSLastGmFreqChangeMs
1.3.111.2.802.1.1.20.1.2.8
Integer32
The value (see 10.2.3.17) is the frequency change that occurred on the most recent change in either grandmaster or gmTimeBaseIndicator (see 9.2.2.2).
This object MUST be read at the same time as ieee8021AsCurrentDSLastGmFreqChangeLs, which represents least significant 32 bits of the value in order for the read operation to succeed. Reference: 14.3.4
ieee8021AsCurrentDSLastGmFreqChangeLs
1.3.111.2.802.1.1.20.1.2.9
Unsigned32
The value (see 10.2.3.17) is the frequency change that occurred on the most recent change in either grandmaster or gmTimeBaseIndicator (see 9.2.2.2).
This object MUST be read at the same time as ieee8021AsCurrentDSLastGmFreqChangeMs, which represents most significant 32 bits of the value in order for the read operation to succeed. Reference: 14.3.4
ieee8021AsCurrentDSGmTimebaseIndicator
1.3.111.2.802.1.1.20.1.2.10
Unsigned32 (0..65535)
This reports the grandmaster's time base change value conveyed in the Sync message. The value is the value of timeBaseIndicator of the current grandmaster (see 9.2.2.2 and 9.6.2.2) Reference: 14.3.5
ieee8021AsCurrentDSGmChangeCount
1.3.111.2.802.1.1.20.1.2.11
Counter32
This statistics counter tracks the number of times the grandmaster has changed in a gPTP domain. This counter increments when the PortAnnounceInformation state machine enters the SUPERIOR_MASTER_PORT state or the INFERIOR_MASTER_OR_OTHER_PORT state (see 10.3.11 and Figure 10-13). Reference: 14.3.6
ieee8021AsCurrentDSTimeOfLastGmChangeEvent
1.3.111.2.802.1.1.20.1.2.12
TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be
defined in the description of any object defined using this type.
If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks · 0.01 seconds
This timestamp denotes the system time when the most recent grandmaster change occurred in a gPTP domain. This timestamp is updated when the PortAnnounceInformation state machine enters the SUPERIOR_MASTER_PORT state or the INFERIOR_MASTER_OR_OTHER_PORT state (see 10.3.11 and Figure 10-13). Reference: 14.3.7
ieee8021AsCurrentDSTimeOfLastGmFreqChangeEvent
1.3.111.2.802.1.1.20.1.2.13
TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be
defined in the description of any object defined using this type.
If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks · 0.01 seconds
This timestamp denotes the system time when the most recent change in grandmaster phase occured, due to a change of either the grandmaster or the grandmaster time base. This timestamp is updated when the PortAnnounceInformation state machine enters the SUPERIOR_MASTER_PORT state or the INFERIOR_MASTER_OR_OTHER_PORT state (see 10.3.11 and Figure 10-13), and when the ieee802AsCurrentDSGmTimebaseIndicator managed object (see 14.3.5) changes. Reference: 14.3.8
ieee8021AsCurrentDSTimeOfLastGmPhaseChangeEvent
1.3.111.2.802.1.1.20.1.2.14
TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be
defined in the description of any object defined using this type.
If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks · 0.01 seconds
This timestamp denotes the system time when the most recent change in grandmaster frequency occured, due to a change of either the grandmaster or the grandmaster time base. This timestamp is updated when the PortAnnounceInformation state machine enters the SUPERIOR_MASTER_PORT state or the INFERIOR_MASTER_OR_OTHER_PORT state (see 10.3.11 and Figure 10-13), and when the ieee802AsCurrentDSGmTimebaseIndicator managed object (see 14.3.5) changes. Reference: 14.3.9
ieee8021AsParentDSParentClockIdentity
1.3.111.2.802.1.1.20.1.3.1
ClockIdentityRepresents an IEEE 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, EUI-64. EUI-48 converts to EUI-64 as specified by IEEE. The conversion assigns values 255 and 254 to octets 3 and 4 respectively, where octet 0 is the most significant and octet 7 the least. For example, EUI-48 of AC:DE:48:23:45:67 would extend to AC:DE:48:FF:FE:23:45:67.Reference: 6.3.3.6 and 8.5.2.2.1 SIZE (8) · OCTET STRING · hint 1x:
Clock identifier (clockIdentity) of the local clock's parent clock. The default value is set to ieee8021AsDefaultDSClockIdentity.
If this time-aware system is the grandmaster, the value is the clockIdentity of this time-aware system. If this time-aware system is not the grandmaster, the value is the clockIdentity of the MasterPort (see Table 10-1) of the gPTP communication path attached to the single slave port of this time-aware system. Reference: 14.4.1
ieee8021AsParentDSParentPortNumber
1.3.111.2.802.1.1.20.1.3.2
Unsigned32 (0..65535)
Port number (portNumber) of the local clock's parent gPTP port number.
If this time-aware system is the grandmaster, the value is the gPTP portNumber of this time-aware system. If this time-aware system is not the grandmaster, the value is the portNumber of the MasterPort (see Table 10-1) of the gPTP communication path attached to the single gPTP slave port of this time-aware system. Reference: 14.4.1
ieee8021AsParentDSCumlativeRateRatio
1.3.111.2.802.1.1.20.1.3.3
Integer32
The value is an estimate of the ratio of the frequency of the grandmaster to the frequency of the LocalClock entity of this time-aware system.
Cumulative rate ratio is expressed as the fractional frequency offset multiplied by 2**41, i.e., the quantity (rateRatio - 1.0)(2**41), where rateRatio is computed by the PortSyncSyncReceive state machine (see 10.2.7.1.4). Reference: 14.4.2
ieee8021AsParentDSGrandmasterIdentity
1.3.111.2.802.1.1.20.1.3.4
ClockIdentityRepresents an IEEE 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, EUI-64. EUI-48 converts to EUI-64 as specified by IEEE. The conversion assigns values 255 and 254 to octets 3 and 4 respectively, where octet 0 is the most significant and octet 7 the least. For example, EUI-48 of AC:DE:48:23:45:67 would extend to AC:DE:48:FF:FE:23:45:67.Reference: 6.3.3.6 and 8.5.2.2.1 SIZE (8) · OCTET STRING · hint 1x:
Clock identifier (clockIdentity) of the grandmaster. The default value is set to ieee8021AsDefaultDSClockIdentity. Reference: 14.4.3
ieee8021AsParentDSGrandmasterClockClass
1.3.111.2.802.1.1.20.1.3.5
IEEE8021ASClockClassValue6 = primarySync7 = primarySyncLost13 = applicationSpecificSync14 = applicationSpecficSyncLost52 = primarySyncAlternativeA58 = applicationSpecificAlternativeA187 = primarySyncAlternativeB193 = applicationSpecficAlternativeB248 = defaultClock255 = slaveOnlyClockClock Class Value from IEEE Std 1588-2008 7.6.2.4, with the following interpretation placed on the value:
6: A clock that is synchronized to a primary reference time source, 7: 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, 13: A clock that is synchronized to an application-specific source of time, 14: 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, 52: Degradation alternative A for a clock of clockClass 7 that is not within holdover specification, 58: Degradation alternative A for a clock of clockClass 14 that is not within holdover specification, 68..122: For use by alternate PTP profiles (68..122), 133..170: For use by alternate PTP profiles (133..170), 187: Degradation alternative B for a clock of clockClass 7 that is not within holdover specification, 193: Degradation alternative B for a clock of clockClass 14 that is not within holdover specification, 216..232: For use by alternate PTP profiles,
248: Default none of the other clockClass definitions apply,
255: A slave-only clock(255).Reference: 14.2.3 and IEEE Std 1588-2008 7.6.2.4 · Integer32
Denotes the traceability of the time or frequency of the grandmaster. The default value is set to ieee8021AsDefaultDSClockClass. Reference: 14.4.4
ieee8021AsParentDSGrandmasterClockAccuracy
1.3.111.2.802.1.1.20.1.3.6
IEEE8021ASClockAccuracyValue32 = timeAccurateTo25ns33 = timeAccurateTo100ns34 = timeAccurateTo250ns35 = timeAccurateTo1us36 = timeAccurateTo2dot5us37 = timeAccurateTo10us38 = timeAccurateTo25us39 = timeAccurateTo100us40 = timeAccurateTo250us41 = timeAccurateTo1ms42 = timeAccurateTo2dot5ms43 = timeAccurateTo10ms44 = timeAccurateTo25ms45 = timeAccurateTo100ms46 = timeAccurateTo250ms47 = timeAccurateTo1s48 = timeAccurateTo10s49 = timeAccurateToGT10s254 = timeAccurateToUnknownClock Accuracy Value from 8.6.2.3, with the following interpretation placed on the value:
32: The time is accurate to within 25 ns, 33: The time is accurate to within 100 ns, 34: The time is accurate to within 250 ns, 35: The time is accurate to within 1 us, 36: The time is accurate to within 2.5 us, 37: The time is accurate to within 10 us, 38: The time is accurate to within 25 us, 39: The time is accurate to within 100 us, 40: The time is accurate to within 250 us, 41: The time is accurate to within 1 ms, 42: The time is accurate to within 2.5 ms, 43: The time is accurate to within 10 ms, 44: The time is accurate to within 25 ms, 45: The time is accurate to within 100 ms, 46: The time is accurate to within 250 ms, 47: The time is accurate to within 1 s, 48: The time is accurate to within 10 s, 49: The time is accurate to within > 10 s, 254: Default indicating unknownReference: 8.6.2.3 · Integer32
Characterizes the grandmaster clock for the purpose of the best master clock algorithm. The default value is set to ieee8021AsDefaultDSClockAccuracy. Reference: 14.4.5
Clock Allan variance of the local clock expressed as a base-2 logarithm multiplied by a scale factor of 256. Hysteresis is applied requiring the underlying computed variance to move by at least 128 before a change is reported. A value of 65535 (0xFFFF) indicates value is too large to be represented or has not been computed. The default value is set to ieee8021AsDefaultDSOffsetScaledLogVariance. Reference: 14.4.6
ieee8021AsParentDSGrandmasterPriority1
1.3.111.2.802.1.1.20.1.3.8
Unsigned32 (0..255)
Grandmaster's most-significant priority declaration in the execution of the best master clock algorithm. Lower values take precedence.
The default value is set to ieee8021AsDefaultDSPriority1. Reference: 14.4.7
ieee8021AsParentDSGrandmasterPriority2
1.3.111.2.802.1.1.20.1.3.9
Unsigned32 (0..255)
Grandmaster's least-significant priority declaration in the execution of the best master clock algorithm. Lower values take precedence.
The default value is set to ieee8021AsDefaultDSDSPriority2. Reference: 14.4.8
ieee8021AsTimePropertiesDSCurrentUtcOffset
1.3.111.2.802.1.1.20.1.4.1
Integer32 (-32768..32767) · seconds
The value is currentUtcOffset for the current grandmaster (see Table 14.2.9). It is equal to the value of the global variable currentUtcOffset (see 10.3.8.9). The value is in units of seconds. The default value is set to ieee8021AsDefaultDSCurrentUTCOffset. Reference: 14.5.1
ieee8021AsTimePropertiesDSCurrentUtcOffsetValid
1.3.111.2.802.1.1.20.1.4.2
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
True (1) if ieee8021AsTimePropertiesDSCurrentUTCOffset is known to be correct; false (2) otherwise. The default value is set to ieee8021AsDefaultDSCurrentUTCOffsetValid. Reference: 14.5.2
ieee8021AsTimePropertiesDSLeap59
1.3.111.2.802.1.1.20.1.4.3
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The value is leap59 for the current grandmaster (see 14.2.11). It is equal to the global variable leap59 (see 10.3.8.5).
A true (1) value indicates that the last minute of the current UTC day, relative to the ClockMaster entity of this time-aware system, will contain 59 seconds.
The default value is set to ieee8021AsDefaultDSLeap59. Reference: 14.5.3
ieee8021AsTimePropertiesDSLeap61
1.3.111.2.802.1.1.20.1.4.4
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The value is leap61 for the current grandmaster (see 14.2.12). It is equal to the global variable leap59 (see 10.3.8.4).
A true (1) value indicates that the last minute of the current UTC day, relative to the ClockMaster entity of this time-aware system, will contain 61 seconds.The default value is set to ieee8021AsDefaultDSLeap61. Reference: 14.5.4
ieee8021AsTimePropertiesDSTimeTraceable
1.3.111.2.802.1.1.20.1.4.5
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The value is timeTraceable for the current grandmaster (see 14.2.13). It is equal to the global variable timeTraceable (see 10.3.8.7).
True (1) if the timescale and the value of timePropertiesDSCurrentUTCOffset are traceable to a primary reference; false (2) otherwise. The default value is set to ieee8021AsDefaultDSTimeTraceable. Reference: 14.5.5
ieee8021AsTimePropertiesDSFrequencyTraceable
1.3.111.2.802.1.1.20.1.4.6
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The value is frequencyTraceable for the current grandmaster (see 14.2.14). It is equal to the global variable frequencyTraceable (see 10.3.8.8).
True (1) if the frequency determining the timescale is traceable to a primary reference; false (2) otherwise. The default value is set to ieee8021AsDefaultDSFrequencyTraceable. Reference: 14.5.6
ieee8021AsTimePropertiesDSTimeSource
1.3.111.2.802.1.1.20.1.4.7
IEEE8021ASTimeSourceValue16 = atomicClock32 = gps48 = terrestrialRadio64 = ptp80 = ntp96 = handSet144 = other160 = internalOscillatorThe timeSource is an information only attribute indicating the type of source of time used by a ClockMaster, representing categories. For example, the GPS entry would include not only the GPS system of the U.S. Department of Defense but the European Galileo system and other present and future satellite-based timing systems.
In the absence of a default value set by a user of this standard, the default value of timeSource shall be OTHER. See 7.6.2.6 of IEEE Std 1588 - 2008 for more detailed description of timeSourceIndicates the source of time used by the grandmaster clock.
The following interpretation placed on the value:
16: Atomic Clock,
32: GPS,
48: Terrestrial Radio,
64: PTP,
80: NTP,
96: Hand Set,
144: Other,
160: Internal OscillatorReference: 8.6.2.7 and Table 8-3 · Integer32
The value is timeSource for the current grandmaster (see 14.2.15). It is equal to the global variable timeTraceable (see 10.3.8.10).
Indicates the source of time used by the grandmaster clock. The default value is set to ieee8021AsDefaultDSTimeSource. Reference: 14.5.7
ieee8021AsAcceptableMasterTableDSMaxTableSize
1.3.111.2.802.1.1.20.1.7.1.1
Unsigned32 (0..65535)
The value is the maximum size of the AcceptableMasterTable. It is equal to the maxTableSize member of the AcceptableMasterTable structure (see 13.1.3.2) Reference: 14.8.1 and 13.1.3.2
ieee8021AsAcceptableMasterTableDSActualTableSize
1.3.111.2.802.1.1.20.1.7.1.2
Unsigned32 (0..65535)
The value is the actual size of the AcceptableMasterTable. It is equal to the actualTableSize member of the AcceptableMasterTable structure (see 13.1.3.2 and 13.1.3.5), i.e., the current number of elements in the acceptable master array. The actual table size is less than or equal to the max table size.
This value SHOULD be reflect the number of entries in
the ieee8021AsAcceptableMasterTableDSMasterTable.
For a time-aware system that contains an ONU attached to an IEEE 802.3 EPON link, the initialization value is 1. For a time-aware system that does not contain an ONU attached to an IEEE 802.3 EPON link, the initialization value is 0. Reference: 14.8.2 and 13.1.3.2
A table of gPTP port related variables in a time-aware Bridge or for a time-aware end station. A value of 1 is used in a bridge or an end station that does not have multiple components.
For a given media port of a Bridge or an end station, there may be one or more gPTP port, and depends whether a media port supports point to point link (e.g. IEEE 802.3 Ethernet) or point to multi-point (e.g. CSN, IEEE 802.3 EPON, etc) links on the media port. Reference: IEEE 802.1AS clause 14.6
ieee8021AsBridgeBasePort
1.3.111.2.802.1.1.20.1.5.1.1
IEEE8021BridgePortNumberAn integer that uniquely identifies a Bridge Port, as specified in 17.3.2.2. This value is used within the spanning tree protocol to identify this port to neighbor Bridges.Reference: 17.3.2.2 (1..65535) · Unsigned32 · hint d
This object identifies the bridge port number of the port for which this entry contains bridge management information. For end stations, this port number shall be (1). Reference: IEEE Std 802.1AS PortDS Group gPTP Port Index
ieee8021AsPortDSAsIfIndex
1.3.111.2.802.1.1.20.1.5.1.2
InterfaceIndexOrZeroThis textual convention is an extension of the InterfaceIndex convention. The latter defines a greater than zero value used to identify an interface or interface sub-layer in the managed system. This extension permits the additional value of zero. the value zero is object-specific and must therefore be defined as part of the description of any object which uses this syntax. Examples of the usage of zero might include situations where interface was unknown, or when none or all interfaces need to be referenced. (0..2147483647) · Integer32 · hint d
This object identifies the gPTP interface group within the system for which this entry contains information. It is the value of the instance of the IfIndex object, defined in the IF-MIB, for the gPTP interface group corresponding to this port, or the value 0 if the port has not been bound to an underlying frame source and sink.
For a given media port of a Bridge or an end station, there may be one or more gPTP port, and depends whether a media port supports point to point link (e.g. IEEE 802.3 Ethernet) or point to multi-point (e.g. CSN, IEEE 802.3 EPON, etc) links on the media port. Reference: IEEE Std 802.1AS PortDS Group gPTP Port Index
ieee8021AsPortDSClockIdentity
1.3.111.2.802.1.1.20.1.5.1.3
ClockIdentityRepresents an IEEE 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, EUI-64. EUI-48 converts to EUI-64 as specified by IEEE. The conversion assigns values 255 and 254 to octets 3 and 4 respectively, where octet 0 is the most significant and octet 7 the least. For example, EUI-48 of AC:DE:48:23:45:67 would extend to AC:DE:48:FF:FE:23:45:67.Reference: 6.3.3.6 and 8.5.2.2.1 SIZE (8) · OCTET STRING · hint 1x:
The clockIdentity is an 8 octet array formed by mapping an IEEE EUI-48 assigned to the time-aware system to IEEE EUI-64 format (i.e., to an array of 8 octets). The EUI-48 shall be an Ethernet MAC address owned by the organization creating the instance of a clockIdentity under the terms of this subclause. The organization owning the MAC address shall ensure that the MAC address is used in generating only a single instance of a clockIdentity, for example by requiring that the MAC address be a MAC address embedded in the device identified by the clockIdentity. The mapping rules for constructing the EUI-64 from the EUI-48 shall be those specified by the IEEE [B2]. The 8 octets of the created IEEE EUI-64 shall be assigned in order to the 8 octet array clockIdentity with most significant octet of the IEEE EUI-64 assigned to the clockIdentity octet array member with index 0.(see 8.5.2.2). Reference: 14.6.2
ieee8021AsPortDSPortNumber
1.3.111.2.802.1.1.20.1.5.1.4
Unsigned32 (0..65535)
The portNumber value for a port on a time-aware end station (i.e., a time-aware system supporting a single gPTP port) shall be 1. The portNumber values for the gPTP ports on a time-aware bridgeBridge supporting N
ports shall be 1, 2, ?, N, respectively (see 8.5.2.3) . Reference: 14.6.2
The value is the value of the port role of this port (see Table 10-1), and is taken from the enumeration in Table 14-5. All other values reserved. The enumeration values are consistent with IEEE Std 1588TM-2008, Table 8. The default value is 3 (DisabledPort). Reference: 14.6.3
ieee8021AsPortDSPttPortEnabled
1.3.111.2.802.1.1.20.1.5.1.6
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
802.1AS function enable for a given port. True (1) if the time-synchronization and best master selection functions of the port are enabled; False (2) otherwise (see 10.2.4.12).
The contents of this table SHALL be maintained across a
restart of the system. Reference: 14.6.4
ieee8021AsPortDSIsMeasuringDelay
1.3.111.2.802.1.1.20.1.5.1.7
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
True (1) if the port is measuring link propagation delay; The value is equal to the value of the Boolean isMeasuringPdDelay (see 11.2.12.5 and E.4.3.2) False (2) otherwise. Reference: 14.6.5
ieee8021AsPortDSAsCapable
1.3.111.2.802.1.1.20.1.5.1.8
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
True (1) if and only if it is determined that this time-aware system and the time-aware system at the other ends of the link attached to this port can interoperate with each other via the IEEE 802.1AS protocol; False (2) otherwise. Reference: 14.6.6
ieee8021AsPortDSNeighborPropDelayHs
1.3.111.2.802.1.1.20.1.5.1.9
Unsigned32 · 2**-16 ns * 2**64
The most (highest) significant 32 bits, unsigned 96 bit number in 2**-16 ns, the value is equal to the value of the per-port global variable neighborPropDelay (see 10.2.4.6). It is an estimate of the current one-way propagation time on the link attached to this port, measured as specified for the respective medium (see 11.2.15, 12.5, and E.4). The value is zero for ports attached to IEEE 802.3 EPON links and for the master port of an IEEE 802.11 link, because one-way propagation delay is not measured on the latter and not directly measured on the former. It is recommended that the data type be scaled in ns. The initialization value is zero.
This object MUST be read at the same time as ieee8021AsPortDSNeighborPropDelayMs, and ieee8021AsPortDSNeighborPropDelayLs, which represents middle and least significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.6.7
ieee8021AsPortDSNeighborPropDelayMs
1.3.111.2.802.1.1.20.1.5.1.10
Unsigned32 · 2**-16 ns * 2**32
The second most (middle) significant 32 bits, unsigned 96 bit number in 2**-16 ns, the value is equal to the value of the per-port global variable neighborPropDelay (see 10.2.4.6). It is an estimate of the current one-way propagation time on the link attached to this port, measured as specified for the respective medium (see 11.2.15, 12.5, and E.4). The value is zero for ports attached to IEEE 802.3 EPON links and for the master port of an IEEE 802.11 link, because one-way propagation delay is not measured on the latter and not directly measured on the former. It is recommended that the data type be scaled in ns. The initialization value is zero.
This object MUST be read at the same time as ieee8021AsPortDSNeighborPropDelayHs, and ieee8021AsPortDSNeighborPropDelayLs, which represents most (highest) and least significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.6.7
ieee8021AsPortDSNeighborPropDelayLs
1.3.111.2.802.1.1.20.1.5.1.11
Unsigned32 · 2**-16 ns
The least significant 32 bits, unsigned 96 bit number in 2**-16 ns, the value is equal to the value of the per-port global variable neighborPropDelay (see 10.2.4.6). It is an estimate of the current one-way propagation time on the link attached to this port, measured as specified for the respective medium (see 11.2.15, 12.5, and E.4). The value is zero for ports attached to IEEE 802.3 EPON links and for the master port of an IEEE 802.11 link, because one-way propagation delay is not measured on the latter and not directly measured on the former. It is recommended that the data type be scaled in ns. The initialization value is zero.
This object MUST be read at the same time as ieee8021AsPortDSNeighborPropDelayHs, and ieee8021AsPortDSNeighborPropDelayMs, which represents most (highest) and middle significant 32 bits of values, respectively, in order for the read operation to succeed. Reference: 14.6.7
ieee8021AsPortDSNeighborPropDelayThreshHs
1.3.111.2.802.1.1.20.1.5.1.12
Unsigned32 · 2**-16 ns * 2 ** 64
The most (highest) significant 32 bits, unsigned 96 bit number in 2**-16 ns, the value is equal to the value of the per-port global variable neighborPropDelayThresh (see 11.2.12.5). It is the propagation time threshold, above which a port is not considered capable of participating in the 802.1AS protocol
This object MUST be read or written at the same time as ieee8021AsPortDSNeighborPropDelayThreshMs, and ieee8021AsPortDSNeighborPropDelayThreshLs, which represents middle and least significant 32 bits of values, respectively, in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.8
ieee8021AsPortDSNeighborPropDelayThreshMs
1.3.111.2.802.1.1.20.1.5.1.13
Unsigned32 · 2**-16 ns * 2 ** 32
The middle significant 32 bits, unsigned 96 bit number in 2**-16 ns, the value is equal to the value of the per-port global variable neighborPropDelayThresh (see 11.2.12.5). It is the propagation time threshold, above which a port is not considered capable of participating in the 802.1AS protocol
This object MUST be read or written at the same time as ieee8021AsPortDSNeighborPropDelayThreshHs, and ieee8021AsPortDSNeighborPropDelayThreshLs, which represents most (highest) and least significant 32 bits of values, respectively, in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.8
ieee8021AsPortDSNeighborPropDelayThreshLs
1.3.111.2.802.1.1.20.1.5.1.14
Unsigned32 · 2**-16 ns
The least significant 32 bits, unsigned 96 bit number in 2**-16 ns, the value is equal to the value of the per-port global variable neighborPropDelayThresh (see 11.2.12.5). It is the propagation time threshold, above which a port is not considered capable of participating in the 802.1AS protocol
This object MUST be read at the same time as ieee8021AsPortDSNeighborPropDelayThreshHs, and ieee8021AsPortDSNeighborPropDelayThreshMs, which represents most (highest) and middle significant 32 bits of values, respectively, in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.8
ieee8021AsPortDSDelayAsymmetryHs
1.3.111.2.802.1.1.20.1.5.1.15
Integer32 · 2**-16 ns * 2**64
The most (highest) significant 32 bits, signed 96 bit number in 2**-16 ns. The value is the asymmetry in the propagation delay on the link attached to this port relative to the grandmaster time base, as defined in 8.3. If propagation delay asymmetry is not modeled, then delayAsymmetry is 0.
This object MUST be read or written at the same time as ieee8021AsPortDSDelayAsymmetryMs, and ieee8021AsPortDSDelayAsymmetryLs, which represents middle and least significant 32 bits of values, respectively, in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.9 and 8.3
ieee8021AsPortDSDelayAsymmetryMs
1.3.111.2.802.1.1.20.1.5.1.16
Unsigned32 · 2**-16 ns * 2**32
The middle significant 32 bits, signed 96 bit number in 2**-16 ns. The value is the asymmetry in the propagation delay on the link attached to this port relative to the grandmaster time base, as defined in 8.3. If propagation delay asymmetry is not modeled, then delayAsymmetry is 0.
This object MUST be read or written at the same time as ieee8021AsPortDSDelayAsymmetryHs, and ieee8021AsPortDSDelayAsymmetryLs, which represents middle and least significant 32 bits of values, respectively, in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.9 and 8.3
ieee8021AsPortDSDelayAsymmetryLs
1.3.111.2.802.1.1.20.1.5.1.17
Unsigned32 · 2**-16 ns
The least significant 32 bits, signed 96 bit number in 2**-16 ns. The value is the asymmetry in the propagation delay on the link attached to this port relative to the grandmaster time base, as defined in 8.3. If propagation delay asymmetry is not modeled, then delayAsymmetry is 0.
This object MUST be read or written at the same time as ieee8021AsPortDSDelayAsymmetryHs, and ieee8021AsPortDSDelayAsymmetryLs, which represents most (highest) and least significant 32 bits of values, respectively, in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.9 and 8.3
ieee8021AsPortDSNeighborRateRatio
1.3.111.2.802.1.1.20.1.5.1.18
Integer32
The value is an estimate of the ratio of the frequency of the LocalClock entity of the time-aware system at the other end of the link attached to this port, to the frequency of the LocalClock entity of this time-aware system (see 10.2.4.6). Neighbor rate ratio is expressed as the fractional frequency offset multiplied by 2**41, i.e., the quantity (neighborRateRatio - 1.0)(2**41). Reference: 14.6.10
ieee8021AsPortDSInitialLogAnnounceInterval
1.3.111.2.802.1.1.20.1.5.1.19
Integer32 (-128..127)
The value is the logarithm to the base 2 of the of the
announce interval used when
(a) the port is initialized, or (b) a message interval request TLV is received with announceInterval field set to 126 (see 10.6.2.2 and and the AnnounceIntervalSetting state machine 10.3.14) The default value is 0.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.11
ieee8021AsPortDSCurrentLogAnnounceInterval
1.3.111.2.802.1.1.20.1.5.1.20
Integer32 (-128..127)
The value is the logarithm to the base 2 of the of the current announce transmission interval.
The currentLogAnnounceInterval specifies the current value of the announce interval. Every port supports the value 127; the port does not send Announce messages when currentLogAnnounceInterval has this value (see 10.3.14). A port may support other values, except for the reserved values -128 through - 125, inclusive, and 124 through 126, inclusive. A port ignores requests (see 10.3.14) for unsupported values. Reference: 14.6.12
ieee8021AsPortDSAnnounceReceiptTimeout
1.3.111.2.802.1.1.20.1.5.1.21
Unsigned32 (0..255)
The value is the number of Announce message transmission intervals that a slave port waits without receiving an Announce message, before assuming that the master is no longer transmitting Announce messages, and that the BMC algorithm needs to be run, if appropriate. The condition of the slave port not receiving an Announce message for announceReceiptTimeout announce intervals is referred to as 'announce receipt timeout'.
The default value is 3 (see 10.6.3.2).
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.13
ieee8021AsPortDSInitialLogSyncInterval
1.3.111.2.802.1.1.20.1.5.1.22
Integer32 (-128..127)
The value is the logarithm to the base 2 of the sync interval used when, (a) the port is initialized, or (b) a message interval request TLV is received with the timeSyncInterval field set to 126 (see 10.6.2.3, 11.5.2.3, 12.6.2, 13.9.2, and the LinkDelaySyncIntervalSetting state machine, 11.2.17).
The initialization value is -3 (see 10.6.2.3).
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.14
ieee8021AsPortDSCurrentLogSyncInterval
1.3.111.2.802.1.1.20.1.5.1.23
Integer32 (-128..127)
The value is the logarithm to the base 2 of the current time-synchronization transmission interval, see 10.6.2.3.
The initialization value is -3. Reference: 14.6.15
ieee8021AsPortDSSyncReceiptTimeout
1.3.111.2.802.1.1.20.1.5.1.24
Unsigned32 (0..255)
The value of this attribute tells a slave port the number of sync intervals to wait without receiving synchronization information, before assuming that the master is no longer transmitting synchronization information, and that the BMC algorithm needs to be run, if appropriate. The condition of the slave port not receiving synchronization information for syncReceiptTimeout sync intervals is referred to as 'sync receipt timeout'.
The initialization value is 3 (see 10.6.3.1).
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.16
ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalHs
1.3.111.2.802.1.1.20.1.5.1.25
Unsigned32 · 2**-16 ns
The most (highest) significant 32 bits, of unsigned 96 bit number in 2**-16 ns. The value is equal to the value of the per port global variable syncReceiptTimeoutTimeInterval (see 10.2.4.2). It is the time interval after which sync receipt timeout occurs if time-synchronization information has not been received during the interval.
This object MUST be read at the same time as
ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalMs, and ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalLs, which represents middle and least significant 32 bits of values, respectively, in order for the read operation to succeed.
Default value is calculated per 10.2.4.2, or '0000 0000 0000 165A 0BC0 0000'h.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.17
ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalMs
1.3.111.2.802.1.1.20.1.5.1.26
Unsigned32 · 2**-16 ns * 2**32
The middle significant 32 bits, unsigned 96 bit number in 2**-16 ns. The value is equal to the value of the per port global variable syncReceiptTimeoutTimeInterval (see 10.2.4.2). It is the time interval after which sync receipt timeout occurs if time-synchronization information has not been received during the interval.
This object MUST be read at the same time as
ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalHs, and ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalLs, which represents most (highest) and least significant 32 bits of values, respectively, in order for the read operation to succeed.
Default value is calculated per 10.2.4.2, or '0000 0000 0000 165A 0BC0 0000'h.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.17
ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalLs
1.3.111.2.802.1.1.20.1.5.1.27
Unsigned32 · 2**-16 ns
The least significant 32 bits, unsigned 96 bit number in 2**-16 ns. The value is equal to the value of the per port global variable syncReceiptTimeoutTimeInterval (see 10.2.4.2). It is the time interval after which sync receipt timeout occurs if time-synchronization information has not been received during the interval.
This object MUST be read at the same time as
ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalHs, and ieee8021AsPortDSSyncReceiptTimeoutTimeIntervalMs, which represents most (highest) and middle significant 32 bits of values, respectively, in order for the read operation to succeed.
Default value is calculated per 10.2.4.2, or '0000 0000 0000 165A 0BC0 0000'h.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.17
ieee8021AsPortDSInitialLogPdelayReqInterval
1.3.111.2.802.1.1.20.1.5.1.28
Integer32 (-128..127)
For full-duplex, IEEE 802.3 media and CSN media that use the peer delay mechanism to measure path delay (see E.4.3.1), the value is the logarithm to the base 2 of the Pdelay_Req message transmission interval used when, (a) the port is initialized, or (b) a message interval request TLV is received with the linkDelayInterval field set to 126 (see 11.5.2.2 and the LinkDelaySyncIntervalSetting state machine, 11.2.17).
For these media, the initialization value is 0. For all other media, the value is 127.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.18
ieee8021AsPortDSCurrentLogPdelayReqInterval
1.3.111.2.802.1.1.20.1.5.1.29
Integer32 (-128..127)
For full-duplex, IEEE 802.3 media and CSN media that use the peer delay mechanism to measure path delay (see E.4.3.1), the value is the logarithm to the base 2 of the current Pdelay_Req message transmission interval, see 11.5.2.2.
For all other media, the value is 127.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.19
ieee8021AsPortDSAllowedLostResponses
1.3.111.2.802.1.1.20.1.5.1.30
Unsigned32 (0..65535)
The value is equal to the value of the per-port global variable allowedLostResponses (see 11.2.12.4). It is the number of Pdelay_Req messages for which a valid response is not received, above which a port is considered to not be exchanging peer delay messages with its neighbor. Reference: 14.6.20 and 11.5.3
ieee8021AsPortDSVersionNumber
1.3.111.2.802.1.1.20.1.5.1.31
Unsigned32 (0..63)
Indicates the PTP version in use on the port. The version number for this standard is set to the value 2 (see 10.5.2.2.3).
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.21
ieee8021AsPortDSNupMs
1.3.111.2.802.1.1.20.1.5.1.32
Unsigned32
The most significant 32 bits, of unsigned 64 bit fixed point number between 0 and less than 2. For an OLT port of an IEEE 802.3 EPON link, the value is the effective index of refraction for the EPON upstream wavelength light of the optical path (see 13.1.4 and 13.8.1.2). The default value is 1.46770 for 1 Gb/s upstream links, and 1.46773 for 10 Gb/s upstream links. For all other ports, the value is 0.
This object MUST be read or written at the same time as ieee8021AsPortDSNupLs, which represents least significant 32 bits of the value in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.22
ieee8021AsPortDSNupLs
1.3.111.2.802.1.1.20.1.5.1.33
Unsigned32
The least significant 32 bits, of unsigned 64 bit fixed point number between 0 and less than 2. For an OLT port of an IEEE 802.3 EPON link, the value is the effective index of refraction for the EPON upstream wavelength light of the optical path (see 13.1.4 and 13.8.1.2). The default value is 1.46770 for 1 Gb/s upstream links, and 1.46773 for 10 Gb/s upstream links.
For all other ports, the value is 0.
This object MUST be read or written at the same time as ieee8021AsPortDSNupMs, which represents the most significant 32 bits of the value in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.22
ieee8021AsPortDSNdownMs
1.3.111.2.802.1.1.20.1.5.1.34
Unsigned32
The least significant 32 bits, of unsigned 64 bit fixed point number between 0 and less than 2. For an OLT port of an IEEE 802.3 EPON link, the value is the effective index of refraction for the EPON downstream wavelength light of the optical path (see 13.1.4 and 13.8.1.2.2). The default value is 1.46805 for 1 Gb/s downstream links, and 1.46851 for 10 Gb/s downstream links.
For all other ports, the value is 0.
This object MUST be read or written at the same time as ieee8021AsPortDSNdownLs, which represents the least significant 32 bits of the value in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.23
ieee8021AsPortDSNdownLs
1.3.111.2.802.1.1.20.1.5.1.35
Unsigned32
The least significant 32 bits, of unsigned 64 bit fixed point number between 0 and less than 2. For an OLT port of an IEEE 802.3 EPON link, the value is the effective index of refraction for the EPON downstream wavelength light of the optical path (see 13.1.4 and 13.8.1.2.1). The default value is 1.46805 for 1 Gb/s downstream links, and 1.46851 for 10 Gb/s downstream links.
For all other ports, the value is 0.
This object MUST be read or written at the same time as ieee8021AsPortDSNdownMs, which represents the most significant 32 bits of the value in order for the read or write operation to succeed.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.23
ieee8021AsPortDSAcceptableMasterTableEnabled
1.3.111.2.802.1.1.20.1.5.1.36
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
True (1) if acceptableMasterTableEnabled (see 13.1.3.1) and 13.1.3.5) is true and an ONU port attached to an IEEE 802.3 EPON link in a time-aware system.
False (2), otherwise.
The default value is FALSE.
The contents of this variable SHALL be maintained across a restart of the system. Reference: 14.6.24
A table of time-aware port related counters in a gPTP domain. A value of 1 is used in a bridge or an end station that does not have multiple components. Reference: IEEE 802.1AS clause 14.7
ieee8021AsPortStatRxSyncCount
1.3.111.2.802.1.1.20.1.6.1.1
Counter32
A counter that increments every time synchronization information is received, denoted by a transition to TRUE from FALSE of the rcvdSync variable of the MDSyncReceiveSM state machine (see 11.2.13.1.2 and Figure 11-6), when in the DISCARD or WAITING_FOR_SYNC states; or rcvdIndication transitions to TRUE (see Figure 12-3). Reference: 14.7.2
ieee8021AsPortStatRxFollowUpCount
1.3.111.2.802.1.1.20.1.6.1.2
Counter32
A counter that increments every time a Follow_Up message is received, denoted by a transition to TRUE from FALSE of the rcvdFollowUp variable of the MDSyncReceiveSM state machine (see 11.2.13.1.3 and Figure 11-6) when in the WAITING_FOR_FOLLOW_UP state. Reference: 14.7.3
ieee8021AsPortStatRxPdelayRequest
1.3.111.2.802.1.1.20.1.6.1.3
Counter32
A counter that increments every time a Pdelay_Req message is received, denoted by a transition to TRUE from FALSE of the rcvdPdelayReq variable of the MDPdelayResp state machine (see 11.2.16.1.1 and Figure 11-9) when in the WAITING_FOR_PDELAY_REQ or INITIAL_WAITING_FOR_PDELAY_REQ states. Reference: 14.7.4
ieee8021AsPortStatRxPdelayResponse
1.3.111.2.802.1.1.20.1.6.1.4
Counter32
A counter that increments every time a Pdelay_Resp message is received, denoted by a transition to TRUE from FALSE of the rcvdPdelayResp variable of the MDPdelayReq state machine (see 11.2.15.1.2 and Figure 11-8) when in the WAITING_FOR_PDELAY_RESP state. Reference: 14.7.5
ieee8021AsPortStatRxPdelayResponseFollowUp
1.3.111.2.802.1.1.20.1.6.1.5
Counter32
A counter that increments every time a Pdelay_Resp_Follow_Up message is received, denoted by a transition to TRUE from FALSE of the rcvdPdelayRespFollowUp variable of the MDPdelayReq state machine (see 11.2.15.1.4 and Figure 11-8) when in the WAITING_FOR_PDELAY_RESP_FOLLOW_UP state. Reference: 14.7.6
ieee8021AsPortStatRxAnnounce
1.3.111.2.802.1.1.20.1.6.1.6
Counter32
A counter that increments every time an Announce message is received, denoted by a transition to TRUE from FALSE of the rcvdAnnounce variable of the PortAnnounceReceive state machine (see 10.3.10 and Figure 10-12) when in the DISCARD or RECEIVE states. Reference: 14.7.7
ieee8021AsPortStatRxPTPPacketDiscard
1.3.111.2.802.1.1.20.1.6.1.7
Counter32
A counter that increments every time a PTP message is discarded, caused by the occurrence of any of the following conditions:
a) A received Announce message is not qualified, denoted by the function qualifyAnnounce (see 10.3.10.2.1 and 13.1.3.4) of the PortAnnounceReceive state machine (see 10.3.10 and Figure 10-12) returning FALSE; b) A Follow_Up message corresponding to a received Sync message is not received, denoted by a transition of the condition (currentTime greater or equal to followUpReceiptTimeoutTime) to TRUE from FALSE when in the WAITING_FOR_FOLLOW_UP state of the MDSyncReceiveSM state machine (see 11.2.13 and Figure 11-6); c) A Pdelay_Resp message corresponding to a transmitted Pdelay_Req message is not received, denoted by a transition from the WAITING_FOR_PDELAY_RESP state to the RESET state of the MDPdelayReq state machine (see 11.2.15 and Figure 11-8); d) A Pdelay_Resp_Follow_Up message corresponding to a transmitted Pdelay_Req message is not received, denoted by a transition from the WAITING_FOR_PDELAY_RESP_FOLLOW_UP state to the RESET state of the MDPdelayReq state machine (see 11.2.15 and Figure 11-8). Reference: 14.7.8
ieee8021AsPortStatRxSyncReceiptTimeouts
1.3.111.2.802.1.1.20.1.6.1.8
Counter32
A counter that increments every time sync receipt timeout occurs, denoted by entering the AGED state of the PortAnnounceInformation state machine (see 10.3.11 and Figure 10-13), with the condition (currentTime greater or equual to announceReceiptTimeoutTime) TRUE Reference: 14.7.9
ieee8021AsPortStatAnnounceReceiptTimeouts
1.3.111.2.802.1.1.20.1.6.1.9
Counter32
A counter that increments every time announce receipt timeout occurs, denoted by entering the AGED state of the PortAnnounceInformation state machine (see 10.3.11 and Figure 10-13), with the condition ((currentTime greater than or equal to syncReceiptTimeoutTime) AND gmPresent)) TRUE. Reference: 14.7.10
A counter that increments everytime the value of the variable lostResponses (see, 11.2.15.1.10) exceeds the value of the variable allowedLostResponses (see 11.2.12.4), in the RESET state of the MDPdelayReq state machine (see 11.2.15 and Figure 11-8) Reference: 14.7.11
ieee8021AsPortStatTxSyncCount
1.3.111.2.802.1.1.20.1.6.1.11
Counter32
A counter that increments every time synchronization information is transmitted, denoted by a transition to TRUE from FALSE of the rcvdMDSync variable of the MDSyncSendSM state machine (see 11.2.14.1.1 and Figure 11-7), when in the INITIALIZING or SEND_FOLLOW_UP states; or the INITIATE_REQUEST_WAIT_CONFIRM state is entered in Figure 12-3. Reference: 14.7.12
ieee8021AsPortStatTxFollowUpCount
1.3.111.2.802.1.1.20.1.6.1.12
Counter32
A counter that increments every time a Follow_Up message is transmitted, denoted by a transition to TRUE from FALSE of the rcvdMDTimestampReceive variable of the MDSyncSendSM state machine (see 11.2.14.1.3 and Figure 11-7), when in the SEND_SYNC state increments every time a Follow_Up packet is transmitted. Reference: 14.7.13
ieee8021AsPortStatTxPdelayRequest
1.3.111.2.802.1.1.20.1.6.1.13
Counter32
A counter that increments every time a Pdelay_Req message is transmitted, denoted by entering the INITIAL_SEND_PDELAY_REQ or SEND_PDELAY_REQ states of the MDPdelayReq state machine (see 11.2.15 and Figure 11-8). Reference: 14.7.14
ieee8021AsPortStatTxPdelayResponse
1.3.111.2.802.1.1.20.1.6.1.14
Counter32
A counter that increments every time a Pdelay_Resp message is transmitted, denoted by a transition to TRUE from FALSE of the rcvdPdelayReq variable of the MDPdelayResp state machine (see 11.2.16.1.1 and Figure 11-9) when in the WAITING_FOR_PDELAY_REQ or INITIAL_WAITING_FOR_PDELAY_REQ states, and resulting entry to the SENT_PDELAY_RESP_WAITING_FOR_TIMESTAMP state. Reference: 14.7.15
ieee8021AsPortStatTxPdelayResponseFollowUp
1.3.111.2.802.1.1.20.1.6.1.15
Counter32
A counter that increments every time a Pdelay_Resp_Follow_Up message is transmitted, denoted by a transition to TRUE from FALSE of the rcvdMDTimestampReceive variable of the MDPdelayResp state machine (see 11.2.16.1.2 and Figure 11-9) when in the SENT_PDELAY_RESP_WAITING_FOR_TIMESTAMP state, and resulting entry to the WAITING_FOR_PDELAY_REQ state. Reference: 14.7.16
ieee8021AsPortStatTxAnnounce
1.3.111.2.802.1.1.20.1.6.1.16
Counter32
A counter that increments every time an Announce message is transmitted, denoted by entering the TRANSMIT_ANNOUNCE state of the PortAnnounceReceive state machine (see 10.3.13 and Figure 10-15). Reference: 14.7.17
ieee8021AsAcceptableMasterTableDSMasterTable
1.3.111.2.802.1.1.20.1.7.2.1
Index: ieee8021AsAcceptableMasterTableDSMasterId
A table of time-aware port related variables in a time-aware bridge or for a time-aware end station. A value of 1 is used in a bridge or an end station that does not have multiple components.
The contents of this table SHALL be maintained across a restart of the system. Reference: IEEE 802.1AS clause 14.8
ieee8021AsAcceptableMasterTableDSMasterId
1.3.111.2.802.1.1.20.1.7.2.1.1.1
Unsigned32
Acceptable Master row entry index in this ieee8021AsAcceptableMasterTabdDSMaster Entry applies. If the does not contain Media type of EPON, this variable (index) MUST be equal to 0.
ieee8021AsAcceptableMasterClockIdentity
1.3.111.2.802.1.1.20.1.7.2.1.1.2
ClockIdentityRepresents an IEEE 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, EUI-64. EUI-48 converts to EUI-64 as specified by IEEE. The conversion assigns values 255 and 254 to octets 3 and 4 respectively, where octet 0 is the most significant and octet 7 the least. For example, EUI-48 of AC:DE:48:23:45:67 would extend to AC:DE:48:FF:FE:23:45:67.Reference: 6.3.3.6 and 8.5.2.2.1 SIZE (8) · OCTET STRING · hint 1x:
Globally unique manufacturer-assigned clock identifier for the local clock port. The identifier is based on an EUI-64. Reference: 14.8.3
ieee8021AsAcceptableMasterPortNumber
1.3.111.2.802.1.1.20.1.7.2.1.1.3
Unsigned32 (0..65535)
This object represents a Port or aggregated port on a bridge component or end-station. This object and ieee8021AsAcceptableMasterClockIdentity together forms AcceptableMasterDS Port Identity. Reference: 14.8.3
ieee8021AsAcceptableMasterAlternatePriority1
1.3.111.2.802.1.1.20.1.7.2.1.1.4
Unsigned32 (0..255)
If the alternatePriority1 member of the AcceptableMaster array element that corresponds to the sourcePortIdentity of a received Announce message is greater than 0, the value of the grandmasterPriority1 field of the Announce message is replaced by the value of alternatePriority1 of this AcceptableMaster array element for use in the invocation of BMCA Reference: 14.8.3 and 13.1.3.4
ieee8021AsAcceptableMasterRowStatus
1.3.111.2.802.1.1.20.1.7.2.1.1.5
RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is available for use by the managed device;
- `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
- `notReady', 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 (i.e., one or more required columns in the conceptual row have not been instanciated);
- `createAndGo', 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', 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', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'.
Also note that whenever any elements of a row exist, the RowStatus column must also exist.
To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram:
STATE +--------------+-----------+-------------+-------------
| A | B | C | D
| |status col.|status column|
|status column | is | is |status column
ACTION |does not exist| notReady | notInService| is active
--------------+--------------+-----------+-------------+-------------
set status |noError ->D|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndGo |inconsistent- | | |
| Value| | |
--------------+--------------+-----------+-------------+-------------
set status |noError see 1|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndWait |wrongValue | | |
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError
column to | Value| entValue| |
active | | | |
| | or | |
| | | |
| |see 2 ->D|see 8 ->D| ->D
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError ->C
column to | Value| entValue| |
notInService | | | |
| | or | | or
| | | |
| |see 3 ->C| ->C|see 6
--------------+--------------+-----------+-------------+-------------
set status |noError |noError |noError |noError ->A
column to | | | | or
destroy | ->A| ->A| ->A|see 7
--------------+--------------+-----------+-------------+-------------
set any other |see 4 |noError |noError |see 5
column to some| | | |
value | | see 1| ->C| ->D
--------------+--------------+-----------+-------------+-------------
(1) goto B or C, depending on information available to the agent.
(2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D.
(3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be either:
inconsistentName: because the agent does not choose to
create such an instance when the corresponding RowStatus instance does not exist, or
inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's value, or
noError: because the agent chooses to create the instance.
If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A.
(5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned.
(6) the return value can indicate one of the following errors:
wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or
inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated.
(7) the return value can indicate the following error:
inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated.
(8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue.
NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc.
Conceptual Row Creation
There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device.
Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics.
In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.)
Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different.
Finally, the management station could select a pseudo-random number to use as the index. In the event that this index
was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation.
A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used.
Interaction 2: Creating the Conceptual Row
Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions.
Interaction 2a: Creating and Activating the Conceptual Row
The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes:
- a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'.
When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information
available to the agent is provided by two sources: the
management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row.
NOTE WELL
Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm.
Interaction 2b: Negotiating the Creation of the Conceptual Row
The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3.
Interaction 3: Initializing non-defaulted Objects
The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes:
- a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4.
Interaction 4: Making the Conceptual Row Available
Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'.
NOTE WELL
A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device.
If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row.
Conceptual Row Suspension
When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified).
Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds,
then all instances associated with the conceptual row are immediately removed. · Integer32
This object indicates the status of an entry, and is used to create/delete entries. Reference: 14.8.3