TestSuiteRun

A Test Suite Run represents the execution of a given Test Suite within a diagnostic container on an NSG. It groups together multiple Test Runs.

Overview

associatedEntityType string read only  
associatedTestSuiteID string required   creation only  
associatedTestSuiteName string read only   filterable   orderable  
associatedUnderlayTestID string filterable   orderable  
birthCertificate boolean filterable   orderable  
datapathID string read only   filterable   orderable  
destination string creation only   filterable   orderable  
domainName string read only   filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
NSGatewayName string read only   filterable   orderable  
operationStatus enum (COMPLETED | CONTAINER_IP_FAILURE | STARTED | UNKNOWN)
subnetName string read only   filterable   orderable  
VPortName string read only   filterable   orderable  
zoneName string read only   filterable   orderable  

API Resource

/testsuiteruns/id
get put

Parents

/vports/id/testsuiteruns
delete get post
/testsuites/id/testsuiteruns
get

Children

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

Members

This object has no members.

Attributes documentation

associatedEntityType string read only  
Discussion

Type of the entity that is hosting the Test Suite Run. This can be a vPort or an NSG.

Charateristics

Format: free
SDK attribute: associatedEntityType

associatedTestSuiteID string required   creation only  
Discussion

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

Charateristics

Format: free
SDK attribute: associatedTestSuiteID

associatedTestSuiteName string read only   filterable   orderable  
Discussion

The name of the Test Suite instance from which this Test Suite Run was created.

Charateristics

Format: free
SDK attribute: associatedTestSuiteName

associatedUnderlayTestID string filterable   orderable  
Discussion

The associated underlay test (if applicable)

Charateristics

Format: free
Max length: 255
SDK attribute: associatedUnderlayTestID

birthCertificate boolean filterable   orderable  
Discussion

Flag to mark this test as the Birth Certificate (i.e. it was run during activation)

Charateristics

Default value: false
SDK attribute: birthCertificate

datapathID string read only   filterable   orderable  
Discussion

The datapath ID (System ID) of the NSG instance against which the tests are to be executed.

Charateristics

Format: free
SDK attribute: datapathID

destination string creation only   filterable   orderable  
Discussion

Destination to be used in conjunction with tests part of the Test Suite. Could be an IPv4 address or FQDN.

Charateristics

Format: free
SDK attribute: destination

domainName string read only   filterable   orderable  
Discussion

The name of the Domain within which the source vPort being tested resides.

Charateristics

Format: free
SDK attribute: domainName

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

NSGatewayName string read only   filterable   orderable  
Discussion

The name of the NSG against which the Test Suite will be executed.

Charateristics

Format: free
SDK attribute: NSGatewayName

operationStatus enum
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, CONTAINER_IP_FAILURE, STARTED, UNKNOWN
SDK attribute: operationStatus

subnetName string read only   filterable   orderable  
Discussion

The name of the Subnet within which the source vPort being tested resides.

Charateristics

Format: free
SDK attribute: subnetName

VPortName string read only   filterable   orderable  
Discussion

The name of the vPort against which the Test Suite is to be executed.

Charateristics

Format: free
SDK attribute: VPortName

zoneName string read only   filterable   orderable  
Discussion

The name of the Zone within which the source vPort being tested resides.

Charateristics

Format: free
SDK attribute: zoneName