| Overview | Package | Class | Deprecated | Help |
| 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) |
| dnsName |
Specifies the DNS name to be resolved to an IP address
type=string minimum=0 maximum=64 |
| hopsPerProbe |
type=int default=3 minimum=1 maximum=10 Displayed(tab/group)=Number of Test Probes (Test Parameters/Execution Details) |
| iesAccessInterfacePointer |
type=Pointer default= Displayed(tab/group)=IES Interface (/Source) |
| 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) |
| interfacePointer |
Pointer to the interface (Network Interface Ies or L3AccessInterface)
type=Pointer access=read-only default= |
| 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) |
| originatingEpsPath |
Specifies the EPS Path that needs to be tested.
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=Pointer access=read-create default= Mandatory on create |
| originatingEpsPeer |
Specifies the EPS Peer that will be used as the source of the OAM test
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=Pointer access=read-create default= Mandatory on create |
| originatingEpsSite |
Specifies the EPS Node that will be used as the source of the OAM test.
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=Pointer access=read-create default= Mandatory on create |
| originatingIesSite |
The network element that is the origin of the test.
type=Pointer access=read-create default= Mandatory on create Displayed(tab/group)=NE Address (/Source) |
| originatingNode |
The network element that is the origin of the test.
type=Pointer access=read-create default= Mandatory on create Displayed(tab/group)=Source IP Address (/From IP Address) |
| originatingVprnSite |
The network element that is the origin of the test.
type=Pointer access=read-create default= Mandatory on create Displayed(tab/group)=NE Address (/Source) |
| 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) |
| rtrInstanceOrServiceName |
The value of tmnxOamTrCtlRouterInstanceName specifies the name of
the service or router instance to be used by an 'icmpTrace' test.
Supersedes serviceId and virtualRouterId if set.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Router Instance Name (/Source) |
| rtrNetworkInterfacePointer |
type=Pointer default= Displayed(tab/group)=Source Network Interface (/Source IP Address) |
| sourceIpAddress |
Specifies the address to be used as the source for
performing the ICMP trace test.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=IP Address (/Source), IP Address (/Source), IP Address (/Source IP Address) |
| sourceIpAddressType |
Specifies the address type of sourceIpAddress.
type=icmp.InetAddressType default=ipv4 |
| srOriginatingNode |
The network element that is the origin of the test.
type=Pointer access=read-create default= Mandatory on create Displayed(tab/group)=Site (/SR Test Source Site) |
| srplEndPointAddr |
Specifies the Segment Routing (SR) policy endpoint address to be used for the test.
IPv4 addresses are not supported in this release.
type=InetAddress default=0:0:0:0:0:0:0:0 Displayed(tab/group)=Endpoint Address (/SRv6-PL Options) |
| srplEndPointAddrType |
Specifies the type of IP address stored in tmnxOamIcmpTrCtlSrV6PlcyEndPtAdd.
The supported object combinations for 'icmpTraceRoute' tests are
listed in the tmnxOamIcmpTrCtlTable DESCRIPTION clause.
type=rtr.InetAddressType default=ipv6 |
| srplPathOwner |
specifies the path owner used to identify the SRv6 policy candidate path to be tested.
'none' indicates the path owner is absent.
type=icmp.PathOwner default=none Displayed(tab/group)=Protocol Owner (/SRv6-PL Options) |
| srplPolicyColor |
Specifies the Segment Routing (SR) policy color to be used for the test. A color associates an
SR policy with an intent (e.g. low latency).
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Color (/SRv6-PL Options) |
| srplPreference |
Specifies the preference used to identify the SRv6 policy candidate path to be tested.
type=long default=100 minimum=0 maximum=4294967295 Displayed(tab/group)=Preference (/SRv6-PL Options) |
| srplRtDistinguisher |
Specifies the route distinguisher used to identify the SRv6 policy candidate path to be
tested.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Distinguisher (/SRv6-PL Options) |
| srplSegmentList |
Specifies the Segment Routing (SR) policy segment list to be used for the test.
Zero specifies no segment list is configured.
type=int default=0 minimum=0 maximum=32 Displayed(tab/group)=Segment List (/SRv6-PL Options) |
| targetIpAddress |
Specifies the address to be used as the destination
for the ICMP trace test.
type=InetAddress Displayed(tab/group)=Target IP Address (/Target IP Address) |
| targetIpAddressType |
Specifies the address to be used as the destination
for the ICMP trace test.
type=icmp.InetAddressType access=read-only |
| testSubMode |
Specifies the type of 'icmpTraceRoute' test to perform.
'srv6Policy' specifies each launched packet contains an IPv6 Segment Routing Header (SRH;RFC 8754).
'unspecified' specifies any other 'icmpTraceRoute' test.
type=icmp.TestSubMode default=unspecified |
| 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) |
| virtualRouterId |
The value of virtualRouterId specifies the virtual router to be
used for the test. The value specified must be the index of an active
row in TIMETRA-VRTR-MIB::vRtrConfTable.
This object is applicable if tmnxOamPingCtlTestMode is 'icmpPing' or
'mrInfo'.
When directing an 'icmpPing' or 'mrInfo' test to use a virtual router
associated with a VPRN service, the virtual router can be specified
using tmnxOamPingCtlVRtrID (with the VPRN's virtual router number) or
tmnxOamPingCtlServiceId (with the VPRN's service number).
tmnxOamPingCtlServiceId is preferred, because service numbers are
constant across an SROS reboot (while virtual routers may be
renumbered). If non-default values are specified for both
tmnxOamPingCtlVRtrID and tmnxOamPingCtlServiceId,
tmnxOamPingCtlServiceId is used.
Setting this object is optional.
type=long access=read-only default=1 minimum=0 maximum=10240 |
| vprnAccessInterfacePointer |
type=Pointer default= Displayed(tab/group)=VPRN Interface (/Source) |
| 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.Trace |
|---|
| assurance, maxFailures, maxHistoryRows, packetInterval, packetSize, packetTimeout, packetsToSend, testType, trapGenerationPolicy |
| 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.Test |
|---|
| adhocExecuteAndWait, executeAndWait, setNeSchedulableAdminState |
| Methods inherited from sas.AbstractTest |
|---|
| execute, stop |