Class isis:FmcastTree (CONCRETE)

Class ID:2766
Class Label: IS-IS Fabric Multicast Tree
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, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
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: true, HasFaults: true, HasHealth: true, HasEventRules: true ]

The ISIS Fabric Multicast(ftag) tree element is a manged object that captures ISIS fabric-wide multicast tree membership information.

Naming Rules
RN FORMAT: fmtree-{id}

    [1] PREFIX=fmtree- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/isis/inst-{name}/dom-{name}/fmtree-{id}

[1] sys/isis/inst-{name}/dom-{name}/fmtree-{id}

                


Diagram

Super Mo: mcast:Tree,
Container Mos: isis:Dom (deletable:no),
Contained Mos: isis:NodeIdRec, isis:OifListLeaf, isis:OifListSpine,


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] isis:Entity IS-IS control plane entity information.
 
 
 
 
 
 ├
[V] isis:Inst Per- IS-IS instance information.
 
 
 
 
 
 
 ├
[V] isis:Dom The IS-IS domain (vrf) information.
 
 
 
 
 
 
 
 ├
[V] isis:FmcastTree The ISIS Fabric Multicast(ftag) tree element is a manged object that captures ISIS fabric-wide multicast tree membership information.
[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] isis:Entity IS-IS control plane entity information.
 
 
 ├
[V] isis:Inst Per- IS-IS instance information.
 
 
 
 ├
[V] isis:Dom The IS-IS domain (vrf) information.
 
 
 
 
 ├
[V] isis:FmcastTree The ISIS Fabric Multicast(ftag) tree element is a manged object that captures ISIS fabric-wide multicast tree membership information.


Contained Hierarchy
[V] isis:FmcastTree The ISIS Fabric Multicast(ftag) tree element is a manged object that captures ISIS fabric-wide multicast tree membership information.
 ├
[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: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] isis:NodeIdRec The fabric nodes active for this multicast group element.
 ├
[V] isis:OifListLeaf The outgoing interface list on the leaf switch.
 ├
[V] isis:OifListSpine The outgoing interface list on the spine switch.


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:Tree A tree abstraction.
 
 
 ├
[V] mcast:Tree An abstraction of a multicast tree.
 
 
 
 ├
[V] isis:FmcastTree The ISIS Fabric Multicast(ftag) tree element is a manged object that captures ISIS fabric-wide multicast tree membership information.


Stat Counters
scalar:Uint32 COUNTER: isis:FtagTreeStats:avgAvgPenalty(count)
           average average penalty
          Comments: Running Average of Avg Oversubscription factor
scalar:Uint32 COUNTER: isis:FtagTreeStats:avgMaxPenalty(count)
           average maximum penalty
          Comments: Running Average of Max Oversubscription factor
scalar:Uint32 COUNTER: isis:FtagTreeStats:curAvgPenalty(count)
           current average penalty
          Comments: Current Avg Oversubscription factor for the tree
scalar:Uint64 COUNTER: isis:FtagTreeStats:curMaxPenalty(count)
           current maximum penalty
          Comments: Current max Oversubscription factor for the tree


Stats
[V] isis:FmcastTree The ISIS Fabric Multicast(ftag) tree element is a manged object that captures ISIS fabric-wide multicast tree membership information.
 ├
[V] isis:FtagTreeStats15min A class that represents the most current statistics for FTAG in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] isis:FtagTreeStats1d A class that represents the most current statistics for FTAG in a 1 day sampling interval. This class updates every hour.
 ├
[V] isis:FtagTreeStats1h A class that represents the most current statistics for FTAG in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] isis:FtagTreeStats1mo A class that represents the most current statistics for FTAG in a 1 month sampling interval. This class updates every day.
 ├
[V] isis:FtagTreeStats1qtr A class that represents the most current statistics for FTAG in a 1 quarter sampling interval. This class updates every day.
 ├
[V] isis:FtagTreeStats1w A class that represents the most current statistics for FTAG in a 1 week sampling interval. This class updates every day.
 ├
[V] isis:FtagTreeStats1year A class that represents the most current statistics for FTAG in a 1 year sampling interval. This class updates every day.
 ├
[V] isis:FtagTreeStats5min A class that represents the most current statistics for FTAG in a 5 minute sampling interval. This class updates every 10 seconds.
 ├
[V] isis:FtagTreeStatsHist15min A class that represents historical statistics for FTAG in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] isis:FtagTreeStatsHist1d A class that represents historical statistics for FTAG in a 1 day sampling interval. This class updates every hour.
 ├
[V] isis:FtagTreeStatsHist1h A class that represents historical statistics for FTAG in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] isis:FtagTreeStatsHist1mo A class that represents historical statistics for FTAG in a 1 month sampling interval. This class updates every day.
 ├
[V] isis:FtagTreeStatsHist1qtr A class that represents historical statistics for FTAG in a 1 quarter sampling interval. This class updates every day.
 ├
[V] isis:FtagTreeStatsHist1w A class that represents historical statistics for FTAG in a 1 week sampling interval. This class updates every day.
 ├
[V] isis:FtagTreeStatsHist1year A class that represents historical statistics for FTAG in a 1 year sampling interval. This class updates every day.
 ├
[V] isis:FtagTreeStatsHist5min A class that represents historical statistics for FTAG in a 5 minute sampling interval. This class updates every 10 seconds.


Events
                isis:FmcastTree:isis_FmcastTree_treeOperStateInactive
isis:FmcastTree:isis_FmcastTree_treeOperStateActive


Faults
                isis:FmcastTree:treeLargeDia


Fsms
                


Properties Summary
Defined in: isis:FmcastTree
fmcast:DiameterAlert
          scalar:Enum8
diaAlert  (isis:FmcastTree:diaAlert)
           The forwarding tag (FTAG) when diameter is large.
fmcast:Diameter
          scalar:Uint16
diameter  (isis:FmcastTree:diameter)
           Specifies the forwarding tag (FTAG) diameter.
fmcast:Id
          scalar:UByte
id  (isis:FmcastTree:id)
           Specifies the forwarding tag (FTAG) ID.
reference:BinRef monPolDn  (isis:FmcastTree:monPolDn)
           Holds the monitoring policy for the forwarding tag (FTAG) object.
fmcast:OperSt
          scalar:Enum8
operSt  (isis:FmcastTree:operSt)
           The IS-IS forwarding tag (FTAG) operational state.
fmcast:Origin
          scalar:Enum8
origin  (isis:FmcastTree:origin)
           The origin of the IS-IS forwarding tag (FTAG) object.
mcast:Root
          address:Ip
root  (isis:FmcastTree:root)
           Specifies the Multicast root address for the FTAG.
base:IfIndex rootPort  (isis:FmcastTree:rootPort)
           Specifies the forwarding tag (FTAG) outgoing port to reach the root.
isis:Usage
          scalar:Enum8
usage  (isis:FmcastTree:usage)
           The usage of the port. This property shows how the port is used.
Defined in: nw:Tree
naming:Name
          string:Basic
name  (nw:Tree: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

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





diaAlert

Type: fmcast:DiameterAlert
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The forwarding tag (FTAG) when diameter is large.
Constants
inactive 1 Normal Alert is not active
active 2 Excessive Diameter Alert Alert is active due to large diameter
DEFAULT inactive(1) Normal Alert is not active





diameter

Type: fmcast:Diameter
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the forwarding tag (FTAG) diameter.



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.



id

Type: fmcast:Id
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
Specifies the forwarding tag (FTAG) ID.
Constants
defaultValue 0 --- 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:
Holds the monitoring policy for the forwarding tag (FTAG) object.



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.



operSt

Type: fmcast:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IS-IS forwarding tag (FTAG) operational state.
Constants
active 1 Active Active
inactive 2 Inactive Inactive
DEFAULT inactive(2) Inactive Inactive





origin

Type: fmcast:Origin
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The origin of the IS-IS forwarding tag (FTAG) object.
Constants
static 1 Static statically configured
isis 2 Learned through isis learned through isis protocol
DEFAULT static(1) Static statically configured





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.



root

Type: mcast:Root
Primitive Type: address:Ip

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the Multicast root address for the FTAG.



rootPort

Type: base:IfIndex

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the forwarding tag (FTAG) outgoing port to reach the root.



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.






usage

Type: isis:Usage
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The usage of the port. This property shows how the port is used.
Constants
user 0 User User FTAG
internal 1 Fabric Internal Usage Internal
DEFAULT user(0) User User FTAG