DCT-TOOLKIT COMMAND TOPIC Generated on: Tue Oct 21 12:26:59 USEDT 2025 Source: dct-toolkit-help-2025.5.txt ================================================================================ DCT-TOOLKIT COMPLETE COMMAND REFERENCE Generated on: Tue Oct 21 12:26:59 USEDT 2025 ======================================== MAIN HELP (dct-toolkit.exe -h): ======================================== Usage: dct-toolkit[-hV] [COMMAND] -h, --help Show this help message and exit. -V, --version Print version information and exit. Commands: ================================================================================ ================================================================================ TOPIC: Network Performance Tool ================================================================================ Commands (6): create_latency_test, get_latency_test_result, create_dsp_test, get_dsp_test_result, create_throughput_test, get_throughput_test_result COMMAND: create_latency_test ======================================== Usage: dct-toolkit create_latency_test[-hVw] [-cs] [-jh] ([engine_id=string host_id=string [request_count=integer] [request_size=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id=string The ID of the engine where the test is to be executed. host_id=string Identifier of host that must exist within an associated with engine. request_count=integer Number of requests to send. request_size=integer The size of requests to send (bytes). --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_latency_test_result ======================================== Usage: dct-toolkit get_latency_test_result[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= Unique identifier of the network test job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_dsp_test ======================================== Usage: dct-toolkit create_dsp_test[-hVw] [-cs] [-jh] ([engine_id=string [host_id=string] [direction=string] [num_connections=integer] [duration=integer] [destination_type=string] [--[no-] compression] [--[no-]encryption] [queue_depth=integer] [block_size=integer] [send_socket_buffer=integer] [receive_socket_buffer=integer] [xport_scheduler=string] [target_engine_id=string] [target_engine_address=string] [target_engine_user=string] [target_engine_password=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id=string The ID of the engine where the test is to be executed. host_id=string Identifier of host that must exist within an associated with engine. direction=string Values: [TRANSMIT, RECEIVE]Whether the test is a transmit or receive test. num_connections=integer The number of connections to use for the test. The special value 0 (the default) causes the test to automatically discover duration=integer 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 Values: [REMOTE_HOST, DELPHIX_ENGINE]Whether the test is testing connectivity to a Delphix Engine or remote host. --[no-]compression Whether or not compression is used for the test. --[no-]encryption Whether or not encryption is used for the test. queue_depth=integer The queue depth used for the DSP throughput test. block_size=integer The size of each transmit request in bytes. send_socket_buffer=integer The size of the send socket buffer in bytes. receive_socket_buffer=integer The size of the receive socket buffer in bytes. xport_scheduler=string Values: [ROUND_ROBIN, LEAST_QUEUE]The transport scheduler to use. 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. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_dsp_test_result ======================================== Usage: dct-toolkit get_dsp_test_result[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= Unique identifier of the network test job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_throughput_test ======================================== Usage: dct-toolkit create_throughput_test[-hVw] [-cs] [-jh] ([engine_id=string host_id=string [direction=string] [num_connections=integer] [duration=integer] [port=integer] [block_size=integer] [send_socket_buffer=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id=string The ID of the engine where the test is to be executed. host_id=string Identifier of host that must exist within an associated with engine. direction=string Values: [TRANSMIT, RECEIVE]Whether the test is a transmit or receive test. num_connections=integer The number of connections to use for the test. The special value 0 (the default) causes the test to automatically discover duration=integer 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 The TCP port number that the server (the receiver) will be listening on. block_size=integer The size of each transmit request in bytes. send_socket_buffer=integer The size of the send socket buffer in bytes. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_throughput_test_result ======================================== Usage: dct-toolkit get_throughput_test_result[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= Unique identifier of the network test job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ========================================