Class track:IpSla (CONCRETE)

Class ID:13154
Class Label: Object tracking of IP SLAs operations allow clients to track the output from IP SLAs 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 ]

IP SLA track object. Object tracking of IP SLAs operations allow clients to track the output from IP SLAs objects and use this information to trigger an action. Two aspects of IP SLAs can be tracked: state and reachability. For state, if the return code is OK, then the track state is UP; if the return code is not OK, then the track state is Down. For reachability, if the return code is OK or OverThreshold, reachability is UP; if not OK, reachability is Down.

Naming Rules
RN FORMAT: ipsla

    [1] PREFIX=ipsla


DN FORMAT: 

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

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

                


Diagram

Container Mos: track:Object (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] 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:IpSla  IP SLA track object. Object tracking of IP SLAs operations allow clients to track the output from IP SLAs objects and use this information to trigger an action. Two aspects of IP SLAs can be tracked: state and reachability. For state, if the return code is OK, then the track state is UP; if the return code is not OK, then the track state is...
[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:IpSla  IP SLA track object. Object tracking of IP SLAs operations allow clients to track the output from IP SLAs objects and use this information to trigger an action. Two aspects of IP SLAs can be tracked: state and reachability. For state, if the return code is OK, then the track state is UP; if the return code is not OK, then the track state is...


Contained Hierarchy
[V] track:IpSla  IP SLA track object. Object tracking of IP SLAs operations allow clients to track the output from IP SLAs objects and use this information to trigger an action. Two aspects of IP SLAs can be tracked: state and reachability. For state, if the return code is OK, then the track state is UP; if the return code is not OK, then the track state is...


Inheritance
[V] track:IpSla  IP SLA track object. Object tracking of IP SLAs operations allow clients to track the output from IP SLAs objects and use this information to trigger an action. Two aspects of IP SLAs can be tracked: state and reachability. For state, if the return code is OK, then the track state is UP; if the return code is not OK, then the track state is...


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: track:IpSla
string:Basic latestOpRetCode  (track:IpSla:latestOpRetCode)
           Latest operation return code from IP SLA
scalar:Uint32 latestRTT  (track:IpSla:latestRTT)
           Latest RTT Value
scalar:Uint32 probeId  (track:IpSla:probeId)
           SLA Probe ID to be tracked
track:ProbeState
          scalar:Enum8
probeState  (track:IpSla:probeState)
           SLA Probe States
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.



latestOpRetCode

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Latest operation return code from IP SLA



latestRTT

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Latest RTT Value



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





probeId

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SLA Probe ID to be tracked



probeState

Type: track:ProbeState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
SLA Probe States
Constants
reachability 0 probe state is reachable or over threshold For reachability, if the return code is OK or OverThreshold, reachability is UP; if not OK, reachability is Down.
state 1 probe state is reachable and within threshold For state, if the return code is OK, the track state is UP; if the return code is not OK, the track state is Down.
DEFAULT state(1) probe state is reachable and within threshold For state, if the return code is OK, the track state is UP; if the return code is not OK, the track state is Down.





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.