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: DSources ================================================================================ Commands (44): get_dsources, link_oracle_database, get_oracle_dsource_linking_defaults, detach_oracle_dsource, attach_oracle_dsource, link_oracle_staging_push_database, get_oracle_staging_push_dsource_linking_defaults, update_oracle_dsource_by_id, upgrade_oracle_dsource, upgrade_dsource, link_ase_database, get_ase_dsource_linking_defaults, update_ase_dsource_by_id, link_appdata_database, get_appdata_dsource_linking_defaults, update_appdata_dsource_by_id, link_mssql_database, detach_mssql_database, attach_mssql_database, attach_mssql_staging_push_database, get_mssql_dsource_linking_defaults, link_mssql_staging_push_database, get_mssql_staging_push_dsource_linking_defaults, delete_dsource, search_dsources, get_dsource_by_id, enable_dsource, disable_dsource, get_upgrade_compatible_repo_for_dsource, update_mssql_dsource_by_id, get_dsource_snapshots, snapshot_dsource, get_dsource_deletion_dependencies, get_tags_dsource, create_tags_dsource, delete_tags_dsource, export_dsource_to_asm_by_snapshot, export_dsource_by_snapshot, export_dsource_to_asm_by_location, export_dsource_to_asm_by_bookmark, export_dsource_from_bookmark, export_dsource_to_asm_by_timestamp, export_dsource_by_timestamp, export_dsource_by_location COMMAND: get_dsources ======================================== Usage: dct-toolkit get_dsources[-hVw] [-cs] [-jh] [cursor=] [limit=] [permission=] [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. permission= Restrict the objects, which are allowed. 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: link_oracle_database ======================================== Usage: dct-toolkit link_oracle_database[-hVw] [-cs] [-jh] [[[name=string] [source_id=string] [group_id=string] [description=string] [--[no-] log_sync_enabled] [sync_policy_id=string] [retention_policy_id=string] [--[no-] make_current_account_owner] [tags [=array...]]... [ops_pre_sync=array] [ops_post_sync=array] [external_file_path=string] [environment_user_id=string] [--[no-] backup_level_enabled] [rman_channels=integer] [files_per_set=integer] [--[no-] check_logical] [--[no-] encrypted_linking_enabled] [--[no-] compressed_linking_enabled] [bandwidth_limit=integer] [number_of_connections=integer] [--[no-] diagnose_no_logging_faults] [--[no-] pre_provisioning_enabled] [--[no-] link_now] [--[no-]force_full_backup] [-- [no-]double_sync] [rman_rate_in_MB=integer] [--[no-] skip_space_check] [--[no-] do_not_resume] [files_for_full_backup=array[, array...]]... [log_sync_mode=string] [log_sync_interval=integer] [non_sys_username=string] [non_sys_password=string] [non_sys_vault_username=string] [non_sys_vault=string] [non_sys_hashicorp_vault_engine=string] [non_sys_hashicorp_vault_secret_path=str ing] [non_sys_hashicorp_vault_username_key=st ring] [non_sys_hashicorp_vault_secret_key=stri ng] [non_sys_azure_vault_name=string] [non_sys_azure_vault_username_key=string ] [non_sys_azure_vault_secret_key=string] [non_sys_cyberark_vault_query_string=str ing] [fallback_username=string] [fallback_password=string] [fallback_vault_username=string] [fallback_vault=string] [fallback_hashicorp_vault_engine=string] [fallback_hashicorp_vault_secret_path=st ring] [fallback_hashicorp_vault_username_key=s tring] [fallback_hashicorp_vault_secret_key=str ing] [fallback_azure_vault_name=string] [fallback_azure_vault_username_key=strin g] [fallback_azure_vault_secret_key=string] [fallback_cyberark_vault_query_string=st ring] [ops_pre_log_sync=array]] | [--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 Name of the dSource to be created. source_id=string Id of the source to link. group_id=string Id of the dataset group where this dSource should belong to. description=string The notes/description for the dSource. --[no-]log_sync_enabled True if LogSync should run for this database. sync_policy_id=string The ID of the SnapSync policy for the dSource. retention_policy_id=string The ID of the Retention policy for the dSource. --[no-]make_current_account_owner Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. tags[=array...] The tags to be created for dSource. ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. external_file_path=string External file path. environment_user_id=string Id of the environment user to use for linking. --[no-]backup_level_enabled Boolean value indicates whether LEVEL-based incremental backups can be used on the source database. rman_channels=integer Number of parallel channels to use. files_per_set=integer Number of data files to include in each RMAN backup set. --[no-]check_logical True if extended block checking should be used for this linked database. --[no-]encrypted_linking_enabled True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data. --[no-]compressed_linking_enabled True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network. bandwidth_limit=integer Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit. number_of_connections=integer Total number of transport connections to use during SnapSync. --[no-]diagnose_no_logging_faults If true, NOLOGGING operations on this container are treated as faults and cannot be resolved manually. --[no-]pre_provisioning_enabled If true, pre-provisioning will be performed after every sync. --[no-]link_now True if initial load should be done immediately. --[no-]force_full_backup Whether or not to take another full backup of the source database. --[no-]double_sync True if two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot. rman_rate_in_MB=integer RMAN rate in megabytes to be used. This is the upper limit for bytes read so that RMAN does not consume excessive disk bandwidth and degrade online performance. (Oracle only) --[no-]skip_space_check Skip check that tests if there is enough space available to store the database in the Delphix Engine. The Delphix Engine estimates how much space a database will occupy after compression and prevents SnapSync if insufficient space is available. This safeguard can be overridden using this option. This may be useful when linking highly compressible databases. --[no-]do_not_resume Indicates whether a fresh SnapSync must be started regardless if it was possible to resume the current SnapSync. If true, we will not resume but instead ignore previous progress and backup all datafiles even if already completed from previous failed SnapSync. This does not force a full backup, if an incremental was in progress this will start a new incremental snapshot. files_for_full_backup=array[,array...] List of datafiles to take a full backup of. This would be useful in situations where certain datafiles could not be backed up during previous SnapSync due to corruption or because they went offline. log_sync_mode=string Values: [ARCHIVE_ONLY_MODE, ARCHIVE_REDO_MODE, UNDEFINED]LogSync operation mode for this database. log_sync_interval=integer Interval between LogSync requests, in seconds. non_sys_username=string Non-SYS database user to access this database. Only required for username-password auth (Single tenant only). non_sys_password=string Password for non sys user authentication (Single tenant only). non_sys_vault_username=string Delphix display name for the non sys vault user (Single tenant only). non_sys_vault=string The name or reference of the vault from which to read the database credentials (Single tenant only). non_sys_hashicorp_vault_engine=string Vault engine name where the credential is stored (Single tenant only). non_sys_hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored (Single tenant only). non_sys_hashicorp_vault_username_key=string Hashicorp vault key for the username in the key-value store (Single tenant only). non_sys_hashicorp_vault_secret_key=string Hashicorp vault key for the password in the key-value store (Single tenant only). non_sys_azure_vault_name=string Azure key vault name (Single tenant only). non_sys_azure_vault_username_key=string Azure vault key for the username in the key-value store (Single tenant only). non_sys_azure_vault_secret_key=string Azure vault key for the password in the key-value store (Single tenant only). non_sys_cyberark_vault_query_string=string Query to find a credential in the CyberArk vault (Single tenant only). fallback_username=string The database fallback username. Optional if bequeath connections are enabled (to be used in case of bequeath connection failures). Only required for username-password auth. fallback_password=string Password for fallback username. fallback_vault_username=string Delphix display name for the fallback vault user. fallback_vault=string The name or reference of the vault from which to read the database credentials. fallback_hashicorp_vault_engine=string Vault engine name where the credential is stored. fallback_hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. fallback_hashicorp_vault_username_key=string Hashicorp vault key for the username in the key-value store. fallback_hashicorp_vault_secret_key=string Hashicorp vault key for the password in the key-value store. fallback_azure_vault_name=string Azure key vault name. fallback_azure_vault_username_key=string Azure vault key for the username in the key-value store. fallback_azure_vault_secret_key=string Azure vault key for the password in the key-value store. fallback_cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. ops_pre_log_sync=array Operations to perform after syncing a created dSource and before running the LogSync. --body=PARAM The parameters to link an Oracle dSource. -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_oracle_dsource_linking_defaults ======================================== Usage: dct-toolkit get_oracle_dsource_linking_defaults[-hVw] [-cs] [-jh] ([source_id=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. source_id=string The ID of the source to be linked. --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: detach_oracle_dsource ======================================== Usage: dct-toolkit detach_oracle_dsource[-hVw] [-cs] [-jh] dsource_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. dsourceId, dsource_id= The ID of the dSource. -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: attach_oracle_dsource ======================================== Usage: dct-toolkit attach_oracle_dsource[-hVw] dsource_id= [-cs] [-jh] [[[--[no-]backup_level_enabled] [bandwidth_limit=integer] [--[no-] check_logical] [--[no-]compressed_linking_enabled] [--[no-]double_sync] [--[no-]encrypted_linking_enabled] [environment_user=string] [external_file_path=string] [files_per_set=integer] [--[no-]force] [-- [no-]link_now] [number_of_connections=integer] [operations=array] [oracle_fallback_user=string] [oracle_fallback_credentials=string] [rman_channels=integer] [source_id=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. --[no-]backup_level_enabled Boolean value indicates whether LEVEL-based incremental backups can be used on the source database. bandwidth_limit=integer Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit. --[no-]check_logical True if extended block checking should be used for this linked database. --[no-]compressed_linking_enabled True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network. --[no-]double_sync True if two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot. --[no-]encrypted_linking_enabled True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data. environment_user=string Reference to the user that should be used in the host. external_file_path=string External file path. files_per_set=integer Number of data files to include in each RMAN backup set. --[no-]force If true, attach will succeed even if the resetlogs of the new database does not match the resetlogs information of the original database. --[no-]link_now True if initial load should be done immediately. number_of_connections=integer Total number of transport connections to use during SnapSync. operations=array Operations to perform after syncing a created dSource and before running the LogSync. oracle_fallback_user=string The database fallback username. Optional if bequeath connections are enabled (to be used in case of bequeath connection failures). Only required for username-password auth. oracle_fallback_credentials=string Password for fallback username. rman_channels=integer Number of parallel channels to use. source_id=string Id of the source to attach. --body=PARAM The parameters to attach an Oracle dSource. -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: link_oracle_staging_push_database ======================================== Usage: dct-toolkit link_oracle_staging_push_database[-hVw] [-cs] [-jh] [[[name=string] [source_id=string] [group_id=string] [description=string] [--[no-]log_sync_enabled] [sync_policy_id=string] [retention_policy_id=string] [--[no-]make_current_account_owner] [tags [=array...]]... [ops_pre_sync=array] [ops_post_sync=array] [engine_id=string] [container_type=string] [environment_user_id=string] [repository=string] [database_name=string] [database_unique_name=string] [sid=string] [mount_base=string] [custom_env_variables_pairs=array] [custom_env_variables_paths=array[,array...]]... [--[no-] auto_staging_restart] [--[no-]allow_auto_staging_restart_on_host_reboot] [--[no-]physical_standby] [--[no-]validate_snapshot_in_readonly] [--[no-] validate_by_opening_db_in_read_only_mode] [staging_database_templates=array] [staging_database_config_params [=object...]]... [staging_container_database_reference=string] [ops_pre_log_sync=array] [tde_keystore_config_type=string] [template_id=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. name=string Name of the dSource to be created. source_id=string Id of the source to link. group_id=string Id of the dataset group where this dSource should belong to. description=string The notes/description for the dSource. --[no-]log_sync_enabled True if LogSync should run for this database. sync_policy_id=string The ID of the SnapSync policy for the dSource. retention_policy_id=string The ID of the Retention policy for the dSource. --[no-]make_current_account_owner Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. tags[=array...] The tags to be created for dSource. ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. engine_id=string The ID of the engine to link staging push database on. container_type=string Values: [ROOT_CDB, NON_CDB]The container type of this database.If not provided the request would be considered as a PDB database. environment_user_id=string Id of the environment user to use for linking. repository=string The repository reference to link. database_name=string The name of the database. database_unique_name=string The unique name of the database. sid=string The name (sid) of the instance. mount_base=string The base mount point to use for the NFS mounts. custom_env_variables_pairs=array An array of name value pair of environment variables. custom_env_variables_paths=array[,array...] An array of strings of whitespace-separated parameters to be passed to the source command. The first parameter must be an absolute path to a file that exists on the target environment. Every subsequent parameter will be treated as an argument interpreted by the environment file. --[no-]auto_staging_restart Boolean value indicates whether this staging database should automatically be restarted when staging host reboot is detected. --[no-]allow_auto_staging_restart_on_host_reboot Boolean value indicates whether this staging database should automatically be restarted when staging host reboot is detected. --[no-]physical_standby Boolean value indicates whether this staging database will be configured as a physical standby. --[no-]validate_snapshot_in_readonly Boolean value indicates whether this staging database snapshot will be validated by opening it in read-only. --[no-]validate_by_opening_db_in_read_only_mode Boolean value indicates whether this staging database snapshot will be validated by opening it in read-only. staging_database_templates=array An array of name value pair of Oracle database configuration parameter overrides. This property is deprecated. Use staging_database_config_params instead. staging_database_config_params[=object...] Oracle database configuration parameter overrides. If both staging_database_templates and staging_database_config_params are specified, staging_database_config_params will be used. staging_container_database_reference=string Reference of the CDB source config. ops_pre_log_sync=array Operations to perform after syncing a created dSource and before running the LogSync. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. template_id=string The template ID of the target Oracle Staging Push dSource. --body=PARAM The parameters to link an Oracle dSource. -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_oracle_staging_push_dsource_linking_defaults ======================================== Usage: dct-toolkit get_oracle_staging_push_dsource_linking_defaults[-hVw] [-cs] [-jh] ([environment_id=string [container_type=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. environment_id=string The ID of the environment to be linked. container_type=string Values: [ROOT_CDB, NON_CDB]The container type of this database.If not provided the request would be considered for a PDB database. --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: update_oracle_dsource_by_id ======================================== Usage: dct-toolkit update_oracle_dsource_by_id[-hVw] dsource_id= [-cs] [-jh] [[[--[no-]pre_provisioning_enabled] [hooks. pre_validated_sync=array] [description=string] [--[no-] encrypted_linking_enabled] [--[no-]compressed_linking_enabled] [--[no-] validate_by_opening_db_in_read_only_mode] [repository=string] [environment_user_id=string] [custom_env_variables_paths=array[, array...]]... [--[no-]allow_auto_staging_restart_on_host_reboot] [non_sys_username=string] [rac_max_instance_lag=integer] [--[no-] physical_standby] [--[no-]check_logical] [--[no-]logsync_enabled] [logsync_mode=string] [db_password=string] [bandwidth_limit=integer] [hooks.post_validated_sync=array] [files_per_set=integer] [--[no-] diagnose_no_logging_faults] [hooks.ops_post_sync=array] [external_file_path=string] [logsync_interval=integer] [--[no-] backup_level_enabled] [--[no-]validate_db_credentials] [non_sys_password=string] [number_of_connections=integer] [hooks. ops_pre_log_sync=array] [db_username=string] [name=string] [custom_env_variables_pairs=array] [hooks.ops_pre_sync=array] [template_id=string] [rman_channels=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. --[no-]pre_provisioning_enabled Boolean flag indicating whether or not pre-provisioning is turned on for this dSource. hooks.pre_validated_sync=array The commands to execute on the staging source before performing a validated sync. description=string The description of the dSource. --[no-]encrypted_linking_enabled True if SnapSync data from the source should be retrieved through an encrypted connection. Enabling this feature can decrease the performance of SnapSync from the source but has no impact on the performance of VDBs created from the retrieved data. --[no-]compressed_linking_enabled True if SnapSync data from the source should be compressed over the network. Enabling this feature will reduce network bandwidth consumption and may significantly improve throughput, especially over slow network. --[no-]validate_by_opening_db_in_read_only_mode Whether the snaphots of this dSource's staging database will be validated by opening it in read-only mode. repository=string The repository Id where staging database will be created. environment_user_id=string The environment user ID to use to connect to the target environment. custom_env_variables_paths=array[,array...] An array of strings of whitespace-separated parameters to be passed to the source command. The first parameter must be an absolute path to a file that exists on the target environment. Every subsequent parameter will be treated as an argument interpreted by the environment file. --[no-]allow_auto_staging_restart_on_host_reboot Allow auto restart of staging source on host reboot. non_sys_username=string Non-SYS database user to access this database. Only required for username-password auth (Single tenant only). rac_max_instance_lag=integer Maximum number of log sequences to allow a RAC instance to lag before considering the instance offline. --[no-]physical_standby If true, convert this dSource's staging database to a physical standby. --[no-]check_logical True if extended block checking should be used for this dSource. --[no-]logsync_enabled True if LogSync is enabled for this dSource. logsync_mode=string Values: [ARCHIVE_ONLY_MODE, ARCHIVE_REDO_MODE, UNDEFINED]LogSync operation mode for this dSource. db_password=string The password of the database user. bandwidth_limit=integer Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A value of 0 means no limit. hooks.post_validated_sync=array The commands to execute on the staging source after performing a validated sync. files_per_set=integer Number of data files to include in each RMAN backup set. --[no-]diagnose_no_logging_faults If true, NOLOGGING operations on this dSource are treated as faults and cannot be resolved manually. hooks.ops_post_sync=array The commands to execute after syncing a linked source. external_file_path=string External file path. logsync_interval=integer Interval between LogSync requests, in seconds. --[no-]backup_level_enabled Boolean value indicates whether LEVEL-based incremental backups can be used on the source database. --[no-]validate_db_credentials Whether db_username and db_password must be validated, if present, against the dSource. This must be set to false when credentials validation is not possible, for instance if the dSource is known to be disabled. non_sys_password=string Password for non sys user authentication (Single tenant only). number_of_connections=integer Total number of transport connections to use during SnapSync. hooks.ops_pre_log_sync=array The commands to execute after syncing with external data and before running the LogSync. db_username=string The username of the database user. name=string The unique name of the dSource within a group. custom_env_variables_pairs=array An array of name value pair of environment variables. hooks.ops_pre_sync=array The commands to execute before syncing with external data. template_id=string The template ID of the target Oracle Staging Push dSource. rman_channels=integer Number of parallel channels to use. --body=PARAM The new data to update an Oracle dSource. -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: upgrade_oracle_dsource ======================================== Usage: dct-toolkit upgrade_oracle_dsource[-hVw] dsource_id= [-cs] [-jh] ([repository_id=string environment_user_id=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. repository_id=string The id of the dSource/VDB repository to upgrade to. environment_user_id=string Reference of the environment user to use for dSource/VDB upgrade. --body=PARAM The new data to upgrade an Oracle dSource. -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: upgrade_dsource ======================================== Usage: dct-toolkit upgrade_dsource[-hVw] dsource_id= [-cs] [-jh] ([repository_id=string [environment_user_id=string] [ppt_repository=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. repository_id=string The id of the dSource/VDB repository to upgrade to. environment_user_id=string Reference of the environment user to use for dSource/VDB upgrade. ppt_repository=string The id of the SQL instance on the PPT environment that we want to use for pre-provisioning (MSSQL only). --body=PARAM The new API to upgrade dSource -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: link_ase_database ======================================== Usage: dct-toolkit link_ase_database[-hVw] [-cs] [-jh] [[[name=string] [source_id=string] [group_id=string] [description=string] [--[no-] log_sync_enabled] [sync_policy_id=string] [retention_policy_id=string] [--[no-] make_current_account_owner] [tags [=array...]]... [ops_pre_sync=array] [ops_post_sync=array] [external_file_path=string] [mount_base=string] [load_backup_path=string] [backup_server_name=string] [backup_host_user=string] [backup_host=string] [dump_credentials=string] [source_host_user=string] [db_user=string] [db_password=string] [db_vault_username=string] [db_vault=string] [db_hashicorp_vault_engine=string] [db_hashicorp_vault_secret_path=string] [db_hashicorp_vault_username_key=string] [db_hashicorp_vault_secret_key=string] [db_azure_vault_name=string] [db_azure_vault_username_key=string] [db_azure_vault_secret_key=string] [db_cyberark_vault_query_string=string] [staging_repository=string] [staging_host_user=string] [validated_sync_mode=string] [--[no-] dump_history_file_enabled] [--[no-] drop_and_recreate_devices] [sync_strategy=string] [ase_backup_files=array[,array...]]... [pre_validated_sync=array] [post_validated_sync=array]] | [--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 Name of the dSource to be created. source_id=string Id of the source to link. group_id=string Id of the dataset group where this dSource should belong to. description=string The notes/description for the dSource. --[no-]log_sync_enabled True if LogSync should run for this database. sync_policy_id=string The ID of the SnapSync policy for the dSource. retention_policy_id=string The ID of the Retention policy for the dSource. --[no-]make_current_account_owner Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. tags[=array...] The tags to be created for dSource. ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. external_file_path=string External file path. mount_base=string The base mount point to use for the NFS mounts. load_backup_path=string Source database backup location. backup_server_name=string Name of the backup server instance. backup_host_user=string OS user for the host where the backup server is located. backup_host=string Host environment where the backup server is located. dump_credentials=string The password credential for the source DB user. source_host_user=string ID or user reference of the host OS user to use for linking. db_user=string The user name for the source DB user. db_password=string Password for the database user. db_vault_username=string Delphix display name for the vault user. db_vault=string The name or reference of the vault from which to read the database credentials. db_hashicorp_vault_engine=string Vault engine name where the credential is stored. db_hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. db_hashicorp_vault_username_key=string Hashicorp vault key for the username in the key-value store. db_hashicorp_vault_secret_key=string Hashicorp vault key for the password in the key-value store. db_azure_vault_name=string Azure key vault name. db_azure_vault_username_key=string Azure vault key for the username in the key-value store. db_azure_vault_secret_key=string Azure vault key for the password in the key-value store. db_cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. staging_repository=string The SAP ASE instance on the staging environment that we want to use for validated sync. staging_host_user=string Information about the host OS user on the staging environment to use for linking. validated_sync_mode=string Values: [ENABLED, DISABLED]Information about the host OS user on the staging environment to use for linking. --[no-]dump_history_file_enabled Specifies if Dump History File is enabled for backup history detection. --[no-]drop_and_recreate_devices If this parameter is set to true, it will drop the older devices and create new devices during manual sync operations instead of trying to remap the devices. This might increase the space utilization on Delphix Engine. sync_strategy=string Values: [latest_backup, new_backup, specific_backup]Determines how the Delphix Engine will take a backup: * `latest_backup` - Use the most recent backup. * `new_backup` - Delphix will take a new backup of your source database. * `specific_backup` - Use a specific backup. Using this option requires setting `ase_backup_files`. Default is `new_backup`. ase_backup_files=array[,array...] The location of the full backup of the source database to restore from. The backup should be present in the shared backup location for the source database. pre_validated_sync=array Operations to perform on the staging source before performing a validated sync. post_validated_sync=array Operations to perform on the staging source after performing a validated sync. --body=PARAM The parameters to link an ASE dSource. -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_ase_dsource_linking_defaults ======================================== Usage: dct-toolkit get_ase_dsource_linking_defaults[-hVw] [-cs] [-jh] ([source_id=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. source_id=string The ID of the source to be linked. --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: update_ase_dsource_by_id ======================================== Usage: dct-toolkit update_ase_dsource_by_id[-hVw] dsource_id= [-cs] [-jh] [[[name=string] [description=string] [sync_policy_id=string] [retention_policy_id=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. name=string Name of the dSource and container to be updated. description=string The notes/description for the dSource. sync_policy_id=string The ID of the SnapSync policy for the dSource. retention_policy_id=string The ID of the Retention policy for the dSource. --body=PARAM The new data to update an ASE dSource. -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: link_appdata_database ======================================== Usage: dct-toolkit link_appdata_database[-hVw] [-cs] [-jh] [[[name=string] [source_id=string] [group_id=string] [description=string] [--[no-] log_sync_enabled] [sync_policy_id=string] [retention_policy_id=string] [--[no-]make_current_account_owner] [tags[=array...]]... [ops_pre_sync=array] [ops_post_sync=array] [link_type=string] [staging_mount_base=string] [staging_environment=string] [staging_environment_user=string] [environment_user=string] [excludes=array[,array...]]... [follow_symlinks=array[,array...]]... [parameters=object] [sync_parameters=object]] | [--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 Name of the dSource to be created. source_id=string Id of the source to link. group_id=string Id of the dataset group where this dSource should belong to. description=string The notes/description for the dSource. --[no-]log_sync_enabled True if LogSync should run for this database. sync_policy_id=string The ID of the SnapSync policy for the dSource. retention_policy_id=string The ID of the Retention policy for the dSource. --[no-]make_current_account_owner Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. tags[=array...] The tags to be created for dSource. ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. link_type=string Values: [AppDataDirect, AppDataStaged]The type of link to create. Default is AppDataDirect. * `AppDataDirect` - Represents the AppData specific parameters of a link request for a source directly replicated into the Delphix Engine. * `AppDataStaged` - Represents the AppData specific parameters of a link request for a source with a staging source. staging_mount_base=string The base mount point for the NFS mount on the staging environment [AppDataStaged only]. staging_environment=string The environment used as an intermediate stage to pull data into Delphix [AppDataStaged only]. staging_environment_user=string The environment user used to access the staging environment [AppDataStaged only]. environment_user=string The OS user to use for linking. excludes=array[,array...] List of subdirectories in the source to exclude when syncing data. These paths are relative to the root of the source directory. [AppDataDirect only] follow_symlinks=array[,array...] List of symlinks in the source to follow when syncing data. These paths are relative to the root of the source directory. All other symlinks are preserved. [AppDataDirect only] parameters=object The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. sync_parameters=object The JSON payload conforming to the snapshot parameters definition in a LUA toolkit or platform plugin. --body=PARAM The parameters to link an AppData dSource. -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_appdata_dsource_linking_defaults ======================================== Usage: dct-toolkit get_appdata_dsource_linking_defaults[-hVw] [-cs] [-jh] ([source_id=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. source_id=string The ID of the source to be linked. --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: update_appdata_dsource_by_id ======================================== Usage: dct-toolkit update_appdata_dsource_by_id[-hVw] dsource_id= [-cs] [-jh] [[[name=string] [description=string] [staging_environment=string] [staging_environment_user=string] [environment_user=string] [parameters=object] [sync_policy_id=string] [retention_policy_id=string] [ops_pre_sync=array] [ops_post_sync=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c= [,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. name=string Name of the dSource and container to be updated. description=string The notes/description for the dSource. staging_environment=string The environment used as an intermediate stage to pull data into Delphix [AppDataStaged only]. staging_environment_user=string The environment user used to access the staging environment [AppDataStaged only]. environment_user=string The OS user to use for linking. parameters=object The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. sync_policy_id=string The ID of the SnapSync policy for the dSource. retention_policy_id=string The ID of the Retention policy for the dSource. ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. --body=PARAM The new data to update an AppData dSource. -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: link_mssql_database ======================================== Usage: dct-toolkit link_mssql_database[-hVw] [-cs] [-jh] [[[name=string] [source_id=string] [group_id=string] [description=string] [--[no-] log_sync_enabled] [sync_policy_id=string] [retention_policy_id=string] [--[no-] make_current_account_owner] [tags [=array...]]... [ops_pre_sync=array] [ops_post_sync=array] [encryption_key=string] [sync_strategy=string] [mssql_backup_uuid=string] [--[no-] compression_enabled] [availability_group_backup_policy=string] [source_host_user=string] [ppt_repository=string] [ppt_host_user=string] [staging_pre_script=string] [staging_post_script=string] [sync_strategy_managed_type=string] [mssql_user_environment_reference=string] [mssql_user_domain_username=string] [mssql_user_domain_password=string] [mssql_user_domain_vault_username=string] [mssql_user_domain_vault=string] [mssql_user_domain_hashicorp_vault_engine =string] [mssql_user_domain_hashicorp_vault_secret _path=string] [mssql_user_domain_hashicorp_vault_userna me_key=string] [mssql_user_domain_hashicorp_vault_secret _key=string] [mssql_user_domain_azure_vault_name=strin g] [mssql_user_domain_azure_vault_username_k ey=string] [mssql_user_domain_azure_vault_secret_key =string] [mssql_user_domain_cyberark_vault_query_s tring=string] [mssql_database_username=string] [mssql_database_password=string] [--[no-] delphix_managed_backup_compression_enable d] [delphix_managed_backup_policy=string] [external_managed_validate_sync_mode=stri ng] [external_managed_shared_backup_locations =array[,array...]]... [external_netbackup_config_master_name=st ring] [external_netbackup_config_source_client_ name=string] [external_netbackup_config_params=object] [external_netbackup_config_templates=stri ng] [external_commserve_host_name=string] [external_commvault_config_source_client_ name=string] [external_commvault_config_staging_client _name=string] [external_commvault_config_params=object] [external_commvault_config_templates=stri ng]] | [--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 Name of the dSource to be created. source_id=string Id of the source to link. group_id=string Id of the dataset group where this dSource should belong to. description=string The notes/description for the dSource. --[no-]log_sync_enabled True if LogSync should run for this database. sync_policy_id=string The ID of the SnapSync policy for the dSource. retention_policy_id=string The ID of the Retention policy for the dSource. --[no-]make_current_account_owner Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. tags[=array...] The tags to be created for dSource. ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. encryption_key=string The encryption key to use when restoring encrypted backups. sync_strategy=string Values: [latest_backup, new_backup, specific_backup, no_backup]Determines how the Delphix Engine will take a backup: * `latest_backup` - Use the most recent backup. * `new_backup` - Delphix will take a new backup of your source database. * `specific_backup` - Use a specific backup. Using this option requires setting `ase_backup_files`. * `no_backup` - Use as input to sync MSSQL databases without a backup. Default is `new_backup`. mssql_backup_uuid=string When using the `specific_backup` sync_strategy, determines the Backup Set UUID. --[no-]compression_enabled When using the `new_backup` sync_strategy, determines if compression must be enabled. Defaults to the configuration of the ingestion strategy configured on the Delphix Engine for this dSource. availability_group_backup_policy=string Values: [primary, secondary_only, prefer_secondary] When using the `new_backup` sync_strategy for an MSSql Availability Group, determines the backup policy: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. source_host_user=string ID or user reference of the host OS user to use for linking. ppt_repository=string Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning. ppt_host_user=string Reference of the host OS user on the PPT host to use for linking. staging_pre_script=string A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning. staging_post_script=string A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning. sync_strategy_managed_type=string Values: [external, delphix, staging_push]MSSQL specific parameters for source based sync strategy.: * `external` - MSSQL specific parameters for externally managed source based sync strategy. * `delphix` - MSSQL specific parameters for delphix managed source based sync strategy. * `staging_push` - MSSQL specific parameters for staging push based sync strategy. mssql_user_environment_reference=string Reference to the source environment user to use for linking. mssql_user_domain_username=string The username for the source DB user. mssql_user_domain_password=string Password for the database user. mssql_user_domain_vault_username=string Delphix display name for the vault user. mssql_user_domain_vault=string The name or reference of the vault from which to read the database credentials. mssql_user_domain_hashicorp_vault_engine=string Vault engine name where the credential is stored. mssql_user_domain_hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. mssql_user_domain_hashicorp_vault_username_key=string Hashicorp vault key for the username in the key-value store. mssql_user_domain_hashicorp_vault_secret_key=string Hashicorp vault key for the password in the key-value store. mssql_user_domain_azure_vault_name=string Azure key vault name. mssql_user_domain_azure_vault_username_key=string Azure vault key for the username in the key-value store. mssql_user_domain_azure_vault_secret_key=string Azure vault key for the password in the key-value store. mssql_user_domain_cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. mssql_database_username=string The username for the source DB user. mssql_database_password=string Password for the database user. --[no-]delphix_managed_backup_compression_enabled Specify whether the backups taken should be compressed or uncompressed when Delphix managed option is selected. delphix_managed_backup_policy=string Values: [primary, secondary_only, prefer_secondary] Specify which node of an availability group to run the copy-only full backup on: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. external_managed_validate_sync_mode=string Values: [TRANSACTION_LOG, FULL_OR_DIFFERENTIAL, FULL, NONE]Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database external_managed_shared_backup_locations=array[,array...] Shared source database backup locations. external_netbackup_config_master_name=string The master server name of this NetBackup configuration. external_netbackup_config_source_client_name=string The source's client server name of this NetBackup configuration. external_netbackup_config_params=object NetBackup configuration parameter overrides. external_netbackup_config_templates=string Optional config template selection for NetBackup configurations. If set, external_netbackup_config_params will be ignored. external_commserve_host_name=string The commserve host name of this Commvault configuration. external_commvault_config_source_client_name=string The source client name of this Commvault configuration. external_commvault_config_staging_client_name=string The staging client name of this Commvault configuration. external_commvault_config_params=object Commvault configuration parameter overrides. external_commvault_config_templates=string Optional config template selection for Commvault configurations. If set, configParams will be ignored. --body=PARAM The parameters to link an MSSql dSource. -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: detach_mssql_database ======================================== Usage: dct-toolkit detach_mssql_database[-hVw] [-cs] [-jh] dsource_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. dsourceId, dsource_id= The ID of the dSource. -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: attach_mssql_database ======================================== Usage: dct-toolkit attach_mssql_database[-hVw] dsource_id= [-cs] [-jh] ([source_id=string ppt_repository=string [sync_strategy_managed_type=string] [mssql_user_environment_reference=string] [mssql_user_domain_username=string] [mssql_user_domain_password=string] [mssql_user_domain_vault_username=string] [mssql_user_domain_vault=string] [mssql_user_domain_hashicorp_vault_engine=string] [mssql_user_domain_hashicorp_vault_secret_path=string] [mssql_user_domain_hashicorp_vault_username_key=string] [mssql_user_domain_hashicorp_vault_secret_key=string] [mssql_user_domain_azure_vault_name=string] [mssql_user_domain_azure_vault_username_key=string] [mssql_user_domain_azure_vault_secret_key=string] [mssql_user_domain_cyberark_vault_query_string=string] [mssql_database_username=string] [mssql_database_password=string] [-- [no-]delphix_managed_backup_compression_enabled] [delphix_managed_backup_policy=string] [external_managed_validate_sync_mode=string] [external_managed_shared_backup_locations=array[,array...]]... [external_netbackup_config_master_name=string] [external_netbackup_config_source_client_name=string] [external_netbackup_config_params=object] [external_netbackup_config_templates=string] [external_commserve_host_name=string] [external_commvault_config_source_client_name=string] [external_commvault_config_staging_client_name=string] [external_commvault_config_params=object] [external_commvault_config_templates=string] [encryption_key=string] [source_host_user=string] [ppt_host_user=string] [staging_pre_script=string] [staging_post_script=string] [ops_pre_sync=array] [ops_post_sync=array]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. source_id=string Id of the source to link. ppt_repository=string Id of the SQL instance on the PPT environment that we want to use for pre-provisioning. sync_strategy_managed_type=string Values: [external, delphix]MSSQL specific parameters for source based sync strategy.: * `external` - MSSQL specific parameters for externally managed source based sync strategy. * `delphix` - MSSQL specific parameters for delphix managed source based sync strategy. mssql_user_environment_reference=string Reference to the source environment user to use for linking. mssql_user_domain_username=string The username for the source DB user. mssql_user_domain_password=string Password for the database user. mssql_user_domain_vault_username=string Delphix display name for the vault user. mssql_user_domain_vault=string The name or reference of the vault from which to read the database credentials. mssql_user_domain_hashicorp_vault_engine=string Vault engine name where the credential is stored. mssql_user_domain_hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. mssql_user_domain_hashicorp_vault_username_key=string Hashicorp vault key for the username in the key-value store. mssql_user_domain_hashicorp_vault_secret_key=string Hashicorp vault key for the password in the key-value store. mssql_user_domain_azure_vault_name=string Azure key vault name. mssql_user_domain_azure_vault_username_key=string Azure vault key for the username in the key-value store. mssql_user_domain_azure_vault_secret_key=string Azure vault key for the password in the key-value store. mssql_user_domain_cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. mssql_database_username=string The username for the source DB user. mssql_database_password=string Password for the database user. --[no-]delphix_managed_backup_compression_enabled Specify whether the backups taken should be compressed or uncompressed when Delphix managed option is selected. delphix_managed_backup_policy=string Values: [primary, secondary_only, prefer_secondary] Specify which node of an availability group to run the copy-only full backup on: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. external_managed_validate_sync_mode=string Values: [TRANSACTION_LOG, FULL_OR_DIFFERENTIAL, FULL, NONE]Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database external_managed_shared_backup_locations=array[,array...] Shared source database backup locations. external_netbackup_config_master_name=string The master server name of this NetBackup configuration. external_netbackup_config_source_client_name=string The source's client server name of this NetBackup configuration. external_netbackup_config_params=object NetBackup configuration parameter overrides. external_netbackup_config_templates=string Optional config template selection for NetBackup configurations. If set, external_netbackup_config_params will be ignored. external_commserve_host_name=string The commserve host name of this Commvault configuration. external_commvault_config_source_client_name=string The source client name of this Commvault configuration. external_commvault_config_staging_client_name=string The staging client name of this Commvault configuration. external_commvault_config_params=object Commvault configuration parameter overrides. external_commvault_config_templates=string Optional config template selection for Commvault configurations. If set, configParams will be ignored. encryption_key=string The encryption key to use when restoring encrypted backups. source_host_user=string ID or user reference of the host OS user to use for linking. ppt_host_user=string Reference of the host OS user on the PPT host to use for linking. staging_pre_script=string A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning. staging_post_script=string A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning. ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. --body=PARAM The parameters to attach a MSSql dSource. -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: attach_mssql_staging_push_database ======================================== Usage: dct-toolkit attach_mssql_staging_push_database[-hVw] dsource_id= [-cs] [-jh] ([ppt_repository=string staging_database_name=string [encryption_key=string] [ppt_host_user=string] [staging_pre_script=string] [staging_post_script=string] [db_state=string] [ops_pre_sync=array] [ops_post_sync=array]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. ppt_repository=string Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning. staging_database_name=string The name of the database to create on the staging environment. This property is mutually exclusive to sync_strategy_managed_type encryption_key=string The encryption key to use when restoring encrypted backups. ppt_host_user=string Reference of the host OS user on the PPT host to use for linking. staging_pre_script=string A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning. staging_post_script=string A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning. db_state=string Values: [RESTORING, ONLINE]User provided db state that will be used to create staging push db. Default is RESTORING ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. --body=PARAM The parameters to attach an MSSql dSource. -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_mssql_dsource_linking_defaults ======================================== Usage: dct-toolkit get_mssql_dsource_linking_defaults[-hVw] [-cs] [-jh] ([source_id=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. source_id=string The ID of the source to be linked. --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: link_mssql_staging_push_database ======================================== Usage: dct-toolkit link_mssql_staging_push_database[-hVw] [-cs] [-jh] [[[name=string] [source_id=string] [group_id=string] [description=string] [--[no-]log_sync_enabled] [sync_policy_id=string] [retention_policy_id=string] [--[no-]make_current_account_owner] [tags [=array...]]... [ops_pre_sync=array] [ops_post_sync=array] [engine_id=string] [encryption_key=string] [ppt_repository=string] [ppt_host_user=string] [staging_pre_script=string] [staging_post_script=string] [staging_database_name=string] [db_state=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 Name of the dSource to be created. source_id=string Id of the source to link. group_id=string Id of the dataset group where this dSource should belong to. description=string The notes/description for the dSource. --[no-]log_sync_enabled True if LogSync should run for this database. sync_policy_id=string The ID of the SnapSync policy for the dSource. retention_policy_id=string The ID of the Retention policy for the dSource. --[no-]make_current_account_owner Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. tags[=array...] The tags to be created for dSource. ops_pre_sync=array Operations to perform before syncing the created dSource. These operations can quiesce any data prior to syncing. ops_post_sync=array Operations to perform after syncing a created dSource. engine_id=string The ID of the engine to link staging push database on. encryption_key=string The encryption key to use when restoring encrypted backups. ppt_repository=string Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning. ppt_host_user=string Reference of the host OS user on the PPT host to use for linking. staging_pre_script=string A user-provided PowerShell script or executable to run prior to restoring from a backup during pre-provisioning. staging_post_script=string A user-provided PowerShell script or executable to run after restoring from a backup during pre-provisioning. staging_database_name=string The name of the database to create on the staging environment. This property is mutually exclusive to sync_strategy_managed_type db_state=string Values: [RESTORING, ONLINE]User provided db state that will be used to create staging push db. Default is RESTORING --body=PARAM The parameters to link an MSSql dSource. -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_mssql_staging_push_dsource_linking_defaults ======================================== Usage: dct-toolkit get_mssql_staging_push_dsource_linking_defaults[-hVw] [-cs] [-jh] ([environment_id=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. environment_id=string The ID of the environment to be linked. --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: delete_dsource ======================================== Usage: dct-toolkit delete_dsource[-hVw] [-cs] [-jh] ([dsource_id=string [-- [no-]force] [oracle_username=string] [oracle_password=string] [--[no-] delete_all_dependent_vdbs]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsource_id=string Id of the dSource to delete. --[no-]force Flag indicating whether to continue the operation upon failures. oracle_username=string The name of the privileged user to run the delete operation as (Oracle only). oracle_password=string Password for privileged user (Oracle only). --[no-]delete_all_dependent_vdbs Flag indicating whether to delete all dependent VDBs before deleting the dSource. --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_dsources ======================================== Usage: dct-toolkit search_dsources[-hVw] [limit=] [cursor=] [sort=] [permission=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [data_uuid=string] [database_type=string] [name=string] [description=string] [database_version=string] [content_type=string] [storage_size=integer] [plugin_version=string] [creation_date=string] [group_name=string] [--[no-]enabled] [--[no-]is_detached] [-- [no-]logsync_enabled] [logsync_mode=string] [logsync_interval=integer] [exported_data_directory=string] [engine_id=string] [source_id=string] [staging_source_id=string] [status=string] [engine_name=string] [cdb_id=string] [current_timeflow_id=string] [previous_timeflow_id=string] [namespace_id=string] [namespace_name=string] [--[no-]is_replica] [primary_object_id=string] [primary_engine_id=string] [primary_engine_name=string] [sync_policy_id=string] [retention_policy_id=string] [replica_retention_policy_id=string] [quota_policy_id=string] [template_id=string] [--[no-] allow_auto_staging_restart_on_host_reboot] [--[no-]physical_standby] [--[no-] validate_by_opening_db_in_read_only_mode] [mssql_sync_strategy_managed_type=string] [validated_sync_mode=string] [backup_policy=string] [--[no-] compression_enabled] [staging_database_name=string] [db_state=string] [encryption_key=string] [external_netbackup_config_master_name=string ] [external_netbackup_config_source_client_name =string] [external_netbackup_config_params=string] [external_netbackup_config_templates=string] [external_commserve_host_name=string] [external_commvault_config_source_client_name =string] [external_commvault_config_staging_client_nam e=string] [external_commvault_config_params=string] [external_commvault_config_templates=string] [mssql_user_type=string] [domain_user_credential_type=string] [mssql_database_username=string] [mssql_user_environment_reference=string] [mssql_user_domain_username=string] [mssql_user_domain_vault_username=string] [mssql_user_domain_vault=string] [mssql_user_domain_hashicorp_vault_engine=str ing] [mssql_user_domain_hashicorp_vault_secret_pat h=string] [mssql_user_domain_hashicorp_vault_username_k ey=string] [mssql_user_domain_hashicorp_vault_secret_key =string] [mssql_user_domain_azure_vault_name=string] [mssql_user_domain_azure_vault_username_key=s tring] [mssql_user_domain_azure_vault_secret_key=str ing] [mssql_user_domain_cyberark_vault_query_strin g=string] [--[no-] diagnose_no_logging_faults] [--[no-] pre_provisioning_enabled] [--[no-] backup_level_enabled] [rman_channels=integer] [files_per_set=integer] [--[no-] check_logical] [--[no-] encrypted_linking_enabled] [--[no-] compressed_linking_enabled] [bandwidth_limit=integer] [number_of_connections=integer] [toolkit_id=string] [data_connection_id=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. permission= Restrict the objects, which are allowed. 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 data_uuid=string Filter by data_uuid database_type=string Filter by database_type name=string Filter by name description=string Filter by description database_version=string Filter by database_version content_type=string Filter by content_type storage_size=integer Filter by storage_size plugin_version=string Filter by plugin_version creation_date=string Filter by creation_date group_name=string Filter by group_name --[no-]enabled Filter by enabled --[no-]is_detached Filter by is_detached --[no-]logsync_enabled Filter by logsync_enabled logsync_mode=string Filter by logsync_mode logsync_interval=integer Filter by logsync_interval exported_data_directory=string Filter by exported_data_directory engine_id=string Filter by engine_id source_id=string Filter by source_id staging_source_id=string Filter by staging_source_id status=string Filter by status engine_name=string Filter by engine_name cdb_id=string Filter by cdb_id current_timeflow_id=string Filter by current_timeflow_id previous_timeflow_id=string Filter by previous_timeflow_id namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica primary_object_id=string Filter by primary_object_id primary_engine_id=string Filter by primary_engine_id primary_engine_name=string Filter by primary_engine_name sync_policy_id=string Filter by sync_policy_id retention_policy_id=string Filter by retention_policy_id replica_retention_policy_id=string Filter by replica_retention_policy_id quota_policy_id=string Filter by quota_policy_id template_id=string Filter by template_id --[no-]allow_auto_staging_restart_on_host_reboot Filter by allow_auto_staging_restart_on_host_reboot --[no-]physical_standby Filter by physical_standby --[no-]validate_by_opening_db_in_read_only_mode Filter by validate_by_opening_db_in_read_only_mode mssql_sync_strategy_managed_type=string Filter by mssql_sync_strategy_managed_type validated_sync_mode=string Filter by validated_sync_mode backup_policy=string Filter by backup_policy --[no-]compression_enabled Filter by compression_enabled staging_database_name=string Filter by staging_database_name db_state=string Filter by db_state encryption_key=string Filter by encryption_key external_netbackup_config_master_name=string Filter by external_netbackup_config_master_name external_netbackup_config_source_client_name=string Filter by external_netbackup_config_source_client_name external_netbackup_config_params=string Filter by external_netbackup_config_params external_netbackup_config_templates=string Filter by external_netbackup_config_templates external_commserve_host_name=string Filter by external_commserve_host_name external_commvault_config_source_client_name=string Filter by external_commvault_config_source_client_name external_commvault_config_staging_client_name=string Filter by external_commvault_config_staging_client_name external_commvault_config_params=string Filter by external_commvault_config_params external_commvault_config_templates=string Filter by external_commvault_config_templates mssql_user_type=string Filter by mssql_user_type domain_user_credential_type=string Filter by domain_user_credential_type mssql_database_username=string Filter by mssql_database_username mssql_user_environment_reference=string Filter by mssql_user_environment_reference mssql_user_domain_username=string Filter by mssql_user_domain_username mssql_user_domain_vault_username=string Filter by mssql_user_domain_vault_username mssql_user_domain_vault=string Filter by mssql_user_domain_vault mssql_user_domain_hashicorp_vault_engine=string Filter by mssql_user_domain_hashicorp_vault_engine mssql_user_domain_hashicorp_vault_secret_path=string Filter by mssql_user_domain_hashicorp_vault_secret_path mssql_user_domain_hashicorp_vault_username_key=string Filter by mssql_user_domain_hashicorp_vault_username_key mssql_user_domain_hashicorp_vault_secret_key=string Filter by mssql_user_domain_hashicorp_vault_secret_key mssql_user_domain_azure_vault_name=string Filter by mssql_user_domain_azure_vault_name mssql_user_domain_azure_vault_username_key=string Filter by mssql_user_domain_azure_vault_username_key mssql_user_domain_azure_vault_secret_key=string Filter by mssql_user_domain_azure_vault_secret_key mssql_user_domain_cyberark_vault_query_string=string Filter by mssql_user_domain_cyberark_vault_query_string --[no-]diagnose_no_logging_faults Filter by diagnose_no_logging_faults --[no-]pre_provisioning_enabled Filter by pre_provisioning_enabled --[no-]backup_level_enabled Filter by backup_level_enabled rman_channels=integer Filter by rman_channels files_per_set=integer Filter by files_per_set --[no-]check_logical Filter by check_logical --[no-]encrypted_linking_enabled Filter by encrypted_linking_enabled --[no-]compressed_linking_enabled Filter by compressed_linking_enabled bandwidth_limit=integer Filter by bandwidth_limit number_of_connections=integer Filter by number_of_connections toolkit_id=string Filter by toolkit_id data_connection_id=string Filter by data_connection_id -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_dsource_by_id ======================================== Usage: dct-toolkit get_dsource_by_id[-hVw] [-cs] [-jh] dsource_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. dsourceId, dsource_id= The ID of the dSource. -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: enable_dsource ======================================== Usage: dct-toolkit enable_dsource[-hVw] dsource_id= [-cs] [-jh] [[[--[no-]attempt_start]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. --[no-]attempt_start Whether to attempt a startup of the source after the enable. --body=PARAM The parameters to enable a dSource. -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: disable_dsource ======================================== Usage: dct-toolkit disable_dsource[-hVw] dsource_id= [-cs] [-jh] [[[--[no-]attempt_cleanup]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. --[no-]attempt_cleanup Whether to attempt a cleanup of the database from the environment before the disable. --body=PARAM The parameters to disable a dSource. -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_upgrade_compatible_repo_for_dsource ======================================== Usage: dct-toolkit get_upgrade_compatible_repo_for_dsource[-hVw] [-cs] [-jh] dsource_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. dsourceId, dsource_id= The ID of the dSource. -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_mssql_dsource_by_id ======================================== Usage: dct-toolkit update_mssql_dsource_by_id[-hVw] dsource_id= [-cs] [-jh] [[[mssql_database_password=string] [hooks. pre_validated_sync=array] [sync_policy_id=string] [external_commserve_host_name=string] [ppt_repository=string] [mssql_user_domain_azure_vault_username_key=string] [mssql_user_domain_username=string] [source_host_user=string] [delphix_managed_backup_policy=string] [mssql_user_environment_reference=string] [--[no-] delphix_managed_backup_compression_enabled] [mssql_user_domain_vault_username=string] [external_commvault_config_templates=string] [ppt_host_user=string] [-- [no-]logsync_enabled] [external_netbackup_config_master_name=string] [external_commvault_config_source_client_name=string] [mssql_user_domain_vault=string] [hooks.post_validated_sync=array] [mssql_user_domain_hashicorp_vault_engine=string] [--[no-] disable_netbackup_config] [mssql_user_domain_password=string] [hooks. ops_post_sync=array] [external_netbackup_config_templates=string] [external_managed_shared_backup_locations=array[,array...]]... [mssql_user_domain_hashicorp_vault_secret_path=string] [external_managed_validate_sync_mode=string] [--[no-] disable_commvault_config] [mssql_user_domain_azure_vault_secret_key=string] [mssql_user_domain_hashicorp_vault_secret_key=string] [mssql_database_username=string] [sync_strategy_managed_type=string] [mssql_user_domain_hashicorp_vault_username_key=string] [mssql_user_domain_cyberark_vault_query_string=string] [hooks. ops_pre_log_sync=array] [external_netbackup_config_source_client_name=string] [retention_policy_id=string] [name=string] [mssql_user_domain_azure_vault_name=string] [encryption_key=string] [hooks.ops_pre_sync=array] [external_commvault_config_staging_client_name=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. mssql_database_password=string Password for the database user. hooks.pre_validated_sync=array The commands to execute on the staging source before performing a validated sync. sync_policy_id=string The ID of the SnapSync policy for the dSource. external_commserve_host_name=string The commserve host name of this Commvault configuration. ppt_repository=string Reference of the SQL instance on the PPT environment that we want to use for pre-provisioning. mssql_user_domain_azure_vault_username_key=string Azure vault key for the username in the key-value store. mssql_user_domain_username=string The username for the source DB user. source_host_user=string ID or user reference of the host OS user to use for linking. delphix_managed_backup_policy=string Values: [primary, secondary_only, prefer_secondary] Specify which node of an availability group to run the copy-only full backup on: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. mssql_user_environment_reference=string Reference to the source environment user to use for linking. --[no-]delphix_managed_backup_compression_enabled Specify whether the backups taken should be compressed or uncompressed when Delphix managed option is selected. mssql_user_domain_vault_username=string Delphix display name for the vault user. external_commvault_config_templates=string Optional config template selection for Commvault configurations. If set, configParams will be ignored. ppt_host_user=string Reference of the host OS user on the PPT host to use for linking. --[no-]logsync_enabled Enabled LogSync for this dSource. external_netbackup_config_master_name=string The master server name of this NetBackup configuration. external_commvault_config_source_client_name=string The source client name of this Commvault configuration. mssql_user_domain_vault=string The name or reference of the vault from which to read the database credentials. hooks.post_validated_sync=array The commands to execute on the staging source after performing a validated sync. mssql_user_domain_hashicorp_vault_engine=string Vault engine name where the credential is stored. --[no-]disable_netbackup_config Disable NetBackup configuration. mssql_user_domain_password=string Password for the database user. hooks.ops_post_sync=array The commands to execute after syncing a linked source. external_netbackup_config_templates=string Optional config template selection for NetBackup configurations. If set, external_netbackup_config_params will be ignored. external_managed_shared_backup_locations=array[,array...] Shared source database backup locations. mssql_user_domain_hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. external_managed_validate_sync_mode=string Values: [TRANSACTION_LOG, FULL_OR_DIFFERENTIAL, FULL, NONE]Specifies the backup types ValidatedSync will use to synchronize the dSource with the source database --[no-]disable_commvault_config Disable Commvault configuration. mssql_user_domain_azure_vault_secret_key=string Azure vault key for the password in the key-value store. mssql_user_domain_hashicorp_vault_secret_key=string Hashicorp vault key for the password in the key-value store. mssql_database_username=string The username for the source DB user. sync_strategy_managed_type=string Values: [external, delphix, staging_push]MSSQL specific parameters for source based sync strategy.: * `external` - MSSQL specific parameters for externally managed source based sync strategy. * `delphix` - MSSQL specific parameters for delphix managed source based sync strategy. * `staging_push` - MSSQL specific parameters for staging push based sync strategy. mssql_user_domain_hashicorp_vault_username_key=string Hashicorp vault key for the username in the key-value store. mssql_user_domain_cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. hooks.ops_pre_log_sync=array The commands to execute after syncing with external data and before running the LogSync. external_netbackup_config_source_client_name=string The source's client server name of this NetBackup configuration. retention_policy_id=string The ID of the Retention policy for the dSource. name=string The unique name of the dSource within a group. mssql_user_domain_azure_vault_name=string Azure key vault name. encryption_key=string The encryption key to use when restoring encrypted backups. hooks.ops_pre_sync=array The commands to execute before syncing with external data. external_commvault_config_staging_client_name=string The staging client name of this Commvault configuration. --body=PARAM The new data to update an MSSql dSource. -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_dsource_snapshots ======================================== Usage: dct-toolkit get_dsource_snapshots[-hVw] [-cs] [-jh] [cursor=] dsource_id= [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. 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. dsourceId, dsource_id= The ID of the dSource. -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. -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: snapshot_dsource ======================================== Usage: dct-toolkit snapshot_dsource[-hVw] dsource_id= [-cs] [-jh] [[[--[no-]drop_and_recreate_devices] [sync_strategy=string] [ase_backup_files=array[,array...]]... [mssql_backup_uuid=string] [--[no-] compression_enabled] [availability_group_backup_policy=string] [--[no-]do_not_resume] [--[no-]double_sync] [--[no-]force_full_backup] [--[no-] skip_space_check] [files_for_partial_full_backup=array[, array...]]... [appdata_parameters=object] [rman_rate_in_MB=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. --[no-]drop_and_recreate_devices If this parameter is set to true, older devices will be dropped and new devices created instead of trying to remap the devices. This might increase the space utilization on Delphix Engine. (ASE only) sync_strategy=string Values: [latest_backup, new_backup, specific_backup]Determines how the Delphix Engine will take a backup: * `latest_backup` - Use the most recent backup. * `new_backup` - Delphix will take a new backup of your source database. * `specific_backup` - Use a specific backup. Using this option requires setting `ase_backup_files` for ASE dSources or `mssql_backup_uuid` for MSSql dSources. Default is `new_backup`. (ASE, MSSql only) ase_backup_files=array[,array...] When using the `specific_backup` sync_strategy, determines the backup files. (ASE Only) mssql_backup_uuid=string When using the `specific_backup` sync_strategy, determines the Backup Set UUID. (MSSql only) --[no-]compression_enabled When using the `new_backup` sync_strategy, determines if compression must be enabled. Defaults to the configuration of the ingestion strategy configured on the Delphix Engine for this dSource. (MSSql only) availability_group_backup_policy=string Values: [primary, secondary_only, prefer_secondary] When using the `new_backup` sync_strategy for an MSSql Availability Group, determines the backup policy: * `primary` - Backups only go to the primary node. * `secondary_only` - Backups only go to secondary nodes. If secondary nodes are down, backups will fail. * `prefer_secondary` - Backups go to secondary nodes, but if secondary nodes are down, backups will go to the primary node. (MSSql only) --[no-]do_not_resume Indicates whether a fresh SnapSync must be started regardless if it was possible to resume the current SnapSync. If true, we will not resume but instead ignore previous progress and backup all datafiles even if already completed from previous failed SnapSync. This does not force a full backup, if an incremental was in progress this will start a new incremental snapshot. (Oracle only) --[no-]double_sync Indicates whether two SnapSyncs should be performed in immediate succession to reduce the number of logs required to provision the snapshot. This may significantly reduce the time necessary to provision from a snapshot. (Oracle only). --[no-]force_full_backup Whether or not to take another full backup of the source database. (Oracle only) --[no-]skip_space_check Skip check that tests if there is enough space available to store the database in the Delphix Engine. The Delphix Engine estimates how much space a database will occupy after compression and prevents SnapSync if insufficient space is available. This safeguard can be overridden using this option. This may be useful when linking highly compressible databases. (Oracle only) files_for_partial_full_backup=array[,array...] List of datafiles to take a full backup of. This would be useful in situations where certain datafiles could not be backed up during previous SnapSync due to corruption or because they went offline. (Oracle only) appdata_parameters=object The list of parameters specified by the snapshotParametersDefinition schema in the toolkit (AppData only). rman_rate_in_MB=integer RMAN rate in megabytes to be used. This is the upper limit for bytes read so that RMAN does not consume excessive disk bandwidth and degrade online performance. (Oracle only) --body=PARAM Optional parameters to snapshot a DSource. -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_dsource_deletion_dependencies ======================================== Usage: dct-toolkit get_dsource_deletion_dependencies[-hVw] [-cs] [-jh] dsource_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. dsourceId, dsource_id= The ID of the dSource. -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_tags_dsource ======================================== Usage: dct-toolkit get_tags_dsource[-hVw] [-cs] [-jh] dsource_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. dsourceId, dsource_id= The ID of the dSource. -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_tags_dsource ======================================== Usage: dct-toolkit create_tags_dsource[-hVw] dsource_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. dsourceId, dsource_id= The ID of the dSource. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for DSource. -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_tags_dsource ======================================== Usage: dct-toolkit delete_tags_dsource[-hVw] dsource_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. dsourceId, dsource_id= The ID of the dSource. 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: export_dsource_to_asm_by_snapshot ======================================== Usage: dct-toolkit export_dsource_to_asm_by_snapshot[-hVw] dsource_id= [-cs] [-jh] ([default_data_diskgroup=string [unique_name=string] [database_name=string] [repository_id=string] [environment_user_ref=string] [tde_keystore_password=string] [tde_keystore_config_type=string] [oracle_instance_name=string] [instance_number=integer] [instances=array] [mount_base=string] [config_params=object] [cdb_id=string] [parent_tde_keystore_path=string] [parent_tde_keystore_password=string] [tde_exported_keyfile_secret=string] [tde_key_identifier=string] [crs_database_name=string] [--[no-]recover_database] [file_mapping_rules=string] [--[no-]enable_cdc] [recovery_model=string] [mirroring_state=string] [redo_diskgroup=string] [rman_channels=integer] [rman_file_section_size_in_gb=integer] [snapshot_id=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. default_data_diskgroup=string Default diskgroup for datafiles. unique_name=string The unique name of the database. database_name=string The name of the database. repository_id=string The repository_id to use for this operation. environment_user_ref=string The environment user reference. tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with this database. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. oracle_instance_name=string SID of the exported database instance_number=integer The number of the instance. instances=array mount_base=string The base mount point to use for the NFS mounts for the temporary VDB. config_params=object Database configuration parameter overrides. cdb_id=string ID of an Oracle multitenant database this pluggable database belongs to. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. tde_exported_keyfile_secret=string Secret to be used while exporting and importing vPDB encryption keys. tde_key_identifier=string Virtual database master encryption key id, as recorded in v$encryption_keys.key_id. crs_database_name=string The Oracle Clusterware database name. --[no-]recover_database If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. file_mapping_rules=string Database file mapping rules. --[no-]enable_cdc Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). recovery_model=string Values: [FULL, SIMPLE, BULK_LOGGED]Recovery model of the database (MSSql Only). mirroring_state=string Values: [SUSPENDED, DISCONNECTED, SYNCHRONIZING, PENDING_FAILOVER, SYNCHRONIZED, NOT_SYNCHRONIZED, FAILOVER_POSSIBLE, NONE] Recovery model of the database (MSSql Only). redo_diskgroup=string Diskgroup for archive logs. Optional as it is not required for PDB databases. rman_channels=integer Number of data streams to connect to the database. rman_file_section_size_in_gb=integer Number of GigaBytes in which RMAN will break large files to back them in parallel. snapshot_id=string The ID of the snapshot from which to execute the operation. If snapshot_id is not provided, the latest snapshot will be selected. --body=PARAM The parameters to export a dSource. -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: export_dsource_by_snapshot ======================================== Usage: dct-toolkit export_dsource_by_snapshot[-hVw] dsource_id= [-cs] [-jh] [[[unique_name=string] [database_name=string] [repository_id=string] [environment_user_ref=string] [tde_keystore_password=string] [tde_keystore_config_type=string] [oracle_instance_name=string] [instance_number=integer] [instances=array] [mount_base=string] [config_params=object] [cdb_id=string] [parent_tde_keystore_path=string] [parent_tde_keystore_password=string] [tde_exported_keyfile_secret=string] [tde_key_identifier=string] [crs_database_name=string] [--[no-]recover_database] [file_mapping_rules=string] [--[no-]enable_cdc] [recovery_model=string] [mirroring_state=string] [targetDirectory=string] [dataDirectory=string] [archiveDirectory=string] [externalDirectory=string] [tempDirectory=string] [scriptDirectory=string] [--[no-] useAbsolutePathForDataFiles] [rman_channels=integer] [rman_file_section_size_in_gb=integer] [snapshot_id=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. unique_name=string The unique name of the database. database_name=string The name of the database. repository_id=string The repository_id to use for this operation. environment_user_ref=string The environment user reference. tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with this database. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. oracle_instance_name=string SID of the exported database instance_number=integer The number of the instance. instances=array mount_base=string The base mount point to use for the NFS mounts for the temporary VDB. config_params=object Database configuration parameter overrides. cdb_id=string ID of an Oracle multitenant database this pluggable database belongs to. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. tde_exported_keyfile_secret=string Secret to be used while exporting and importing vPDB encryption keys. tde_key_identifier=string Virtual database master encryption key id, as recorded in v$encryption_keys.key_id. crs_database_name=string The Oracle Clusterware database name. --[no-]recover_database If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. file_mapping_rules=string Database file mapping rules. --[no-]enable_cdc Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). recovery_model=string Values: [FULL, SIMPLE, BULK_LOGGED]Recovery model of the database (MSSql Only). mirroring_state=string Values: [SUSPENDED, DISCONNECTED, SYNCHRONIZING, PENDING_FAILOVER, SYNCHRONIZED, NOT_SYNCHRONIZED, FAILOVER_POSSIBLE, NONE] Recovery model of the database (MSSql Only). targetDirectory=string The base directory to use for the exported database. dataDirectory=string The directory for data files. archiveDirectory=string The directory for archive files. externalDirectory=string The directory for external files. tempDirectory=string The directory for temporary files. scriptDirectory=string The directory for script files. --[no-]useAbsolutePathForDataFiles Whether to use absolute path for data files (Oracle only). rman_channels=integer Number of data streams to connect to the database. rman_file_section_size_in_gb=integer Number of GigaBytes in which RMAN will break large files to back them in parallel. snapshot_id=string The ID of the snapshot from which to execute the operation. If snapshot_id is not provided, the latest snapshot will be selected. --body=PARAM The parameters to export a dSource. -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: export_dsource_to_asm_by_location ======================================== Usage: dct-toolkit export_dsource_to_asm_by_location[-hVw] dsource_id= [-cs] [-jh] ([default_data_diskgroup=string location=string [unique_name=string] [database_name=string] [repository_id=string] [environment_user_ref=string] [tde_keystore_password=string] [tde_keystore_config_type=string] [oracle_instance_name=string] [instance_number=integer] [instances=array] [mount_base=string] [config_params=object] [cdb_id=string] [parent_tde_keystore_path=string] [parent_tde_keystore_password=string] [tde_exported_keyfile_secret=string] [tde_key_identifier=string] [crs_database_name=string] [--[no-]recover_database] [file_mapping_rules=string] [--[no-]enable_cdc] [recovery_model=string] [mirroring_state=string] [redo_diskgroup=string] [rman_channels=integer] [rman_file_section_size_in_gb=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. default_data_diskgroup=string Default diskgroup for datafiles. location=string The SCN value in the snapshot to perform the export from this SCN location. unique_name=string The unique name of the database. database_name=string The name of the database. repository_id=string The repository_id to use for this operation. environment_user_ref=string The environment user reference. tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with this database. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. oracle_instance_name=string SID of the exported database instance_number=integer The number of the instance. instances=array mount_base=string The base mount point to use for the NFS mounts for the temporary VDB. config_params=object Database configuration parameter overrides. cdb_id=string ID of an Oracle multitenant database this pluggable database belongs to. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. tde_exported_keyfile_secret=string Secret to be used while exporting and importing vPDB encryption keys. tde_key_identifier=string Virtual database master encryption key id, as recorded in v$encryption_keys.key_id. crs_database_name=string The Oracle Clusterware database name. --[no-]recover_database If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. file_mapping_rules=string Database file mapping rules. --[no-]enable_cdc Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). recovery_model=string Values: [FULL, SIMPLE, BULK_LOGGED]Recovery model of the database (MSSql Only). mirroring_state=string Values: [SUSPENDED, DISCONNECTED, SYNCHRONIZING, PENDING_FAILOVER, SYNCHRONIZED, NOT_SYNCHRONIZED, FAILOVER_POSSIBLE, NONE] Recovery model of the database (MSSql Only). redo_diskgroup=string Diskgroup for archive logs. Optional as it is not required for PDB databases. rman_channels=integer Number of data streams to connect to the database. rman_file_section_size_in_gb=integer Number of GigaBytes in which RMAN will break large files to back them in parallel. --body=PARAM The parameters to export a dSource. -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: export_dsource_to_asm_by_bookmark ======================================== Usage: dct-toolkit export_dsource_to_asm_by_bookmark[-hVw] dsource_id= [-cs] [-jh] ([bookmark_id=string default_data_diskgroup=string [unique_name=string] [database_name=string] [repository_id=string] [environment_user_ref=string] [tde_keystore_password=string] [tde_keystore_config_type=string] [oracle_instance_name=string] [instance_number=integer] [instances=array] [mount_base=string] [config_params=object] [cdb_id=string] [parent_tde_keystore_path=string] [parent_tde_keystore_password=string] [tde_exported_keyfile_secret=string] [tde_key_identifier=string] [crs_database_name=string] [--[no-]recover_database] [file_mapping_rules=string] [--[no-]enable_cdc] [recovery_model=string] [mirroring_state=string] [redo_diskgroup=string] [rman_channels=integer] [rman_file_section_size_in_gb=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. bookmark_id=string The ID of the bookmark from which to execute the operation. default_data_diskgroup=string Default diskgroup for datafiles. unique_name=string The unique name of the database. database_name=string The name of the database. repository_id=string The repository_id to use for this operation. environment_user_ref=string The environment user reference. tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with this database. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. oracle_instance_name=string SID of the exported database instance_number=integer The number of the instance. instances=array mount_base=string The base mount point to use for the NFS mounts for the temporary VDB. config_params=object Database configuration parameter overrides. cdb_id=string ID of an Oracle multitenant database this pluggable database belongs to. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. tde_exported_keyfile_secret=string Secret to be used while exporting and importing vPDB encryption keys. tde_key_identifier=string Virtual database master encryption key id, as recorded in v$encryption_keys.key_id. crs_database_name=string The Oracle Clusterware database name. --[no-]recover_database If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. file_mapping_rules=string Database file mapping rules. --[no-]enable_cdc Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). recovery_model=string Values: [FULL, SIMPLE, BULK_LOGGED]Recovery model of the database (MSSql Only). mirroring_state=string Values: [SUSPENDED, DISCONNECTED, SYNCHRONIZING, PENDING_FAILOVER, SYNCHRONIZED, NOT_SYNCHRONIZED, FAILOVER_POSSIBLE, NONE] Recovery model of the database (MSSql Only). redo_diskgroup=string Diskgroup for archive logs. Optional as it is not required for PDB databases. rman_channels=integer Number of data streams to connect to the database. rman_file_section_size_in_gb=integer Number of GigaBytes in which RMAN will break large files to back them in parallel. --body=PARAM The parameters to export a dSource. -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: export_dsource_from_bookmark ======================================== Usage: dct-toolkit export_dsource_from_bookmark[-hVw] dsource_id= [-cs] [-jh] ([bookmark_id=string [unique_name=string] [database_name=string] [repository_id=string] [environment_user_ref=string] [tde_keystore_password=string] [tde_keystore_config_type=string] [oracle_instance_name=string] [instance_number=integer] [instances=array] [mount_base=string] [config_params=object] [cdb_id=string] [parent_tde_keystore_path=string] [parent_tde_keystore_password=string] [tde_exported_keyfile_secret=string] [tde_key_identifier=string] [crs_database_name=string] [--[no-]recover_database] [file_mapping_rules=string] [--[no-]enable_cdc] [recovery_model=string] [mirroring_state=string] [targetDirectory=string] [dataDirectory=string] [archiveDirectory=string] [externalDirectory=string] [tempDirectory=string] [scriptDirectory=string] [--[no-] useAbsolutePathForDataFiles] [rman_channels=integer] [rman_file_section_size_in_gb=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. bookmark_id=string The ID of the bookmark from which to execute the operation. unique_name=string The unique name of the database. database_name=string The name of the database. repository_id=string The repository_id to use for this operation. environment_user_ref=string The environment user reference. tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with this database. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. oracle_instance_name=string SID of the exported database instance_number=integer The number of the instance. instances=array mount_base=string The base mount point to use for the NFS mounts for the temporary VDB. config_params=object Database configuration parameter overrides. cdb_id=string ID of an Oracle multitenant database this pluggable database belongs to. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. tde_exported_keyfile_secret=string Secret to be used while exporting and importing vPDB encryption keys. tde_key_identifier=string Virtual database master encryption key id, as recorded in v$encryption_keys.key_id. crs_database_name=string The Oracle Clusterware database name. --[no-]recover_database If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. file_mapping_rules=string Database file mapping rules. --[no-]enable_cdc Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). recovery_model=string Values: [FULL, SIMPLE, BULK_LOGGED]Recovery model of the database (MSSql Only). mirroring_state=string Values: [SUSPENDED, DISCONNECTED, SYNCHRONIZING, PENDING_FAILOVER, SYNCHRONIZED, NOT_SYNCHRONIZED, FAILOVER_POSSIBLE, NONE] Recovery model of the database (MSSql Only). targetDirectory=string The base directory to use for the exported database. dataDirectory=string The directory for data files. archiveDirectory=string The directory for archive files. externalDirectory=string The directory for external files. tempDirectory=string The directory for temporary files. scriptDirectory=string The directory for script files. --[no-]useAbsolutePathForDataFiles Whether to use absolute path for data files (Oracle only). rman_channels=integer Number of data streams to connect to the database. rman_file_section_size_in_gb=integer Number of GigaBytes in which RMAN will break large files to back them in parallel. --body=PARAM The parameters to export a dSource. -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: export_dsource_to_asm_by_timestamp ======================================== Usage: dct-toolkit export_dsource_to_asm_by_timestamp[-hVw] dsource_id= [-cs] [-jh] ([timeflow_id=string default_data_diskgroup=string timestamp=string [unique_name=string] [database_name=string] [repository_id=string] [environment_user_ref=string] [tde_keystore_password=string] [tde_keystore_config_type=string] [oracle_instance_name=string] [instance_number=integer] [instances=array] [mount_base=string] [config_params=object] [cdb_id=string] [parent_tde_keystore_path=string] [parent_tde_keystore_password=string] [tde_exported_keyfile_secret=string] [tde_key_identifier=string] [crs_database_name=string] [--[no-]recover_database] [file_mapping_rules=string] [--[no-]enable_cdc] [recovery_model=string] [mirroring_state=string] [redo_diskgroup=string] [rman_channels=integer] [rman_file_section_size_in_gb=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. timeflow_id=string The Timeflow ID. default_data_diskgroup=string Default diskgroup for datafiles. timestamp=string The timestamp at which to execute the operation. unique_name=string The unique name of the database. database_name=string The name of the database. repository_id=string The repository_id to use for this operation. environment_user_ref=string The environment user reference. tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with this database. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. oracle_instance_name=string SID of the exported database instance_number=integer The number of the instance. instances=array mount_base=string The base mount point to use for the NFS mounts for the temporary VDB. config_params=object Database configuration parameter overrides. cdb_id=string ID of an Oracle multitenant database this pluggable database belongs to. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. tde_exported_keyfile_secret=string Secret to be used while exporting and importing vPDB encryption keys. tde_key_identifier=string Virtual database master encryption key id, as recorded in v$encryption_keys.key_id. crs_database_name=string The Oracle Clusterware database name. --[no-]recover_database If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. file_mapping_rules=string Database file mapping rules. --[no-]enable_cdc Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). recovery_model=string Values: [FULL, SIMPLE, BULK_LOGGED]Recovery model of the database (MSSql Only). mirroring_state=string Values: [SUSPENDED, DISCONNECTED, SYNCHRONIZING, PENDING_FAILOVER, SYNCHRONIZED, NOT_SYNCHRONIZED, FAILOVER_POSSIBLE, NONE] Recovery model of the database (MSSql Only). redo_diskgroup=string Diskgroup for archive logs. Optional as it is not required for PDB databases. rman_channels=integer Number of data streams to connect to the database. rman_file_section_size_in_gb=integer Number of GigaBytes in which RMAN will break large files to back them in parallel. --body=PARAM The parameters to export a dSource. -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: export_dsource_by_timestamp ======================================== Usage: dct-toolkit export_dsource_by_timestamp[-hVw] dsource_id= [-cs] [-jh] ([timeflow_id=string timestamp=string [unique_name=string] [database_name=string] [repository_id=string] [environment_user_ref=string] [tde_keystore_password=string] [tde_keystore_config_type=string] [oracle_instance_name=string] [instance_number=integer] [instances=array] [mount_base=string] [config_params=object] [cdb_id=string] [parent_tde_keystore_path=string] [parent_tde_keystore_password=string] [tde_exported_keyfile_secret=string] [tde_key_identifier=string] [crs_database_name=string] [--[no-]recover_database] [file_mapping_rules=string] [--[no-]enable_cdc] [recovery_model=string] [mirroring_state=string] [targetDirectory=string] [dataDirectory=string] [archiveDirectory=string] [externalDirectory=string] [tempDirectory=string] [scriptDirectory=string] [--[no-] useAbsolutePathForDataFiles] [rman_channels=integer] [rman_file_section_size_in_gb=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. timeflow_id=string The Timeflow ID. timestamp=string The timestamp at which to execute the operation. unique_name=string The unique name of the database. database_name=string The name of the database. repository_id=string The repository_id to use for this operation. environment_user_ref=string The environment user reference. tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with this database. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. oracle_instance_name=string SID of the exported database instance_number=integer The number of the instance. instances=array mount_base=string The base mount point to use for the NFS mounts for the temporary VDB. config_params=object Database configuration parameter overrides. cdb_id=string ID of an Oracle multitenant database this pluggable database belongs to. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. tde_exported_keyfile_secret=string Secret to be used while exporting and importing vPDB encryption keys. tde_key_identifier=string Virtual database master encryption key id, as recorded in v$encryption_keys.key_id. crs_database_name=string The Oracle Clusterware database name. --[no-]recover_database If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. file_mapping_rules=string Database file mapping rules. --[no-]enable_cdc Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). recovery_model=string Values: [FULL, SIMPLE, BULK_LOGGED]Recovery model of the database (MSSql Only). mirroring_state=string Values: [SUSPENDED, DISCONNECTED, SYNCHRONIZING, PENDING_FAILOVER, SYNCHRONIZED, NOT_SYNCHRONIZED, FAILOVER_POSSIBLE, NONE] Recovery model of the database (MSSql Only). targetDirectory=string The base directory to use for the exported database. dataDirectory=string The directory for data files. archiveDirectory=string The directory for archive files. externalDirectory=string The directory for external files. tempDirectory=string The directory for temporary files. scriptDirectory=string The directory for script files. --[no-]useAbsolutePathForDataFiles Whether to use absolute path for data files (Oracle only). rman_channels=integer Number of data streams to connect to the database. rman_file_section_size_in_gb=integer Number of GigaBytes in which RMAN will break large files to back them in parallel. --body=PARAM The parameters to export a dSource. -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: export_dsource_by_location ======================================== Usage: dct-toolkit export_dsource_by_location[-hVw] dsource_id= [-cs] [-jh] ([location=string [unique_name=string] [database_name=string] [repository_id=string] [environment_user_ref=string] [tde_keystore_password=string] [tde_keystore_config_type=string] [oracle_instance_name=string] [instance_number=integer] [instances=array] [mount_base=string] [config_params=object] [cdb_id=string] [parent_tde_keystore_path=string] [parent_tde_keystore_password=string] [tde_exported_keyfile_secret=string] [tde_key_identifier=string] [crs_database_name=string] [--[no-]recover_database] [file_mapping_rules=string] [--[no-]enable_cdc] [recovery_model=string] [mirroring_state=string] [targetDirectory=string] [dataDirectory=string] [archiveDirectory=string] [externalDirectory=string] [tempDirectory=string] [scriptDirectory=string] [--[no-] useAbsolutePathForDataFiles] [rman_channels=integer] [rman_file_section_size_in_gb=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dsourceId, dsource_id= The ID of the dSource. location=string The timeflow point location to execute the operation. unique_name=string The unique name of the database. database_name=string The name of the database. repository_id=string The repository_id to use for this operation. environment_user_ref=string The environment user reference. tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with this database. tde_keystore_config_type=string Values: [FILE, OKV, HSM, OKV|FILE, FILE|OKV, HSM|FILE, FILE|HSM, OCI_VAULT]Oracle TDE keystore configuration type. oracle_instance_name=string SID of the exported database instance_number=integer The number of the instance. instances=array mount_base=string The base mount point to use for the NFS mounts for the temporary VDB. config_params=object Database configuration parameter overrides. cdb_id=string ID of an Oracle multitenant database this pluggable database belongs to. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. tde_exported_keyfile_secret=string Secret to be used while exporting and importing vPDB encryption keys. tde_key_identifier=string Virtual database master encryption key id, as recorded in v$encryption_keys.key_id. crs_database_name=string The Oracle Clusterware database name. --[no-]recover_database If specified, then take the exported database through recovery procedures, if necessary, to reach a consistent point. file_mapping_rules=string Database file mapping rules. --[no-]enable_cdc Indicates whether to enable Change Data Capture (CDC) or not on exported database(MSSql Only). recovery_model=string Values: [FULL, SIMPLE, BULK_LOGGED]Recovery model of the database (MSSql Only). mirroring_state=string Values: [SUSPENDED, DISCONNECTED, SYNCHRONIZING, PENDING_FAILOVER, SYNCHRONIZED, NOT_SYNCHRONIZED, FAILOVER_POSSIBLE, NONE] Recovery model of the database (MSSql Only). targetDirectory=string The base directory to use for the exported database. dataDirectory=string The directory for data files. archiveDirectory=string The directory for archive files. externalDirectory=string The directory for external files. tempDirectory=string The directory for temporary files. scriptDirectory=string The directory for script files. --[no-]useAbsolutePathForDataFiles Whether to use absolute path for data files (Oracle only). rman_channels=integer Number of data streams to connect to the database. rman_file_section_size_in_gb=integer Number of GigaBytes in which RMAN will break large files to back them in parallel. --body=PARAM The parameters to export a dSource. -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 ========================================