| Overview | Package | Class | Deprecated | Help |
| 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 access=read-only 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 access=read-only Displayed(tab/group)=DiffServ Field (Test Parameters/ICMP Details) |
| dnsName |
Specifies the DNS name to be resolved to an IP address
type=string access=read-only maximum=64 |
| 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 access=read-only Displayed(tab/group)=Do Not Fragment (bit only valid for IPv4) (Test Parameters/ICMP Details) |
| egressIesAccessInterfacePointer |
type=Pointer access=read-only Displayed(tab/group)=Egress IES Interface (Test Parameters/ICMP Details) |
| egressIfIndex |
The value of egressIfIndex specifies the ifIndex of the
interface to use to transmit the ICMP ping packets.
When bypassRouting has a value of 'true', an attempt
to set egressIfIndex to a value other than 0 will fail
with an inconsistentValue error.
Only one of nextHopAddr, egressIfIndex, bypassRouting, or
subscrIdent may be set to a non-default value.
type=int access=read-only |
| egressIfName |
The value of tmnxOamIcmpPingCtlEgrIfName specifies the name of the
interface to use to transmit the ICMP ping packets. The value
provided is accepted whether or not it is a known interface name
(validation is done as part of executing the test).
type=string access=read-only maximum=32 |
| egressRtrNetworkInterfacePointer |
type=Pointer access=read-only Displayed(tab/group)=Egress Interface (Test Parameters/ICMP Details) |
| egressVprnAccessInterfacePointer |
type=Pointer access=read-only Displayed(tab/group)=Egress VPRN Interface (Test Parameters/ICMP Details) |
| fcQueue |
Specifies the forwarding class Queue the ICMP ping will use.
type=boolean access=read-only Displayed(tab/group)=Forwarding Class queue (Test Parameters/ICMP Details) |
| forwardingClass |
Specifies the forwarding class the IMCP ping will use.
type=qos.FcEnum access=read-only Displayed(tab/group)=Forwarding Class (Test Parameters/ICMP Details) |
| iesAccessInterfacePointer |
type=Pointer access=read-only Displayed(tab/group)=IES Interface (/Source) |
| nextHopAddr |
Specifies the Internet address of the next-hop.
When bypassRouting has a value of 'true' or egressIfIndex
has a value not equal 0, an attempt to set nextHopAddr to a value
other than ''H will fail with an inconsistentValue error.
Only one of nextHopAddr, egressIfIndex, bypassRouting, or subscrIdent may be
set to a non-default value.
type=InetAddress access=read-only Displayed(tab/group)=Next Hop Address (Test Parameters/ICMP Details) |
| nextHopAddrType |
Specifies the address type of the nextHopAddr.
type=icmp.InetAddressType access=read-only |
| originatingEpsPath |
Specifies the EPS Path that needs to be tested.
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=Pointer access=read-only |
| 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-only |
| 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-only |
| originatingIesSite |
The network element that is the origin of the test.
type=Pointer access=read-only Displayed(tab/group)=NE Address (/Source) |
| originatingNode |
The network element that is the origin of the test.
type=Pointer access=read-only Displayed(tab/group)=From IP Address (/From IP Address) |
| originatingVprnSite |
The network element that is the origin of the test.
type=Pointer access=read-only Displayed(tab/group)=NE Address (/Source) |
| packetTimeoutType |
"The value ofPingCtlTimeOutType specifies the type of the
timeout for an 'icmpPing' test otherwise the value is irrelevant and
PingCtlTimeOut usage will be according to the test mode
mentioned in the description.
The object is currently supported only in non-SAA 'icmp-ping'."
type=icmp.PingCtrlTimeOutType access=read-only Displayed(tab/group)=Timeout Type (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 access=read-only 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 access=read-only 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 access=read-only 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 access=read-only 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 access=read-only Displayed(tab/group)=Router Instance (/From IP Address) |
| rtrInstanceOrServiceName |
The value of tmnxOamPingCtlRouterInstanceName specifies the name of
the service or router instance to be used by an 'icmpPing' test.
Supersedes serviceId and virtualRouterId if set.
type=string access=read-only maximum=64 Displayed(tab/group)=Router Instance Name (/Source) |
| rtrNetworkInterfacePointer |
type=Pointer access=read-only Displayed(tab/group)=Source Network Interface (/Source IP Address) |
| serviceId |
Specifies the service ID associated with the CFM Test, If the originating MEP is a service MEP.
type=long access=read-only |
| serviceType |
Specifies the service type.
type=service.ServiceType access=read-only |
| sourceIpAddress |
Specifies the address to be used as the source for
performing the ICMP ping test.
type=InetAddress access=read-only Displayed(tab/group)=IP Address (/Source), IP Address (/Source) |
| sourceIpAddressType |
Specifies the address type of the sourceIpAddress.
type=icmp.InetAddressType access=read-only |
| srOriginatingNode |
The network element that is the origin of the test.
type=Pointer access=read-only Displayed(tab/group)=Site (/SR Test Source Site) |
| srplEndPointAddr |
The Segment Routing (SR) policy endpoint address to be used for the SRPL test.
leave empty for non-SRPL tests.
type=InetAddress access=read-only Displayed(tab/group)=Endpoint Address (/SRv6-PL Options) |
| srplEndPointAddrType |
Specifies the type of IP address stored in tmnxOamIcmpPingCtlSrV6PyEndPtAdd.
The supported object combinations for 'icmpPing' tests are listed in
the tmnxOamIcmpPingCtlTable DESCRIPTION clause.
type=rtr.InetAddressType access=read-only |
| 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 access=read-only 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 access=read-only Displayed(tab/group)=Color (/SRv6-PL Options) |
| srplPreference |
Specifies the preference used to identify the SRv6 policy candidate path to be tested.
type=long access=read-only Displayed(tab/group)=Preference (/SRv6-PL Options) |
| srplRtDistinguisher |
Specifies the route distinguisher used to identify the SRv6 policy candidate path to be
tested. Zero indicates the route distinguisher is absent.
type=long access=read-only Displayed(tab/group)=Distinguisher (/SRv6-PL Options) |
| srplSegmentList |
The Segment Routing (SR) policy segment list to be used for the test. 0 means "none".
type=int access=read-only Displayed(tab/group)=Segment List (/SRv6-PL Options) |
| subscrIdent |
Specifies the the name of the subscriber to be pinged.
When a non-default value for this object is specified, a Layer-2-Aware
Network Address Translation (NAT) ping is requested. The subscriber
name and the target IP address are used together to ping the subscriber's
device.
If subscrIdent is set to a non-default value, then egressIfIndex, nextHopAddr,
bypassRouting, rapid, and neSchedulable must be set the their default values.
type=string access=read-only maximum=32 Displayed(tab/group)=Name (/Subscriber ID) |
| targetIpAddress |
Specifies the address to be used as the destination
for the ICMP ping test.
type=InetAddress access=read-only Displayed(tab/group)=Target IP Address (/Target IP Address) |
| targetIpAddressType |
Specifies the address type of the targetIpAddress.
type=icmp.InetAddressType access=read-only |
| targetVportIpAddress |
This is the target VPort for the test
type=Pointer access=read-only |
| testInterval |
Specifies the interval for this Test
type=int access=read-only Displayed(tab/group)=Test Interval (Test Parameters/ICMP Details) |
| testSubMode |
Specifies the type of 'icmpPing' test to perform.
'srv6Policy' specifies each launched packet contains an IPv6 Segment Routing Header (SRH;RFC 8754).
'unspecified' specifies any other 'icmpPing' test.
type=icmp.TestSubMode access=read-only |
| testTargetType |
Specifies the target type of the pingtest. The
target may either be an Core Routing Instance, or VPRN Site.
type=sas.TestTarget access=read-only Displayed(tab/group)=Target Type (/Test Object) |
| timeToLive |
Specifies the initial time-to-live value for the ICMP ping packets
type=int access=read-only Displayed(tab/group)=Time to Live (Test Parameters/ICMP Details) |
| toNodeId |
The STM test targets the site specified in this property. (If target site is managed by NFM-P)
type=string access=read-only maximum=50 |
| typeOfService |
Specifies the type of service
type=int access=read-only Displayed(tab/group)=Type Of Service (/Ping Information) |
| virtualRouterId |
The unique value which identifies this virtual router in the
7x50 SR system. The vRtrID value for each virtual router
must remain constant at least from one re-initialization of the
system management processor (CPM) to the next. There will always
be at least one router entry defined by the agent with vRtrID=1
which represents the base transport router.
If no value is specified the base router ID is used.
type=long access=read-only |
| vprnAccessInterfacePointer |
type=Pointer access=read-only Displayed(tab/group)=VPRN Interface (/Source) |
| Overridden Properties | |
|---|---|
| id | The identifier for the STM test. |
| Properties inherited from sas.ArchivedPing |
|---|
| assurance, id, maxHistoryRows, packetFailureThreshold, packetInterval, packetSize, packetTimeout, packetsToSend, testFailureThreshold, 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.AbstractTest |
|---|
| execute, stop |