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: Management ================================================================================ Commands (45): validate_java_path, get_registered_engines, register_engine, get_registered_engine, update_registered_engine, unregister_engine, update_registered_engine_partial, get_engine_auto_tagging_config, update_engine_auto_tagging_config, get_compliance_application_settings, search_compliance_application_settings, search_engines, get_engine_tags, create_engine_tags, delete_engine_tags, get_hashicorp_vaults, create_hashicorp_vault, search_hashicorp_vaults, get_hashicorp_vault, delete_hashicorp_vault, get_hashicorp_vault_tags, create_hashicorp_vault_tags, delete_hashicorp_vault_tag, list_properties, update_properties, get_api_classification, update_api_classification, get_smtp_config, update_smtp_config, validate_smtp_config, get_metadata_database, get_ldap_config, update_ldap_config, validate_ldap_config, get_saml_config, update_saml_config, get_dct_product_telemetry_events, trigger_dct_product_telemetry_bundle_upload, get_proxy_configuration, update_proxy_configuration, get_product_registration_delphix_connectivity_check, get_product_registration_status, get_product_registration_key, register_product_offline, register_product_online COMMAND: validate_java_path ======================================== Usage: dct-toolkit validate_java_path[-hVw] engine_id= [-cs] [-jh] ([java_home=string port=integer host_name=string [username=string] [password=string] [--[no-] use_engine_public_key] [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. engineId, engine_id= The ID of the registered engine. java_home=string Path pointing to java home on the remote machine. port=integer SSH port of the remote host machine that will be used to establish SSH connection. host_name=string Hostname of the remote host machine that will be used to establish connection. username=string The username of the user that will be used to connect to the remote host machine. password=string The password of the user that will be used to connect to the remote host machine. --[no-]use_engine_public_key Whether to use public key authentication. 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: get_registered_engines ======================================== Usage: dct-toolkit get_registered_engines[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-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. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -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 -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. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -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: register_engine ======================================== Usage: dct-toolkit register_engine[-hVw] [-cs] [-jh] ([name=string hostname=string [hashicorp_vault_masking_username_command_arg s=array[,array...]]... [--auto_tagging_config.enable_engine_name] [masking_password=string] [--[no-] unsafe_ssl_hostname_check] [hashicorp_vault_masking_password_command_arg s=array[,array...]]... [hashicorp_vault_id=integer] [hashicorp_vault_username_command_args=array [,array...]]... [tags[=array...]]... [--auto_tagging_config. enable_masking_applications] [hashicorp_vault_password_command_args=array [,array...]]... [password=string] [auto_tagging_config.custom_tags=array] [-- [no-]insecure_ssl] [--auto_tagging_config. enable_virtualization_dataset_groups] [masking_hashicorp_vault_id=integer] [--auto_tagging_config. enable_masking_environments] [username=string] [masking_username=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. name=string hostname=string hashicorp_vault_masking_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine. --auto_tagging_config.enable_engine_name Include the engine name as a tag on discovered objects (key 'dlpx-engine'). masking_password=string The masking admin password. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. hashicorp_vault_masking_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine. hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve virtualization engine credentials. hashicorp_vault_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualzation username for the engine. tags[=array...] The tags to be created for this engine. --auto_tagging_config.enable_masking_applications Include masking app names as tags for masking Jobs and Connectors (key 'dlpx-application'). hashicorp_vault_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine. password=string The virtualization domain admin password. auto_tagging_config.custom_tags=array List of custom tags to add to discovered objects. --[no-]insecure_ssl Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates.. --auto_tagging_config.enable_virtualization_dataset_groups Include dataset group names as tags for dSources, VDBs, and vCDBs (key 'dlpx-dataset-group'). masking_hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve masking engine credentials. --auto_tagging_config.enable_masking_environments Include masking environment names as tags for masking Jobs and Connectors (key 'dlpx-environment'). username=string The virtualization domain admin username. masking_username=string The masking admin username. --body=PARAM The parameters to register an engine. -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_registered_engine ======================================== Usage: dct-toolkit get_registered_engine[-hVw] [-cs] [-jh] engine_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. engineId, engine_id= The ID of the registered engine. -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 -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: update_registered_engine ======================================== Usage: dct-toolkit update_registered_engine[-hVw] engine_id= [-cs] [-jh] [[[id=string] [uuid=string] [type=string] [version=string] [name=string] [ssh_public_key=string] [hostname=string] [cpu_core_count=integer] [memory_size=integer] [data_storage_capacity=integer] [data_storage_used=integer] [--[no-] insecure_ssl] [--[no-]unsafe_ssl_hostname_check] [status=string] [connection_status=string] [engine_connection_status=string] [connection_status_details=string] [engine_connection_status_details=string] [username=string] [password=string] [masking_username=string] [masking_password=string] [hashicorp_vault_username_command_args=array[,array...]]... [hashicorp_vault_masking_username_command_args=array[,array...]]... [hashicorp_vault_password_command_args=array[,array...]]... [hashicorp_vault_masking_password_command_args=array[,array...]]... [masking_hashicorp_vault_id=integer] [hashicorp_vault_id=integer] [tags [=array...]]... [masking_memory_used=integer] [masking_allocated_memory=integer] [masking_jobs_running=integer] [masking_max_concurrent_jobs=integer] [masking_available_cores=integer] [hyperscale_instance_ids=array[,array...]]... [hyperscale_truststore_filename=string] [hyperscale_truststore_password=string] [--[no-]using_object_storage] [-- [no-]using_continuous_vault] [platform=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. id=string The Engine object entity ID. uuid=string The unique identifier generated by this engine. type=string Values: [VIRTUALIZATION, MASKING, BOTH, UNSET]The type of this engine. version=string The engine version. name=string The name of this engine. ssh_public_key=string The ssh public key of this engine. hostname=string The hostname of this engine. cpu_core_count=integer The total number of CPU cores on this engine. memory_size=integer The total amount of memory on this engine, in bytes. data_storage_capacity=integer The total amount of storage allocated for engine objects and system metadata, in bytes. data_storage_used=integer The amount of storage used by engine objects and system metadata, in bytes. --[no-]insecure_ssl Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. status=string Values: [CREATED, DELETING]the status of the engine connection_status=string Values: [ONLINE, OFFLINE]The status of the connection to the engine. Deprecated; use "engine_connection_status" instead. engine_connection_status=string Values: [ONLINE, CONNECTION_ERROR, MISSING_CREDENTIALS, BAD_CREDENTIALS]The state of the connection to the engine. connection_status_details=string If set, details about the status of the connection to the engine. Deprecated; use "engine_connection_status_details" instead. engine_connection_status_details=string If set, details about the state of the connection to the engine. username=string The virtualization domain admin username. password=string The virtualization domain admin password. masking_username=string The masking admin username. masking_password=string The masking admin password. hashicorp_vault_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization username for the engine. hashicorp_vault_masking_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine. hashicorp_vault_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine. hashicorp_vault_masking_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine. masking_hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve masking engine credentials. hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve virtualization engine credentials. tags[=array...] The tags to be created for this engine. masking_memory_used=integer The current amount of memory used by running masking jobs in bytes. masking_allocated_memory=integer The maximum amount of memory available for running masking jobs in bytes. masking_jobs_running=integer The number of masking jobs currently running. masking_max_concurrent_jobs=integer The maximum number of masking jobs that can be running at the same time. masking_available_cores=integer The number of CPU cores available to the masking engine. hyperscale_instance_ids=array[,array...] List of Hyperscale Instances that this engine is connected to. hyperscale_truststore_filename=string File name of a truststore which can be used to validate the TLS certificate of the engine as expected by associated hyperscale instances. hyperscale_truststore_password=string Password to read the truststore as expected by associated hyperscale instances. --[no-]using_object_storage true if the engine is using an object store (like AWS S3) to store data | false if the engine is using block storage to store its data | null if the engine is not initialized (unlikely) or the engine API version does not provide that information --[no-]using_continuous_vault true if the engine is using an object store (like AWS S3) to store data | false if the engine is using block storage to store its data | null if the engine is not initialized (unlikely) or the engine API version does not provide that information platform=string The infrastructure or environment where the engine is deployed or built, including cloud provider and instance type. --body=PARAM The updated registration engine information. -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: unregister_engine ======================================== Usage: dct-toolkit unregister_engine[-hVw] [-cs] [-jh] engine_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. engineId, engine_id= The ID of the registered engine. -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 -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: update_registered_engine_partial ======================================== Usage: dct-toolkit update_registered_engine_partial[-hVw] engine_id= [-cs] [-jh] [[[id=string] [uuid=string] [type=string] [version=string] [name=string] [ssh_public_key=string] [hostname=string] [cpu_core_count=integer] [memory_size=integer] [data_storage_capacity=integer] [data_storage_used=integer] [--[no-] insecure_ssl] [--[no-]unsafe_ssl_hostname_check] [status=string] [connection_status=string] [engine_connection_status=string] [connection_status_details=string] [engine_connection_status_details=string] [username=string] [password=string] [masking_username=string] [masking_password=string] [hashicorp_vault_username_command_args=array[,array...]]... [hashicorp_vault_masking_username_command_args=array[,array...]]... [hashicorp_vault_password_command_args=array[,array...]]... [hashicorp_vault_masking_password_command_args=array[,array...]]... [masking_hashicorp_vault_id=integer] [hashicorp_vault_id=integer] [tags [=array...]]... [masking_memory_used=integer] [masking_allocated_memory=integer] [masking_jobs_running=integer] [masking_max_concurrent_jobs=integer] [masking_available_cores=integer] [hyperscale_instance_ids=array[,array...]]... [hyperscale_truststore_filename=string] [hyperscale_truststore_password=string] [--[no-]using_object_storage] [-- [no-]using_continuous_vault] [platform=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. id=string The Engine object entity ID. uuid=string The unique identifier generated by this engine. type=string Values: [VIRTUALIZATION, MASKING, BOTH, UNSET]The type of this engine. version=string The engine version. name=string The name of this engine. ssh_public_key=string The ssh public key of this engine. hostname=string The hostname of this engine. cpu_core_count=integer The total number of CPU cores on this engine. memory_size=integer The total amount of memory on this engine, in bytes. data_storage_capacity=integer The total amount of storage allocated for engine objects and system metadata, in bytes. data_storage_used=integer The amount of storage used by engine objects and system metadata, in bytes. --[no-]insecure_ssl Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. status=string Values: [CREATED, DELETING]the status of the engine connection_status=string Values: [ONLINE, OFFLINE]The status of the connection to the engine. Deprecated; use "engine_connection_status" instead. engine_connection_status=string Values: [ONLINE, CONNECTION_ERROR, MISSING_CREDENTIALS, BAD_CREDENTIALS]The state of the connection to the engine. connection_status_details=string If set, details about the status of the connection to the engine. Deprecated; use "engine_connection_status_details" instead. engine_connection_status_details=string If set, details about the state of the connection to the engine. username=string The virtualization domain admin username. password=string The virtualization domain admin password. masking_username=string The masking admin username. masking_password=string The masking admin password. hashicorp_vault_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization username for the engine. hashicorp_vault_masking_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine. hashicorp_vault_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine. hashicorp_vault_masking_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine. masking_hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve masking engine credentials. hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve virtualization engine credentials. tags[=array...] The tags to be created for this engine. masking_memory_used=integer The current amount of memory used by running masking jobs in bytes. masking_allocated_memory=integer The maximum amount of memory available for running masking jobs in bytes. masking_jobs_running=integer The number of masking jobs currently running. masking_max_concurrent_jobs=integer The maximum number of masking jobs that can be running at the same time. masking_available_cores=integer The number of CPU cores available to the masking engine. hyperscale_instance_ids=array[,array...] List of Hyperscale Instances that this engine is connected to. hyperscale_truststore_filename=string File name of a truststore which can be used to validate the TLS certificate of the engine as expected by associated hyperscale instances. hyperscale_truststore_password=string Password to read the truststore as expected by associated hyperscale instances. --[no-]using_object_storage true if the engine is using an object store (like AWS S3) to store data | false if the engine is using block storage to store its data | null if the engine is not initialized (unlikely) or the engine API version does not provide that information --[no-]using_continuous_vault true if the engine is using an object store (like AWS S3) to store data | false if the engine is using block storage to store its data | null if the engine is not initialized (unlikely) or the engine API version does not provide that information platform=string The infrastructure or environment where the engine is deployed or built, including cloud provider and instance type. --body=PARAM The updated registration engine information. -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_engine_auto_tagging_config ======================================== Usage: dct-toolkit get_engine_auto_tagging_config[-hVw] [-cs] [-jh] engine_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. engineId, engine_id= The ID of the registered engine. -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 -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: update_engine_auto_tagging_config ======================================== Usage: dct-toolkit update_engine_auto_tagging_config[-hVw] engine_id= [-cs] [-jh] [[[--[no-] enable_virtualization_dataset_groups] [--[no-] enable_masking_environments] [--[no-]enable_masking_applications] [-- [no-]enable_engine_name] [custom_tags_to_add=array] [custom_tags_to_remove=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. --[no-]enable_virtualization_dataset_groups Include dataset group names as tags for dSources, VDBs, and vCDBs (key 'dlpx-dataset-group'). --[no-]enable_masking_environments Include masking environment names as tags for masking Jobs and Connectors (key 'dlpx-environment'). --[no-]enable_masking_applications Include masking app names as tags for masking Jobs and Connectors (key 'dlpx-application'). --[no-]enable_engine_name Include the engine name as a tag on discovered objects (key 'dlpx-engine'). custom_tags_to_add=array List of new custom tags to be added to discovered objects. These are appended to the AutoTaggingConfig's custom_tags list. custom_tags_to_remove=array List of tags to remove from the AutoTaggingConfig's custom_tags list (applied AFTER custom_tags_to_add). --body=PARAM The auto tagging config update parameters. -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_compliance_application_settings ======================================== Usage: dct-toolkit get_compliance_application_settings[-hVw] [-cs] [-jh] [cursor=] engine_id= [limit=] [sort=] [-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. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. engineId, engine_id= The ID of the registered engine. -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 -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. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -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: search_compliance_application_settings ======================================== Usage: dct-toolkit search_compliance_application_settings[-hVw] engine_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [group=string] [name=string] [value=string]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id group=string Filter by group name=string Filter by name value=string Filter by value -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: search_engines ======================================== Usage: dct-toolkit search_engines[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [uuid=string] [ssh_public_key=string] [type=string] [name=string] [hostname=string] [cpu_core_count=integer] [memory_size=integer] [data_storage_capacity=integer] [data_storage_used=integer] [--[no-] insecure_ssl] [--[no-] unsafe_ssl_hostname_check] [hyperscale_truststore_filename=string] [status=string] [username=string] [hashicorp_vault_id=string] [tags[=array [object]...]]... [connection_status=string] [connection_status_details=string] [engine_connection_status=string] [engine_connection_status_details=string] [masking_memory_used=integer] [masking_allocated_memory=integer] [masking_jobs_running=integer] [masking_max_concurrent_jobs=integer] [masking_available_cores=integer] [hyperscale_instance_ids=array[string]]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id uuid=string Filter by uuid ssh_public_key=string Filter by ssh_public_key type=string Filter by type name=string Filter by name hostname=string Filter by hostname cpu_core_count=integer Filter by cpu_core_count memory_size=integer Filter by memory_size data_storage_capacity=integer Filter by data_storage_capacity data_storage_used=integer Filter by data_storage_used --[no-]insecure_ssl Filter by insecure_ssl --[no-]unsafe_ssl_hostname_check Filter by unsafe_ssl_hostname_check hyperscale_truststore_filename=string Filter by hyperscale_truststore_filename status=string Filter by status username=string Filter by username hashicorp_vault_id=string Filter by hashicorp_vault_id tags[=array[object]...] Filter by tags connection_status=string Filter by connection_status connection_status_details=string Filter by connection_status_details engine_connection_status=string Filter by engine_connection_status engine_connection_status_details=string Filter by engine_connection_status_details masking_memory_used=integer Filter by masking_memory_used masking_allocated_memory=integer Filter by masking_allocated_memory masking_jobs_running=integer Filter by masking_jobs_running masking_max_concurrent_jobs=integer Filter by masking_max_concurrent_jobs masking_available_cores=integer Filter by masking_available_cores hyperscale_instance_ids=array[string] Filter by hyperscale_instance_ids -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_engine_tags ======================================== Usage: dct-toolkit get_engine_tags[-hVw] [-cs] [-jh] engine_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. engineId, engine_id= The ID of the registered engine. -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 -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_engine_tags ======================================== Usage: dct-toolkit create_engine_tags[-hVw] engine_id= [-cs] [-jh] ([tags[=array...] [tags[=array...]]...] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Engine. -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: delete_engine_tags ======================================== Usage: dct-toolkit delete_engine_tags[-hVw] engine_id= [-cs] [-jh] [[[key=string] [value=string] [tags [=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -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_hashicorp_vaults ======================================== Usage: dct-toolkit get_hashicorp_vaults[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-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. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -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 -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. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -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_hashicorp_vault ======================================== Usage: dct-toolkit create_hashicorp_vault[-hVw] [-cs] [-jh] [[[id=integer] [env_variables[=object...]]... [login_command_args=array[,array...]]... [tags[=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. id=integer env_variables[=object...] Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both to login to the vault (if this step is required) and to retrieve engine username and passwords. login_command_args=array[,array...] Arguments to the "vault" CLI tool to be used to fetch a client token (or "login"). If supporting files, such as TLS certificates, must be used to authenticate, they can be mounted to the /etc/config directory. This property must not be set when using the TOKEN authentication method as login is not required. tags[=array...] --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: search_hashicorp_vaults ======================================== Usage: dct-toolkit search_hashicorp_vaults[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=integer] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=integer Filter by id tags[=array[object]...] Filter by tags -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_hashicorp_vault ======================================== Usage: dct-toolkit get_hashicorp_vault[-hVw] [-cs] [-jh] vault_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 -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. vaultId, vault_id= Numeric ID of the Hashicorp vault -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: delete_hashicorp_vault ======================================== Usage: dct-toolkit delete_hashicorp_vault[-hVw] [-cs] [-jh] vault_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 -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. vaultId, vault_id= Numeric ID of the Hashicorp vault -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: get_hashicorp_vault_tags ======================================== Usage: dct-toolkit get_hashicorp_vault_tags[-hVw] [-cs] [-jh] vault_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 -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. vaultId, vault_id= Numeric ID of the Hashicorp vault -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_hashicorp_vault_tags ======================================== Usage: dct-toolkit create_hashicorp_vault_tags[-hVw] vault_id= [-cs] [-jh] ([tags[=array...] [tags[=array...]]...] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vaultId, vault_id= Numeric ID of the Hashicorp vault tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Hashicorp vault. -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: delete_hashicorp_vault_tag ======================================== Usage: dct-toolkit delete_hashicorp_vault_tag[-hVw] vault_id= [-cs] [-jh] [[[key=string] [value=string] [tags[=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vaultId, vault_id= Numeric ID of the Hashicorp vault key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -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: list_properties ======================================== Usage: dct-toolkit list_properties[-hVw] [-cs] [-jh] [-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 -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: update_properties ======================================== Usage: dct-toolkit update_properties[-hVw] [-cs] [-jh] [[[--[no-] disable_username_password] [dct_product_telemetry_upload_cadence=integ er] [dct_product_telemetry_maximum_transfer_siz e=integer] [token_expiry_time=integer] [token_maximum_inactivity_time=integer] [feature_flags=array[,array...]]... [api_key_expiry_time=integer] [allowed_ip_ranges=array[,array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]disable_username_password Property to define either username & password based authentication disabled or not. dct_product_telemetry_upload_cadence=integer Property to define the DCT Product Telemetry bundle upload cadence, in days, if Delphix services are reachable. dct_product_telemetry_maximum_transfer_size=integer Property to define the maximum uncompressed bundle transfer size, in bytes, for DCT Product Telemetry. token_expiry_time=integer Property to define the expiry time for login token, in seconds. Specify -1 to indicate never expiry of token. token_maximum_inactivity_time=integer Property to define the maximum user inactivity time for login token, in seconds. Specify -1 to indicate never invalidate of token due to inactivity. feature_flags=array[,array...] List of enabled features. api_key_expiry_time=integer Property to define the expiry time for API key, in seconds. Specify -1 to indicate never expiry of tapi key. allowed_ip_ranges=array[,array...] Restricts the IP ranges DCT will connect to when registering engines. --body=PARAM The parameters to update property value. -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_api_classification ======================================== Usage: dct-toolkit get_api_classification[-hVw] [-cs] [-jh] [-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 -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: update_api_classification ======================================== Usage: dct-toolkit update_api_classification[-hVw] [-cs] [-jh] [[[version=string] [api_classification=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. version=string Api Classification Config Version. api_classification=array The classification of each APIs, either it is automation or not. --body=PARAM Request to update api classification config. -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_smtp_config ======================================== Usage: dct-toolkit get_smtp_config[-hVw] [-cs] [-jh] [-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 -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: update_smtp_config ======================================== Usage: dct-toolkit update_smtp_config[-hVw] [-cs] [-jh] [[[--[no-]enabled] [server=string] [port=integer] [--[no-] authentication_enabled] [--[no-] tls_enabled] [username=string] [password=string] [from_address=string] [send_timeout=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled True if outbound email is enabled. server=string IP address or hostname of SMTP relay server. port=integer Port number to use. A value of -1 indicates the default (25 or 587 for TLS). --[no-]authentication_enabled True if username/password authentication should be used. --[no-]tls_enabled True if TLS (transport layer security) should be used. username=string If authentication is enabled, username to use when authenticating to the server. password=string If authentication is enabled, password to use when authenticating to the server. from_address=string From address to use when sending mail. If unspecified, 'noreply@delphix.com' is used. send_timeout=integer Maximum timeout to wait, in seconds, when sending mail. --body=PARAM The parameters to update the SMTP config. -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: validate_smtp_config ======================================== Usage: dct-toolkit validate_smtp_config[-hVw] [-cs] [-jh] ([to_address=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. to_address=string --body=PARAM The parameters to validate the SMTP config. -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_metadata_database ======================================== Usage: dct-toolkit get_metadata_database[-hVw] [-cs] [-jh] [-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 -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: get_ldap_config ======================================== Usage: dct-toolkit get_ldap_config[-hVw] [-cs] [-jh] [-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 -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: update_ldap_config ======================================== Usage: dct-toolkit update_ldap_config[-hVw] [-cs] [-jh] [[[--[no-]enabled] [-- [no-]auto_create_users] [hostname=string] [port=integer] [domains=array] [--[no-] enable_ssl] [--[no-]insecure_ssl] [--[no-] unsafe_ssl_hostname_check]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled When set, these settings are enabled. True by default. --[no-]auto_create_users When set, the system will automatically create new Accounts for those who have logged in using LDAP. This must be true if LDAP user is not already registered in system. True by default. hostname=string The hostname of the LDAP server. port=integer The port of the LDAP server. Default port is 389 for non-SSL and 636 for SSL. domains=array DCT will try to authenticate using each Domain given in this list. --[no-]enable_ssl True if LDAP should be used over SSL. --[no-]insecure_ssl Allow connections to the LDAP server over LDAPS without validating the TLS certificate. Even though the connection to the server might be performed over LDAPS, setting this property eliminates the protection against a man-in-the-middle attach for connections to this server. Instead, consider configuring DCT with Certificate Authority certificates. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the LDAP server over LDAPS. Setting this value must only be done if the TLS certificate of the server does not match the hostname, and the TLS configuration of the server cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this server. This is ignored if insecure_ssl is set. --body=PARAM The parameters to update the LDAP config. -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: validate_ldap_config ======================================== Usage: dct-toolkit validate_ldap_config[-hVw] [-cs] [-jh] [[[username=string] [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. username=string Username of the account to validate the ldap optional attributes. password=string Password of the account to validate the ldap optional attributes. --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_saml_config ======================================== Usage: dct-toolkit get_saml_config[-hVw] [-cs] [-jh] [-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 -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: update_saml_config ======================================== Usage: dct-toolkit update_saml_config[-hVw] [-cs] [-jh] [[[--[no-]enabled] [-- [no-]auto_create_users] [metadata=string] [entity_id=string] [response_skew=integer] [group_attr=string] [first_name_attr=string] [last_name_attr=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled When set, SAML settings are enabled. False by default. --[no-]auto_create_users When set, the system will automatically create new Accounts for those who have logged in using SAML. This must be true if SAML user is not already registered in system. True by default. metadata=string IdP metadata for this service provider. This is a required property for successful SAML authentication. entity_id=string Unique identifier of this instance as a SAML/SSO service provider. response_skew=integer Maximum time difference allowed between a SAML response and the DCT's current time, in seconds. If not set, it defaults to 120 seconds. group_attr=string Group mapped attribute on SAML to create account tags in DCT. first_name_attr=string First name attribute mapped on SAML used for mapping on DCT account. last_name_attr=string Last name attribute mapped on SAML used for mapping on DCT account. --body=PARAM The parameters to update the SAML config. -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_dct_product_telemetry_events ======================================== Usage: dct-toolkit get_dct_product_telemetry_events[-hVw] [-cs] [-jh] [limit=] [-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 -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. limit= The maximum number of items to return. -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: trigger_dct_product_telemetry_bundle_upload ======================================== Usage: dct-toolkit trigger_dct_product_telemetry_bundle_upload[-hVw] [-cs] [-jh] [-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 -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: get_proxy_configuration ======================================== Usage: dct-toolkit get_proxy_configuration[-hVw] [-cs] [-jh] [-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 -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: update_proxy_configuration ======================================== Usage: dct-toolkit update_proxy_configuration[-hVw] [-cs] [-jh] ([host=string --[no-]enabled port=integer [username=string] [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. host=string The host name or IP address of the proxy server. --[no-]enabled When set, these settings are enabled. True by default. port=integer The port number of the proxy server. username=string The username to use when authenticating with the proxy server. password=string The password to use when authenticating with the proxy server. --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_product_registration_delphix_connectivity_check ======================================== Usage: dct-toolkit get_product_registration_delphix_connectivity_check[-hVw] [-cs] [-jh] [-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 -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: get_product_registration_status ======================================== Usage: dct-toolkit get_product_registration_status[-hVw] [-cs] [-jh] [-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 -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: get_product_registration_key ======================================== Usage: dct-toolkit get_product_registration_key[-hVw] [-cs] [-jh] [-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 -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: register_product_offline ======================================== Usage: dct-toolkit register_product_offline[-hVw] [-cs] [-jh] ([authentication_token=string data_key=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. authentication_token=string data_key=string --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: register_product_online ======================================== Usage: dct-toolkit register_product_online[-hVw] [-cs] [-jh] ([token=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. token=string --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 ========================================