Class igmpsnoop:RtrIf (CONCRETE)

Class ID:2716
Class Label: Router 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, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
Read Access: [access-protocol, admin, fabric-protocol, tenant-ext-protocol, tenant-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: false, HasHealth: false, HasEventRules: true ]

The Multicast router interface.

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

    [1] PREFIX=rtrif- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/igmpsnoop/inst/dom-{[encap]}/rtrif-{[id]}

[1] sys/igmpsnoop/inst/dom-{[encap]}/rtrif-{[id]}

                


Diagram

Super Mo: ipmcsnoop:RtrIf,
Container Mos: igmpsnoop:Dom (deletable:yes),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,


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] igmpsnoop:Entity Holds IGMP control plane entity information.
 
 
 
 
 
 ├
[V] igmpsnoop:Inst Holds per IGMP instance information. There is only one instance of IGMP running in the system today.
 
 
 
 
 
 
 ├
[V] igmpsnoop:Dom An IGMP snooping domain, which is a bridge domain (BD) in which IGMP snooping is enabled. When an IGMP querier is in the network, it sends periodic IGMP queries that trigger IGMP report messages from hosts that want to receive IP multicast traffic. IGMP snooping listens to these IGMP reports to establish appropriate forwarding
 
 
 
 
 
 
 
 ├
[V] igmpsnoop:RtrIf The Multicast router interface.
[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] igmpsnoop:Entity Holds IGMP control plane entity information.
 
 
 ├
[V] igmpsnoop:Inst Holds per IGMP instance information. There is only one instance of IGMP running in the system today.
 
 
 
 ├
[V] igmpsnoop:Dom An IGMP snooping domain, which is a bridge domain (BD) in which IGMP snooping is enabled. When an IGMP querier is in the network, it sends periodic IGMP queries that trigger IGMP report messages from hosts that want to receive IP multicast traffic. IGMP snooping listens to these IGMP reports to establish appropriate forwarding
 
 
 
 
 ├
[V] igmpsnoop:RtrIf The Multicast router interface.


Contained Hierarchy
[V] igmpsnoop:RtrIf The Multicast router interface.
 ├
[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 


Inheritance
[V] ipmcsnoop:RtrIf  Multicast router if
 ├
[V] igmpsnoop:RtrIf The Multicast router interface.


Events
                igmpsnoop:RtrIf:igmpsnoop_RtrIf_igmpSnoopNewRtrIf
igmpsnoop:RtrIf:igmpsnoop_RtrIf_igmpSnoopDeleteRtrIf
igmpsnoop:RtrIf:creation__igmpsnoop_RtrIf
igmpsnoop:RtrIf:modification__igmpsnoop_RtrIf
igmpsnoop:RtrIf:deletion__igmpsnoop_RtrIf


Faults
                


Fsms
                


Properties Summary
Defined in: igmpsnoop:RtrIf
mo:Annotation
          string:Basic
annotation  (igmpsnoop:RtrIf:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (igmpsnoop:RtrIf:extMngdBy)
           NO COMMENTS
nw:IfId
          base:IfIndex
id  (igmpsnoop:RtrIf:id)
           Overrides:ipmcsnoop:RtrIf:id
           The router interface port identifier.
reference:BinRef monPolDn  (igmpsnoop:RtrIf:monPolDn)
           The monitoring policy attached to this observable object.
Defined in: ipmcsnoop:RtrIf
ipmcsnoop:LcC
          scalar:Bitmask8
lcC  (ipmcsnoop:RtrIf:lcC)
           Life cycle control
scalar:Date nextExpiryTs  (ipmcsnoop:RtrIf:nextExpiryTs)
           Router Expiry timestamp
scalar:Date upTs  (ipmcsnoop:RtrIf:upTs)
           Last up transition timestamp
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



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





id

Type: nw:IfId
Primitive Type: base:IfIndex

Overrides:ipmcsnoop:RtrIf:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators:
    Comments:
The router interface port identifier.



lcC

Type: ipmcsnoop:LcC
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Life cycle control
Constants
static 1 Statically Configured statically configured by admin
dynamic 2 Dynamically Learned dynamically detected through protocol signalling
internal 4 Internally Configured internally configured via layer 3 interface (svi)
DEFAULT 0 --- Life Cycle Control specifies how the router-if is controlled





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.



nextExpiryTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Router Expiry timestamp



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.






upTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Last up transition timestamp