logo

Network Performance Tool

Create Latency Network Performance Test

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
engine_id
required
string

The ID of the engine where the test is to be executed.

host_id
required
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_.-]+$

Identifier of host that must exist within an associated with engine.

request_count
integer [ 1 .. 3600 ]
Default: 20

Number of requests to send.

request_size
integer [ 16 .. 65507 ]
Default: 16

The size of requests to send (bytes).

Responses
201

Latency test initiated

post/network-performance/test/latency
Request samples
application/json
{
  • "engine_id": "string",
  • "host_id": "string",
  • "request_count": 20,
  • "request_size": 16
}
Response samples
application/json
{
  • "job": {
    }
}

Retrieve Network Latency Test Result

Returns the result of a previously executed network latency test identified by the job ID.

SecurityApiKeyAuth
Request
path Parameters
jobId
required
string non-empty

Unique identifier of the network test job.

Example: d2f2310bd4e0455289581a7d61fea6c2
Responses
200

Successful retrieval of latency test result.

get/network-performance/test/latency/{jobId}
Response samples
application/json
{
  • "dct_job_id": "string",
  • "name": "string",
  • "remote_address": "string",
  • "remote_host": "string",
  • "state": "COMPLETED",
  • "start_time": "string",
  • "end_time": "string",
  • "engine_id": "string",
  • "host_id": "string",
  • "request_count": 20,
  • "request_size": 16,
  • "minimum": 0,
  • "maximum": 0,
  • "average": 0,
  • "stddev": 0,
  • "loss": 0
}

Create DSP Network Performance Test

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
engine_id
required
string

The ID of the engine where the test is to be executed.

host_id
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_.-]+$

Identifier of host that must exist within an associated with engine.

direction
string
Default: "TRANSMIT"

Whether the test is a transmit or receive test.

Enum: "TRANSMIT" "RECEIVE"
num_connections
integer [ 0 .. 32 ]

The number of connections to use for the test. The special value 0 (the default) causes the test to automatically discover

duration
integer [ 1 .. 3600 ]
Default: 30

The duration of the test in seconds. Note that when numConnections is 0, an initial period of time will be spent calculating the optimal number of connections, and that time does not count toward the duration of the test.

destination_type
string
Default: "REMOTE_HOST"

Whether the test is testing connectivity to a Delphix Engine or remote host.

Enum: "REMOTE_HOST" "DELPHIX_ENGINE"
compression
boolean
Default: false

Whether or not compression is used for the test.

encryption
boolean
Default: false

Whether or not encryption is used for the test.

queue_depth
integer [ 0 .. 4096 ]
Default: 64

The queue depth used for the DSP throughput test.

block_size
integer [ 0 .. 1048576 ]
Default: 1048576

The size of each transmit request in bytes.

send_socket_buffer
integer [ 0 .. 16777216 ]
Default: 1048576

The size of the send socket buffer in bytes.

receive_socket_buffer
integer [ 0 .. 16777216 ]
Default: 1048576

The size of the receive socket buffer in bytes.

xport_scheduler
string
Default: "ROUND_ROBIN"

The transport scheduler to use.

Enum: "ROUND_ROBIN" "LEAST_QUEUE"
target_engine_id
string

engine id which test exc

target_engine_address
string

Address of other target Delphix Engine.

target_engine_user
string

Username for the other target Delphix Engine.

target_engine_password
string

Password for the other target Delphix Engine.

Responses
201

DSP test initiated

post/network-performance/test/dsp
Request samples
application/json
{
  • "engine_id": "string",
  • "host_id": "string",
  • "direction": "TRANSMIT",
  • "num_connections": 0,
  • "duration": 30,
  • "destination_type": "REMOTE_HOST",
  • "compression": false,
  • "encryption": false,
  • "queue_depth": 64,
  • "block_size": 1048576,
  • "send_socket_buffer": 1048576,
  • "receive_socket_buffer": 1048576,
  • "xport_scheduler": "ROUND_ROBIN",
  • "target_engine_id": "2",
  • "target_engine_address": "example.engine.co",
  • "target_engine_user": "admin",
  • "target_engine_password": "string"
}
Response samples
application/json
{
  • "job": {
    }
}

Retrieve Network DSP Test Result

Returns the result of a previously executed network dsp test identified by the job ID.

SecurityApiKeyAuth
Request
path Parameters
jobId
required
string non-empty

Unique identifier of the network test job.

Example: d2f2310bd4e0455289581a7d61fea6c2
Responses
200

Successful retrieval of DSP test result.

get/network-performance/test/dsp/{jobId}
Response samples
application/json
{
  • "dct_job_id": "string",
  • "name": "string",
  • "remote_address": "string",
  • "remote_host": "string",
  • "state": "COMPLETED",
  • "start_time": "string",
  • "end_time": "string",
  • "engine_id": "string",
  • "host_id": "string",
  • "direction": "TRANSMIT",
  • "num_connections": 0,
  • "duration": 30,
  • "destination_type": "REMOTE_HOST",
  • "compression": false,
  • "encryption": false,
  • "queue_depth": 64,
  • "block_size": 1048576,
  • "send_socket_buffer": 1048576,
  • "receive_socket_buffer": 1048576,
  • "xport_scheduler": "ROUND_ROBIN",
  • "target_engine_id": "2",
  • "target_engine_address": "example.engine.co",
  • "target_engine_user": "admin",
  • "target_engine_password": "string",
  • "throughput": 0
}

Create Throughput Network Performance Test

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
engine_id
required
string

The ID of the engine where the test is to be executed.

host_id
required
string [ 1 .. 256 ] characters ^[a-zA-Z0-9_.-]+$

Identifier of host that must exist within an associated with engine.

direction
string
Default: "TRANSMIT"

Whether the test is a transmit or receive test.

Enum: "TRANSMIT" "RECEIVE"
num_connections
integer [ 0 .. 32 ]

The number of connections to use for the test. The special value 0 (the default) causes the test to automatically discover

duration
integer [ 1 .. 3600 ]
Default: 30

The duration of the test in seconds. Note that when numConnections is 0, an initial period of time will be spent calculating the optimal number of connections, and that time does not count toward the duration of the test.

port
integer [ 0 .. 65535 ]

The TCP port number that the server (the receiver) will be listening on.

block_size
integer [ 0 .. 1048576 ]
Default: 16384

The size of each transmit request in bytes.

send_socket_buffer
integer [ 0 .. 16777216 ]
Default: 4194304

The size of the send socket buffer in bytes.

Responses
201

Throughput test initiated

post/network-performance/test/throughput
Request samples
application/json
{
  • "engine_id": "string",
  • "host_id": "string",
  • "direction": "TRANSMIT",
  • "num_connections": 0,
  • "duration": 30,
  • "port": 65535,
  • "block_size": 16384,
  • "send_socket_buffer": 4194304
}
Response samples
application/json
{
  • "job": {
    }
}

Retrieve Network Throughput Test Result

Returns the result of a previously executed network throughput test identified by the job ID.

SecurityApiKeyAuth
Request
path Parameters
jobId
required
string non-empty

Unique identifier of the network test job.

Example: d2f2310bd4e0455289581a7d61fea6c2
Responses
200

Successful retrieval of throughput test result.

get/network-performance/test/throughput/{jobId}
Response samples
application/json
{
  • "dct_job_id": "string",
  • "name": "string",
  • "remote_address": "string",
  • "remote_host": "string",
  • "state": "COMPLETED",
  • "start_time": "string",
  • "end_time": "string",
  • "engine_id": "string",
  • "host_id": "string",
  • "direction": "TRANSMIT",
  • "num_connections": 0,
  • "duration": 30,
  • "port": 65535,
  • "block_size": 16384,
  • "send_socket_buffer": 4194304,
  • "throughput": 0
}
➔ Next to AiManagement