Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class coop:FabMcGrpv4Rec (CONCRETE)

Class ID:6938
Class Label: Tenant IPv4 Multicast Group Record
Encrypted: false - Exportable: false - Persistent: false - 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: 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 ]

Fabric IPv4 multicast group records

Naming Rules 
RN FORMAT: bf-{bfId}-ver-{version}-vnid-{vnid}-grp-{mcGrpIp}

    [1] PREFIX=bf- PROPERTY = bfId


    [2] PREFIX=-ver- PROPERTY = version


    [3] PREFIX=-vnid- PROPERTY = vnid


    [4] PREFIX=-grp- PROPERTY = mcGrpIp




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/coop/inst/dom-{name}/db-{type}/bf-{bfId}-ver-{version}-vnid-{vnid}-grp-{mcGrpIp}

[1] sys/coop/inst/dom-{name}/db-{type}/bf-{bfId}-ver-{version}-vnid-{vnid}-grp-{mcGrpIp}


Diagram

Super Mo: coop:FabMcGrpRec,
Container Mos: coop:Db (deletable:no),
Relations To: coop:LeafRec,
Relations: coop:RsFabMcgrp2Leaf,


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] coop:Entity The COOP control plane entity information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] coop:Dom Per COOP domain (vrf) information.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] coop:Db An abstraction of the COOP database (repository).
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] coop:FabMcGrpv4Rec  Fabric IPv4 multicast group records
[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] coop:Entity The COOP control plane entity information.
 
 		 
 		 ├
 		[V] coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.
 
 		 
 		 
 		 ├
 		[V] coop:Dom Per COOP domain (vrf) information.
 
 		 
 		 
 		 
 		 ├
 		[V] coop:Db An abstraction of the COOP database (repository).
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] coop:FabMcGrpv4Rec  Fabric IPv4 multicast group records


Contained Hierarchy
[V] coop:FabMcGrpv4Rec  Fabric IPv4 multicast group records
 ├
 		[V] coop:RsFabMcgrp2Leaf  List of interested leafs


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:GEp A group endpoint abstraction.
 
 		 
 		 ├
 		[V] nw:DbRec An abstraction of a database record.
 
 		 
 		 
 		 ├
 		[V] l3:DbRec A database record abstraction.
 
 		 
 		 
 		 
 		 ├
 		[V] coop:Rec The abstraction for the COOP database record.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] coop:CoopRec The COOP records.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] coop:FabMcGrpRec  Fabric Multicast group records
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] coop:FabMcGrpv4Rec  Fabric IPv4 multicast group records


Events


Faults


Fsms


Properties Summary
Defined in: coop:FabMcGrpv4Rec
coop:BrownFieldId
          scalar:Uint32 		bfId  (coop:FabMcGrpv4Rec:bfId)
           Brownfield ID TODO: Get the type from common type
address:IPv4 mcGrpIp  (coop:FabMcGrpv4Rec:mcGrpIp)
           A multicast group IP address subscribed to on a leaf switch.
coop:IGMPVersion
          scalar:UByte 		version  (coop:FabMcGrpv4Rec:version)
           The version of the compatibility catalog.
coop:Vnid
          scalar:Uint32 		vnid  (coop:FabMcGrpv4Rec:vnid)
           Overrides:coop:FabMcGrpRec:vnid
           The virtual network ID of the object (VRF, bridge domain, or layer 3 context).
Defined in: coop:FabMcGrpRec
coop:McGrpFlags
          scalar:Bitmask8 		flags  (coop:FabMcGrpRec:flags)
           The IP address flags.
Defined in: coop:CoopRec
coop:DampPenalty
          scalar:Uint16 		dampPenalty  (coop:CoopRec:dampPenalty)
           The penalty score for multiple rapid publishing of records.
coop:Timestamp
          scalar:Date 		lastDampen  (coop:CoopRec:lastDampen)
           The last timestamp at which the dampening policy was enforced due to the dampen penalty exceeding the threshold.
coop:Timestamp
          scalar:Date 		lastPub  (coop:CoopRec:lastPub)
           A timestamp indicating the last time a record was published by the client.
coop:Timestamp
          scalar:Date 		recordTs  (coop:CoopRec:recordTs)
          
Defined in: nw:DbRec
naming:Name
          string:Basic 		name  (nw:DbRec:name)
           Overrides:nw:Conn:name
           The name of the object.
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

bfId

Type: coop:BrownFieldId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Brownfield ID TODO: Get the type from common type


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




dampPenalty

Type: coop:DampPenalty
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The penalty score for multiple rapid publishing of records.
Constants
defaultValue 1000 --- 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.


flags

Type: coop:McGrpFlags
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IP address flags.
Constants
bridge 1 Bridging Bridging
routing 2 Routing Routing
dampen 4 Dampen Dampen
DEFAULT 0 --- McastGrp flags




lastDampen

Type: coop:Timestamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The last timestamp at which the dampening policy was enforced due to the dampen penalty exceeding the threshold.


lastPub

Type: coop:Timestamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A timestamp indicating the last time a record was published by the client.


mcGrpIp

Type: address:IPv4

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
A multicast group IP address subscribed to on a leaf switch.


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
    Comments:
The name of the object.


recordTs

Type: coop:Timestamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    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.


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.





version

Type: coop:IGMPVersion
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The version of the compatibility catalog.
Constants
defaultValue 2 --- NO COMMENTS




vnid

Type: coop:Vnid
Primitive Type: scalar:Uint32

Overrides:coop:FabMcGrpRec:vnid

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The virtual network ID of the object (VRF, bridge domain, or layer 3 context).
Constants
defaultValue 1u --- NO COMMENTS






Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail