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: VCDBs ================================================================================ Commands (16): get_vcdbs, search_vcdbs, get_vcdb_by_id, update_vcdb, get_tags_vcdb, create_vcdb_tags, delete_vcdb_tags, enable_vcdb, disable_vcdb, get_vcdb_deletion_dependencies, delete_vcdb, update_vcdb_by_id, start_vcdb, stop_vcdb, upgrade_vcdb, verify_vcdb_jdbc_connection_string COMMAND: get_vcdbs ======================================== Usage: dct-toolkit get_vcdbs[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_vcdbs ======================================== Usage: dct-toolkit search_vcdbs[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [database_name=string] [database_version=string] [environment_id=string] [size=integer] [engine_id=string] [status=string] [parent_id=string] [creation_date=string] [group_name=string] [--[no-]enabled] [content_type=string] [namespace_id=string] [namespace_name=string] [--[no-]is_replica] [-- [no-]vcdb_restart] [--[no-]invoke_datapatch] [node_listeners=array[string]] [instance_name=string] [instance_number=integer] [repository_id=string] [containerization_state=string] [tde_key_identifier=string] [tde_keystore_config_type=string] [--[no-] is_tde_keystore_password_set] [database_unique_name=string] [db_username=string] [redo_log_groups=integer] [redo_log_size_in_mb=integer] [nfs_version=integer] [nfs_version_reason=string] [--[no-] nfs_encryption_enabled]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name database_name=string Filter by database_name database_version=string Filter by database_version environment_id=string Filter by environment_id size=integer Filter by size engine_id=string Filter by engine_id status=string Filter by status parent_id=string Filter by parent_id creation_date=string Filter by creation_date group_name=string Filter by group_name --[no-]enabled Filter by enabled content_type=string Filter by content_type namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica --[no-]vcdb_restart Filter by vcdb_restart --[no-]invoke_datapatch Filter by invoke_datapatch node_listeners=array[string] Filter by node_listeners instance_name=string Filter by instance_name instance_number=integer Filter by instance_number repository_id=string Filter by repository_id containerization_state=string Filter by containerization_state tde_key_identifier=string Filter by tde_key_identifier tde_keystore_config_type=string Filter by tde_keystore_config_type --[no-]is_tde_keystore_password_set Filter by is_tde_keystore_password_set database_unique_name=string Filter by database_unique_name db_username=string Filter by db_username redo_log_groups=integer Filter by redo_log_groups redo_log_size_in_mb=integer Filter by redo_log_size_in_mb nfs_version=integer Filter by nfs_version nfs_version_reason=string Filter by nfs_version_reason --[no-]nfs_encryption_enabled Filter by nfs_encryption_enabled -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_vcdb_by_id ======================================== Usage: dct-toolkit get_vcdb_by_id[-hVw] [-cs] [-jh] vcdb_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. -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_vcdb ======================================== Usage: dct-toolkit update_vcdb[-hVw] vcdb_id= [-cs] [-jh] [[[oracle_services=array[,array...]]... [instances=array] [node_listeners=array[, array...]]... [--[no-]invoke_datapatch] [tde_keystore_password=string] [tde_keystore_config_type=string] [tde_key_identifier=string] [db_username=string] [db_password=string] [--[no-]auto_restart] [environment_user_id=string] [config_params=object] [custom_env_vars [=object...]]... [custom_env_files=array[, array...]]... [oracle_rac_custom_env_files=array] [oracle_rac_custom_env_vars=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. oracle_services=array[,array...] List of jdbc connection strings which are used to connect with the database. instances=array The instances of this RAC database. node_listeners=array[,array...] The list of node listener ids for this VCDB. --[no-]invoke_datapatch Indicates whether datapatch should be invoked. tde_keystore_password=string For a vCDB using software keystore, this is the password of the software keystore used by this database. For a vCDB using OKV, this is the password for the endpoint provided during the installation of the Oracle Key Vault client library (i.e., okvclient.jar) on the host where this database runs. For a vCDB using HSM, this is the credential of the external key manager which is managing master encryption keys of 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. tde_key_identifier=string The master encryption key id of this database. db_username=string The username of the database user. db_password=string The password of the database user. --[no-]auto_restart Whether to enable VDB restart. environment_user_id=string The environment user ID to use to connect to the target environment. config_params=object Database configuration parameter overrides. custom_env_vars[=object...] Environment variable to be set when the engine administers a VCDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VCDB is disabled. custom_env_files=array[,array...] Environment files to be sourced when the Engine administers a VCDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VCDB is disabled. oracle_rac_custom_env_files=array Environment files to be sourced when the Engine administers an Oracle RAC VCDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VCDB is disabled. oracle_rac_custom_env_vars=array Environment variable to be set when the engine administers an Oracle RAC VCDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VCDB is disabled. --body=PARAM The parameters to update a VCDB. -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_tags_vcdb ======================================== Usage: dct-toolkit get_tags_vcdb[-hVw] [-cs] [-jh] vcdb_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. -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_vcdb_tags ======================================== Usage: dct-toolkit create_vcdb_tags[-hVw] vcdb_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. vcdbId, vcdb_id= The ID of the vCDB. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for vCDB. -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_vcdb_tags ======================================== Usage: dct-toolkit delete_vcdb_tags[-hVw] vcdb_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. vcdbId, vcdb_id= The ID of the vCDB. 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: enable_vcdb ======================================== Usage: dct-toolkit enable_vcdb[-hVw] vcdb_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. vcdbId, vcdb_id= The ID of the vCDB. --[no-]attempt_start Whether to attempt a startup of the vCDB after the enable. --body=PARAM The parameters to enable a vCDB. -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_vcdb ======================================== Usage: dct-toolkit disable_vcdb[-hVw] vcdb_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. vcdbId, vcdb_id= The ID of the vCDB. --[no-]attempt_cleanup Whether to attempt a cleanup of the vCDB before the disable. --body=PARAM The parameters to disable a vCDB. -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_vcdb_deletion_dependencies ======================================== Usage: dct-toolkit get_vcdb_deletion_dependencies[-hVw] [-cs] [-jh] vcdb_id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: delete_vcdb ======================================== Usage: dct-toolkit delete_vcdb[-hVw] vcdb_id= [-cs] [-jh] [[[--[no-] force] [--[no-]delete_all_dependent_datasets]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. --[no-]force Whether to continue the operation upon failures. --[no-]delete_all_dependent_datasets Whether to delete all dependent datasets of the CDB. --body=PARAM The parameters to delete a vCDB. -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_vcdb_by_id ======================================== Usage: dct-toolkit update_vcdb_by_id[-hVw] vcdb_id= [-cs] [-jh] [[[oracle_services=array[,array...]]... [instances=array] [node_listeners=array[, array...]]... [--[no-]invoke_datapatch] [tde_keystore_password=string] [tde_keystore_config_type=string] [tde_key_identifier=string] [db_username=string] [db_password=string] [--[no-]auto_restart] [environment_user_id=string] [config_params=object] [custom_env_vars [=object...]]... [custom_env_files=array[, array...]]... [oracle_rac_custom_env_files=array] [oracle_rac_custom_env_vars=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. oracle_services=array[,array...] List of jdbc connection strings which are used to connect with the database. instances=array The instances of this RAC database. node_listeners=array[,array...] The list of node listener ids for this VCDB. --[no-]invoke_datapatch Indicates whether datapatch should be invoked. tde_keystore_password=string For a vCDB using software keystore, this is the password of the software keystore used by this database. For a vCDB using OKV, this is the password for the endpoint provided during the installation of the Oracle Key Vault client library (i.e., okvclient.jar) on the host where this database runs. For a vCDB using HSM, this is the credential of the external key manager which is managing master encryption keys of 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. tde_key_identifier=string The master encryption key id of this database. db_username=string The username of the database user. db_password=string The password of the database user. --[no-]auto_restart Whether to enable VDB restart. environment_user_id=string The environment user ID to use to connect to the target environment. config_params=object Database configuration parameter overrides. custom_env_vars[=object...] Environment variable to be set when the engine administers a VCDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VCDB is disabled. custom_env_files=array[,array...] Environment files to be sourced when the Engine administers a VCDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VCDB is disabled. oracle_rac_custom_env_files=array Environment files to be sourced when the Engine administers an Oracle RAC VCDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VCDB is disabled. oracle_rac_custom_env_vars=array Environment variable to be set when the engine administers an Oracle RAC VCDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution. Custom environment variables can only be updated while the VCDB is disabled. --body=PARAM The parameters to update a VCDB. -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: start_vcdb ======================================== Usage: dct-toolkit start_vcdb[-hVw] vcdb_id= [-cs] [-jh] [[[instances=array[,array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. instances=array[,array...] List of specific Virtual Container Database Instances to start. --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: stop_vcdb ======================================== Usage: dct-toolkit stop_vcdb[-hVw] vcdb_id= [-cs] [-jh] [[[instances=array[,array...]]... [--[no-]abort]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. instances=array[,array...] List of specific Virtual Container Database Instances to stop. --[no-]abort Whether to issue 'shutdown abort' to shutdown Virtual Container DB instances. --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: upgrade_vcdb ======================================== Usage: dct-toolkit upgrade_vcdb[-hVw] vcdb_id= [-cs] [-jh] ([environment_user_id=string repository_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. vcdbId, vcdb_id= The ID of the vCDB. environment_user_id=string Reference of the environment user to use for CDB/vCDB upgrade. repository_id=string The id of the CDB/vCDB repository to upgrade to. --body=PARAM The new data to upgrade an Oracle vCDB. -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: verify_vcdb_jdbc_connection_string ======================================== Usage: dct-toolkit verify_vcdb_jdbc_connection_string[-hVw] vcdb_id= [-cs] [-jh] ([jdbc_connection_string=string database_username=string database_password=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vcdbId, vcdb_id= The ID of the vCDB. jdbc_connection_string=string Oracle jdbc connection string to validate. database_username=string oracle database username. database_password=string oracle database password. --body=PARAM The parameters to verify oracle jdbc connection string. -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 ========================================