Class datetime:NtpProviderStatus (CONCRETE)

Class ID:3960
Class Label: ProviderStatus
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-protocol-mgmt]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]



Naming Rules
RN FORMAT: status

    [1] PREFIX=status


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/time/prov-{name}/status

[1] sys/time/prov-{name}/status

                


Diagram

Container Mos: datetime:NtpProvider (deletable:yes),


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] datetime:ClkPol Represents the date/time clock policy information.
 
 
 
 
 
 ├
[V] datetime:NtpProvider Represents the date/time NTP provider information for the switch.
 
 
 
 
 
 
 ├
[V] datetime:NtpProviderStatus 
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] datetime:ClkPol Represents the date/time clock policy information.
 
 
 ├
[V] datetime:NtpProvider Represents the date/time NTP provider information for the switch.
 
 
 
 ├
[V] datetime:NtpProviderStatus 


Contained Hierarchy
[V] datetime:NtpProviderStatus 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] datetime:NtpProviderStatus 


Events
                


Faults
                datetime:NtpProviderStatus:ntp-prov-fault


Fsms
                


Properties Summary
Defined in: datetime:NtpProviderStatus
datetime:NTPAssocIdentifier
          scalar:Uint32
assocId  (datetime:NtpProviderStatus:assocId)
           A peer associated with the local NTP server.
string:Basic delay  (datetime:NtpProviderStatus:delay)
           The administrative port delay.
scalar:Sint32 delayRaw  (datetime:NtpProviderStatus:delayRaw)
          
datetime:NTPUnsignedTimeValue
          scalar:Uint32
dispersion  (datetime:NtpProviderStatus:dispersion)
           The estimated maximum error of the peer clock relative to the local clock over the network path between them in seconds.
datetime:Gauge32
          scalar:Uint32
filterValidEntries  (datetime:NtpProviderStatus:filterValidEntries)
           The number of valid entries for a peer in the filter register table.
datetime:PeerStatusFlags
          scalar:Bitmask8
flags  (datetime:NtpProviderStatus:flags)
           The IP address flags.
address:Ip hostAddress  (datetime:NtpProviderStatus:hostAddress)
           The IP address of the local host.
datetime:NTPPollInterval
          scalar:Sint32
hostPoll  (datetime:NtpProviderStatus:hostPoll)
           The interval (in seconds, powers of two) at which the local host polls the peer.
scalar:Uint32 hostPollSeconds  (datetime:NtpProviderStatus:hostPollSeconds)
          
scalar:Uint32 hostPort  (datetime:NtpProviderStatus:hostPort)
           The UDP port number on which the local host receives NTP messages.
datetime:NTPLeapIndicator
          scalar:UByte
leap  (datetime:NtpProviderStatus:leap)
           A signed fixed-point number indicating the total round-trip delay in seconds to the primary reference source at the root of the synchronization subnet.
datetime:NTPPeerMode
          scalar:Enum8
mode  (datetime:NtpProviderStatus:mode)
           The BGP Domain mode.
reference:BinRef monPolDn  (datetime:NtpProviderStatus:monPolDn)
           The monitoring policy attached to this observable object.
scalar:Bitmask64 ntpdCfgFailedBmp  (datetime:NtpProviderStatus:ntpdCfgFailedBmp)
           A bitmap of configuration attributes that failed to be applied.
scalar:Time ntpdCfgFailedTs  (datetime:NtpProviderStatus:ntpdCfgFailedTs)
          
scalar:UByte ntpdCfgState  (datetime:NtpProviderStatus:ntpdCfgState)
           The configuration state of a remote NTPD destination.
scalar:Sint32 offset  (datetime:NtpProviderStatus:offset)
           The estimated offset of the peer clock relative to the local clock, in seconds.
scalar:Date orgTime  (datetime:NtpProviderStatus:orgTime)
           The local time at the peer when its latest NTP message was sent. If the peer becomes unreachable the value is set to zero.
scalar:Uint64 orgTimeRaw  (datetime:NtpProviderStatus:orgTimeRaw)
           The local time at the peer when its latest NTP message was sent. If the peer becomes unreachable the value is set to zero (NTPD format).
address:Ip peerAddress  (datetime:NtpProviderStatus:peerAddress)
           The IP address of the peer.
string:Basic peerName  (datetime:NtpProviderStatus:peerName)
           The address of the peer
datetime:NTPPollInterval
          scalar:Sint32
peerPoll  (datetime:NtpProviderStatus:peerPoll)
           The interval at which the peer polls the local host.
scalar:Uint32 peerPort  (datetime:NtpProviderStatus:peerPort)
           The UDP port number on which the peer receives NTP messages.
datetime:InetAddressType
          scalar:Enum8
peerType  (datetime:NtpProviderStatus:peerType)
           The address format of the peer.
scalar:Sint32 precision  (datetime:NtpProviderStatus:precision)
           A signed integer indicating the precision of the peer clock in seconds to the nearest power of two.
scalar:UByte reach  (datetime:NtpProviderStatus:reach)
           A shift register used to determine the reachability status of the peer.
scalar:Date receiveTime  (datetime:NtpProviderStatus:receiveTime)
           The local time when the latest NTP message from the peer arrived. If the peer becomes unreachable the value is set to zero.
scalar:Uint64 receiveTimeRaw  (datetime:NtpProviderStatus:receiveTimeRaw)
           The local time when the latest NTP message from the peer arrived. If the peer becomes unreachable the value is set to zero (Raw NTPD Format).
datetime:NTPRefId
          address:IPv4
refId  (datetime:NtpProviderStatus:refId)
           The reference identifier of the peer.
scalar:Date refTime  (datetime:NtpProviderStatus:refTime)
           The local time when the local clock was last updated. If the local clock has never been synchronized, the value is zero.
scalar:Uint64 refTimeRaw  (datetime:NtpProviderStatus:refTimeRaw)
           The local time when the local clock was last updated. If the local clock has never been synchronized, the value is zero (raw NTPD format).
datetime:NTPSignedTimeValue
          scalar:Sint32
rootDelay  (datetime:NtpProviderStatus:rootDelay)
           A signed fixed-point number indicating the total round-trip delay in seconds, to the primary reference source at the root of the synchronization subnet.
datetime:NTPUnsignedTimeValue
          scalar:Uint32
rootDispersion  (datetime:NtpProviderStatus:rootDispersion)
           The maximum error in seconds relative to the primary reference source at the root of the synchronization subnet.
datetime:NTPStratum
          scalar:UByte
stratum  (datetime:NtpProviderStatus:stratum)
           The stratum of the peer clock.
scalar:Uint32 timer  (datetime:NtpProviderStatus:timer)
           The interval, in seconds, between transmitted NTP messages from the local host to the peer.
scalar:Date transmitTime  (datetime:NtpProviderStatus:transmitTime)
           The local time at which the NTP message departed the sender.
scalar:Uint64 transmitTimeRaw  (datetime:NtpProviderStatus:transmitTimeRaw)
           The local time at which the NTP message departed the sender (raw NTPD format).
scalar:Uint32 updateTime  (datetime:NtpProviderStatus:updateTime)
           The local time when the most recent NTP message was received from the peer was used to calculate the skew dispersion.
scalar:Uint64 updateTimeRaw  (datetime:NtpProviderStatus:updateTimeRaw)
           The local time when the most recent NTP message was received from the peer that was used to calculate the skew dispersion (raw NTPD format).
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

assocId

Type: datetime:NTPAssocIdentifier
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A peer associated with the local NTP server.



childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





delay

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The administrative port delay.



delayRaw

Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



dispersion

Type: datetime:NTPUnsignedTimeValue
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The estimated maximum error of the peer clock relative to the local clock over the network path between them in seconds.



dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



filterValidEntries

Type: datetime:Gauge32
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The number of valid entries for a peer in the filter register table.



flags

Type: datetime:PeerStatusFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IP address flags.
Constants
configured 1 Configured NO COMMENTS
preferred 2 Preferred NO COMMENTS
DEFAULT 0 --- NTP Peer Status flags





hostAddress

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IP address of the local host.



hostPoll

Type: datetime:NTPPollInterval
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The interval (in seconds, powers of two) at which the local host polls the peer.



hostPollSeconds

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



hostPort

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The UDP port number on which the local host receives NTP messages.



leap

Type: datetime:NTPLeapIndicator
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A signed fixed-point number indicating the total round-trip delay in seconds to the primary reference source at the root of the synchronization subnet.



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





mode

Type: datetime:NTPPeerMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The BGP Domain mode.
Constants
unspecified 0 Unspecified NO COMMENTS
symmetricActive 1 Symmetric Active NO COMMENTS
symmetricPassive 2 Symmetric Passive NO COMMENTS
client 3 Client NO COMMENTS
server 4 Server NO COMMENTS
broadcast 5 Broadcast NO COMMENTS
reservedControl 6 Reserved Control NO COMMENTS
reservedPrivate 7 Reserved Private NO COMMENTS
DEFAULT 0 --- NTP Peer Mode





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



ntpdCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A bitmap of configuration attributes that failed to be applied.
Constants
datetime:NtpProviderStatusmonPolDn_failed_flag 4096ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





ntpdCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:



ntpdCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The configuration state of a remote NTPD destination.



offset

Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The estimated offset of the peer clock relative to the local clock, in seconds.



orgTime

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time at the peer when its latest NTP message was sent. If the peer becomes unreachable the value is set to zero.



orgTimeRaw

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time at the peer when its latest NTP message was sent. If the peer becomes unreachable the value is set to zero (NTPD format).



peerAddress

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IP address of the peer.



peerName

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The address of the peer



peerPoll

Type: datetime:NTPPollInterval
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The interval at which the peer polls the local host.



peerPort

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The UDP port number on which the peer receives NTP messages.



peerType

Type: datetime:InetAddressType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The address format of the peer.
Constants
unknown 0 Unknown NO COMMENTS
ipv4 1 IPv4 NO COMMENTS
ipv6 2 IPv6 NO COMMENTS
ipv4z 3 IPv4z NO COMMENTS
ipv6z 4 IPv6z NO COMMENTS
dns 16 DNS NO COMMENTS
DEFAULT 0 --- NO COMMENTS





precision

Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A signed integer indicating the precision of the peer clock in seconds to the nearest power of two.



reach

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A shift register used to determine the reachability status of the peer.



receiveTime

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time when the latest NTP message from the peer arrived. If the peer becomes unreachable the value is set to zero.



receiveTimeRaw

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time when the latest NTP message from the peer arrived. If the peer becomes unreachable the value is set to zero (Raw NTPD Format).



refId

Type: datetime:NTPRefId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The reference identifier of the peer.



refTime

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time when the local clock was last updated. If the local clock has never been synchronized, the value is zero.



refTimeRaw

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time when the local clock was last updated. If the local clock has never been synchronized, the value is zero (raw NTPD format).



rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



rootDelay

Type: datetime:NTPSignedTimeValue
Primitive Type: scalar:Sint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A signed fixed-point number indicating the total round-trip delay in seconds, to the primary reference source at the root of the synchronization subnet.



rootDispersion

Type: datetime:NTPUnsignedTimeValue
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The maximum error in seconds relative to the primary reference source at the root of the synchronization subnet.



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.






stratum

Type: datetime:NTPStratum
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The stratum of the peer clock.



timer

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The interval, in seconds, between transmitted NTP messages from the local host to the peer.



transmitTime

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time at which the NTP message departed the sender.



transmitTimeRaw

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time at which the NTP message departed the sender (raw NTPD format).



updateTime

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time when the most recent NTP message was received from the peer was used to calculate the skew dispersion.



updateTimeRaw

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The local time when the most recent NTP message was received from the peer that was used to calculate the skew dispersion (raw NTPD format).