Class datetime:ClkPol (CONCRETE)

Class ID:3955
Class Label: Date Time Policy
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-protocol]
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 ]

Represents the date/time clock policy information.

Naming Rules
RN FORMAT: time

    [1] PREFIX=time


DN FORMAT: 

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

[1] sys/time

                


Diagram

Super Mo: datetime:APol,
Container Mos: top:System (deletable:yes),
Contained Mos: datetime:NTPIffKey, datetime:NtpAuth, datetime:NtpProvider,


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] 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.


Contained Hierarchy
[V] datetime:ClkPol Represents the date/time clock policy information.
 ├
[V] datetime:NTPIffKey  NTP Secure Session IFF Key
 
 ├
[V] datetime:RtNtpProviderToNTPIffKey  Relation to Secure Session key Cardinality is 1-to-n but 1-to-1 should be enforced
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] datetime:NtpAuth The NTP client authentication configures the device to authenticate the time sources to which the local clock is synchronized. When you enable NTP authentication, the device synchronizes to a time source only if the source carries one of the authentication keys specified by the ntp trusted-key command. The device drops any packets that fail the authentication check and prevents them from updating the local clock. NTP authentication is disabled by...
 
 ├
[V] datetime:RtNtpProviderToNtpAuth A target relation to the NTP client authentication.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] datetime:NtpProvider Represents the date/time NTP provider information for the switch.
 
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 
 ├
[V] tag:Annotation 
 
 
 
 ├
[V] tag:Tag 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] datetime:RsNtpProviderToNTPIffKey  Relation to Secure Session key Cardinality is 1-to-n but 1-to-1 should be enforced
 
 ├
[V] datetime:RsNtpProviderToNtpAuth A source relation to the date/time NTP authorization.
 
 ├
[V] datetime:Statistics 
 
 ├
[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:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[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:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Def Represents self-contained policy document.
 
 
 ├
[V] datetime:APol The date time policy is based on international time zones and a defined NTP server. Before configuring a date and time policy under a domain group, this policy must first be created. Policies under the Domain Groups root were already created by the system and ready to configure.
 
 
 
 ├
[V] datetime:ClkPol Represents the date/time clock policy information.


Events
                


Faults
                datetime:ClkPol:ntp-prov-fault
datetime:ClkPol:ntp-server-notstart-fault


Fsms
                


Properties Summary
Defined in: datetime:ClkPol
datetime:AdminState
          scalar:Enum8
adminSt  (datetime:ClkPol:adminSt)
           Overrides:datetime:APol:adminSt
           Indicates if the NTP protocol is enabled or disabled.
datetime:AdminState
          scalar:Enum8
authSt  (datetime:ClkPol:authSt)
           Overrides:datetime:APol:authSt
           Indicates if the Datetime policy authentication is enabled or disabled.
scalar:Date clock  (datetime:ClkPol:clock)
          
scalar:Uint64 clockRaw  (datetime:ClkPol:clockRaw)
          
datetime:SysStatusFlags
          scalar:Bitmask8
flags  (datetime:ClkPol:flags)
           null
datetime:NTPLeapIndicator
          scalar:UByte
leap  (datetime:ClkPol:leap)
          
reference:BinRef monPolDn  (datetime:ClkPol:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (datetime:ClkPol:name)
           Overrides:datetime:APol:name | pol:Obj:name | naming:NamedObject:name
           Specifies the user configured Datetime policy name.
scalar:Bitmask64 ntpdCfgFailedBmp  (datetime:ClkPol:ntpdCfgFailedBmp)
           null
scalar:Time ntpdCfgFailedTs  (datetime:ClkPol:ntpdCfgFailedTs)
          
scalar:UByte ntpdCfgState  (datetime:ClkPol:ntpdCfgState)
           null
datetime:NTPAssocIdentifier
          scalar:Uint32
peer  (datetime:ClkPol:peer)
          
reference:BinRef polDn  (datetime:ClkPol:polDn)
           The distinguised name of the techsupport policy for this triggerable.
datetime:NTPPollInterval
          scalar:Sint32
poll  (datetime:ClkPol:poll)
          
scalar:Sint32 precision  (datetime:ClkPol:precision)
          
datetime:NTPRefId
          address:IPv4
refId  (datetime:ClkPol:refId)
          
string:Basic refName  (datetime:ClkPol:refName)
           NO COMMENTS
scalar:Date refTime  (datetime:ClkPol:refTime)
          
scalar:Uint64 refTimeRaw  (datetime:ClkPol:refTimeRaw)
          
datetime:NTPSignedTimeValue
          scalar:Sint32
rootDelay  (datetime:ClkPol:rootDelay)
          
datetime:NTPUnsignedTimeValue
          scalar:Uint32
rootDispersion  (datetime:ClkPol:rootDispersion)
          
datetime:NtpSrvStatus
          scalar:Enum8
srvStatus  (datetime:ClkPol:srvStatus)
          
datetime:NTPStratum
          scalar:UByte
stratum  (datetime:ClkPol:stratum)
          
Defined in: datetime:APol
datetime:Stratum
          scalar:UByte
StratumValue  (datetime:APol:StratumValue)
           NTP Stratum value, see RFC 5905
naming:Descr
          string:Basic
descr  (datetime:APol:descr)
           Overrides:pol:Def:descr
           Specifies a description of the policy definition.
datetime:AdminState
          scalar:Enum8
masterMode  (datetime:APol:masterMode)
           Toggle between master clock mode
datetime:AdminState
          scalar:Enum8
serverState  (datetime:APol:serverState)
           NO COMMENTS
Defined in: pol:Def
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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.
Properties Detail

StratumValue

Type: datetime:Stratum
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NTP Stratum value, see RFC 5905
Constants
primary 1 Primary Server NO COMMENTS
defaultValue 8 --- NO COMMENTS





adminSt

Type: datetime:AdminState
Primitive Type: scalar:Enum8

Overrides:datetime:APol:adminSt
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
Indicates if the NTP protocol is enabled or disabled.
Constants
enabled 1 enabled NO COMMENTS
disabled 2 disabled NO COMMENTS
DEFAULT enabled(1) enabled NO COMMENTS





authSt

Type: datetime:AdminState
Primitive Type: scalar:Enum8

Overrides:datetime:APol:authSt
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
Indicates if the Datetime policy authentication is enabled or disabled.
Constants
enabled 1 enabled NO COMMENTS
disabled 2 disabled NO COMMENTS
DEFAULT disabled(2) disabled NO COMMENTS





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





clock

Type: scalar:Date

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



clockRaw

Type: scalar:Uint64

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



descr

Type: naming:Descr
Primitive Type: string:Basic

Overrides:pol:Def:descr
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
Specifies a description of the policy definition.



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.



flags

Type: datetime:SysStatusFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
null
Constants
synced 1 Synced Time Synced
DEFAULT 0 --- System Status flags





lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





leap

Type: datetime:NTPLeapIndicator
Primitive Type: scalar:UByte

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



masterMode

Type: datetime:AdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Toggle between master clock mode
Constants
enabled 1 enabled NO COMMENTS
disabled 2 disabled NO COMMENTS
DEFAULT disabled(2) disabled NO COMMENTS





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





monPolDn

Type: reference:BinRef

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



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:datetime:APol:name  |  pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
Specifies the user configured Datetime policy name.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



ntpdCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
null
Constants
datetime:ClkPollcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
datetime:ClkPolmodTs_failed_flag 1152921504606846976ull --- NO COMMENTS
datetime:ClkPolauthSt_failed_flag 128ull --- NO COMMENTS
datetime:ClkPolmonPolDn_failed_flag 16384ull --- NO COMMENTS
datetime:ClkPolownerTag_failed_flag 16ull --- NO COMMENTS
datetime:ClkPolname_failed_flag 1ull --- NO COMMENTS
datetime:ClkPolmasterMode_failed_flag 256ull --- NO COMMENTS
datetime:ClkPolnameAlias_failed_flag 2ull --- NO COMMENTS
datetime:ClkPolStratumValue_failed_flag 32ull --- NO COMMENTS
datetime:ClkPoldescr_failed_flag 4ull --- NO COMMENTS
datetime:ClkPolserverState_failed_flag 512ull --- NO COMMENTS
datetime:ClkPolpolDn_failed_flag 524288ull --- NO COMMENTS
datetime:ClkPoladminSt_failed_flag 64ull --- NO COMMENTS
datetime:ClkPolownerKey_failed_flag 8ull --- 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:
null



ownerKey

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



peer

Type: datetime:NTPAssocIdentifier
Primitive Type: scalar:Uint32

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



polDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The distinguised name of the techsupport policy for this triggerable.



poll

Type: datetime:NTPPollInterval
Primitive Type: scalar:Sint32

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



precision

Type: scalar:Sint32

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



refId

Type: datetime:NTPRefId
Primitive Type: address:IPv4

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



refName

Type: string:Basic

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



refTime

Type: scalar:Date

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



refTimeRaw

Type: scalar:Uint64

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



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:



rootDispersion

Type: datetime:NTPUnsignedTimeValue
Primitive Type: scalar:Uint32

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



serverState

Type: datetime:AdminState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
enabled 1 enabled NO COMMENTS
disabled 2 disabled NO COMMENTS
DEFAULT disabled(2) disabled NO COMMENTS





srvStatus

Type: datetime:NtpSrvStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
unknown 1 Unknown NO COMMENTS
not_running 2 Not Running NO COMMENTS
not_synchronized 3 Not Synchronized NO COMMENTS
synced_local_clock 4 Synced to Local Clock NO COMMENTS
synced_local_hw_refclk 5 Synced to Local RefClock NO COMMENTS
synced_remote_server 6 Synced to Remote NTP Server NO COMMENTS
DEFAULT unknown(1) Unknown NO COMMENTS





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: