IP SLA Test Parameters

Property

Description

Owner

A string that identifies the entity that created this table row.

Tag

A string which is used by a managing application to identify the RTT target. This string is inserted into trap notifications, but has no other significance to the agent.

Type

The type of IP SLA operation to be performed.

Threshold

An administrative threshold limit. If the RTT operation time exceeds this limit and if the conditions specified in Threshold Type (Reactions table) or Filter (History table) are satisfied, a threshold violation event is generated.

Frequency

Specifies the duration between initiating each RTT operation. This object cannot be set to a value which would be a shorter duration than Timeout.

When the test Type is Path Echo, the suggested value for this object is greater than Timeout times the maximum number of expected hops to the target.

When the test Type is DHCP, the minimum allowed value for this object is 10 seconds.

Timeout

Specifies the duration to wait for a RTT operation completion. The value of this object cannot be set to a value which would specify a duration exceeding Frequency.

For connection oriented protocols, this may cause the connection to be closed by the probe. Once closed, it will be assumed that the connection reestablishment will be performed. To prevent unwanted closure of connections, be sure to set this value to a realistic connection timeout.

Protocol

Specifies the protocol to be used to perform the RTT operation. When this protocol does not support the type, a 'badValue' error will be returned.

Target Address

A string which specifies the address of the target.

Source Address

A string which specifies the IP address of the source. This object is applicable to all probes except dns, dlsw and sna.

Property

Description

Verify Data

When set to true, the resulting data in each RTT operation is compared with the expected data. This includes checking header information (if possible) and exact packet size. Any mismatch will be recorded in the rttMonStatsCollectVerifyErrors object. Some test types may not support this option. When a type does not support this option, the agent will transition this property to false. It is the management applications responsibility to check for this transition. This property is only applicable to SNA protocols.

Non Volatile Memory

When set to true, this entry will be shown in 'show running' command and can be saved into Non-volatile memory.

Request Size

This object represents the number of octets to be placed into the ARR Data portion of the request message, when using SNA protocols.

For non-ARR protocols' RTT request/responses, this value represents the native payload size. The ARR Header overhead is not included in this value.

For echo probes the total packet size = (IP header(20) + ICMP header(8) + 8 (internal timestamps) + request size).

For echo and pathEcho default request size is 28. For udp probe, default request size is 16 and for jitter probe it is 32. For dlsw probes default request size is 0.

The minimum request size for echo and pathEcho is 28 bytes, for udp it is 4 and for jitter it is 16.

For udp and jitter probes the maximum request size is 1500.

Response Size

This object represents the number of octets to be placed into the ARR Data portion of the response message.

This value is passed to the RTT Echo Server via a field in the ARR Header.

For non-ARR RTT request/response (i.e. ipIcmpecho) this value will be set by the agent to match the size of Request Size, when native payloads are supported.

The ARR Header overhead is not included in this value.

This object is only supported by SNA protocols.

VPN Name

This field is used to specify the VPN name in which the RTT operation will be used. For regular RTT operation this field should not be configured. The agent  will use this field to identify the VPN routing Table for this operation.

Clock Synchronization Type Value

This object specifies whether the value in specified for oneway NTP sync tolerance is absolute value or percent value.

Property

Description

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

LSR Enable

If this object is enabled then it means that the application calculates response time for a specific path. This object is applicable to echo probe only.

LSP FEC Type

The type of the target FEC for the RTT 'echo' and 'pathEcho' operations based on 'mplsLspPingAppl' Protocol.

LSP Selector

A string which specifies a valid 127/8 address. This address is of the form 127.x.y.z. This address is not used to route the MPLS echo packet to the destination but is used for load balancing in cases where the IP payload's destination address is used for load balancing.

LSP Reply Mode

This object specifies the reply mode for the LSP Echo requests.

LSP TTL

This object represents the TTL setting for MPLS echo request packets. For ping operation this represents the TTL value to be set in the echo request packet. For trace operation it represent the maximum ttl value that can be set in the echo request packets starting with TTL=1.

For 'echo' based on mplsLspPingAppl the default TTL will be set to 255, and for 'pathEcho' based on mplsLspPingAppl the default will be set to 30.

Note: This object cannot be set to the value of 0. The default value of 0 signifies the default TTL values to be used for 'echo' and 'pathEcho' based on 'mplsLspPingAppl'.

LSP EXP Value

This object represents the EXP value that needs to be put as precedence bit in the MPLS echo request IP header.

LSP DSCP Reply Value

This object specifies the DSCP value to be set in the IP header of the LSP echo reply packet.

The value of this object will be in range of DiffServ codepoint values between 0 to 63.

Note: This object cannot be set to value of 255. This default value specifies that DSCP is not set for this row.

LSP Null Label

This object specifies if the explicit-null label is to be added to LSP echo requests which are sent while performing RTT operation.

Property

Description

Target Port

This object represents the target's port number. This object is applicable to udpEcho, tcpConnect and jitter probes.

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Property

Description

Target Port

This object represents the target's port number. This object is applicable to udpEcho, tcpConnect and jitter probes.

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Property

Description

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Operation Type

A code that represents the specific type of HTTP or FTP operation. This object is applicable to http and ftp probe only.

HTTP Version

A string which specifies the version number of the HTTP Server. The syntax for the version string is <major number>.<minor number> An example would be 1.0, 1.1 etc.,. This object is applicable to http probe only.

URL

A string which represents the URL to which a HTTP probe should communicate with. This object is applicable to http probe only.

Cache

If this object is false then it means that HTTP request should not download cached pages. This means that the request should

be forwarded to the origin server. This object is applicable to http probe only.

Proxy

This string represents the proxy server information. This object is applicable to http probe only.

Request String 1

This string stores the content of HTTP raw request. If the request cannot fit into String1 then it should be split and put in Strings 1 through 5.

This string stores the content of the DHCP raw option data. The raw DHCP option data must be in HEX. If an odd number of characters are specified, a 0 will be appended to the end of the string. Only DHCP option 82 (decimal) is allowed. Here is an example of a valid string:

5208010610005A6F1234

Only Request String 1 is used for dhcp, Strings 1 through 5 are not used.

This object is applicable to http and dhcp probe types only.

Request String 2

This string stores the content of HTTP raw request. Request Strings 1-5 are concatenated to form the HTTP raw request used in the RTT operation. This object is applicable to http probe only.

Request String 3

This string stores the content of HTTP raw request. Request Strings 1-5 are concatenated to form the HTTP raw request used in the RTT operation. This object is applicable to http probe only.

Request String 4

This string stores the content of HTTP raw request. Request Strings 1-5 are concatenated to form the HTTP raw request used in the RTT operation. This object is applicable to http probe only.

Request String 5

This string stores the content of HTTP raw request. Request Strings 1-5 are concatenated to form the HTTP raw request used in the RTT operation. This object is applicable to http probe only.

Property

Description

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Operation Type

A code that represents the specific type of HTTP or FTP operation. This object is applicable to http and ftp probe only.

Mode

A code that represents the specific type of RTT operation. This object is applicable to ftp probe only.

Property

Description

Target Address String

A string which specifies the address of the target. This string can be in IP address format or a hostname. This object is applicable to dns probe only.

Name Server

A string which specifies the ip address of the name-server. This object is applicable to dns probe only.

Property

Description

Target Port

This object represents the target's port number. This object is applicable to udpEcho, tcpConnect and jitter probes.

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Interval

This value represents the inter-packet delay between packets and is in milliseconds. This value is currently used for

Jitter probe. This object is applicable to jitter probe only.

Number of Packets

This value represents the number of packets that need to be transmitted. This value is currently used for Jitter probe.

This object is applicable to jitter probe only.

Codec Type

Specifies the codec type to be used with jitter probe. This is applicable only for the jitter probe.

If codec-type is configured the following parameters cannot be configured.

• Request Size

• Interval

• Number of Packets

Codec Interval

This field represents the inter-packet delay between packets and is in milliseconds. This object is applicable only to jitter probe which uses codec type.

Codec Payload

This object represents the number of octets that needs to be placed into the Data portion of the message. This value is used only for jitter probe which uses codec type.

Codec Number of Packets

This value represents the number of packets that need to be transmitted. This value is used only for jitter probe which uses codec type.

ICPIF Factor

The advantage factor is dependant on the type of access and how the service is to be used.

• Conventional Wire-line - 0
• Mobility within Building - 5
• Mobility within geographic area - 10
• Access to hard-to-reach location - 20

This will be used while calculating the ICPIF values. This valid only for Jitter while calculating the ICPIF value.

Precision

This object specifies the accuracy of statistics that needs to be calculated milliseconds - The accuracy of stats will be of milliseconds microseconds - The accuracy of stats will be in microseconds.

This value can be set only for jitter operation

Probe Packet Priority

This object specifies the priority that will be assigned to probe packet. This value can be set only for jitter operation.

Total Clock Synchronization Error, microseconds

This object specifies the total clock synchronization error on source and responder that is considered acceptable for one way measurement when NTP is used as clock synchronization mechanism. The total clock synchronization error is sum of NTP offsets on source and responder. The value specified is in microseconds. This value can be set only for jitter operation with precision of microsecond.

Total Clock Synchronization Error, %

This object specifies the total clock synchronization error on source and responder that is considered acceptable for oneway measurement when NTP is used as clock synchronization mechanism. The total clock synchronization error is sum of NTP offsets on source and responder. The value is expressed as the percentage of actual oneway latency that is measured.

This value can be set only for jitter operation with precision of microsecond.

Property

Description

Target Port

This object represents the target's port number. This object is applicable to udpEcho, tcpConnect and jitter probes.

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Interval

This value represents the inter-packet delay between packets and is in milliseconds. This value is currently used for

Jitter probe. This object is applicable to jitter probe only.

Number of Packets

This value represents the number of packets that need to be transmitted. This value is currently used for Jitter probe.

This object is applicable to jitter probe only.

Codec Type

Specifies the codec type to be used with jitter probe. This is applicable only for the jitter probe.

If codec-type is configured the following parameters cannot be configured.

• Request Size

• Interval

• Number of Packets

Codec Interval

This field represents the inter-packet delay between packets and is in milliseconds. This object is applicable only to jitter probe which uses codec type.

Codel Payload

This object represents the number of octets that needs to be placed into the Data portion of the message. This value is used only for jitter probe which uses codec type.

Codec Number of Packets

This value represents the number of packets that need to be transmitted. This value is used only for jitter probe which uses codec type.

ICPIF Factor

The advantage factor is dependant on the type of access and how the service is to be used.

• Conventional Wire-line - 0
• Mobility within Building - 5
• Mobility within geographic area - 10
• Access to hard-to-reach location - 20

This will be used while calculating the ICPIF values. This valid only for Jitter while calculating the ICPIF value.

Precision

This object specifies the accuracy of statistics that needs to be calculated milliseconds - The accuracy of stats will be of milliseconds microseconds - The accuracy of stats will be in microseconds.

This value can be set only for jitter operation

Probe Packet Priority

This object specifies the priority that will be assigned to probe packet. This value can be set only for jitter operation.

Total Clock Synchronization Error, microseconds

This object specifies the total clock synchronization error on source and responder that is considered acceptable for one way measurement when NTP is used as clock synchronization mechanism. The total clock synchronization error is sum of NTP offsets on source and responder. The value specified is microseconds. This value can be set only for jitter operation with precision of microsecond.

Total Clock Synchronization Error, %

This object specifies the total clock synchronization error on source and responder that is considered acceptable for oneway measurement when NTP is used as clock synchronization mechanism. The total clock synchronization error is sum of NTP offsets on source and responder. The value is expressed as the percentage of actual oneway latency that is measured.

This value can be set only for jitter operation with precision of microsecond.

Property

Description

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Property

Description

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

Request String 1

This string stores the content of HTTP raw request. If the request cannot fit into String1 then it should be split and put in Strings 1 through 5.

This string stores the content of the DHCP raw option data. The raw DHCP option data must be in HEX. If an odd number of characters are specified, a 0 will be appended to the end of the string. Only DHCP option 82 (decimal) is allowed. Here is an example of a valid string:

5208010610005A6F1234

Only Request String 1 is used for dhcp, Strings 1 through 5 are not used.

This object is applicable to http and dhcp probe types only.

Property

Description

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Called Number

This string stores the called number of post dial delay. This object is applicable to voip post dial delay probe only. The number will be like the one actually the user could dial. It has the number required by the local country dial plan, plus E.164 number. The maximum length is 24 digits. Only digit (0-9) is allowed.

Detect Point

A code that represents the detect point of post dial delay.

This object is applicable to SAA post dial delay probe only.

VoIP GK Registration Delay

A boolean that represents VoIP GK registration delay. This object is applicable to SAA GK registration delay probe only.

Property

Description

Source Port

This object represents the source's port number. If this object is not specified, the application will get a port allocated by the system. This object is applicable to all probes except dns, dlsw and sna.

Control Message

If this object is enabled, then the RTR application will send control messages to a responder, residing on the target router to respond to the data request packets being sent by the source router. This object is not applicable to echo, pathEcho, dns and http probes.

IP Type of Service (TOS)

This object represents the type of service octet in an IP header. This object is not applicable to dhcp and dns.

Source Voice Port

A string which specifies the voice-port on the source gateway.

This object is applicable to RTP probe only.

Call Duration

Duration of RTP session. This object is applicable to RTP probe only.