Test

A Test defines a command to run inside a diagnositc container on an NSG. It represents a command with arguments that will be executed within the diagnostic container as part of a Test Suite run

Overview

associatedTestDefinitionID string required   filterable   orderable  
associatedTestDefinitionType enum (ICMP_ECHO_TEST_DEFINITION | TEST_DEFINITION) required   filterable   orderable  
associatedTestSuiteID string read only   filterable   orderable  
command string read only   filterable   orderable  
creationDate string read only   autogenerated   orderable  
description string read only   filterable   orderable  
destination string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string read only   filterable   orderable  
order integer autogenerated   filterable   orderable  
owner string autogenerated  
timeout integer read only   filterable   orderable  

API Resource

/tests/id
delete get put

Parents

/scheduledtestsuites/id/tests
get post
/testsuites/id/tests
get post

Children

/tests/id/permissions
delete get post put
/tests/id/metadatas
get post
/tests/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedTestDefinitionID string required   filterable   orderable  
Discussion

The associated Test Definition instance used as an information base for the Test object.

Charateristics

Format: free
Max length: 255
SDK attribute: associatedTestDefinitionID

associatedTestDefinitionType enum required   filterable   orderable  
Discussion

The type of associated Test Definition instance.

Charateristics

Allowed values: ICMP_ECHO_TEST_DEFINITION, TEST_DEFINITION
SDK attribute: associatedTestDefinitionType

associatedTestSuiteID string read only   filterable   orderable  
Discussion

The ID of the Test Suite this Test instance is part of.

Charateristics

Format: free
SDK attribute: associatedTestSuiteID

command string read only   filterable   orderable  
Discussion

The command line with arguments as extracted from the Test Definition instance bound to this Test instance.

Charateristics

Format: free
SDK attribute: command

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string read only   filterable   orderable  
Discussion

A brief description of the Test Definition referred to by this Test object.

Charateristics

Format: free
SDK attribute: description

destination string filterable   orderable  
Discussion

Destination to be used in conjunction with this Test. Could be an IPv4 address or FQDN

Charateristics

Format: free
Max length: 255
SDK attribute: destination

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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string read only   filterable   orderable  
Discussion

The name of the Test Definition instance bound to this Test object.

Charateristics

Format: free
SDK attribute: name

order integer autogenerated   filterable   orderable  
Discussion

Test order used to run tests. Lower order tests will run before higher order ones.

Charateristics

Min value: 1
Max value: 2000000
SDK attribute: order

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

timeout integer read only   filterable   orderable  
Discussion

The timeout value set for the Test Definition instance, in seconds, at which point the system will consider the test as failed.

Charateristics

Min value: 1
Max value: 1200
SDK attribute: timeout