Class igmp:ResP (CONCRETE)

Class ID:8387
Class Label: Resource Policy
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: 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: true, HasHealth: true, HasEventRules: false ]

This object holds resource (router state) limit policy to limit amount of multicast routing state on the router

Naming Rules
RN FORMAT: limit

    [1] PREFIX=limit


DN FORMAT: 

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

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

                


Diagram

Super Mo: mcast:AResP,
Container Mos: igmp:If (deletable:yes),


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:If  This objects hold per igmp interface information
 
 
 
 
 
 
 
 
 ├
[V] igmp:ResP  This object holds resource (router state) limit policy to limit amount of multicast routing state on the router
[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:If  This objects hold per igmp interface information
 
 
 
 
 
 ├
[V] igmp:ResP  This object holds resource (router state) limit policy to limit amount of multicast routing state on the router


Contained Hierarchy
[V] igmp:ResP  This object holds resource (router state) limit policy to limit amount of multicast routing state on the router
 ├
[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] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Instr Represents a policy control instrumentation object.
 
 
 ├
[V] mcast:AResP  This object holds resource (router state) limit policy to limit amount of multicast routing state on the router
 
 
 
 ├
[V] igmp:ResP  This object holds resource (router state) limit policy to limit amount of multicast routing state on the router


Events
                


Faults
                igmp:ResP:stLimitChangeDelGrps
igmp:ResP:stLimitRegEntryChange
igmp:ResP:stLimitRegEntryEmpty
igmp:ResP:stLimitResEntryChange


Fsms
                


Properties Summary
Defined in: igmp:ResP
scalar:Uint32 availRegEntries  (igmp:ResP:availRegEntries)
           Available regular entries
scalar:Uint32 availRsvdEntries  (igmp:ResP:availRsvdEntries)
           Available reserved entries
reference:BinRef monPolDn  (igmp:ResP:monPolDn)
           The monitoring policy attached to this observable object.
igmp:LimitSt
          scalar:Enum8
regEntries  (igmp:ResP:regEntries)
           Regular entry Limit Status
igmp:LimitSt
          scalar:Enum8
rsvdEntries  (igmp:ResP:rsvdEntries)
           Reserved entry Limit Status
Defined in: mcast:AResP
mcast:NumEntries
          scalar:Uint32
max  (mcast:AResP:max)
           A maximum limit on routes leaked.
mcast:ResEntries
          scalar:Uint32
rsvd  (mcast:AResP:rsvd)
           Reserved Multicast Entries
string:Basic rtMap  (mcast:AResP:rtMap)
           The name of the route map. This route map name is used to control distribution.
Defined in: pol:Instr
naming:Descr
          string:Basic
descr  (pol:Instr:descr)
           Specifies a control instrumentation description.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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: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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

availRegEntries

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Available regular entries



availRsvdEntries

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Available reserved entries



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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Specifies a control instrumentation description.



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.



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





max

Type: mcast:NumEntries
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A maximum limit on routes leaked.
Constants
unlimited 4294967295u Unlimited NO COMMENTS
DEFAULT unlimited(4294967295u) Unlimited 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.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



regEntries

Type: igmp:LimitSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Regular entry Limit Status
Constants
below-thresh 0 Below threshold of 80% NO COMMENTS
above-thresh 1 Above 80% threshold NO COMMENTS
exhausted 2 No entries available NO COMMENTS
DEFAULT below-thresh(0) Below threshold of 80% 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.



rsvd

Type: mcast:ResEntries
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Reserved Multicast Entries
Constants
undefined 0u Undefined NO COMMENTS
DEFAULT undefined(0u) Undefined NO COMMENTS





rsvdEntries

Type: igmp:LimitSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Reserved entry Limit Status
Constants
below-thresh 0 Below threshold of 80% NO COMMENTS
above-thresh 1 Above 80% threshold NO COMMENTS
exhausted 2 No entries available NO COMMENTS
DEFAULT below-thresh(0) Below threshold of 80% NO COMMENTS





rtMap

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The name of the route map. This route map name is used to control distribution.



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.