Class igmp:Route (CONCRETE)

Class ID:8391
Class Label: IGMP Route info
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: yes (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 ]

IGMP Group/Src MOs

Naming Rules
RN FORMAT: src-{[src]}-grp-{[grp]}

    [1] PREFIX=src- PROPERTY = src


    [2] PREFIX=-grp- PROPERTY = grp




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/igmp/inst/dom-{name}/db-{type}/src-{[src]}-grp-{[grp]}

[1] sys/igmp/inst/dom-{name}/db-{type}/src-{[src]}-grp-{[grp]}

                


Diagram

Super Mo: ipmc:Route,
Container Mos: igmp:Db (deletable:yes),
Contained Mos: igmp:Oif,


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] igmp:Entity  Holds igmp control plane entity information
 
 
 
 
 
 ├
[V] igmp:Inst  This objects hold per igmp instance information. There is only one instance of igmp running in the system today
 
 
 
 
 
 
 ├
[V] igmp:Dom  This objects hold per igmp domain information
 
 
 
 
 
 
 
 ├
[V] igmp:Db  IGMP databases
 
 
 
 
 
 
 
 
 ├
[V] igmp:Route  IGMP Group/Src MOs
[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] igmp:Entity  Holds igmp control plane entity information
 
 
 ├
[V] igmp:Inst  This objects hold per igmp instance information. There is only one instance of igmp running in the system today
 
 
 
 ├
[V] igmp:Dom  This objects hold per igmp domain information
 
 
 
 
 ├
[V] igmp:Db  IGMP databases
 
 
 
 
 
 ├
[V] igmp:Route  IGMP Group/Src MOs


Contained Hierarchy
[V] igmp:Route  IGMP Group/Src MOs
 ├
[V] igmp:Oif  IGMP Oif MOs. We create one object per interface in the oif list


Inheritance
[V] ipmc:Route 
 ├
[V] igmp:Route  IGMP Group/Src MOs


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: igmp:Route
address:Ip grp  (igmp:Route:grp)
           Overrides:ipmc:Route:grp
           The diagnostics policies are logically grouped (e.g., CPU, forwarding, port, etc.) for ease of deployment. Each of these groups contain one or more diagnostic tests specific to that group. With a group, some of its tests are marked as recommended, which are run by default when the group is enabled for diagnostics tests. The user can enable additional groups or disable existing groups – and within each group that is enabled, the user can choose to run only the recommended tests (default) or all the tests (“full”).
address:Ip src  (igmp:Route:src)
           Overrides:ipmc:Route:src
           The source IP address.
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

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.



grp

Type: address:Ip

Overrides:ipmc:Route:grp
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The diagnostics policies are logically grouped (e.g., CPU, forwarding, port, etc.) for ease of deployment. Each of these groups contain one or more diagnostic tests specific to that group. With a group, some of its tests are marked as recommended, which are run by default when the group is enabled for diagnostics tests. The user can enable additional groups or disable existing groups – and within each group that is enabled, the user can choose to run only the recommended tests (default) or all the tests (“full”).



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





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.



src

Type: address:Ip

Overrides:ipmc:Route:src
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The source IP address.



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.