icmp
IcmpTraceDefinition

DEPRECATED: 8.0 R5 - OBSOLETE: Should Not Be Used

Test definition. Defines the 7x50 SR OAM ICMP Trace Route Control Table for providing, via SNMP, the capability of performing 7x50 SR OAM 'IcmpTrace' test operations.



public class IcmpTraceDefinition

Properties
decodeOriginalDatagram Used to differentiate ICp trace result with decode orginal datagram

type=boolean
default=false
Displayed(tab/group)=Decode Orginal Datagram (/Decode Original Datagram)

destTcpUdpPort The value of tmnxOamIcmpTrCtlDestTcpUdpPort specifies the destination UDP/TCP port number(s) sent in the test's packets. If tmnxOamIcmpTrCtlProtocol='udp', the value is a UDP port number. In that case: a) If tmnxOamIcmpTrCtlDestUdpPortFixed ='true', every packet sent for the test has destination UDP port tmnxOamIcmpTrCtlDestTcpUdpPort. b) If tmnxOamIcmpTrCtlDestUdpPortFixed ='false', the first packet sent for the test has destination UDP port tmnxOamIcmpTrCtlDestTcpUdpPort. The second packet sent for the test has destination UDP port tmnxOamIcmpTrCtlDestTcpUdpPort+1. Etc. If tmnxOamIcmpTrCtlProtocol='tcp', the value is a TCP port number. In that case, every packet sent for the test has destination TCP port tmnxOamIcmpTrCtlDestTcpUdpPort. The default is the port designated by IANA for UDP traceroute and TCP traceroute. Using, for example, the default 'icmpTraceRoute' configuration tmnxOamIcmpTrCtlProtocol ='udp' tmnxOamIcmpTrCtlDestTcpUdpPort =33434 tmnxOamIcmpTrCtlDestUdpPortFixed ='false' in a network with the IANA-standard mtrace UDP port 33435 configured for mtrace may result in conflicts between 'icmpTraceRoute' tests and mtrace. If the 'icmpTraceRoute' test is an SAA test (as created using tmnxOamSaaCtlRowStatus), only 33434 is supported.

type=long
default=33434
minimum=1
maximum=65535
Displayed(tab/group)=Destination UDP or TCP Port (Test Parameters/Execution Details)

destUdpPortFixed The value of tmnxOamIcmpTrCtlProtocol specifies the type of packet to be sent for the 'icmpTraceRoute' test. 'udp' specifies the transmission of UDP packets. 'udp' was the only supported packet type, prior to SROS Release 21.10. 'tcp' specifies the transmission of TCP SYN packets. If the 'icmpTraceRoute' test is an SAA test (as created using tmnxOamSaaCtlRowStatus), only 'udp' is supported

type=boolean
default=false
Displayed(tab/group)=Destination UDP Fixed Port (Test Parameters/Execution Details)

diffServField Specifies the value to store in the Differentiated Services (DS) Field in the IP packet used to encapsulate the 7x50 SR OAM Trace Route probe. The DS Field is defined as the Type of Service (TOS) octet in a IPv4 header or as the Traffic Class octet in a IPv6 header. The value of this object must be a decimal integer in the range from 0 to 255. This option can be used to determine what effect an explicit DS Field setting has on a tmnxOamTr response. Not all values are legal or meaningful. DS Field usage is often not supported by IP implementations. A value of 0 means that the function represented by this option is not supported. Well known TOS octet values are '16' (low delay) and '8' (high throughput). This parameter is optional.

type=int
default=0
minimum=0
maximum=255
Displayed(tab/group)=DiffServ Field (Test Parameters/Test Probe)

hopsPerProbe

type=int
default=3
minimum=1
maximum=10
Displayed(tab/group)=Number of Test Probes (Test Parameters/Execution Details)

initialTimeToLive Specifies the initial outermost label time-to-live value. This enables bypassing the initial (often well known) portion of a path.

type=int
default=1
minimum=1
maximum=255
Displayed(tab/group)=Initial Time To Live (Test Parameters/Test Probe)

maxTimeToLive Specifies the maximum outermost label time-to-live value.

type=int
default=30
minimum=1
maximum=255
Displayed(tab/group)=Maximum Time To Live (Test Parameters/Test Probe)

padSize The value of padSize specifies the number of padding octets to add to the launched request packets for an 'icmpTraceRoute' test. Padding a request packet is typically used to ensure the test works with large packets. The combination padSize > 0, and protocol ='tcp' is not supported by some third party far end nodes. If the 'icmpTraceRoute' test is an SAA test (as created using tmnxOamSaaCtlRowStatus), only zero is supported. tmnxOamTrCtlDataSize is ignored for 'icmpTraceRoute' tests.

type=int
default=0
minimum=0
maximum=9786
units=bytes
Displayed(tab/group)=Size (Test Parameters/Execution Details)

protocol The value of the tmnxOamIfPingIfCurrentInterval indicates if the ping check interval being used is the value of tmnxOamIfPingIfCtlInterval or tmnxOamIfPingIfCtlReactInt. A value of 'interval' indicates the ping check is failed, waiting for a first success, or that the ping check is Operational. A value of reactivation indicates the ping check is recovering.

type=icmp.IcmpTraceProtocol
default=udp
Displayed(tab/group)=Protocol (Test Parameters/Execution 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 IcmpTrace test. The target may either be an Core Routing Instance, or VPRN Site.

type=sas.TestTarget
default=coreSite
Displayed(tab/group)=Target Type (/Test Object)

waitMilliSec Specifies the time in milliseconds to wait for a response before sending the next probe.

type=int
default=5000
minimum=10
maximum=60000
units=milliseconds
Displayed(tab/group)=Time To Wait (Test Parameters/Test Probe)

 
Overridden Properties
packetsToSend The number of probes to send.

default=3
minimum=3
maximum=3

 
Properties inherited from sas.TraceDefinition
assurance, maxFailures, maxHistoryRows, packetInterval, packetSize, packetTimeout, packetsToSend, 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