Class sla:ICMPEcho (CONCRETE)

Class ID:13178
Class Label: ICMP Echo Operation
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: true, HasStats: true, HasFaults: true, HasHealth: true, HasEventRules: false ]

NO COMMENTS

Naming Rules
RN FORMAT: icmpEcho-{[dstIp]}-vnid-{[vrfEncap]}-dP0

    [1] PREFIX=icmpEcho- PROPERTY = dstIp


    [2] PREFIX=-vnid- PROPERTY = vrfEncap


    [3] PREFIX=-dP0


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/sla/inst/opCont/icmpEcho-{[dstIp]}-vnid-{[vrfEncap]}-dP0

[1] sys/sla/inst/opCont/icmpEcho-{[dstIp]}-vnid-{[vrfEncap]}-dP0

                


Diagram

Super Mo: sla:Operation,
Container Mos: sla:OpCont (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] sla:Entity  Holds IP SLA control plane entity information
 
 
 
 
 
 ├
[V] sla:Inst  This objects hold per IP SLA instance information. There is only one instance of IP SLA running in the system today
 
 
 
 
 
 
 ├
[V] sla:OpCont  Holds IP SLA operations information
 
 
 
 
 
 
 
 ├
[V] sla:ICMPEcho 
[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] sla:Entity  Holds IP SLA control plane entity information
 
 
 ├
[V] sla:Inst  This objects hold per IP SLA instance information. There is only one instance of IP SLA running in the system today
 
 
 
 ├
[V] sla:OpCont  Holds IP SLA operations information
 
 
 
 
 ├
[V] sla:ICMPEcho 


Contained Hierarchy
[V] sla:ICMPEcho 
 ├
[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)


Inheritance
[V] sla:Operation 
 ├
[V] sla:ICMPEcho 


Stat Counters
scalar:Uint64 COUNTER: sla:ICMPEchoStats:failures(packets)
           number of failed ICMP Echo probes
          Comments: NO COMMENTS
scalar:Uint64 COUNTER: sla:ICMPEchoStats:success(packets)
           number of successful ICMP Echo probes
          Comments: NO COMMENTS
scalar:Uint64 COUNTER: sla:ICMPEchoStats:txPkts(packets)
           number of transmitted ICMP Echo probes
          Comments: Transmitted Packets
scalar:Uint64 GAUGE: sla:ICMPEchoStats:rtt(milliseconds)
           ICMP Echo Round Trip Time
          Comments: Round Trip Time


Stats
[V] sla:ICMPEcho 
 ├
[V] sla:ICMPEchoStats15min A class that represents the most current statistics for ICMP Echo Operation Statistics in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] sla:ICMPEchoStats1d A class that represents the most current statistics for ICMP Echo Operation Statistics in a 1 day sampling interval. This class updates every hour.
 ├
[V] sla:ICMPEchoStats1h A class that represents the most current statistics for ICMP Echo Operation Statistics in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] sla:ICMPEchoStats1mo A class that represents the most current statistics for ICMP Echo Operation Statistics in a 1 month sampling interval. This class updates every day.
 ├
[V] sla:ICMPEchoStats1qtr A class that represents the most current statistics for ICMP Echo Operation Statistics in a 1 quarter sampling interval. This class updates every day.
 ├
[V] sla:ICMPEchoStats1w A class that represents the most current statistics for ICMP Echo Operation Statistics in a 1 week sampling interval. This class updates every day.
 ├
[V] sla:ICMPEchoStats1year A class that represents the most current statistics for ICMP Echo Operation Statistics in a 1 year sampling interval. This class updates every day.
 ├
[V] sla:ICMPEchoStats5min A class that represents the most current statistics for ICMP Echo Operation Statistics in a 5 minute sampling interval. This class updates every 10 seconds.
 ├
[V] sla:ICMPEchoStatsHist15min A class that represents historical statistics for ICMP Echo Operation Statistics in a 15 minute sampling interval. This class updates every 5 minutes.
 ├
[V] sla:ICMPEchoStatsHist1d A class that represents historical statistics for ICMP Echo Operation Statistics in a 1 day sampling interval. This class updates every hour.
 ├
[V] sla:ICMPEchoStatsHist1h A class that represents historical statistics for ICMP Echo Operation Statistics in a 1 hour sampling interval. This class updates every 15 minutes.
 ├
[V] sla:ICMPEchoStatsHist1mo A class that represents historical statistics for ICMP Echo Operation Statistics in a 1 month sampling interval. This class updates every day.
 ├
[V] sla:ICMPEchoStatsHist1qtr A class that represents historical statistics for ICMP Echo Operation Statistics in a 1 quarter sampling interval. This class updates every day.
 ├
[V] sla:ICMPEchoStatsHist1w A class that represents historical statistics for ICMP Echo Operation Statistics in a 1 week sampling interval. This class updates every day.
 ├
[V] sla:ICMPEchoStatsHist1year A class that represents historical statistics for ICMP Echo Operation Statistics in a 1 year sampling interval. This class updates every day.
 ├
[V] sla:ICMPEchoStatsHist5min A class that represents historical statistics for ICMP Echo Operation Statistics in a 5 minute sampling interval. This class updates every 10 seconds.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: sla:ICMPEcho
address:Ip dstIp  (sla:ICMPEcho:dstIp)
           The destination IP address.
reference:BinRef monPolDn  (sla:ICMPEcho:monPolDn)
           The monitoring policy attached to this observable object.
sla:ReqDataSize
          scalar:Uint32
reqDataSize  (sla:ICMPEcho:reqDataSize)
           NO COMMENTS
scalar:Bool verifyData  (sla:ICMPEcho:verifyData)
           NO COMMENTS
base:Encap vrfEncap  (sla:ICMPEcho:vrfEncap)
           Overrides:sla:Operation:vrfEncap
           Ignore, removed
Defined in: sla:Operation
base:Encap bdVnid  (sla:Operation:bdVnid)
           NO COMMENTS
sla:DetectMultiplier
          scalar:Uint32
detectmult  (sla:Operation:detectmult)
           NO COMMENTS
sla:Frequency
          scalar:Uint32
frequency  (sla:Operation:frequency)
           NO COMMENTS
sla:OpNum
          scalar:Uint32
id  (sla:Operation:id)
           An object identifier.
sla:TosValue
          scalar:UByte
ipv4Tos  (sla:Operation:ipv4Tos)
           NO COMMENTS
sla:TrfClass
          scalar:UByte
ipv6TrfClass  (sla:Operation:ipv6TrfClass)
           NO COMMENTS
string:Basic lastErrMsg  (sla:Operation:lastErrMsg)
           NO COMMENTS
string:Basic opStartTime  (sla:Operation:opStartTime)
           NO COMMENTS
sla:OperStatus
          scalar:Enum8
operSt  (sla:Operation:operSt)
           The runtime state of the object or policy.
reference:BinRef slaLogicalDn  (sla:Operation:slaLogicalDn)
           NO COMMENTS
sla:Threshold
          scalar:Uint32
threshold  (sla:Operation:threshold)
           NO COMMENTS
sla:Timeout
          scalar:Uint32
timeout  (sla:Operation:timeout)
           The amount of time between authentication attempts.
scalar:Bool trackEnabled  (sla:Operation:trackEnabled)
           NO COMMENTS
l3:VrfName
          string:Basic
vrfName  (sla:Operation:vrfName)
           The VRF name. This name can be up to 64 alphanumeric characters.
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

bdVnid

Type: base:Encap

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



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





detectmult

Type: sla:DetectMultiplier
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 3u --- 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.



dstIp

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The destination IP address.



frequency

Type: sla:Frequency
Primitive Type: scalar:Uint32

Units: seconds
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 1u --- NO COMMENTS





id

Type: sla:OpNum
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
An object identifier.
Constants
defaultValue 100u --- NO COMMENTS





ipv4Tos

Type: sla:TosValue
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 0 --- NO COMMENTS





ipv6TrfClass

Type: sla:TrfClass
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 0 --- NO COMMENTS





lastErrMsg

Type: string:Basic

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



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





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



opStartTime

Type: string:Basic

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



operSt

Type: sla:OperStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unreachable 0 Unreachable Unreachable
reachable 1 Reachable Reachable
unspecified 2 Unspecified Unspecified
DEFAULT unspecified(2) Unspecified Unspecified





reqDataSize

Type: sla:ReqDataSize
Primitive Type: scalar:Uint32

Units: bytes
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
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.



slaLogicalDn

Type: reference:BinRef

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



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.






threshold

Type: sla:Threshold
Primitive Type: scalar:Uint32

Units: milliseconds
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 900u --- NO COMMENTS





timeout

Type: sla:Timeout
Primitive Type: scalar:Uint32

Units: milliseconds
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The amount of time between authentication attempts.
Constants
defaultValue 900u --- NO COMMENTS





trackEnabled

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





verifyData

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





vrfEncap

Type: base:Encap

Overrides:sla:Operation:vrfEncap
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
Ignore, removed



vrfName

Type: l3:VrfName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The VRF name. This name can be up to 64 alphanumeric characters.