A Test definition describes a command to run inside a diagnositcs container on an NSGateway. It represents a command with arguments that will be run in the container as part of a Test Suite run
arguments |
command |
description |
embeddedMetadata |
entityScope |
externalID |
lastUpdatedBy |
name |
timeout |
This object has no members.
The arguments that will be appended to the test command field.
Format: free
Max value: 255
SDK attribute: arguments
The Linux command that this test definition will use.
Format: free
Min value: 1
Max value: 255
SDK attribute: command
A concise description of the Test Definition object.
Format: free
Max length: 255
SDK attribute: description
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.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
A descriptive name for the Test Definition instance.
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Optional timeout value, in seconds, for the test until the system considers it as failed. Default is 60 s.
Default value: 60
Min value: 1
Max value: 1200
SDK attribute: timeout