TestRun

A Test Run object represents the execution of a specific Test as part of a Test Suite Run.

Overview

associatedTestID string read only   filterable   orderable  
associatedTestSuiteRunID string read only   filterable   orderable  
command string read only   filterable   orderable  
commandExitCode integer filterable   orderable  
commandOutput string filterable   orderable  
commandOutputSummary string read only   filterable   orderable  
duration integer read only   filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
operationStatus enum (COMPLETED | FAILED | STARTED | TIMED_OUT | UNKNOWN) filterable   orderable  
startDateTime integer filterable   orderable  
stopDateTime integer filterable   orderable  
testResult enum (DEGRADED | FAIL | NOT_APPLICABLE | PASS) filterable   orderable  
testResultData object filterable   orderable  
testResultDataType enum (BandwidthTestResult | MTUDiscoveryTestResult | None | TCPConnectTestResult | UDPProbeTestResult) filterable   orderable  
testResultSpecificationEntityName string read only  
underlayTestCategory enum (BANDWIDTH | CONNECTIVITY | MTU_DISCOVERY) filterable   orderable  
underlayTestDescription string filterable   orderable  
underlayTestName string filterable   orderable  

API Resource

/testruns/id
delete get put

Parents

/testsuiteruns/id/testruns
get

Children

/testruns/id/metadatas
get post
/testruns/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedTestID string read only   filterable   orderable  
Discussion

The ID of the Test instance to which this Test Run is bound.

Charateristics

Format: free
SDK attribute: associatedTestID

associatedTestSuiteRunID string read only   filterable   orderable  
Discussion

Test Run instances are part of a Test Suite Run. This is the ID of the Test Suite Run object to which this Test Run belongs.

Charateristics

Format: free
SDK attribute: associatedTestSuiteRunID

command string read only   filterable   orderable  
Discussion

The command, with its arguments, that is to be executed as part of the Test Run.

Charateristics

Format: free
SDK attribute: command

commandExitCode integer filterable   orderable  
Discussion

The exit code returned to the OS from the executed test command. Field modified on VSD by the NSG.

Charateristics

SDK attribute: commandExitCode

commandOutput string filterable   orderable  
Discussion

The output of the test command that was executed. Updated on VSD by the NSG.

Charateristics

Format: free
SDK attribute: commandOutput

commandOutputSummary string read only   filterable   orderable  
Discussion

A brief summary of the command output received by the NSG. Only the beginning and the end of the output is displayed.

Charateristics

Format: free
SDK attribute: commandOutputSummary

duration integer read only   filterable   orderable  
Discussion

The duration of execution of the Test in milliseconds.

Charateristics

SDK attribute: duration

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

operationStatus enum filterable   orderable  
Discussion

The status of the test operation request as received by the NSG Agent. This field is set by the NSG.

Charateristics

Allowed values: COMPLETED, FAILED, STARTED, TIMED_OUT, UNKNOWN
SDK attribute: operationStatus

startDateTime integer filterable   orderable  
Discussion

The start date and time of the test in milliseconds since Epoch.

Charateristics

SDK attribute: startDateTime

stopDateTime integer filterable   orderable  
Discussion

The stop date and time of the test in milliseconds since Epoch.

Charateristics

SDK attribute: stopDateTime

testResult enum filterable   orderable  
Discussion

The result of the test

Charateristics

Allowed values: DEGRADED, FAIL, NOT_APPLICABLE, PASS
SDK attribute: testResult

testResultData object filterable   orderable  
Discussion

The test result data

Charateristics

SDK attribute: testResultData

testResultDataType enum filterable   orderable  
Discussion

The type of the data embedded in the testResultData attribute

Charateristics

Allowed values: BandwidthTestResult, MTUDiscoveryTestResult, None, TCPConnectTestResult, UDPProbeTestResult
SDK attribute: testResultDataType

testResultSpecificationEntityName string read only  
Discussion

The spefication entity name of the data embedded in the testResultData attribute

Charateristics

Format: free
Max length: 255
SDK attribute: testResultSpecificationEntityName

underlayTestCategory enum filterable   orderable  
Discussion

The underlay test category

Charateristics

Allowed values: BANDWIDTH, CONNECTIVITY, MTU_DISCOVERY
SDK attribute: underlayTestCategory

underlayTestDescription string filterable   orderable  
Discussion

The underlay test description

Charateristics

Format: free
Max length: 255
SDK attribute: underlayTestDescription

underlayTestName string filterable   orderable  
Discussion

The underlay test name

Charateristics

Format: free
Max length: 255
SDK attribute: underlayTestName