ICMPEchoTestDefinition

ICMP Echo Test Definition describes the ICMP ping command with parameters to run inside a namespace on NSGateway. This command will be run as per the schedule specified on the Scheduled Test Suite along with the other commands in that suite.

Overview

description string filterable   orderable  
donotFragment boolean filterable   orderable  
name string required   filterable   orderable  
packetCount integer filterable   orderable  
packetInterval integer filterable   orderable  
packetSize integer filterable   orderable  
slaMonitoring boolean filterable   orderable  
thresholdAverageRoundTripTime float filterable   orderable  
thresholdPacketLoss float filterable   orderable  
timeout integer filterable   orderable  
tos integer filterable   orderable  

API Resource

/icmpechotestdefinitions/id
delete get put

Parents

/enterprises/id/icmpechotestdefinitions
get post

Children

This object has no children.

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

Description of the ICMP Echo Test Definition instance.


Charateristics

Format: free
Max length: 255
SDK attribute: description

donotFragment boolean filterable   orderable  
Discussion

Sets the Don't Fragment flag when enabled. When an IP datagram has its DF flag set, intermediate devices are not allowed to fragment it so if it needs to travel across a network with a MTU smaller that datagram length, the datagram will be dropped.


Charateristics

Default value: false
SDK attribute: donotFragment

name string required   filterable   orderable  
Discussion

A descriptive name for the ICMP Echo Test Definition instance.


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

packetCount integer filterable   orderable  
Discussion

Specifies the number of echo requests to be sent.


Charateristics

Default value: 5
Min value: 5
Max value: 300
SDK attribute: packetCount

packetInterval integer filterable   orderable  
Discussion

Delay in milliseconds between the probes.


Charateristics

Default value: 1000
Min value: 100
Max value: 5000
SDK attribute: packetInterval

packetSize integer filterable   orderable  
Discussion

Specifies the number of data bytes to be sent.


Charateristics

Default value: 64
Min value: 28
Max value: 1472
SDK attribute: packetSize

slaMonitoring boolean filterable   orderable  
Discussion

Enables or disables the SLA monitoring.


Charateristics

Default value: false
SDK attribute: slaMonitoring

thresholdAverageRoundTripTime float filterable   orderable  
Discussion

The threshold average round trip time KPI in milliseconds that will be monitored when SLA monitoring is enabled.


Charateristics

Max value: 10000
SDK attribute: thresholdAverageRoundTripTime

thresholdPacketLoss float filterable   orderable  
Discussion

The threshold packet loss percentage KPI to be monitored when SLA monitoring is enabled.


Charateristics

Max value: 100
SDK attribute: thresholdPacketLoss

timeout integer filterable   orderable  
Discussion

Timeout value, in seconds, for the test until the system considers it as failed.


Charateristics

Default value: 60
Min value: 1
Max value: 1200
SDK attribute: timeout

tos integer filterable   orderable  
Discussion

This field is used to carry information to provide quality of service features. It is normally used to support Differentiated Services.


Charateristics

Max value: 255
SDK attribute: tos