| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| bypassRouting |
The value of bypassRouting specifies whether or not
to send the ping request (for an IP test which belongs to the specified
session) to a host on a directly attached network, bypassing the
routing table.
type=boolean default=false Displayed(tab/group)=Bypass Routing (/Session Details) |
| destIpAddress |
Specifies destination address
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Destination IP (/Source and Destination Addresses) |
| destIpAddressType |
Specifies the address type of the destIpAddress.
type=rtr.InetAddressType default=ipv4 |
| destUDPPort |
Specifies destination UDP Port
type=int default=49224 minimum=0 maximum=65535 Displayed(tab/group)=Dest UDP Port (/Session Details) |
| doNotFragment |
The value of doNotFragment specifies whether or not
the IPv4 Don't Fragment (DF) bit is set in each echo request packet
launched for each test belonging to the specified session.
type=boolean default=false Displayed(tab/group)=Do Not Fragment (/Session Details) |
| dscpEgressRemark |
The value of dscpEgressRemark specifies whether or not
to allow each echo request packet's IP header Differentiated Services
Code Point (DSCP) to be overwritten in accordance with the egress
port's Quality of Service (QoS) policy. The echo request packets are
launched for each test belonging to the specified session.
type=boolean default=false Displayed(tab/group)=DSCP Egress Remark (/Session Details) |
| dscpName |
The value of dscpName specifies the Differentiated
Services Code Point (DSCP) to be copied into the IP header of each
echo request packet launched for each test belonging to the specified
session.
type=sas.DscpEnum default=0 Displayed(tab/group)=DSCP Name (/Session Details) |
| egressIfName |
Egress Interface Name
type=string default= minimum=0 maximum=32 |
| egressRtrNetworkInterfacePointer |
type=Pointer default= Displayed(tab/group)=Egress Interface (/Session Details) |
| egressVprnAccessInterfacePointer |
type=Pointer default= Displayed(tab/group)=Egress Interface (/Session Details) |
| forwardingClass |
forwarding class
type=qos.FcEnum default=be Displayed(tab/group)=Forwarding Class (/Session Details) |
| fromAddress |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=From Address (/Session Details) |
| fromAddressType |
Specifies the type of Internet address stored in nhAddress.
type=rtr.InetAddressType default=ipv4 |
| 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 default=0 minimum=0 maximum=127 Displayed(tab/group)=IGP Instance (/Session Details) |
| ipProfile |
IP Profile
type=qos.Profile default=out Displayed(tab/group)=IP Profile (/Session Details) |
| ipSessionMplsTunnelType |
type=sas.IpSessionMplsTunnelType default=none Displayed(tab/group)=Mpls Tunnel (/Session Details) |
| ipSessionTunnelType |
type=sas.IpSessionTunnelType default=none Displayed(tab/group)=Tunnel (/Session Details) |
| 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 default= Displayed(tab/group)=LSP Name (/Session Details) |
| lspName |
type=string access=read-only default= |
| lspTemplate |
type=Pointer default= Displayed(tab/group)=LSP Template Name (/Session Details) |
| lspTemplateName |
type=string access=read-only default= |
| nhIpAddress |
Specifies the next hop address
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Next Hop IP (/Session Details) |
| nhIpAddressType |
Specifies the address type of the nhIpAddress.
type=rtr.InetAddressType default=ipv4 |
| pattern |
The value of pattern specifies a two octet pattern
to be repeated to fill the padding field of each echo request packet
launched for each test belonging to the specified session. For
example, if 255 is specified, the padding field is filled with the
octet values 00, FF, 00, FF, ... (hexadecimal).
type=int default=0 minimum=-1 maximum=65535 Displayed(tab/group)=Pattern (/Session Details) |
| 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 default=0.0.0.0 Displayed(tab/group)=Prefix (/Session Details) |
| 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 default=32 minimum=32 maximum=128 Displayed(tab/group)=Prefix Length (/Session Details) |
| 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 default=ipv4 |
| sas.TWLSession-Set |
type=Children-Set |
| serviceId |
Specifies the service Id
type=int default=0 minimum=0 maximum=2147483647 Displayed(tab/group)=Service Id |
| serviceName |
The value of tmnxOamPmCfgSessIpRouterInstName specifies the name of
the virtual router to be used by tests belonging to the specified
session.
Supersedes tmnxOamPmCfgSessIpServiceId if set.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Service Name |
| sourceIpAddress |
Specifies source address
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Source IP Address (/Source and Destination Addresses) |
| sourceIpAddressType |
Specifies the address type of the sourceIpAddress.
type=rtr.InetAddressType default=ipv4 |
| sourceUDPPort |
Specifies source UDP Port
type=int default=0 minimum=0 maximum=64383 Displayed(tab/group)=Source UDP Port (/Session Details) |
| srcAccessInterfacePointer |
Specify the source L3 Access Interface.
type=Pointer access=read-create default= Mandatory on create |
| srcIpAddrPointer |
Specify the source IP address.
type=Pointer access=read-create default= Mandatory on create Displayed(tab/group)=Source IP Interface (/Source and Destination Addresses) |
| testTargetType |
type=sas.IPTestTarget default=router Displayed(tab/group)=IP Session Target Type |
| toAddress |
type=InetAddress default=0.0.0.0 Displayed(tab/group)=To Address (/Session Details) |
| toAddressType |
Specifies the type of Internet address stored in nhAddress.
type=rtr.InetAddressType default=ipv4 |
| ttl |
Time to Live
type=int default=255 minimum=1 maximum=255 Displayed(tab/group)=Time to Live (/Session Details) |
| usePattern |
Specifies whether the "pattern" field should be used to specify
a pattern to be repeated to fill the padding field of each echo
request packet.
type=boolean default=true Displayed(tab/group)=Use Pattern (/Session Details) |
| vprnService |
The VPRN site to test.
type=Pointer default= Displayed(tab/group)=VPRN Service |
| Properties inherited from sas.AbstractSession |
|---|
| sessionName, siteId |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |