Class pim6:If (CONCRETE)

Class ID:13644
Class Label: PIM6 Interface
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
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 pim6 information that is operated at a interface level

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

    [1] PREFIX=if- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/pim6/inst/dom-{name}/if-{[id]}

[1] sys/pim6/inst/dom-{name}/if-{[id]}

                


Diagram

Super Mo: rtdmc:AIf,
Container Mos: pim6:Dom (deletable:no),
Contained Mos: aaa:RbacAnnotation, pim6:AdjEp, pim6:Db, pim6:HelloTrP, pim6:IfStats, pim6:JPTrP, pim6:TrafficStats, tag:Annotation, tag:Tag,
Relations From: nw:PathEp, pim:IfDef,
Relations: nw:RtPathToIf, pim6:RtIfDefToPim6If,


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] pim6:Entity  Holds pim control plane entity information
 
 
 
 
 
 ├
[V] pim6:Inst  This objects hold per pim instance information
 
 
 
 
 
 
 ├
[V] pim6:Dom  This objects hold per pim6 domain (vrf) information
 
 
 
 
 
 
 
 ├
[V] pim6:If  This object holds pim6 information that is operated at a interface level
[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] pim6:Entity  Holds pim control plane entity information
 
 
 ├
[V] pim6:Inst  This objects hold per pim instance information
 
 
 
 ├
[V] pim6:Dom  This objects hold per pim6 domain (vrf) information
 
 
 
 
 ├
[V] pim6:If  This object holds pim6 information that is operated at a interface level


Contained Hierarchy
[V] pim6:If  This object holds pim6 information that is operated at a interface level
 ├
[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] nw:RtPathToIf A target relation to the interface information.
 ├
[V] pim6:AdjEp  This object holds pim neighbor information
 
 ├
[V] pim6:AdjStats  This object holds the pim neighbor related statistics
 ├
[V] pim6:Db  PIM6 databases
 
 ├
[V] pim6:AutoRPPInfo 
 
 ├
[V] pim6:BSRInfo 
 
 ├
[V] pim6:RPGrange 
 
 
 ├
[V] pim6:RtRP2Grange 
 
 ├
[V] pim6:RPInfo 
 
 
 ├
[V] pim6:RsRP2Grange 
 
 ├
[V] pim6:Route  PIM Group/Src MOs
 
 
 ├
[V] pim6:Oif  PIM6 OIF list MOs
 ├
[V] pim6:HelloTrP  This object holds the hello traffic policy
 
 ├
[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] pim6:IfStats  This object holds the pim interface related statistics
 ├
[V] pim6:JPTrP  This object holds the join-prune traffic policy
 
 ├
[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] pim6:RtIfDefToPim6If 
 ├
[V] pim6:TrafficStats  This object holds the pim control traffic stats
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 


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] rtdmc:AIf  This object holds routed multicast information that is operated at a interface level
 
 
 
 
 
 
 
 
 ├
[V] pim6:If  This object holds pim6 information that is operated at a interface level


Events
                pim6:If:creation__pim6_If
pim6:If:modification__pim6_If
pim6:If:deletion__pim6_If


Faults
                


Fsms
                


Properties Summary
Defined in: pim6:If
mo:Annotation
          string:Basic
annotation  (pim6:If:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (pim6:If:extMngdBy)
           NO COMMENTS
nw:IfId
          base:IfIndex
id  (pim6:If:id)
           Overrides:nw:If:id
           An object identifier.
Defined in: rtdmc:AIf
rtdmc:IfCtrl
          scalar:Bitmask16
ctrl  (rtdmc:AIf:ctrl)
           Interface Control
address:Ip dr  (rtdmc:AIf:dr)
           PIM DR
rtdmc:DRDelay
          scalar:Uint16
drDelay  (rtdmc:AIf:drDelay)
           Designated Router Delay
rtdmc:DRPrio
          scalar:Uint32
drPrio  (rtdmc:AIf:drPrio)
           Designated Router Priority
rtdmc:DRPrio
          scalar:Uint32
drPriority  (rtdmc:AIf:drPriority)
           Elected DR priority on the IF
rtdmc:GenId
          scalar:Uint32
genID  (rtdmc:AIf:genID)
           Generation id
address:Ip ipAddr  (rtdmc:AIf:ipAddr)
           IP Address of the interface
scalar:Uint32 nbrHoldTime  (rtdmc:AIf:nbrHoldTime)
           PIM nbr holdtime
string:Basic neighRtMap  (rtdmc:AIf:neighRtMap)
           Neighbor Policy
scalar:Date nextHello  (rtdmc:AIf:nextHello)
           Time when next hello is sent
reference:BinRef rtEpPDn  (rtdmc:AIf:rtEpPDn)
           L3 Router EpP dn
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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

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





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



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





ctrl

Type: rtdmc:IfCtrl
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Interface Control
Constants
border 1 Multicast Domain Boundary Boundary of Multicast domain
passive 2 Passive Passive - Do not send/receive PIM protocol packets
quiet 4 Quiet Quiet - Only listen to PIM protocol packets Do not transmit
bfd-enable 8 Enable BFD Enable bidirectional forwarding detection (BFD) on the interface
strict-rfc-compliant 16 Strict RFC Compliant Enable strict RFC compliance on this interface
DEFAULT 0 --- Interface Ctrl





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    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.



dr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
PIM DR



drDelay

Type: rtdmc:DRDelay
Primitive Type: scalar:Uint16

Units: seconds
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Designated Router Delay
Constants
defaultValue 3 --- NO COMMENTS





drPrio

Type: rtdmc:DRPrio
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Designated Router Priority
Constants
defaultValue 1u --- NO COMMENTS





drPriority

Type: rtdmc:DRPrio
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4294967295l
    Comments:
Elected DR priority on the IF
Constants
defaultValue 1u --- NO COMMENTS





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





genID

Type: rtdmc:GenId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Generation id



id

Type: nw:IfId
Primitive Type: base:IfIndex

Overrides:nw:If:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators:
    Comments:
An object identifier.



ipAddr

Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
IP Address of the interface



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 Property Validators: Range: min: "1" max: "128"
    Comments:
The name of the object.



nbrHoldTime

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
PIM nbr holdtime



neighRtMap

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Neighbor Policy



nextHello

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Time when next hello is sent



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.



rtEpPDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
L3 Router EpP dn



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.






uid

Type: scalar:Uint16

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