Class track:List (CONCRETE)

Class ID:13155
Class Label: list object allows User to track the combined states of multiple objects
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: 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 ]

An object track list allows User to track the combined states of multiple objects. Object track lists support the following capabilities: * Boolean "and" function: Each object defined within the track list must be in an UP state so that the track list object can become UP. track:List.type should be specified as 'and' * Boolean "or" function: At least one object defined within the track list must be in UP state so that the tracked object can become UP. track:List.type should be specified as 'or' * Threshold percentage: The percentage of UP objects in the tracked list must be greater than the configured UP threshold for the tracked list to be in the UP state. If the percentage of Down objects in the tracked list is above the configured track list Down threshold, the tracked list is marked as Down. track:List.type should be specified as 'percentage'. The value for 'percentageUp' and 'percentageDown' * Threshold weight: Assign a weight value to each object in the tracked list, and a weight threshold for the track list. If the combined weights of all UP objects exceeds the track list weight UP threshold, the track list is in an UP state. If the combined weights of all the Down objects exceeds the track list weight Down threshold, the track list is in the Down state. track:List.type should be specified as 'weight'. The value for 'weightUp' and 'weightDown'. Mo for List type track

Naming Rules
RN FORMAT: list

    [1] PREFIX=list


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/track/inst/object-{id}/list

[1] sys/track/inst/object-{id}/list

                


Diagram

Container Mos: track:Object (deletable:yes),
Contained Mos: track:Member,


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] track:Entity  Holds object tracking entity information
 
 
 
 
 
 ├
[V] track:Inst  This objects holds OTM instance information.
 
 
 
 
 
 
 ├
[V] track:Object  This object represents object of track. The object tracking monitors the status of the tracked objects and communicates any changes made to interested clients. Each tracked object is identified by a unique number (track:Object.id) that clients can use to configure the action to take when a tracked object changes state. Object types that can b...
 
 
 
 
 
 
 
 ├
[V] track:List An object track list allows User to track the combined states of multiple objects. Object track lists support the following capabilities: * Boolean "and" function: Each object defined within the track list must be in an UP state so that the track list object can become UP. track:List.type should be specified as 'and' * Boolea...
[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] track:Entity  Holds object tracking entity information
 
 
 ├
[V] track:Inst  This objects holds OTM instance information.
 
 
 
 ├
[V] track:Object  This object represents object of track. The object tracking monitors the status of the tracked objects and communicates any changes made to interested clients. Each tracked object is identified by a unique number (track:Object.id) that clients can use to configure the action to take when a tracked object changes state. Object types that can b...
 
 
 
 
 ├
[V] track:List An object track list allows User to track the combined states of multiple objects. Object track lists support the following capabilities: * Boolean "and" function: Each object defined within the track list must be in an UP state so that the track list object can become UP. track:List.type should be specified as 'and' * Boolea...


Contained Hierarchy
[V] track:List An object track list allows User to track the combined states of multiple objects. Object track lists support the following capabilities: * Boolean "and" function: Each object defined within the track list must be in an UP state so that the track list object can become UP. track:List.type should be specified as 'and' * Boolea...
 ├
[V] track:Member  track list member objects, object-id is a naming property here


Inheritance
[V] track:List An object track list allows User to track the combined states of multiple objects. Object track lists support the following capabilities: * Boolean "and" function: Each object defined within the track list must be in an UP state so that the track list object can become UP. track:List.type should be specified as 'and' * Boolea...


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: track:List
scalar:Uint16 percentageDown  (track:List:percentageDown)
           Down Threshold percentage. This specifies the threshold percentage down. This applies when track:List.type is 'percentage'.
scalar:Uint16 percentageUp  (track:List:percentageUp)
           Up Threshold percentage. This specifies the threshold percentage up. This applies when track:List.type is 'percentage'.
track:ListObj
          scalar:Enum8
type  (track:List:type)
           The specific type of the object or component.
scalar:Uint16 weightDown  (track:List:weightDown)
           Down Threshold weight. This specifies the threshold weight down. This applies when track:List.type is 'weight'.
scalar:Uint16 weightUp  (track:List:weightUp)
           Up Threshold weight. This specifies the threshold weight up. This applies when track:List.type is 'weight'.
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: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.



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





percentageDown

Type: scalar:Uint16

Units: percentage
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Down Threshold percentage. This specifies the threshold percentage down. This applies when track:List.type is 'percentage'.
Constants
defaultValue 0 --- NO COMMENTS





percentageUp

Type: scalar:Uint16

Units: percentage
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Up Threshold percentage. This specifies the threshold percentage up. This applies when track:List.type is 'percentage'.
Constants
defaultValue 1 --- 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.



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.






type

Type: track:ListObj
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
percentage 3 Threshold percentage const name="none" value="0"/ Each object defined within the track list must be in an UP state so that the track list object can become UP. const name="and" value="1" label="Boolean 'and' function"/ At least one object defined within the track list must be in an UP state so that the tracked object can become UP. const name="or" value="2" label="Boolean 'or' function"/ The percentage of UP objects in the tracked list must be greater than the configured UP threshold for the tracked list to be in the UP state. If the percentage of Down objects in the tracked list is above the configured track list Down threshold, the tracked list is marked as Down.
weight 4 Threshold weight Assign a weight value to each object in the tracked list, and a weight threshold for the track list. If the combined weights of all UP objects exceeds the track list weight UP threshold, the track list is in an UP state. If the combined weights of all the Down objects exceeds the track list weight Down threshold, the track list is in the Down state.
DEFAULT percentage(3) Threshold percentage const name="none" value="0"/ Each object defined within the track list must be in an UP state so that the track list object can become UP. const name="and" value="1" label="Boolean 'and' function"/ At least one object defined within the track list must be in an UP state so that the tracked object can become UP. const name="or" value="2" label="Boolean 'or' function"/ The percentage of UP objects in the tracked list must be greater than the configured UP threshold for the tracked list to be in the UP state. If the percentage of Down objects in the tracked list is above the configured track list Down threshold, the tracked list is marked as Down.





weightDown

Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Down Threshold weight. This specifies the threshold weight down. This applies when track:List.type is 'weight'.
Constants
defaultValue 0 --- NO COMMENTS





weightUp

Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Up Threshold weight. This specifies the threshold weight up. This applies when track:List.type is 'weight'.
Constants
defaultValue 1 --- NO COMMENTS