UnderlayTest

Underlay Test is a wrapper object for a Test Suite Run from the built in Underlay Tests Test Suite.

Overview

associatedDataPathID string filterable   orderable  
associatedNSGatewayID string read only   filterable   orderable  
associatedNSGatewayName string filterable   orderable  
associatedSystemID string filterable   orderable  
associatedTestSuiteRunID string read only   filterable   orderable  
associatedUplinkConnectionID string filterable   orderable  
associatedUplinkInterface string read only   filterable   orderable  
createOnly boolean filterable   orderable  
duration integer filterable   orderable  
name string read only  
runBandwidthTest boolean creation only   filterable   orderable  
runConnectivityTest boolean creation only   filterable   orderable  
runMTUDiscoveryTest boolean creation only   filterable   orderable  
startDateTime integer filterable   orderable  
stopDateTime integer filterable   orderable  
testResult enum (DEGRADED | FAIL | NOT_APPLICABLE | PASS) filterable   orderable  
underlayTestServer string creation only   filterable   orderable  
underlayTestType enum (BIRTH_CERTIFICATE | ON_DEMAND | PRE_BOOTSTRAP) creation only   filterable   orderable  

API Resource

/underlaytests/id
delete get put

Parents

/nsgateways/id/underlaytests
get post
/uplinkconnections/id/underlaytests
get post

Children

/underlaytests/id/testruns
get

Members

This object has no members.

Attributes documentation

associatedDataPathID string filterable   orderable  
Discussion

The associated data path ID

Charateristics

Format: free
Max length: 255
SDK attribute: associatedDataPathID

associatedNSGatewayID string read only   filterable   orderable  
Discussion

The ID of the associated NSGateway

Charateristics

Format: free
Max length: 255
SDK attribute: associatedNSGatewayID

associatedNSGatewayName string filterable   orderable  
Discussion

The name of the associated NSGateway

Charateristics

Format: free
Max length: 255
SDK attribute: associatedNSGatewayName

associatedSystemID string filterable   orderable  
Discussion

The associated System ID

Charateristics

Format: free
Max length: 255
SDK attribute: associatedSystemID

associatedTestSuiteRunID string read only   filterable   orderable  
Discussion

The ID of the associated Test Suite Run

Charateristics

Format: free
Max length: 255
SDK attribute: associatedTestSuiteRunID

associatedUplinkConnectionID string filterable   orderable  
Discussion

The uplink connection ID that this underlay test will be triggered on. This can be null in order to use any uplink

Charateristics

Format: free
Max length: 255
SDK attribute: associatedUplinkConnectionID

associatedUplinkInterface string read only   filterable   orderable  
Discussion

The interface name of the associated uplink in port.vlan format

Charateristics

Format: free
Max length: 255
SDK attribute: associatedUplinkInterface

createOnly boolean filterable   orderable  
Discussion

Create the test only, do not trigger the command. Used for loading existing results

Charateristics

Default value: false
SDK attribute: createOnly

duration integer filterable   orderable  
Discussion

The test duration in seconds

Charateristics

Max value: 2147483647
SDK attribute: duration

name string read only  
Discussion

The name of the test

Charateristics

Format: free
Max length: 255
SDK attribute: name

runBandwidthTest boolean creation only   filterable   orderable  
Discussion

Bandwidth test results enable verification of minimal requirements for NSG operations and is not indicative of the maximum throughput possible on an uplink.

Charateristics

Default value: true
SDK attribute: runBandwidthTest

runConnectivityTest boolean creation only   filterable   orderable  
Discussion

Flag to run the connectivity test

Charateristics

Default value: true
SDK attribute: runConnectivityTest

runMTUDiscoveryTest boolean creation only   filterable   orderable  
Discussion

Flag to run the MTU Discovery test

Charateristics

Default value: true
SDK attribute: runMTUDiscoveryTest

startDateTime integer filterable   orderable  
Discussion

The start date time of the test

Charateristics

Max value: 2147483647
SDK attribute: startDateTime

stopDateTime integer filterable   orderable  
Discussion

The stop date time of the test

Charateristics

Max value: 2147483647
SDK attribute: stopDateTime

testResult enum filterable   orderable  
Discussion

The result of the test

Charateristics

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

underlayTestServer string creation only   filterable   orderable  
Discussion

The Underlay Test Server this test was executed against

Charateristics

Format: free
Max length: 255
SDK attribute: underlayTestServer

underlayTestType enum creation only   filterable   orderable  
Discussion

Type of Test

Charateristics

Allowed values: BIRTH_CERTIFICATE, ON_DEMAND, PRE_BOOTSTRAP
SDK attribute: underlayTestType