| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| bgpPrefix |
Specifies the address prefix of the destination node
for a testTargetType of router. May only be specified
when testTargetType is bgpPrefix.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=BGP Prefix (/BGP Prefix) |
| bgpPrefixLen |
Specifies the subnet mask of the destination node
for a testTargetType of router. May only be specified
when testTargetType is bgpPrefix.
type=int access=read-only default=32 Displayed(tab/group)=BGP Prefix Length (/BGP Prefix) |
| bgpPrefixType |
Specifies the address type for the ldpPrefix.
type=rtr.InetAddressType access=read-only default=ipv4 |
| bgpSite |
The LSP path to test. May only be specified when
testTargetType is lspPath.
type=Pointer access=read-only default= Displayed(tab/group)=BGP Site (/BGP Site) |
| flexAlgoNum |
The value of flexAlgoNum specifies the Flexible
Algorithm to use for the test.
Zero indicates no Flexible Algorithm is specified.
The supported object combinations for LSP ping tests are listed in the
tmnxOamLspPingCtlTable DESCRIPTION clause.
tmnxOamLspPingCtlFlexAlgo must not be changed away from default for an
SAA test.
type=int access=read-only default=0 Displayed(tab/group)=Flex Algo Number (/Lsp Ping Flex Algo) |
| forwardingClass |
Specifies the forwarding class the LSP ping will use.
type=qos.FcEnum access=read-only default=be Displayed(tab/group)=Forwarding Class (Test Parameters/Test Probe) |
| igpInstance |
Specifies the Interior Gateway
Protocol (IGP) instance to be used for the test.
Supported IGPs are Intermediate System to Intermediate System (IS-IS)
and Open Shortest Path First (OSPF).
The supported range varies with the IGP and address family, as
follows.
IGP Address Family Supported Range
------ -------------- ---------------
IS-IS all 0..127
OSPFv2 all 0..31
OSPFv3 IPv4 unicast 64..95
OSPFv3 IPv6 unicast 0..31
type=int access=read-only default=0 Displayed(tab/group)=IGP Instance ID (/SR Test Options) |
| ldpPrefix |
Specifies the address prefix of the destination node
for a testTargetType of router. May only be specified
when testTargetType is ldpPrefix.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=LDP Prefix (/LDP) |
| ldpPrefixLen |
Specifies the subnet mask of the destination node
for a testTargetType of router. May only be specified
when testTargetType is ldpPrefix.
type=int access=read-only default=32 Displayed(tab/group)=LDP Prefix Length (/LDP) |
| ldpPrefixType |
Specifies the address type for the ldpPrefix.
type=rtr.InetAddressType access=read-only default=ipv4 |
| ldpSite |
The LSP path to test. May only be specified when
testTargetType is lspPath.
type=Pointer access=read-only default= Displayed(tab/group)=LDP Site (/LDP Site) |
| lsp |
The LSP to test. May only be specified when
testTargetType is lsp or lspPath.
Administrative name of the target Labeled Switch Path (LSP) for this
OAM LSP Ping test. The LSP name must be unique within the virtual
router instance specified by vRtrID.
This parameter is mutually exclusive with the IP prefix parameter
associated with an LDP based LSP ldpIpPrefix.
Either the LSP name or the LDP IP Prefix must be specified but not both.
type=Pointer access=read-only default= Displayed(tab/group)=LSP (/LSP) |
| lspPath |
The LSP path to test. May only be specified when
testTargetType is lspPath.
type=Pointer access=read-only default= Displayed(tab/group)=LSP Path (/LSP Path) |
| mplsSite |
The LSP path to test. May only be specified when
testTargetType is lspPath.
type=Pointer access=read-only default= Displayed(tab/group)=MPLS Site (/MPLS Site) |
| mplsTpSendMode |
Specifies the encapsulation of the launched echo request, when testing an MPLS-TP LSP
type=mpls.MplsTpSendMode access=read-only default=notApplicable Displayed(tab/group)=Send Mode (/MPLS-TP Site) |
| mplsTpSite |
The MPLS-TP Site to test. May only be specified when
testTargetType is tpLsp.
type=Pointer access=read-only default= Displayed(tab/group)=MPLS-TP Site (/MPLS-TP Site) |
| mplsTpToNodeAddressType |
Specifies the address type for the mplsTpToNodeId.
type=rtr.InetAddressType access=read-only default=ipv4 |
| mplsTpToNodeId |
The node ID of the destination node.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Destination IP Address (/MPLS-TP LSP) |
| nhAddress |
The value of tmnxOamLspPingCtlNhAddress specifies the Interface
address to the next hop in which this OAM LSP ping test will be
transmitted.
This is an optional parameter which can be specified only if the
tmnxOamLspPingCtlPathDest parameter is specified. This parameter
is mutually exclusive with tmnxOamLspPingCtlNhIntfName parameter.
Either the next-hop interface name or next-hop address
can be specified but not both. An attempt to set this object to a
non-default value when tmnxOamLspPingCtlNhIntfName has a
non-default value will result in an 'inconsistentValue' error.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Next Hop Interface Address (/LDP), Next Hop Interface Address (/SR Test Options), Next Hop Interface Address (/BGP Prefix), Next Hop Interface Address (/SR-TE LSP), Next Hop Interface Address (/SR-PL Options) |
| nhAddressType |
Specifies the type of Internet address stored in nhAddress.
type=rtr.InetAddressType access=read-only default=ipv4 |
| nhIntfName |
Administrative name of the next hop interface for this OAM LSP
Ping test to be sent. The interface name must be unique within
the virtual router instance specified by tmnxOamLspPingCtlVRtrID.
This is an optional parameter which can be specified only if the
tmnxOamLspPingCtlPathDest parameter is specified. This parameter
is mutually exclusive with the tmnxOamLspPingCtlNhAddress
parameter. Either the next-hop interface name or next-hop address
can be specified but not both. An attempt to set this object to a
non-default value when tmnxOamLspPingCtlNhAddress has a
non-default value will result in an 'inconsistentValue' error."
type=string access=read-only default=N/A maximum=32 Displayed(tab/group)=Next Hop Interface Name (/LDP), Next Hop Interface Name (/SR Test Options), Next Hop Interface Name (/BGP Prefix), Next Hop Interface Name (/SR-TE LSP), Next Hop Interface Name (/SR-PL Options) |
| pathDest |
Specifies a unique path for this OAM Lsp Ping to traverse.
This address is used as part of a hash key to select the appropriate
ECMP path to the destination of an OAM LSP Ping test.
This is an optional parameter.
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Destination Path Address (/LDP), Destination Path Address (/SR Test Options), Destination Path Address (/BGP Prefix), Destination Path Address (/SR-TE LSP), Destination Path Address (/SR-PL Options) |
| pathDestType |
Specifies the type of Internet address stored in pathDest
type=rtr.InetAddressType access=read-only default=ipv4 |
| prefix |
Specifies the address prefix of the destination node
for tests whose testTargetType require a prefix.
Used for OSPF- and ISIS- targeted tests. Could also be
used for new target types requiring a prefix,
other than BGP- and Router- tests (because of backward
compatibility).
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Prefix (/SR Test Options) |
| prefixLen |
Specifies the subnet mask of the destination node
for tests whose testTargetType require a prefix.
Used for OSPF- and ISIS- targeted tests. Could also be
used for new target types requiring a prefix,
other than BGP- and Router- tests (because of backward
compatibility).
type=int access=read-only default=32 Displayed(tab/group)=Prefix Length (/SR Test Options) |
| prefixType |
Specifies the prefix address type
for tests whose testTargetType require a prefix.
Used for OSPF- and ISIS- targeted tests. Could also be
used for new target types requiring a prefix,
other than BGP- and Router- tests (because of backward
compatibility).
type=rtr.InetAddressType access=read-only default=ipv4 |
| profile |
Specifies the profile value to be used with the
forwarding class specified in forwardingClass.
type=qos.Profile access=read-only default=out Displayed(tab/group)=Forwarding Profile (Test Parameters/Test Probe) |
| returnLsp |
Administrative name of the Labeled Switch Path (LSP) to use to
return the response to this OAM LSP Ping test. The LSP name must
be unique within the virtual router instance specified by
tmnxOamLspPingCtlVRtrID.
This is an optional parameter
DEPRECATED: 8.0R1 - OBSOLETE: removed from the CLI command type=string access=read-only maximum=32 |
| sourceSite |
Source node of the LSP to test. May only be specified when
testTargetType is OSPF, ISIS, or SR-Policy.
type=Pointer access=read-only default= Displayed(tab/group)=Site (/SR Test Source Site) |
| srcIpAddr |
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Source IP Address (/Source IP Address) |
| srcIpAddrPointer |
Specify the source IP address. This is defined when the OAM packet
must be generated from a different address than the node's system interface address.
type=Pointer access=read-only default= Displayed(tab/group)=Source IP Address (/Source IP Address) |
| srcIpAddrType |
type=rtr.InetAddressType access=read-only default=ipv4 |
| 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 default= Displayed(tab/group)=Endpoint Address (/SR-PL Options) |
| srplEndPointAddrType |
The address type for srplEndPointAddr.
SRPL tests support ipv4' or 'ipv6' types. For other types, use "unknown".
type=rtr.InetAddressType access=read-only default=unknown |
| 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 default=0 Displayed(tab/group)=Color (/SR-PL Options) |
| srplSegmentList |
The Segment Routing (SR) policy segment list to be used for the test. 0 means "none".
type=int access=read-only default=0 Displayed(tab/group)=Segment List (/SR-PL Options) |
| testSubMode |
Specifies the type of LSP ping or LSP trace route test to perform.
type=mpls.TestSubMode access=read-only default=unspecified |
| testTargetType |
Specifies the target type of the LSP ping test. The
target may either be an lsp, an lspPath, or a
router.
A target of lsp signifies that the targeted test will run against a specific LSP. The packetSize minimum is 98. A target of lspPath signifies that the targeted test will run against the specified path in an LSP. The lspPath parameter is mandatory when type is lspPath. The packetSize minimum is 108. A target of router requires the ldpPrefix and ldpPrefixLen parameters to be configured. The targeted test will run on a router (specified in mplsSite) and attempt an LSP ping to a destination router(s) specified in the ldpPrefix and ldpPrefixLen. The packet size minimum is 84. type=sas.TestTargetaccess=read-only default=lsp Displayed(tab/group)=Target Type |
| timeToLive |
Specifies the outermost label time-to-live value.
type=int access=read-only default=255 Displayed(tab/group)=Time To Live (Test Parameters/Test Probe) |
| tpLsp |
The MPLS-TP LSP to test. May only be specified when
testTargetType is tpLsp.
Administrative name of the target MPLS-TP Labeled Switch Path (LSP) for this
OAM MPLS-TP LSP Ping test. The MPLS-TP LSP name must be unique within the virtual
router instance specified by vRtrID.
This parameter is mutually exclusive with the IP prefix parameter
associated with an LDP based MPLS-TP LSP ldpIpPrefix.
Either the MPLS-TP LSP name or the LDP IP Prefix must be specified but not both.
type=Pointer access=read-only default= Displayed(tab/group)=MPLS-TP LSP (/MPLS-TP LSP) |
| tpLspPathType |
The MPLS-TP LSP path type to test. May only be specified when
testTargetType is tpLsp.
type=mpls.MplsTpPathType access=read-only default=active Displayed(tab/group)=MPLS-TP LSP Path Type (/MPLS-TP LSP) |
| tpLspTargetGlobalId |
The MPLS-TP LSP Destination Global ID to test..
type=long access=read-only default=0 Displayed(tab/group)=Destination Global ID (/MPLS-TP LSP) |
| vRtrID |
A number used to identify a virtual router instance in the system
type=int access=read-only default=1 |
| Overridden Properties | |
|---|---|
| id | The identifier for the STM test. |
| Properties inherited from sas.DeployedPing |
|---|
| 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 |