Overview Package Class Deprecated Help

icmp
IcmpPingDefinition

Test definition. Verify the reachability of a remote host

public class IcmpPingDefinition

Properties
bypassRouting Specifies whether to send the ping request to a host on a directly attached network bypassing the routing table. An attempt to set bypassRouting to 'true'will fail with an inconsistentValue error if nextHopAddr does not have the value ''H or egressIfIndex is not equal 0. Only one of nextHopAddr, egressIfIndex, bypassRouting, or subscrIdent may be set to a non-default value.

type=boolean
default=false
Displayed(tab/group)=Bypass Routing (Test Parameters/ICMP Details)
diffServField specifies the value to load in the Type of Service (TOS) octet or the Traffic Class (TC) octet of the launched ICMP echo request(s). The TOS octet is a field in the IPv4 packet header. The TC octet is a field in the IPv6 packet header. The value in the TOS or TC octet may influence the route, latency, and/or probability of loss for the echo request (and, by inference, for the associated data flow). This object is optional. REFERENCE RFC 791, 'Internet Protocol', section 3.1. RFC 1812, 'Requirements for IP Version 4 Routers', section 5.3.2. RFC 2460, 'Internet Protocol, Version 6 (IPv6) Specification', section 7. RFC 2474, 'Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers'.

type=int
default=0
minimum=0
maximum=255
Displayed(tab/group)=DiffServ Field (Test Parameters/ICMP Details)
doNotFragment Specifies whether or not the IPv4 'DF' (Don't Fragment) bit is set in the ICMP ping packet(s) launched for the test. When tmnxOamIcmpPingCtlDoNotFragment is 'true(1)', the 'DF' bit is set. This object is significant if: 1. The target address type for the test (i.e. tmnxOamPingCtlTgtAddrType) is 'ipv4(1)', or 2. tmnxOamPingCtlTgtAddrType is 'dns(16)', and the DNS name resolves to an IPv4 address. Otherwise, this object is ignored.

type=boolean
default=false
Displayed(tab/group)=Do Not Fragment (bit only valid for IPv4) (Test Parameters/ICMP Details)
fcQueue Specifies the forwarding class Queue the ICMP ping will use.

type=boolean
default=true
Displayed(tab/group)=Forwarding Class queue (Test Parameters/ICMP Details)
forwardingClass Specifies the forwarding class the IMCP ping will use.

type=qos.FcEnum
default=nc
Displayed(tab/group)=Forwarding Class (Test Parameters/ICMP Details)
pattern Specifies a pattern to be repeated to fill the data field of the ICMP ping packet. This field is applicable if the positionalPattern property is set to false.

type=int
default=-1
minimum=-1
maximum=65535
Displayed(tab/group)=Data Pattern (Test Parameters/ICMP Details)
positionalPattern Specifies a pattern to be repeated to fill the data field of the ICMP ping packet. If this value is true, then the data field will be filled with positional values. A true value is converted to -1 and send it to the node.

type=boolean
default=false
Displayed(tab/group)=Positional Data Pattern (Test Parameters/ICMP Details)
profile Specifies the profile value to be used with the forwarding class specified in forwardingClass.

type=qos.Profile
default=in
Displayed(tab/group)=Profile (Test Parameters/ICMP Details)
rapid rapid specifies whether or not to send ICMP ping probes in rapid sequence. Changing tmnxOamIcmpPingCtlRapid from 'false' to 'true' implicitly sets tmnxOamPingCtlIntervalUnits to 'centiseconds(2)'. For example, if tmnxOamPingCtlInterval is 1, that makes the interval for the test 0.01 seconds. Changing tmnxOamIcmpPingCtlRapid from 'true' to 'false' implicitly sets tmnxOamPingCtlIntervalUnits to 'seconds(1)'. For example, if tmnxOamPingCtlInterval is 1, that makes the interval for the test 1 second.

type=boolean
default=false
Displayed(tab/group)=Rapid (Test Parameters/ICMP Details)
router Specifies the target type of the pingtest. The target may either be an Core Routing Instance, or VPRN Site.

type=icmp.RouterInstanceType
default=base
Displayed(tab/group)=Router Instance (/From IP Address)
testTargetType Specifies the target type of the pingtest. The target may either be an Core Routing Instance, or VPRN Site.

type=sas.TestTarget
default=coreSite
Displayed(tab/group)=Target Type (/Test Object)
timeToLive Specifies the initial time-to-live value for the ICMP ping packets

type=int
default=64
minimum=1
maximum=128
Displayed(tab/group)=Time to Live (Test Parameters/ICMP Details)
 
Overridden Properties
packetInterval When icmpRapid has a value of 'true',the UNITS for packetInterval is '10 milliseconds' in order to allow rapid intervals less than 1 second to be specified

maximum=10000
packetSize Specifies the payload size following the ICMP header.

default=56
minimum=0
maximum=16384
packetTimeout When icmpPingCtlRapid has a value of 'true', the UNITS for tmnxOamPingCtlInterval is '10 milliseconds' in order to allow rapid intervals less than 1 second to be specified

packetsToSend Specifies the number of times to perform an OAM ping probe operation. Each OAM Echo message request must either timeout or receive a reply before the next message request is sent. The default probe count value for 'icmpPing' is 5.

default=5
maximum=100000
 
Properties inherited from sas.PingDefinition
assurance, maxHistoryRows, packetFailureThreshold, packetInterval, packetSize, packetTimeout, packetsToSend, testFailureThreshold, trapGenerationPolicy
 
Properties inherited from sas.TestDefinition
executionOrder, nePersistent, neSchedulable, probeHistory, publishTopic, sas.ThresholdEventDefinition-Set, testDefinitionmodified
 
Properties inherited from sas.AbstractTest
administrativeState, description, displayedName, failures, globalId, id, lastRunResult, runs, weight
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods inherited from sas.AbstractTest
execute, stop