Scheduledtestsuiterun

A Scheduled Test Suite Run represents the execution of a given Scheduled Test Suite within a namespace on an NSG. It groups together multiple ICMP Echo Test Runs.

Overview

associatedScheduledTestSuiteID string required   creation only  
associatedScheduledTestSuiteName string filterable   orderable  
datapathID string read only   filterable   orderable  
destination string filterable   orderable  
domainName string read only   filterable   orderable  
macAddress string read only   filterable   orderable  
NSGatewayName string filterable   orderable  
operationStatus enum (RUNNING | STARTED | UNKNOWN) filterable   orderable  
secondaryDatapathID string filterable   orderable  
secondaryNSGatewayName string filterable   orderable  
secondarySystemID string filterable   orderable  
sourceIP string creation only   filterable   orderable  
subnetName string read only   filterable   orderable  
systemID string read only   filterable   orderable  
vlanID integer read only   filterable   orderable  
VPortName string read only   filterable   orderable  
vportPortName string read only   filterable   orderable  
vportVlanID integer read only   filterable   orderable  
zoneName string read only   filterable   orderable  

API Resource

/scheduledtestsuiteruns/id
delete get put

Parents

/vports/id/scheduledtestsuiteruns
get post
/scheduledtestsuites/id/scheduledtestsuiteruns
get

Children

/scheduledtestsuiteruns/id/testruns
get post

Members

This object has no members.

Attributes documentation

associatedScheduledTestSuiteID string required   creation only  
Discussion

The ID of the Scheduled Test Suite from which this instance of run was created.


Charateristics

Format: free
Max length: 255
SDK attribute: associatedScheduledTestSuiteID

associatedScheduledTestSuiteName string filterable   orderable  
Discussion

Name of the Scheduled Test Suite from which this run was created.


Charateristics

Format: free
Max length: 255
SDK attribute: associatedScheduledTestSuiteName

datapathID string read only   filterable   orderable  
Discussion

DatapathID of the NSG against which the tests are to be executed.


Charateristics

Format: free
Max length: 255
SDK attribute: datapathID

destination string filterable   orderable  
Discussion

Either an IPv4 address or FQDN to be used in conjunction with the ICMP echo test. If provided, this destination will override the destination at individual Test level.


Charateristics

Format: free
Max length: 255
SDK attribute: destination

domainName string read only   filterable   orderable  
Discussion

Domain name within which the source vPort being tested resides.


Charateristics

Format: free
SDK attribute: domainName

macAddress string read only   filterable   orderable  
Discussion

MAC address for the interface in the namespace on the NSG.


Charateristics

Format: free
Max length: 255
SDK attribute: macAddress

NSGatewayName string filterable   orderable  
Discussion

Name of the NSG on which the suite will be executed.


Charateristics

Format: free
Max length: 255
SDK attribute: NSGatewayName

operationStatus enum filterable   orderable  
Discussion

The status of the test operation request received by the NSG agent.


Charateristics

Allowed values: RUNNING, STARTED, UNKNOWN
SDK attribute: operationStatus

secondaryDatapathID string filterable   orderable  
Discussion

The datapath ID of the secondary gateway in the Redundant Group.


Charateristics

Format: free
Max length: 255
SDK attribute: secondaryDatapathID

secondaryNSGatewayName string filterable   orderable  
Discussion

The NSGateway name of the secondary gateway in the Redundant Group.


Charateristics

Format: free
Max length: 255
SDK attribute: secondaryNSGatewayName

secondarySystemID string filterable   orderable  
Discussion

The system ID of the secondary gateway in the Redundant Group.


Charateristics

Format: free
Max length: 255
SDK attribute: secondarySystemID

sourceIP string creation only   filterable   orderable  
Discussion

The IP address that will be assigned to the interface in namespace on NSG and used by the ICMP Echo test as the source IP. This is an optional field, if not provided the interface in namespace is assigned an IP from the DHCP pool.


Charateristics

Format: ipv4
Max length: 255
SDK attribute: sourceIP

subnetName string read only   filterable   orderable  
Discussion

Subnet name within which the source vPort being tested resides.


Charateristics

Format: free
SDK attribute: subnetName

systemID string read only   filterable   orderable  
Discussion

System ID of the NSG against which the tests are to be executed.


Charateristics

Format: free
Max length: 255
SDK attribute: systemID

vlanID integer read only   filterable   orderable  
Discussion

VLAN ID of the interface in the namespace on NSG.


Charateristics

Max value: 4096
SDK attribute: vlanID

VPortName string read only   filterable   orderable  
Discussion

VPort name against which the test suite is executed.


Charateristics

Format: free
Max length: 255
SDK attribute: VPortName

vportPortName string read only   filterable   orderable  
Discussion

The access port of the VPort against which the test suite is executed.


Charateristics

Format: free
Max length: 255
SDK attribute: vportPortName

vportVlanID integer read only   filterable   orderable  
Discussion

The VLAN ID of the VPort against which the test suite is executed.


Charateristics

SDK attribute: vportVlanID

zoneName string read only   filterable   orderable  
Discussion

Zone name within which the source vPort being tested resides.


Charateristics

Format: free
SDK attribute: zoneName