ScheduledTestSuite

A Scheduled Test Suite is grouping of a number of ICMP Echo Tests that can be run at the specified schedule, consecutively from a given source (NSGateway or VPort) toward a specified destination.

Overview

description string filterable   orderable  
endDateTime time filterable   orderable  
name string required   filterable   orderable  
scheduleInterval integer filterable   orderable  
scheduleIntervalUnits enum (DAYS | HOURS | MINUTES | MONTHS) filterable   orderable  
startDateTime time filterable   orderable  

API Resource

/scheduledtestsuites/id
delete get put

Parents

/enterprises/id/scheduledtestsuites
get post

Children

/scheduledtestsuites/id/scheduledtestsuiteruns
get
/scheduledtestsuites/id/tests
get post

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

Description for the scheduled test suite instance.


Charateristics

Format: free
Max length: 255
SDK attribute: description

endDateTime time filterable   orderable  
Discussion

The date and time by which this suite will be terminated. If this is not specified the tests will continue to run at the specified frequency.


Charateristics

SDK attribute: endDateTime

name string required   filterable   orderable  
Discussion

Name of the scheduled test suite instance.


Charateristics

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

scheduleInterval integer filterable   orderable  
Discussion

This is the interval between all test runs in this suite and the next run of tests in this suite.


Charateristics

Default value: 1
Max value: 300
SDK attribute: scheduleInterval

scheduleIntervalUnits enum filterable   orderable  
Discussion

The units for the specified interval. This can be minutes, hours or days.


Charateristics

Allowed values: DAYS, HOURS, MINUTES, MONTHS
Default value: DAYS
SDK attribute: scheduleIntervalUnits

startDateTime time filterable   orderable  
Discussion

The date and time when this suite will start on the NSGateway.


Charateristics

SDK attribute: startDateTime