Class igmpsnoop:Dom (CONCRETE)

Class ID:2710
Class Label: IGMP Snooping Domain
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: [access-protocol-l2, 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: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

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

Naming Rules
RN FORMAT: dom-{[encap]}

    [1] PREFIX=dom- PROPERTY = encap




DN FORMAT: 

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

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

                


Diagram

Super Mo: ipmcsnoop:Dom,
Container Mos: igmpsnoop:Inst (deletable:no),
Contained Mos: igmpsnoop:CktEp, igmpsnoop:Db, igmpsnoop:DomStats, igmpsnoop:QuerierP, igmpsnoop:QuerierSt, igmpsnoop:RtrIf, igmpsnoop:StRtrIf,


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


Contained Hierarchy
[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] 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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] igmpsnoop:CktEp  Circuit endpoint representing EPG
 
 ├
[V] igmpsnoop:ACtrlP  Route control policy for igmp multicast snoop.
 
 
 ├
[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] igmpsnoop:TgtIf  Target Interface (outgoing interface list)
 
 
 
 ├
[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] igmpsnoop:StMcGrp  Multicast Snoop Configured statically
 
 
 ├
[V] igmpsnoop:McSrc  IPMC Source IP
 
 
 
 ├
[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] igmpsnoop:TgtIf  Target Interface (outgoing interface list)
 
 
 
 
 ├
[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] tag:Annotation 
 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] nlb:StMacGrp  Multicast Snoop Configured statically
 
 
 ├
[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] nlb:NlbTgtIf  Target Interface (outgoing interface list)
 
 
 
 ├
[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] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 ├
[V] igmpsnoop:Db Represents all the IGMP Snooping database information.
 
 ├
[V] igmpsnoop:McGrpRec Represents the Multicast Group records information.
 
 
 ├
[V] igmpsnoop:EpgRec Represents the endpoint group (EPG) entries in the Multicast group record information.
 
 
 
 ├
[V] igmpsnoop:ReportRec Represents the IGMP Snooping report record information snooped by the igmp-snoop application
 
 
 
 
 ├
[V] igmpsnoop:OIFRec Represents the IGMP Snooping outgoing interface list (OIF) information.
 
 
 
 
 
 ├
[V] igmpsnoop:HostRec Used for Explicit Host Tracking.
 
 
 ├
[V] igmpsnoop:ReportRec Represents the IGMP Snooping report record information snooped by the igmp-snoop application
 
 
 
 ├
[V] igmpsnoop:OIFRec Represents the IGMP Snooping outgoing interface list (OIF) information.
 
 
 
 
 ├
[V] igmpsnoop:HostRec Used for Explicit Host Tracking.
 ├
[V] igmpsnoop:DomStats Use the show ip IGMP snooping statistics vlan command to display IGMP snooping statistics. You can see the virtual port channel (vPC) statistics in this output. Use the clear ip igmp snooping statistics vlan command to clear IGMP snooping statistics.
 ├
[V] igmpsnoop:QuerierP When an IGMP snooping querier is enabled on a leaf, it sends out periodic IGMP queries on front panel ports of a BD on that leaf.
 
 ├
[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] igmpsnoop:QuerierSt Shows the IGMP Snoop querier state.
 
 ├
[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)
 ├
[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 
 ├
[V] igmpsnoop:StRtrIf This object represents the multicast router if that is configured statically.
 
 ├
[V] l2:RsEthIf A source relation to an L1 interface. This is an internal object.
 
 ├
[V] l2:RsMgmtIf  Association to the corresponding mgmt::MgmtIf
 
 ├
[V] nw:RtPathToIf A target relation to the interface information.


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:CpDom A control plane domain abstraction. This object represents a domain within a control plane instance. For example, a VRF.
 
 
 
 ├
[V] nw:ProtDom A protocol domain abstraction.
 
 
 
 
 ├
[V] ipmcsnoop:Dom  This objects hold per IP Multicast Snooping domain information
 
 
 
 
 
 ├
[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


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: igmpsnoop:Dom
base:Encap encap  (igmpsnoop:Dom:encap)
           Overrides:ipmcsnoop:Dom:encap
           The layer 2 domain encapsulation block corresponding the the IGMP domain.
ipmcsnoop:DomFlags
          scalar:Bitmask8
flags  (igmpsnoop:Dom:flags)
           Overrides:ipmcsnoop:Dom:flags
           Specifies the IGMP Snooping domain flags.
reference:BinRef monPolDn  (igmpsnoop:Dom:monPolDn)
           The monitoring policy attached to this observable object.
Defined in: ipmcsnoop:Dom
nw:AdminSt
          scalar:Enum8
adminSt  (ipmcsnoop:Dom:adminSt)
           Admin State
ipmcsnoop:DomControl
          scalar:Bitmask8
ctrl  (ipmcsnoop:Dom:ctrl)
           Controls
ipmcsnoop:FwdMode
          scalar:Enum8
fwdMode  (ipmcsnoop:Dom:fwdMode)
           Forwarding mode
scalar:Date grpFlushTs  (ipmcsnoop:Dom:grpFlushTs)
           Group Flush No Querier timestamp
l2:DomId
          scalar:Uint32
id  (ipmcsnoop:Dom:id)
           Id for this domain
l2:DomId
          scalar:Uint32
mrtrEpgId  (ipmcsnoop:Dom:mrtrEpgId)
           Mrtr Epg Id used when sending packets to mrtr port
naming:Name
          string:Basic
name  (ipmcsnoop:Dom:name)
           Overrides:nw:CpDom:name | nw:Conn:name
           dom name. @@@ name = tenantName + BD Name
scalar:Date nextQueryExpTs  (ipmcsnoop:Dom:nextQueryExpTs)
           Querier Expiry timestamp, if external Querier
scalar:Date nextQueryTs  (ipmcsnoop:Dom:nextQueryTs)
           Next Query timestamp, if we are Querier
nw:Counter32
          scalar:Uint32
numMcGrp  (ipmcsnoop:Dom:numMcGrp)
           Number of multicast groups
nw:Counter32
          scalar:Uint32
numRtrIf  (ipmcsnoop:Dom:numRtrIf)
           Number of router interfaces
nw:Counter32
          scalar:Uint32
numSrcGrp  (ipmcsnoop:Dom:numSrcGrp)
           Number of Source groups
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.
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.
Properties Detail

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Admin State
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





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: ipmcsnoop:DomControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Controls
Constants
querier 1 Enable querier Enable querier
fast-leave 2 Fast leave Fast leave - If this knob is turned on, when the switch receives a igmp/mld leave, it removes the interface from the multicast outgoing flood list for this group
opt-flood 4 Optimize flooding @deprecated: THIS FLAG IS A NO-OP
routing 8 Enable Routing Enable routing on the Dom
defaultValue 0 --- NO 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.



encap

Type: base:Encap

Overrides:ipmcsnoop:Dom:encap
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The layer 2 domain encapsulation block corresponding the the IGMP domain.



flags

Type: ipmcsnoop:DomFlags
Primitive Type: scalar:Bitmask8

Overrides:ipmcsnoop:Dom:flags
Holder: igmpsnoop:DomFlags Units: null Encrypted: false Access: oper Category: TopLevelRegular
    Comments:
Specifies the IGMP Snooping domain flags.
Constants
v12r-supr 1 V1/v2 Report Suppression NO COMMENTS
v3r-supr 2 V3 Report Suppression NO COMMENTS
eht 4 End Host Tracking End host tracking
llg-supr 8 Link Local Groups Suppression Link local groups suppression
vpc 16 VPC Enabled VPC enabled
defaultValue 1|2|4|8 --- NO COMMENTS





fwdMode

Type: ipmcsnoop:FwdMode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Forwarding mode
Constants
ip 1 IP based forwarding IP based forwarding
mac 2 Mac based forwarding Mac based forwarding
DEFAULT ip(1) IP based forwarding IP based forwarding





grpFlushTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Group Flush No Querier timestamp



id

Type: l2:DomId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Id for this domain



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.



mrtrEpgId

Type: l2:DomId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Mrtr Epg Id used when sending packets to mrtr port



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:CpDom:name  |  nw:Conn:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
dom name. @@@ name = tenantName + BD Name



nextQueryExpTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Querier Expiry timestamp, if external Querier



nextQueryTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Next Query timestamp, if we are Querier



numMcGrp

Type: nw:Counter32
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of multicast groups



numRtrIf

Type: nw:Counter32
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of router interfaces



numSrcGrp

Type: nw:Counter32
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of Source groups



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.