Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class ptp:If (CONCRETE)

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

This object holds interface information

Naming Rules 
RN FORMAT: if-{[id]}

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ptp/inst/if-{[id]}

[1] sys/ptp/inst/if-{[id]}


Diagram

Super Mo: l3:ProtIf,
Container Mos: ptp:Inst (deletable:no),
Relations From: nw:PathEp,
Relations: nw:RtPathToIf,


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] ptp:Entity  Holds PTP entity information
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ptp:Inst  This object holds PTP instance information.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ptp:If  This object holds interface 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] ptp:Entity  Holds PTP entity information
 
 		 
 		 ├
 		[V] ptp:Inst  This object holds PTP instance information.
 
 		 
 		 
 		 ├
 		[V] ptp:If  This object holds interface information


Contained Hierarchy
[V] ptp:If  This object holds interface information
 ├
 		[V] nw:RtPathToIf A target relation to the interface information.


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:Ep A static endpoint.
 
 		 
 		 ├
 		[V] nw:ConnEp A connection endpoint abstraction.
 
 		 
 		 
 		 ├
 		[V] nw:If The interface information.
 
 		 
 		 
 		 
 		 ├
 		[V] nw:LogicalIf A logical interface abstraction.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] nw:ProtIf A protocol interface abstraction.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] l3:ProtIf A layer 3 protocol interface abstraction.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ptp:If  This object holds interface information


Events


Faults


Fsms


Properties Summary
Defined in: ptp:If
ptp:AnnounceIntvl
          scalar:UByte 		announceIntvl  (ptp:If:announceIntvl)
           Announce Interval
ptp:AnnounceMult
          scalar:UByte 		announceMult  (ptp:If:announceMult)
           Announce Multiplier
ptp:DelayIntvl
          scalar:Sint16 		delayIntvl  (ptp:If:delayIntvl)
           Minimum Delay Interval
nw:IfId
          base:IfIndex 		id  (ptp:If:id)
           Overrides:nw:If:id
          
ptp:OperSt
          scalar:Enum8 		operSt  (ptp:If:operSt)
           Port Operational State
ptp:OperStQual
          scalar:Enum8 		operStQual  (ptp:If:operStQual)
           Operational state qualifier
scalar:Uint16 portId  (ptp:If:portId)
           Port Identity
ptp:PortSt
          scalar:Enum8 		portSt  (ptp:If:portSt)
           Port State
ptp:SyncIntvl
          scalar:Sint16 		syncIntvl  (ptp:If:syncIntvl)
           Sync Interval
ptp:Vlan
          scalar:Uint16 		vlan  (ptp:If:vlan)
           Vlan ID
Defined in: nw:ProtIf
nw:IfAdminSt
          scalar:Enum8 		adminSt  (nw:ProtIf:adminSt)
           The administrative state of the object or policy.
Defined in: nw:If
naming:Descr
          string:Basic 		descr  (nw:If:descr)
          
Defined in: nw:Ep
naming:Name
          string:Basic 		name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
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: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.
Properties Detail

adminSt

Type: nw:IfAdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled




announceIntvl

Type: ptp:AnnounceIntvl
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Announce Interval
Constants
defaultValue 1 --- NO COMMENTS




announceMult

Type: ptp:AnnounceMult
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Announce Multiplier
Constants
defaultValue 3 --- 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




delayIntvl

Type: ptp:DelayIntvl
Primitive Type: scalar:Sint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Minimum Delay Interval
Constants
defaultValue 0 --- NO COMMENTS




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:


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.


id

Type: nw:IfId
Primitive Type: base:IfIndex

Overrides:nw:If:id

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:


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




name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The name of the object.


operSt

Type: ptp:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Port Operational State
Constants
enabled 1 Enabled NO COMMENTS
disabled 2 Disabled NO COMMENTS
DEFAULT disabled(2) Disabled NO COMMENTS




operStQual

Type: ptp:OperStQual
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational state qualifier
Constants
not-configured 1 PTP not configured Down since PTP not configured
invalid-ip 2 Invalid IP Down with invalid ip
invalid-vrf 3 Invalid VRF Down with invalid vrf
if-down 4 Interface down Down because interface down
up 5 Up Up
DEFAULT not-configured(1) PTP not configured Down since PTP not configured




portId

Type: scalar:Uint16

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


portSt

Type: ptp:PortSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Port State
Constants
init 1 Init NO COMMENTS
listen 2 Listen NO COMMENTS
master 3 Master NO COMMENTS
slave 4 Slave NO COMMENTS
premaster 5 Premaster NO COMMENTS
faulty 6 Faulty NO COMMENTS
uncalibrated 7 Uncalibrated NO COMMENTS
passive 8 Passive NO COMMENTS
disabled 9 Disabled NO COMMENTS
DEFAULT disabled(9) Disabled 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.


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.





syncIntvl

Type: ptp:SyncIntvl
Primitive Type: scalar:Sint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Sync Interval
Constants
defaultValue -2 --- NO COMMENTS




vlan

Type: ptp:Vlan
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Vlan ID
Constants
defaultValue 1 --- NO COMMENTS






Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail