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: Connectivity ================================================================================ Commands (4): connectivity_check, database_connectivity_check, netbackup_connectivity_check, commvault_connectivity_check COMMAND: connectivity_check ======================================== Usage: dct-toolkit connectivity_check[-hVw] [-cs] [-jh] ([host=string port=integer engine_id=string [--[no-] use_engine_public_key] [os_name=string] [staging_environment=string] [username=string] [password=string] [vault_id=string] [hashicorp_vault_engine=string] [hashicorp_vault_secret_path=string] [hashicorp_vault_username_key=string] [hashicorp_vault_secret_key=string] [azure_vault_name=string] [azure_vault_username_key=string] [azure_vault_secret_key=string] [cyberark_vault_query_string=string] [-- [no-]use_kerberos_authentication]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. host=string The hostname of the remote host machine to check. port=integer The port of the remote host machine to check. For Windows, port on which Delphix connector is running. engine_id=string The ID of the engine to check. --[no-]use_engine_public_key Whether to use public key authentication. os_name=string Values: [UNIX, WINDOWS]Operating system type of the environment. staging_environment=string Id of the connector environment which is used to connect to this source environment. username=string The username of the remote host machine to check. Username is mandatory input with password/use_engine_public_key/kerberos_authentic ation. password=string The password of the remote host machine to check. vault_id=string The DCT id or name of the vault from which to read the host credentials. hashicorp_vault_engine=string Vault engine name where the credential is stored. hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. hashicorp_vault_username_key=string Key for the username in the key-value store. hashicorp_vault_secret_key=string Key for the password in the key-value store. azure_vault_name=string Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_username_key=string Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_secret_key=string Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. --[no-]use_kerberos_authentication Whether to use kerberos authentication. --body=PARAM The api to check connectivity of engine and a remote host on given port. -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: database_connectivity_check ======================================== Usage: dct-toolkit database_connectivity_check[-hVw] [-cs] [-jh] ([source_id=string credentials_type=string [username=string] [password=string] [vault=string] [hashicorp_vault_engine=string] [hashicorp_vault_secret_path=string] [hashicorp_vault_username_key=string] [hashicorp_vault_secret_key=string] [azure_vault_name=string] [azure_vault_username_key=string] [azure_vault_secret_key=string] [cyberark_vault_query_string=string] [environment_id=string] [environment_user=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. source_id=string Source database config Id. credentials_type=string Values: [MSSQL_ENVIRONMENT_USER, MSSQL_DOMAIN_USER, MSSQL_DATABASE_USER, ORACLE, ASE, SOURCE_CONFIG]The type of credentials. username=string Database username (Not applicable for MSSQL_ENVIRONMENT_USER). password=string Database password (Not applicable for MSSQL_ENVIRONMENT_USER and mutually exclusive with vault attributes). vault=string The name or reference of the vault from which to read the database credentials (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_engine=string Vault engine name where the credential is stored (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_username_key=string Hashicorp vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_secret_key=string Hashicorp vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_name=string Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_username_key=string Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_secret_key=string Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). cyberark_vault_query_string=string Query to find a credential in the CyberArk vault (ORACLE, ASE and MSSQL_DOMAIN_USER only). environment_id=string Id of the environment to which environment user belongs (MSSQL_ENVIRONMENT_USER only). environment_user=string Reference to the environment user (MSSQL_ENVIRONMENT_USER only). --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: netbackup_connectivity_check ======================================== Usage: dct-toolkit netbackup_connectivity_check[-hVw] [-cs] [-jh] ([environment_user_id=string source_client_name=string environment_id=string master_server_name=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. environment_user_id=string Id of the environment user. source_client_name=string The name of the NetBackup client to attempt to connect with. environment_id=string Id of the target environment to test NetBackup connectivity from. master_server_name=string The name of the NetBackup master server to attempt to connect to. --body=PARAM The api to check connectivity of NetBackup master server and client on an environment. -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: commvault_connectivity_check ======================================== Usage: dct-toolkit commvault_connectivity_check[-hVw] [-cs] [-jh] ([commserve_host_name=string staging_client_name=string source_client_name=string environment_id=string environment_user_id=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. commserve_host_name=string The hostname of the CommServe server to connect to. staging_client_name=string The name of the Staging Client in CommServe. source_client_name=string The name of the Source Client in CommServe. environment_id=string Id of the target environment to test Commvault connectivity from. environment_user_id=string Id of the environment user. --body=PARAM The api to check connectivity to the CommServe host and staging client from an environment. -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 ========================================