Class latency:PtpMode (CONCRETE)

Class ID:9802
Class Label: Precision Time Protocol Enabled/Disabled
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Ambiguous Placement in the Model - APIC NX Processing: Disabled
Write Access: [admin]
Read Access: [admin]
Creatable/Deletable: no (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 ]

Precision Time Protocol enable/disable flag

Naming Rules
RN FORMAT: ptpmode

    [1] PREFIX=ptpmode


DN FORMAT: 

[1] uni/fabric/ptpmode

                


Diagram

Container Mos: fabric:Inst (deletable:no),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,
Relations From: dbg:RelnHolder,
Relations: latency:RtRelPtpMode,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 
 
 
 
 
 ├
[V] latency:PtpMode Precision Time Protocol enable/disable flag
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fabric:Inst A container object for fabric policies.
 
 
 ├
[V] latency:PtpMode Precision Time Protocol enable/disable flag


Contained Hierarchy
[V] latency:PtpMode Precision Time Protocol enable/disable flag
 ├
[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] 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] latency:RtRelPtpMode 
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] latency:PtpMode Precision Time Protocol enable/disable flag


Events
                latency:PtpMode:creation__latency_PtpMode
latency:PtpMode:modification__latency_PtpMode
latency:PtpMode:deletion__latency_PtpMode


Faults
                latency:PtpMode:PtpNotEnabled


Fsms
                


Properties Summary
Defined in: latency:PtpMode
mo:Annotation
          string:Basic
annotation  (latency:PtpMode:annotation)
           NO COMMENTS
scalar:Bool canPtpBeDisabled  (latency:PtpMode:canPtpBeDisabled)
           Flag to tell if latency can be enabled or not in the fabric
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (latency:PtpMode:extMngdBy)
           NO COMMENTS
ptp:AnnounceIntvl
          scalar:Sint16
fabAnnounceIntvl  (latency:PtpMode:fabAnnounceIntvl)
           Fabric Interface Announce Interval
ptp:AnnounceTimeout
          scalar:UByte
fabAnnounceTimeout  (latency:PtpMode:fabAnnounceTimeout)
           Fabric Interace Announce timeout
ptp:DelayIntvl
          scalar:Sint16
fabDelayIntvl  (latency:PtpMode:fabDelayIntvl)
           Fabric Interace Minimum Delay Request Interval
ptp:ProfileTemplate
          scalar:Enum8
fabProfileTemplate  (latency:PtpMode:fabProfileTemplate)
           Fabric PTP profile Template
ptp:SyncIntvl
          scalar:Sint16
fabSyncIntvl  (latency:PtpMode:fabSyncIntvl)
           Fabric Interace Sync Interval
ptp:Domain
          scalar:Uint16
globalDomain  (latency:PtpMode:globalDomain)
           NO COMMENTS
scalar:Bool isCountValid  (latency:PtpMode:isCountValid)
           Flag to tell if the policy count is valid or not
scalar:Uint32 latencyPolCount  (latency:PtpMode:latencyPolCount)
           Total number of active latency policies
reference:BinRef monPolDn  (latency:PtpMode:monPolDn)
           The monitoring policy attached to this observable object.
ptp:Prio1
          scalar:Uint16
prio1  (latency:PtpMode:prio1)
           PTP Global properties
ptp:Prio
          scalar:Uint16
prio2  (latency:PtpMode:prio2)
           NO COMMENTS
scalar:Bool raiseFault  (latency:PtpMode:raiseFault)
           Flag to raise a fault
netflow:AdminSt
          scalar:Enum8
state  (latency:PtpMode:state)
           State of the PTP protocol
scalar:Uint32 systemResolution  (latency:PtpMode:systemResolution)
           System Resolution factor, Value could be (0 or 11 )
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           NO COMMENTS
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

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



canPtpBeDisabled

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Flag to tell if latency can be enabled or not in the fabric
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- 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





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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





fabAnnounceIntvl

Type: ptp:AnnounceIntvl
Primitive Type: scalar:Sint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)-3  max: (short)4
    Comments:
Fabric Interface Announce Interval
Constants
defaultValue 1 --- NO COMMENTS





fabAnnounceTimeout

Type: ptp:AnnounceTimeout
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)2  max: (short)10
    Comments:
Fabric Interace Announce timeout
Constants
defaultValue 3 --- NO COMMENTS





fabDelayIntvl

Type: ptp:DelayIntvl
Primitive Type: scalar:Sint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)-4  max: (short)6
    Comments:
Fabric Interace Minimum Delay Request Interval
Constants
defaultValue 0 --- NO COMMENTS





fabProfileTemplate

Type: ptp:ProfileTemplate
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Fabric PTP profile Template
Constants
default 1 Default NO COMMENTS
aes67 2 AES67-2015 NO COMMENTS
smpte 3 SMPTE-2059-2 NO COMMENTS
DEFAULT default(1) Default NO COMMENTS





fabSyncIntvl

Type: ptp:SyncIntvl
Primitive Type: scalar:Sint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)-7  max: (short)1
    Comments:
Fabric Interace Sync Interval
Constants
defaultValue -2 --- NO COMMENTS





globalDomain

Type: ptp:Domain
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 128
    Comments:
NO COMMENTS
Constants
defaultValue 0 --- NO COMMENTS





isCountValid

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Flag to tell if the policy count is valid or not
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





latencyPolCount

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Total number of active latency policies



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





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.



prio1

Type: ptp:Prio1
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 255
    Comments:
PTP Global properties
Constants
defaultValue 255 --- NO COMMENTS





prio2

Type: ptp:Prio
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 255
    Comments:
NO COMMENTS
Constants
defaultValue 255 --- NO COMMENTS





raiseFault

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Flag to raise a fault
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO 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.



state

Type: netflow:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
State of the PTP protocol
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT disabled(2) Disabled Disabled





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.






systemResolution

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
System Resolution factor, Value could be (0 or 11 )
Constants
defaultValue 0u --- NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS