DCT-TOOLKIT COMMAND TOPICS (grouped output) Generated on: Tue Oct 21 12:26:59 USEDT 2025 Source: dct-toolkit-help-2025.5.txt ================================================================================ ================================================================================ TOPIC: Accounts ================================================================================ Commands (19): get_accounts, create_account, api_key_reset, api_key_delete, api-key-regenerate, get_account, update_account, delete_account, enable_account, disable, change_account_password, reset_account_password, get_account_tags, create_account_tags, delete_account_tags, get_account_ui_profiles, get_password_policies, update_password_policies, search_accounts COMMAND: get_accounts ======================================== Usage: dct-toolkit get_accounts[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_account ======================================== Usage: dct-toolkit create_account[-hVw] [-cs] [-jh] [[[--[no-]is_admin] [-- [no-]generate_api_key] [api_client_id=string] [first_name=string] [last_name=string] [email=string] [username=string] [password=string] [ldap_principal=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. --[no-]is_admin Whether the created account must be granted to admin role. --[no-]generate_api_key Whether an API key must be generated for this Account. This must be set if the Account will be used for API key based authentication, and unset otherwise. api_client_id=string The unique ID which is used to identify the identity of an API request. The web server (nginx) configuration must be configured so as to include the external ID as the value of the X_CLIENT_ID HTTP request header when requests are proxied. If this value isn't set, the application will automatically generate one. For OAuth2/JWT based authentication, this typically corresponds to a value extracted from the JWT, uniquely identifying the Account. first_name=string An optional first name for the Account. last_name=string An optional last name for the Account. email=string An optional email for the Account. username=string The username for username/password authentication. This can also be used to provide an optional logical name for the Account. password=string The password for username/password authentication. ldap_principal=string This value will be used for linking this account to an LDAP user when authenticated with the same LDAP principal. When accounts authenticate with LDAP, an LDAP principal value is calculated based on the username, msad_domain_name, search_base and username_pattern. tags[=array...] The tags to be created for this Account. --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: api_key_reset ======================================== Usage: dct-toolkit api_key_reset[-hVw] [-cs] [-jh] 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. id= Numeric ID of the Account. -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: api_key_delete ======================================== Usage: dct-toolkit api_key_delete[-hVw] [-cs] [-jh] 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. id= Numeric ID of the Account. -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: api-key-regenerate ======================================== Usage: dct-toolkit api-key-regenerate[-hVw] [-cs] [-jh] ([token=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. token=string Current api key for the account --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_account ======================================== Usage: dct-toolkit get_account[-hVw] [-cs] [-jh] 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. id= Numeric ID of the Account. -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_account ======================================== Usage: dct-toolkit update_account[-hVw] id= [-cs] [-jh] [[[api_client_id=string] [first_name=string] [last_name=string] [email=string] [username=string] [ldap_principal=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. id= Numeric ID of the Account. api_client_id=string The unique ID which is used to identify the identity of an API request. The web server (nginx) configuration must be configured so as to include the external ID as the value of the X_CLIENT_ID HTTP request header when requests are proxied. For OAuth2/JWT based authentication, this typically corresponds to a value extracted from the JWT, uniquely identifying the Account. first_name=string An optional first name for the Account. last_name=string An optional last name for the Account. email=string An optional email for the Account. username=string The username for username/password authentication. This can also be used to provide an optional logical name for the Account. ldap_principal=string This value will be used for linking this account to an LDAP user when authenticated with the same LDAP principal. When accounts authenticate with LDAP, an LDAP principal value is calculated based on the username, msad_domain_name, search_base and username_pattern. --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_account ======================================== Usage: dct-toolkit delete_account[-hVw] [-cs] [-jh] 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. id= Numeric ID of the Account. -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_account ======================================== Usage: dct-toolkit enable_account[-hVw] [-cs] [-jh] 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. id= Numeric ID of the Account. -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: disable ======================================== Usage: dct-toolkit disable[-hVw] [-cs] [-jh] 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. id= Numeric ID of the Account. -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: change_account_password ======================================== Usage: dct-toolkit change_account_password[-hVw] id= [-cs] [-jh] ([old_password=string [new_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. id= Numeric ID of the Account. old_password=string Old password that needs to be changed for the Account. new_password=string New password that needs to be set for the Account. Set this to null for unsetting the current password. Not including this property also results in unsetting of the current password. --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: reset_account_password ======================================== Usage: dct-toolkit reset_account_password[-hVw] id= [-cs] [-jh] [[[new_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. id= Numeric ID of the Account. new_password=string New password that needs to be set for the Account. Set this to null for unsetting the current password. Not including this property also results in unsetting of the current password. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_account_tags ======================================== Usage: dct-toolkit get_account_tags[-hVw] [-cs] [-jh] 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. id= Numeric ID of the Account. -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_account_tags ======================================== Usage: dct-toolkit create_account_tags[-hVw] 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. id= Numeric ID of the Account. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Account. -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_account_tags ======================================== Usage: dct-toolkit delete_account_tags[-hVw] 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. id= Numeric ID of the Account. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_account_ui_profiles ======================================== Usage: dct-toolkit get_account_ui_profiles[-hVw] [-cs] [-jh] 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. id= Numeric ID of the Account. -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_password_policies ======================================== Usage: dct-toolkit get_password_policies[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_password_policies ======================================== Usage: dct-toolkit update_password_policies[-hVw] [-cs] [-jh] [[[--[no-] enabled] [min_length=integer] [reuse_disallow_limit=integer] [--[no-] digit] [--[no-]uppercase_letter] [--[no-]lowercase_letter] [--[no-] special_character] [--[no-]disallow_username_as_password] [maximum_password_attempts=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled True if password policies are enforced/enabled. min_length=integer Minimum length for password. reuse_disallow_limit=integer The password can not be the same as any of the previous n passwords. --[no-]digit Mandate at least one digit in password. --[no-]uppercase_letter Mandate at least one uppercase letter in password. --[no-]lowercase_letter Mandate at least one lower letter in password. --[no-]special_character Mandate at least one special character in password. --[no-]disallow_username_as_password Disallows password containing case-insensitive user name or reversed user name. maximum_password_attempts=integer The number of allowed attempts for incorrect password, after which the account gets locked. --body=PARAM The parameters to update the password policies. -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_accounts ======================================== Usage: dct-toolkit search_accounts[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [first_name=string] [last_name=string] [email=string] [username=string] [last_access_time=string] [creation_time=string] [--[no-]enabled] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id first_name=string Filter by first_name last_name=string Filter by last_name email=string Filter by email username=string Filter by username last_access_time=string Filter by last_access_time creation_time=string Filter by creation_time --[no-]enabled Filter by enabled tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: AiGenerate ================================================================================ Commands (6): get_all_generate_operations, generate_data, search_all_generate_operations, get_generate_operation, get_generate_values, download_generate_values COMMAND: get_all_generate_operations ======================================== Usage: dct-toolkit get_all_generate_operations[-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 a 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: generate_data ======================================== Usage: dct-toolkit generate_data[-hVw] [-cs] [-jh] ([name=string data_type=string --[no-]multiline_values [description=string] [attributes=array] [max_value_length=integer] [requested_count=integer] [filter_characters=string] [--[no-] allow_duplicates] [--[no-]trim_values] [retention_time=integer] [error_tolerance=integer] [priority=integer]] | [--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 A name for this data generation request. This name will be used for the generated file, if requested. data_type=string The type of data to generate --[no-]multiline_values Whether to allow generation of multiline values. Values generated with this setting true cannot be exported to secure lookup files. When this value is false, multiline values are rejected. description=string An optional description for this data generation request attributes=array Attributes to use when generating some values. For each attribute, generation will iterate over each value, so each attribute value will apply to a subset of the generated values. An empty "" in the values list will cause generation skip this attribute for some generated values. max_value_length=integer The maximum length in characters for each generated value. Generated values which are too long are discarded. The default value depends on whether multiline_values is enabled. requested_count=integer The number of values to generate filter_characters=string A Java regular expression that matches each character to filter from the generated values. --[no-]allow_duplicates Whether to allow duplicate values in the generated value list --[no-]trim_values Whether to trim leading and trailing whitespace from generated values. retention_time=integer The length of time, in seconds, that generated values should be made available in the API. Values will always be available while the generated request is running. No value means data will be retained indefinitely. error_tolerance=integer The quantity of unusable, duplicate or failed LLM prompts allowed before the generate operation will fail. This value is expressed as a percentage multiple of total expected number of prompts need to complete the generate operation. Given the high likelihood of duplicate values, this value should not be decreased unless it is critical to time/resource bound the generate operation. priority=integer The request priority, where higher values mean higher priority. This will typically be 0 for bulk operations and 1 for sample generation. --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_all_generate_operations ======================================== Usage: dct-toolkit search_all_generate_operations[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [status=string] [data_type=string] [description=string] [max_value_length=integer] [requested_count=integer] [generated_count=integer] [--[no-]allow_duplicates] [--[no-] filter_characters] [--[no-]trim_values] [--[no-]multiline_values] [submit_time=string] [start_time=string] [end_time=string] [expiration_time=string] [error_tolerance=integer] [llm_model_name=string] [priority=integer]]] [-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 a 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 status=string Filter by status data_type=string Filter by data_type description=string Filter by description max_value_length=integer Filter by max_value_length requested_count=integer Filter by requested_count generated_count=integer Filter by generated_count --[no-]allow_duplicates Filter by allow_duplicates --[no-]filter_characters Filter by filter_characters --[no-]trim_values Filter by trim_values --[no-]multiline_values Filter by multiline_values submit_time=string Filter by submit_time start_time=string Filter by start_time end_time=string Filter by end_time expiration_time=string Filter by expiration_time error_tolerance=integer Filter by error_tolerance llm_model_name=string Filter by llm_model_name priority=integer Filter by priority -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_generate_operation ======================================== Usage: dct-toolkit get_generate_operation[-hVw] [-cs] [-jh] generate_data_operation_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. generateDataOperationId, generate_data_operation_id= The id of the generate data operation -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_generate_values ======================================== Usage: dct-toolkit get_generate_values[-hVw] [-cs] [-jh] [cursor=] generate_data_operation_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. generateDataOperationId, generate_data_operation_id= The id of the generate data operation -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 a 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: download_generate_values ======================================== Usage: dct-toolkit download_generate_values[-hVw] [-cs] [-jh] format= generate_data_operation_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. format= The format for the generated file generateDataOperationId, generate_data_operation_id= The id of the generate data operation -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. ======================================== ================================================================================ TOPIC: AiManagement ================================================================================ Commands (4): get_all_llm_models, get_llm_model, upload_model, get_all_llm_gateways COMMAND: get_all_llm_models ======================================== Usage: dct-toolkit get_all_llm_models[-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 a 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: get_llm_model ======================================== Usage: dct-toolkit get_llm_model[-hVw] [-cs] [-jh] model_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. modelId, model_id= The id of the LLM model -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: upload_model ======================================== Usage: dct-toolkit upload_model[-hV] [orchestrator_id=] -h, --help Show this help message and exit. orchestratorId, orchestrator_id= The orchestrator where the model should be installed. This must be "default". -V, --version Print version information and exit. ======================================== COMMAND: get_all_llm_gateways ======================================== Usage: dct-toolkit get_all_llm_gateways[-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 a 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. ======================================== ================================================================================ TOPIC: Algorithms ================================================================================ Commands (8): get_algorithms, get_algorithm_by_id, search_algorithms, get_algorithm_tags, create_algorithm_tags, delete_algorithm_tags, get_algorithm_dependencies_by_id, search_algorithm_dependencies COMMAND: get_algorithms ======================================== Usage: dct-toolkit get_algorithms[-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 a 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: get_algorithm_by_id ======================================== Usage: dct-toolkit get_algorithm_by_id[-hVw] [-cs] [-jh] algorithm_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. algorithmId, algorithm_id= The ID of the Algorithm. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_algorithms ======================================== Usage: dct-toolkit search_algorithms[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [description=string] [framework_name=string] [framework_id=string] [plugin_name=string] [plugin_id=string] [engine_name=string] [engine_id=string] [revision_hash=string] [create_date=string] [account_id=integer] [account_name=string] [--[no-]dct_managed] [--[no-]config_invalid] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 description=string Filter by description framework_name=string Filter by framework_name framework_id=string Filter by framework_id plugin_name=string Filter by plugin_name plugin_id=string Filter by plugin_id engine_name=string Filter by engine_name engine_id=string Filter by engine_id revision_hash=string Filter by revision_hash create_date=string Filter by create_date account_id=integer Filter by account_id account_name=string Filter by account_name --[no-]dct_managed Filter by dct_managed --[no-]config_invalid Filter by config_invalid tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_algorithm_tags ======================================== Usage: dct-toolkit get_algorithm_tags[-hVw] [-cs] [-jh] algorithm_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. algorithmId, algorithm_id= The ID of the Algorithm. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_algorithm_tags ======================================== Usage: dct-toolkit create_algorithm_tags[-hVw] algorithm_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. algorithmId, algorithm_id= The ID of the Algorithm. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Algorithm. -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_algorithm_tags ======================================== Usage: dct-toolkit delete_algorithm_tags[-hVw] algorithm_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. algorithmId, algorithm_id= The ID of the Algorithm. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_algorithm_dependencies_by_id ======================================== Usage: dct-toolkit get_algorithm_dependencies_by_id[-hVw] [-cs] [-jh] algorithm_id= [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. algorithmId, algorithm_id= The ID of the Algorithm. -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 a 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_algorithm_dependencies ======================================== Usage: dct-toolkit search_algorithm_dependencies[-hVw] algorithm_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[child_id=string] [child_name=string] [child_type=string]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. algorithmId, algorithm_id= The ID of the Algorithm. 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 a 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. child_id=string Filter by child_id child_name=string Filter by child_name child_type=string Filter by child_type -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 ======================================== ================================================================================ TOPIC: Authorization ================================================================================ Commands (35): get_roles, create_role, get_role_by_id, delete_role, update_role, search_roles, add_role_permissions, remove_role_permissions, get_role_tags, create_role_tags, delete_role_tag, add_role_ui_profiles, delete_role_ui_profiles, get_object_permissions, get_all_object_permissions, get_access_groups, create_access_group, search_access_groups, get_access_group_by_id, delete_access_group, update_access_group, add_access_group_account_tags, remove_access_group_account_tags, add_access_group_account_ids, remove_access_group_account_id, add_access_group_scopes, get_access_group_scope, remove_access_group_scope, update_access_group_scope, add_tags_to_scope, delete_access_group_scope_object_tags, add_objects_to_access_group_scope, delete_access_group_scope_objects, add_always_allowed_permissions, remove_always_allowed_permissions COMMAND: get_roles ======================================== Usage: dct-toolkit get_roles[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_role ======================================== Usage: dct-toolkit create_role[-hVw] [-cs] [-jh] ([permission_objects=array name=string [description=string] [--[no-] immutable] [tags[=array...]]... [ui_profiles=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. permission_objects=array The list of permissions granted by this role. name=string The Role name. description=string Role description. --[no-]immutable If set to true, adding or removing permission is not allowed. tags[=array...] ui_profiles=array[,array...] The list of profiles that influence the navigation menus shown in the UI. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_role_by_id ======================================== Usage: dct-toolkit get_role_by_id[-hVw] [-cs] [-jh] role_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. roleId, role_id= The ID of the role. -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: delete_role ======================================== Usage: dct-toolkit delete_role[-hVw] [-cs] [-jh] role_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. roleId, role_id= The ID of the role. -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_role ======================================== Usage: dct-toolkit update_role[-hVw] role_id= [-cs] [-jh] [[[name=string] [description=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. roleId, role_id= The ID of the role. name=string The role name description=string The role description --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_roles ======================================== Usage: dct-toolkit search_roles[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [description=string] [--[no-]system_role] [-- [no-]immutable] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name description=string Filter by description --[no-]system_role Filter by system_role --[no-]immutable Filter by immutable tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: add_role_permissions ======================================== Usage: dct-toolkit add_role_permissions[-hVw] role_id= [-cs] [-jh] ([permission_objects=array] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. roleId, role_id= The ID of the role. permission_objects=array Array of permissions with object type and their permission. --body=PARAM Permissions to add to the role. -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: remove_role_permissions ======================================== Usage: dct-toolkit remove_role_permissions[-hVw] role_id= [-cs] [-jh] ([permission_objects=array] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. roleId, role_id= The ID of the role. permission_objects=array Array of permissions with object type and their permission. --body=PARAM Permissions to remove from the role. -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_role_tags ======================================== Usage: dct-toolkit get_role_tags[-hVw] [-cs] [-jh] role_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. roleId, role_id= The ID of the role. -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_role_tags ======================================== Usage: dct-toolkit create_role_tags[-hVw] role_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. roleId, role_id= The ID of the role. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Roles. -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_role_tag ======================================== Usage: dct-toolkit delete_role_tag[-hVw] role_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. roleId, role_id= The ID of the role. 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: add_role_ui_profiles ======================================== Usage: dct-toolkit add_role_ui_profiles[-hVw] role_id= [-cs] [-jh] ([ui_profiles=array[,array...] [ui_profiles=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. roleId, role_id= The ID of the role. ui_profiles=array[,array...] List of UI profiles --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_role_ui_profiles ======================================== Usage: dct-toolkit delete_role_ui_profiles[-hVw] role_id= [-cs] [-jh] ([ui_profiles=array[,array...] [ui_profiles=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. roleId, role_id= The ID of the role. ui_profiles=array[,array...] List of UI profiles --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_object_permissions ======================================== Usage: dct-toolkit get_object_permissions[-hVw] [-cs] [-jh] object_id= object_type= [-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. objectId, object_id= The ID of the DCT Object. objectType, object_type= The type of the DCT object. -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_all_object_permissions ======================================== Usage: dct-toolkit get_all_object_permissions[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_access_groups ======================================== Usage: dct-toolkit get_access_groups[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_access_group ======================================== Usage: dct-toolkit create_access_group[-hVw] [-cs] [-jh] ([name=string [id=string] [--[no-]single_account] [account_ids=array[,array...]]... [tagged_account_ids=array[,array...]]... [account_tags=array] [scopes=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 The Access group name id=string The Access group ID. --[no-]single_account Indicates that this Access group defines the permissions of a single account, and thus account and account tags cannot be modified. Instead create a new Access group to manage permissions of multiple accounts. account_ids=array[,array...] List of accounts ids included individually (as opposed to added by tags) in the Access group. tagged_account_ids=array[,array...] List of accounts ids included by tags in the Access group. account_tags=array List of account tags. Accounts matching any of these tags will be automatically added to the Access group. scopes=array The Access group scopes. --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_access_groups ======================================== Usage: dct-toolkit search_access_groups[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=class java.lang. String] [name=class java.lang.String] [account_ids=class java.lang.String] [tagged_account_ids=class java.lang. String] [scopes=class java.lang.String] [single_account=class java.lang. String]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=class java.lang.String Filter by id name=class java.lang.String Filter by name account_ids=class java.lang.String Filter by account_ids tagged_account_ids=class java.lang.String Filter by tagged_account_ids scopes=class java.lang.String Filter by scopes single_account=class java.lang.String Filter by single_account -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_access_group_by_id ======================================== Usage: dct-toolkit get_access_group_by_id[-hVw] [-cs] [-jh] access_group_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. accessGroupId, access_group_id= The ID of the Access group. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: delete_access_group ======================================== Usage: dct-toolkit delete_access_group[-hVw] [-cs] [-jh] access_group_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. accessGroupId, access_group_id= The ID of the Access group. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_access_group ======================================== Usage: dct-toolkit update_access_group[-hVw] access_group_id= [-cs] [-jh] [[[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. accessGroupId, access_group_id= The ID of the Access group. name=string The Access group name --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: add_access_group_account_tags ======================================== Usage: dct-toolkit add_access_group_account_tags[-hVw] access_group_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. accessGroupId, access_group_id= The ID of the Access group. tags[=array...] Array of tags with key value pairs --body=PARAM Account Tags to add to the Access group. -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: remove_access_group_account_tags ======================================== Usage: dct-toolkit remove_access_group_account_tags[-hVw] access_group_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. accessGroupId, access_group_id= The ID of the Access group. 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: add_access_group_account_ids ======================================== Usage: dct-toolkit add_access_group_account_ids[-hVw] access_group_id= [-cs] [-jh] ([account_ids=array[, array...] [account_ids=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. accessGroupId, access_group_id= The ID of the Access group. account_ids=array[,array...] --body=PARAM Account ids to add to the Access group. -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: remove_access_group_account_id ======================================== Usage: dct-toolkit remove_access_group_account_id[-hVw] [-cs] [-jh] access_group_id= account_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. accessGroupId, access_group_id= The ID of the Access group. accountId, account_id= The ID of the account. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: add_access_group_scopes ======================================== Usage: dct-toolkit add_access_group_scopes[-hVw] access_group_id= [-cs] [-jh] ([scopes=array] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. accessGroupId, access_group_id= The ID of the Access group. scopes=array --body=PARAM Scopes to add to the Access group. -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_access_group_scope ======================================== Usage: dct-toolkit get_access_group_scope[-hVw] [-cs] [-jh] access_group_id= scope_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. accessGroupId, access_group_id= The ID of the Access group. -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. scopeId, scope_id= The ID of the Access group scope. -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: remove_access_group_scope ======================================== Usage: dct-toolkit remove_access_group_scope[-hVw] [-cs] [-jh] access_group_id= scope_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. accessGroupId, access_group_id= The ID of the Access group. -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. scopeId, scope_id= The ID of the Access group scope. -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_access_group_scope ======================================== Usage: dct-toolkit update_access_group_scope[-hVw] access_group_id= scope_id= [-cs] [-jh] [[[name=string] [scope_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. accessGroupId, access_group_id= The ID of the Access group. scopeId, scope_id= The ID of the Access group scope. name=string The Access group scope name. scope_type=string Values: [SIMPLE, SCOPED, ADVANCED]Specifies the type of the scope. Scope of type SIMPLE would grant access to all DCT objects. Scope of type SCOPED would grant access to all objects based on objects and object-tags and permissions defined in linked role. Scope of type ADVANCED would grant access to DCT objects based on objects and object-tags and the individual permissions. --body=PARAM Access group scope to update. -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: add_tags_to_scope ======================================== Usage: dct-toolkit add_tags_to_scope[-hVw] access_group_id= scope_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. accessGroupId, access_group_id= The ID of the Access group. scopeId, scope_id= The ID of the Access group scope. tags[=array...] Array of tags with key value pairs along with optional object_type and permissions --body=PARAM Object tags for the access group scope. -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_access_group_scope_object_tags ======================================== Usage: dct-toolkit delete_access_group_scope_object_tags[-hVw] access_group_id= scope_id= [-cs] [-jh] [[[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. accessGroupId, access_group_id= The ID of the Access group. scopeId, scope_id= The ID of the Access group scope. tags[=array...] List of scope tags to be deleted --body=PARAM The parameters to delete scope objects 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: add_objects_to_access_group_scope ======================================== Usage: dct-toolkit add_objects_to_access_group_scope[-hVw] access_group_id= scope_id= [-cs] [-jh] ([objects=array] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. accessGroupId, access_group_id= The ID of the Access group. scopeId, scope_id= The ID of the Access group scope. objects=array An array of scoped objects --body=PARAM Add objects to the access group scope. -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_access_group_scope_objects ======================================== Usage: dct-toolkit delete_access_group_scope_objects[-hVw] access_group_id= scope_id= [-cs] [-jh] ([objects=array] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. accessGroupId, access_group_id= The ID of the Access group. scopeId, scope_id= The ID of the Access group scope. objects=array List of scoped objects to be deleted --body=PARAM The parameters to delete scope objects -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: add_always_allowed_permissions ======================================== Usage: dct-toolkit add_always_allowed_permissions[-hVw] access_group_id= scope_id= [-cs] [-jh] ([always_allowed_permissions=array] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. accessGroupId, access_group_id= The ID of the Access group. scopeId, scope_id= The ID of the Access group scope. always_allowed_permissions=array An array of always allowed permissions --body=PARAM Add always allowed permissions for given object type. -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: remove_always_allowed_permissions ======================================== Usage: dct-toolkit remove_always_allowed_permissions[-hVw] access_group_id= scope_id= [-cs] [-jh] ([always_allowed_permissions=array] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. accessGroupId, access_group_id= The ID of the Access group. scopeId, scope_id= The ID of the Access group scope. always_allowed_permissions=array An array of always allowed permissions --body=PARAM Remove always allowed permissions for given object type. -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 ======================================== ================================================================================ TOPIC: Bookmarks ================================================================================ Commands (12): get_bookmarks, create_bookmark, search_bookmarks, get_bookmark_by_id, delete_bookmark, update_bookmark, get_vdb_groups_by_bookmark, search_vdb_groups_by_bookmark, get_bookmark_tags, create_bookmark_tags, delete_bookmark_tags, import_engine_bookmarks COMMAND: get_bookmarks ======================================== Usage: dct-toolkit get_bookmarks[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_bookmark ======================================== Usage: dct-toolkit create_bookmark[-hVw] [-cs] [-jh] ([name=string [vdb_ids=array[,array...]]... [vdb_group_id=string] [snapshot_ids=array[, array...]]... [timeflow_ids=array[, array...]]... [timestamp=string] [timestamp_in_database_timezone=string] [location=string] [retention=integer] [expiration=string] [--[no-]retain_forever] [tags[=array...]]... [bookmark_type=string] [--[no-]make_current_account_owner] [--[no-] inherit_parent_vdb_tags] [--[no-] inherit_parent_tags]] | [--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 The user-defined name of this bookmark. vdb_ids=array[,array...] The IDs of the VDBs to create the Bookmark on. This parameter is mutually exclusive with snapshot_ids and timeflow_ids. vdb_group_id=string The ID of the VDB group to create the Bookmark on. This parameter is mutually exclusive with vdb_ids. snapshot_ids=array[,array...] The IDs of the snapshots that will be part of the Bookmark. This parameter is mutually exclusive with vdb_ids, timestamp, timestamp_in_database_timezone, location and timeflow_ids. timeflow_ids=array[,array...] The array of timeflow Id. Only allowed to set when timestamp, timestamp_in_database_timezone or location is provided. timestamp=string The point in time from which to execute the operation. Mutually exclusive with snapshot_ids, timestamp_in_database_timezone and location. timestamp_in_database_timezone=string The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with snapshot_ids, timestamp and location. location=string The location to create bookmark from. Mutually exclusive with snapshot_ids, timestamp, and timestamp_in_database_timezone. retention=integer The retention policy for this bookmark, in days. A value of -1 indicates the bookmark should be kept forever. Deprecated in favor of expiration and retain_forever. expiration=string The expiration for this bookmark. Mutually exclusive with retention and retain_forever. --[no-]retain_forever Indicates that the bookmark should be retained forever. tags[=array...] The tags to be created for this Bookmark. bookmark_type=string Values: [PUBLIC, PRIVATE]Type of the bookmark, either PUBLIC or PRIVATE. --[no-]make_current_account_owner Whether the account creating this bookmark must be configured as owner of the bookmark. --[no-]inherit_parent_vdb_tags This field has been deprecated in favour of new field 'inherit_parent_tags'. --[no-]inherit_parent_tags Whether this bookmark should inherit tags from the parent dataset. --body=PARAM The parameters to create a bookmark. -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_bookmarks ======================================== Usage: dct-toolkit search_bookmarks[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [creation_date=date-time] [data_timestamp=date-time] [vdb_ids=array [string]] [dsource_ids=array[string]] [retention=integer] [expiration=date] [bookmark_source=string] [bookmark_status=string] [ss_data_layout_id=string] [ss_bookmark_reference=string] [ss_bookmark_errors=array[string]] [bookmark_type=string] [timeflow_id=date-time] [location=string] [vdb_group_id=string] [vdb_group_name=string] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name creation_date=date-time Filter by creation_date data_timestamp=date-time Filter by data_timestamp vdb_ids=array[string] Filter by vdb_ids dsource_ids=array[string] Filter by dsource_ids retention=integer Filter by retention expiration=date Filter by expiration bookmark_source=string Filter by bookmark_source bookmark_status=string Filter by bookmark_status ss_data_layout_id=string Filter by ss_data_layout_id ss_bookmark_reference=string Filter by ss_bookmark_reference ss_bookmark_errors=array[string] Filter by ss_bookmark_errors bookmark_type=string Filter by bookmark_type timeflow_id=date-time Filter by timeflow_id location=string Filter by location vdb_group_id=string Filter by vdb_group_id vdb_group_name=string Filter by vdb_group_name tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_bookmark_by_id ======================================== Usage: dct-toolkit get_bookmark_by_id[-hVw] [-cs] [-jh] bookmark_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. bookmarkId, bookmark_id= The ID of the Bookmark. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: delete_bookmark ======================================== Usage: dct-toolkit delete_bookmark[-hVw] [-cs] [-jh] bookmark_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. bookmarkId, bookmark_id= The ID of the Bookmark. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_bookmark ======================================== Usage: dct-toolkit update_bookmark[-hVw] bookmark_id= [-cs] [-jh] [[[name=string] [expiration=string] [--[no-] retain_forever] [bookmark_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. bookmarkId, bookmark_id= The ID of the Bookmark. name=string The user-defined name of this bookmark. expiration=string The expiration for this Bookmark. Mutually exclusive with retain_forever. --[no-]retain_forever Indicates that the Bookmark should be retained forever. bookmark_type=string Values: [PUBLIC, PRIVATE]Type of the bookmark, either PUBLIC or PRIVATE. --body=PARAM The new data to update a Bookmark. -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_vdb_groups_by_bookmark ======================================== Usage: dct-toolkit get_vdb_groups_by_bookmark[-hVw] [-cs] [-jh] bookmark_id= [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. bookmarkId, bookmark_id= The ID of the Bookmark. -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_vdb_groups_by_bookmark ======================================== Usage: dct-toolkit search_vdb_groups_by_bookmark[-hVw] bookmark_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [database_type=string] [status=string] [last_successful_refresh_to_bookmark_id=string] [last_successful_refresh_time=string] [vdb_ids=array[string]] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. bookmarkId, bookmark_id= The ID of the Bookmark. 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_type=string Filter by database_type status=string Filter by status last_successful_refresh_to_bookmark_id=string Filter by last_successful_refresh_to_bookmark_id last_successful_refresh_time=string Filter by last_successful_refresh_time vdb_ids=array[string] Filter by vdb_ids tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_bookmark_tags ======================================== Usage: dct-toolkit get_bookmark_tags[-hVw] [-cs] [-jh] bookmark_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. bookmarkId, bookmark_id= The ID of the Bookmark. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_bookmark_tags ======================================== Usage: dct-toolkit create_bookmark_tags[-hVw] bookmark_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. bookmarkId, bookmark_id= The ID of the Bookmark. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Bookmark. -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_bookmark_tags ======================================== Usage: dct-toolkit delete_bookmark_tags[-hVw] bookmark_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. bookmarkId, bookmark_id= The ID of the Bookmark. 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: import_engine_bookmarks ======================================== Usage: dct-toolkit import_engine_bookmarks[-hVw] [-cs] [-jh] engine_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. engineId, engine_id= The ID of the registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== ================================================================================ TOPIC: CDBs ================================================================================ Commands (16): get_cdbs, search_cdbs, get_cdb_by_id, update_cdb, update_cdb_by_id, get_tags_cdb, create_cdb_tags, delete_cdb_tags, enable_cdb, disable_cdb, get_cdb_deletion_dependencies, delete_cdb, upgrade_cdb, detach_cdb, attach_cdb, verify_cdb_jdbc_connection_string COMMAND: get_cdbs ======================================== Usage: dct-toolkit get_cdbs[-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_cdbs ======================================== Usage: dct-toolkit search_cdbs[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [database_version=string] [environment_id=string] [size=integer] [jdbc_connection_string=string] [engine_id=string] [namespace_id=string] [namespace_name=string] [--[no-]is_replica] [-- [no-]is_linked] [group_name=string] [status=string] [--[no-]enabled] [instance_name=string] [instance_number=integer] [repository_id=string] [tde_keystore_config_type=string] [database_name=string] [database_unique_name=string] [tde_kms_pkcs11_config_path=string] [--[no-] is_tde_keystore_password_set]]] [-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_version=string Filter by database_version environment_id=string Filter by environment_id size=integer Filter by size jdbc_connection_string=string Filter by jdbc_connection_string engine_id=string Filter by engine_id namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica --[no-]is_linked Filter by is_linked group_name=string Filter by group_name status=string Filter by status --[no-]enabled Filter by enabled instance_name=string Filter by instance_name instance_number=integer Filter by instance_number repository_id=string Filter by repository_id tde_keystore_config_type=string Filter by tde_keystore_config_type database_name=string Filter by database_name database_unique_name=string Filter by database_unique_name tde_kms_pkcs11_config_path=string Filter by tde_kms_pkcs11_config_path --[no-]is_tde_keystore_password_set Filter by is_tde_keystore_password_set -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_cdb_by_id ======================================== Usage: dct-toolkit get_cdb_by_id[-hVw] [-cs] [-jh] cdb_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. cdbId, cdb_id= The ID of the CDB. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_cdb ======================================== Usage: dct-toolkit update_cdb[-hVw] cdb_id= [-cs] [-jh] [[[oracle_services=array[,array...]]... [--[no-] logsync_enabled] [logsync_mode=string] [logsync_interval=integer] [tde_keystore_password=string] [tde_keystore_config_type=string] [tde_kms_pkcs11_config_path=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. cdbId, cdb_id= The ID of the CDB. oracle_services=array[,array...] List of jdbc connection strings which are used to connect with the database. --[no-]logsync_enabled True if LogSync is enabled for this CDB. logsync_mode=string Values: [ARCHIVE_ONLY_MODE, ARCHIVE_REDO_MODE, UNDEFINED]LogSync operation mode for this dSource. logsync_interval=integer Interval between LogSync requests, in seconds. tde_keystore_password=string For a CDB using software keystore, this is the password of the software keystore used by this database. For a CDB 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 CDB 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_kms_pkcs11_config_path=string Path to the PKCS#11 configuration file for TDE KMS. --body=PARAM The parameters to update a CDB. -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_cdb_by_id ======================================== Usage: dct-toolkit update_cdb_by_id[-hVw] cdb_id= [-cs] [-jh] [[[oracle_services=array[,array...]]... [-- [no-]logsync_enabled] [logsync_mode=string] [logsync_interval=integer] [tde_keystore_password=string] [tde_keystore_config_type=string] [tde_kms_pkcs11_config_path=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. cdbId, cdb_id= The ID of the CDB. oracle_services=array[,array...] List of jdbc connection strings which are used to connect with the database. --[no-]logsync_enabled True if LogSync is enabled for this CDB. logsync_mode=string Values: [ARCHIVE_ONLY_MODE, ARCHIVE_REDO_MODE, UNDEFINED]LogSync operation mode for this dSource. logsync_interval=integer Interval between LogSync requests, in seconds. tde_keystore_password=string For a CDB using software keystore, this is the password of the software keystore used by this database. For a CDB 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 CDB 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_kms_pkcs11_config_path=string Path to the PKCS#11 configuration file for TDE KMS. --body=PARAM The parameters to update a CDB. -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_cdb ======================================== Usage: dct-toolkit get_tags_cdb[-hVw] [-cs] [-jh] cdb_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. cdbId, cdb_id= The ID of the CDB. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_cdb_tags ======================================== Usage: dct-toolkit create_cdb_tags[-hVw] cdb_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. cdbId, cdb_id= The ID of the CDB. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for CDB. -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_cdb_tags ======================================== Usage: dct-toolkit delete_cdb_tags[-hVw] cdb_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. cdbId, cdb_id= The ID of the CDB. 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_cdb ======================================== Usage: dct-toolkit enable_cdb[-hVw] cdb_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. cdbId, cdb_id= The ID of the CDB. --[no-]attempt_start Whether to attempt a startup of the CDB after the enable. --body=PARAM The parameters to enable a CDB. -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_cdb ======================================== Usage: dct-toolkit disable_cdb[-hVw] cdb_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. cdbId, cdb_id= The ID of the CDB. --[no-]attempt_cleanup Whether to attempt a cleanup of the CDB before the disable. --body=PARAM The parameters to disable a CDB. -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_cdb_deletion_dependencies ======================================== Usage: dct-toolkit get_cdb_deletion_dependencies[-hVw] [-cs] [-jh] cdb_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. cdbId, cdb_id= The ID of the CDB. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: delete_cdb ======================================== Usage: dct-toolkit delete_cdb[-hVw] cdb_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. cdbId, cdb_id= The ID of the CDB. --[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 CDB. -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_cdb ======================================== Usage: dct-toolkit upgrade_cdb[-hVw] cdb_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. cdbId, cdb_id= The ID of the CDB. 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 CDB. -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_cdb ======================================== Usage: dct-toolkit detach_cdb[-hVw] [-cs] [-jh] cdb_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. cdbId, cdb_id= The ID of the CDB. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: attach_cdb ======================================== Usage: dct-toolkit attach_cdb[-hVw] cdb_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] [dsource_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. cdbId, cdb_id= The ID of the CDB. --[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. dsource_id=string Id of the dsource to attach. --body=PARAM The parameters to attach an Oracle CDB. -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_cdb_jdbc_connection_string ======================================== Usage: dct-toolkit verify_cdb_jdbc_connection_string[-hVw] cdb_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. cdbId, cdb_id= The ID of the CDB. 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 ======================================== ================================================================================ TOPIC: Classifiers ================================================================================ Commands (8): get_classifiers, search_classifiers, get_classifier_by_id, get_classifier_discovery_policies, search_classifier_discovery_policies, get_classifier_tags, create_classifier_tags, delete_classifier_tags COMMAND: get_classifiers ======================================== Usage: dct-toolkit get_classifiers[-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 a 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_classifiers ======================================== Usage: dct-toolkit search_classifiers[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [framework=string] [description=string] [data_class_id=string] [data_class_name=string] [engine_id=string] [engine_name=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 framework=string Filter by framework description=string Filter by description data_class_id=string Filter by data_class_id data_class_name=string Filter by data_class_name engine_id=string Filter by engine_id engine_name=string Filter by engine_name tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_classifier_by_id ======================================== Usage: dct-toolkit get_classifier_by_id[-hVw] [-cs] [-jh] classifier_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. classifierId, classifier_id= The ID of the Classifier. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_classifier_discovery_policies ======================================== Usage: dct-toolkit get_classifier_discovery_policies[-hVw] [-cs] [-jh] classifier_id= [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. classifierId, classifier_id= The ID of the Classifier. -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 a 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_classifier_discovery_policies ======================================== Usage: dct-toolkit search_classifier_discovery_policies[-hVw] classifier_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [description=string] [account_id=integer] [account_name=string] [--[no-]dct_managed] [discovery_method=string] [assignment_threshold=integer] [engine_id=string] [engine_name=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. classifierId, classifier_id= The ID of the Classifier. 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 a 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 description=string Filter by description account_id=integer Filter by account_id account_name=string Filter by account_name --[no-]dct_managed Filter by dct_managed discovery_method=string Filter by discovery_method assignment_threshold=integer Filter by assignment_threshold engine_id=string Filter by engine_id engine_name=string Filter by engine_name tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_classifier_tags ======================================== Usage: dct-toolkit get_classifier_tags[-hVw] [-cs] [-jh] classifier_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. classifierId, classifier_id= The ID of the Classifier. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_classifier_tags ======================================== Usage: dct-toolkit create_classifier_tags[-hVw] classifier_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. classifierId, classifier_id= The ID of the Classifier. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for classifier. -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_classifier_tags ======================================== Usage: dct-toolkit delete_classifier_tags[-hVw] classifier_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. classifierId, classifier_id= The ID of the Classifier. 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 ======================================== ================================================================================ TOPIC: ComplianceJobCollections ================================================================================ Commands (12): get_compliance_job_collections, create_compliance_job_collection, search_compliance_job_collections, get_compliance_job_collection_by_id, delete_compliance_job_collection, update_compliance_job_collection, execute_compliance_job_collection, get_compliance_job_collection_jobs, search_compliance_job_collection_jobs, get_compliance_job_collection_tags, create_compliance_job_collection_tags, delete_compliance_job_collection_tags COMMAND: get_compliance_job_collections ======================================== Usage: dct-toolkit get_compliance_job_collections[-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 a descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_compliance_job_collection ======================================== Usage: dct-toolkit create_compliance_job_collection[-hVw] [-cs] [-jh] ([name=string [description=string] [failure_handling=string] [members=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. name=string The name of the compliance job collection. description=string The description of the compliance job collection. failure_handling=string Values: [IGNORE, CANCEL_ALL, CANCEL_SUBSEQUENT] members=array The list of compliance job IDs and their collection sequence to be included in the collection. tags[=array...] The tags to be created for this compliance job collection. --body=PARAM The parameters to create a compliance job collection -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_compliance_job_collections ======================================== Usage: dct-toolkit search_compliance_job_collections[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [description=string] [creation_date=string] [job_count=integer] [last_execution_id=string] [failure_handling=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 description=string Filter by description creation_date=string Filter by creation_date job_count=integer Filter by job_count last_execution_id=string Filter by last_execution_id failure_handling=string Filter by failure_handling tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_compliance_job_collection_by_id ======================================== Usage: dct-toolkit get_compliance_job_collection_by_id[-hVw] [-cs] [-jh] compliance_job_collection_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. complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: delete_compliance_job_collection ======================================== Usage: dct-toolkit delete_compliance_job_collection[-hVw] [-cs] [-jh] compliance_job_collection_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. complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_compliance_job_collection ======================================== Usage: dct-toolkit update_compliance_job_collection[-hVw] compliance_job_collection_id= [-cs] [-jh] [[[name=string] [description=string] [failure_handling=string] [members=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. name=string The name of the compliance job collection. description=string The description of the compliance job collection. failure_handling=string Values: [IGNORE, CANCEL_ALL, CANCEL_SUBSEQUENT] members=array The list of compliance job IDs and their collection sequence to be included in the collection. --body=PARAM The parameters to update a compliance job collection -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: execute_compliance_job_collection ======================================== Usage: dct-toolkit execute_compliance_job_collection[-hV] compliance_job_collection_id= complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. -h, --help Show this help message and exit. -V, --version Print version information and exit. ======================================== COMMAND: get_compliance_job_collection_jobs ======================================== Usage: dct-toolkit get_compliance_job_collection_jobs[-hVw] [-cs] [-jh] compliance_job_collection_id= [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. complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. -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 a descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_compliance_job_collection_jobs ======================================== Usage: dct-toolkit search_compliance_job_collection_jobs[-hVw] compliance_job_collection_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [engine_id=string] [engine_name=string] [engine_job_id=integer] [type=string] [execution_type=string] [--[no-] is_on_the_fly_masking] [creation_date=string] [last_completed_execution_date=string] [last_execution_status=string] [last_execution_id=string] [last_execution_start_time=string] [last_execution_run_time=integer] [rule_set_id=string] [rule_set_name=string] [hyperscale_instance_id=string] [description=string] [dataset_id=string] [retain_execution_data=string] [max_memory=integer] [min_memory=integer] [feedback_size=integer] [stream_row_limit=integer] [num_input_streams=integer] [max_concurrent_source_connections=integer] [max_concurrent_target_connections=integer] [parallelism_degree=integer] [discovery_policy_id=string] [discovery_policy_name=string] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c= [,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. 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 a 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 engine_id=string Filter by engine_id engine_name=string Filter by engine_name engine_job_id=integer Filter by engine_job_id type=string Filter by type execution_type=string Filter by execution_type --[no-]is_on_the_fly_masking Filter by is_on_the_fly_masking creation_date=string Filter by creation_date last_completed_execution_date=string Filter by last_completed_execution_date last_execution_status=string Filter by last_execution_status last_execution_id=string Filter by last_execution_id last_execution_start_time=string Filter by last_execution_start_time last_execution_run_time=integer Filter by last_execution_run_time rule_set_id=string Filter by rule_set_id rule_set_name=string Filter by rule_set_name hyperscale_instance_id=string Filter by hyperscale_instance_id description=string Filter by description dataset_id=string Filter by dataset_id retain_execution_data=string Filter by retain_execution_data max_memory=integer Filter by max_memory min_memory=integer Filter by min_memory feedback_size=integer Filter by feedback_size stream_row_limit=integer Filter by stream_row_limit num_input_streams=integer Filter by num_input_streams max_concurrent_source_connections=integer Filter by max_concurrent_source_connections max_concurrent_target_connections=integer Filter by max_concurrent_target_connections parallelism_degree=integer Filter by parallelism_degree discovery_policy_id=string Filter by discovery_policy_id discovery_policy_name=string Filter by discovery_policy_name tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_compliance_job_collection_tags ======================================== Usage: dct-toolkit get_compliance_job_collection_tags[-hVw] [-cs] [-jh] compliance_job_collection_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. complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_compliance_job_collection_tags ======================================== Usage: dct-toolkit create_compliance_job_collection_tags[-hVw] compliance_job_collection_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. complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for a compliance job collection. -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_compliance_job_collection_tags ======================================== Usage: dct-toolkit delete_compliance_job_collection_tags[-hVw] compliance_job_collection_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. complianceJobCollectionId, compliance_job_collection_id= The ID of the compliance job collection. 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 ======================================== ================================================================================ TOPIC: ComplianceJobs ================================================================================ Commands (8): get_compliance_jobs, search_compliance_jobs, get_compliance_job_by_id, get_compliance_job_connectors, get_compliance_job_tag, create_compliance_job_tag, delete_compliance_job_tag, execute_compliance_job COMMAND: get_compliance_jobs ======================================== Usage: dct-toolkit get_compliance_jobs[-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 a descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_compliance_jobs ======================================== Usage: dct-toolkit search_compliance_jobs[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [engine_id=string] [engine_name=string] [engine_job_id=integer] [job_orchestrator_id=string] [job_orchestrator_name=string] [type=string] [execution_type=string] [-- [no-]is_on_the_fly_masking] [creation_date=string] [last_completed_execution_date=string] [last_execution_status=string] [last_execution_id=string] [last_execution_start_time=string] [last_execution_run_time=integer] [rule_set_id=string] [rule_set_name=string] [hyperscale_instance_id=string] [description=string] [dataset_id=string] [retain_execution_data=string] [max_memory=integer] [min_memory=integer] [feedback_size=integer] [stream_row_limit=integer] [num_input_streams=integer] [max_concurrent_source_connections=integer] [max_concurrent_target_connections=integer] [parallelism_degree=integer] [discovery_policy_id=string] [discovery_policy_name=string] [account_id=integer] [account_name=string] [--[no-]dct_managed] [--[no-] fail_immediately] [--[no-]batch_update] [commit_size=integer] [num_output_threads_per_stream=integer] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 engine_id=string Filter by engine_id engine_name=string Filter by engine_name engine_job_id=integer Filter by engine_job_id job_orchestrator_id=string Filter by job_orchestrator_id job_orchestrator_name=string Filter by job_orchestrator_name type=string Filter by type execution_type=string Filter by execution_type --[no-]is_on_the_fly_masking Filter by is_on_the_fly_masking creation_date=string Filter by creation_date last_completed_execution_date=string Filter by last_completed_execution_date last_execution_status=string Filter by last_execution_status last_execution_id=string Filter by last_execution_id last_execution_start_time=string Filter by last_execution_start_time last_execution_run_time=integer Filter by last_execution_run_time rule_set_id=string Filter by rule_set_id rule_set_name=string Filter by rule_set_name hyperscale_instance_id=string Filter by hyperscale_instance_id description=string Filter by description dataset_id=string Filter by dataset_id retain_execution_data=string Filter by retain_execution_data max_memory=integer Filter by max_memory min_memory=integer Filter by min_memory feedback_size=integer Filter by feedback_size stream_row_limit=integer Filter by stream_row_limit num_input_streams=integer Filter by num_input_streams max_concurrent_source_connections=integer Filter by max_concurrent_source_connections max_concurrent_target_connections=integer Filter by max_concurrent_target_connections parallelism_degree=integer Filter by parallelism_degree discovery_policy_id=string Filter by discovery_policy_id discovery_policy_name=string Filter by discovery_policy_name account_id=integer Filter by account_id account_name=string Filter by account_name --[no-]dct_managed Filter by dct_managed --[no-]fail_immediately Filter by fail_immediately --[no-]batch_update Filter by batch_update commit_size=integer Filter by commit_size num_output_threads_per_stream=integer Filter by num_output_threads_per_stream tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_compliance_job_by_id ======================================== Usage: dct-toolkit get_compliance_job_by_id[-hVw] [-cs] [-jh] compliance_job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. complianceJobId, compliance_job_id= The ID of the compliance job. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_compliance_job_connectors ======================================== Usage: dct-toolkit get_compliance_job_connectors[-hVw] [-cs] [-jh] compliance_job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. complianceJobId, compliance_job_id= The ID of the compliance job. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_compliance_job_tag ======================================== Usage: dct-toolkit get_compliance_job_tag[-hVw] [-cs] [-jh] compliance_job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. complianceJobId, compliance_job_id= The ID of the compliance job. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_compliance_job_tag ======================================== Usage: dct-toolkit create_compliance_job_tag[-hVw] compliance_job_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. complianceJobId, compliance_job_id= The ID of the compliance job. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Masking Job. -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_compliance_job_tag ======================================== Usage: dct-toolkit delete_compliance_job_tag[-hVw] compliance_job_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. complianceJobId, compliance_job_id= The ID of the compliance job. 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: execute_compliance_job ======================================== Usage: dct-toolkit execute_compliance_job[-hV] compliance_job_id= complianceJobId, compliance_job_id= The ID of the compliance job. -h, --help Show this help message and exit. -V, --version Print version information and exit. ======================================== ================================================================================ TOPIC: Config ================================================================================ Commands (2): create_config, encrypt_api_key COMMAND: create_config ======================================== Usage:
create_config[-hV] dctUrl= apiKey[=] [configFileOutputLocation=] [apiVersion=] [apiYamlLocation=] [--[no-]insecureSSL] [--[no-] unsafeHostnameCheck] [sslCertificate=] [logLevel=] [logDir=] Command to create config file for DCT toolkit -h, --help Show this help message and exit. -V, --version Print version information and exit. dctUrl= DCT URL. apiKey[=] API key to be used for DCT authentication. configFileOutputLocation= Output location where the config file will be written to. apiVersion= API version to be used for DCT apis. If this is not set then latest api version from the DCT instance. apiYamlLocation= Location of api.yaml file. If this is not set then latest api.yaml file will be downloaded from the DCT instance. --[no-]insecureSSL Set this to true to use insecure SSL connection. --[no-]unsafeHostnameCheck Set this to turn off host name verifier checks for SSL connection. sslCertificate= PEM format SSL certificate path to be used for SSL connection. logLevel= Log level to set. Can be one of OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL. By default log level will be INFO logDir= Directory where the logs should be written. By default logs will be written under the . dct-toolkit/logs directory in the user's home directory. ======================================== COMMAND: encrypt_api_key ======================================== Usage: dct-toolkit encrypt_api_key[-hV] apiKey[=] dctUrl= Command to encrypt API key for DCT toolkit apiKey[=] API key to be encrypted. dctUrl= DCT URL. -h, --help Show this help message and exit. -V, --version Print version information and exit. ======================================== ================================================================================ TOPIC: Connectivity ================================================================================ Commands (4): connectivity_check, database_connectivity_check, netbackup_connectivity_check, commvault_connectivity_check COMMAND: connectivity_check ======================================== Usage: dct-toolkit connectivity_check[-hVw] [-cs] [-jh] ([host=string port=integer engine_id=string [--[no-] use_engine_public_key] [os_name=string] [staging_environment=string] [username=string] [password=string] [vault_id=string] [hashicorp_vault_engine=string] [hashicorp_vault_secret_path=string] [hashicorp_vault_username_key=string] [hashicorp_vault_secret_key=string] [azure_vault_name=string] [azure_vault_username_key=string] [azure_vault_secret_key=string] [cyberark_vault_query_string=string] [-- [no-]use_kerberos_authentication]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. host=string The hostname of the remote host machine to check. port=integer The port of the remote host machine to check. For Windows, port on which Delphix connector is running. engine_id=string The ID of the engine to check. --[no-]use_engine_public_key Whether to use public key authentication. os_name=string Values: [UNIX, WINDOWS]Operating system type of the environment. staging_environment=string Id of the connector environment which is used to connect to this source environment. username=string The username of the remote host machine to check. Username is mandatory input with password/use_engine_public_key/kerberos_authentic ation. password=string The password of the remote host machine to check. vault_id=string The DCT id or name of the vault from which to read the host credentials. hashicorp_vault_engine=string Vault engine name where the credential is stored. hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. hashicorp_vault_username_key=string Key for the username in the key-value store. hashicorp_vault_secret_key=string Key for the password in the key-value store. azure_vault_name=string Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_username_key=string Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_secret_key=string Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. --[no-]use_kerberos_authentication Whether to use kerberos authentication. --body=PARAM The api to check connectivity of engine and a remote host on given port. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: database_connectivity_check ======================================== Usage: dct-toolkit database_connectivity_check[-hVw] [-cs] [-jh] ([source_id=string credentials_type=string [username=string] [password=string] [vault=string] [hashicorp_vault_engine=string] [hashicorp_vault_secret_path=string] [hashicorp_vault_username_key=string] [hashicorp_vault_secret_key=string] [azure_vault_name=string] [azure_vault_username_key=string] [azure_vault_secret_key=string] [cyberark_vault_query_string=string] [environment_id=string] [environment_user=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. source_id=string Source database config Id. credentials_type=string Values: [MSSQL_ENVIRONMENT_USER, MSSQL_DOMAIN_USER, MSSQL_DATABASE_USER, ORACLE, ASE, SOURCE_CONFIG]The type of credentials. username=string Database username (Not applicable for MSSQL_ENVIRONMENT_USER). password=string Database password (Not applicable for MSSQL_ENVIRONMENT_USER and mutually exclusive with vault attributes). vault=string The name or reference of the vault from which to read the database credentials (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_engine=string Vault engine name where the credential is stored (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_username_key=string Hashicorp vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_secret_key=string Hashicorp vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_name=string Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_username_key=string Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_secret_key=string Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). cyberark_vault_query_string=string Query to find a credential in the CyberArk vault (ORACLE, ASE and MSSQL_DOMAIN_USER only). environment_id=string Id of the environment to which environment user belongs (MSSQL_ENVIRONMENT_USER only). environment_user=string Reference to the environment user (MSSQL_ENVIRONMENT_USER only). --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: netbackup_connectivity_check ======================================== Usage: dct-toolkit netbackup_connectivity_check[-hVw] [-cs] [-jh] ([environment_user_id=string source_client_name=string environment_id=string master_server_name=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. environment_user_id=string Id of the environment user. source_client_name=string The name of the NetBackup client to attempt to connect with. environment_id=string Id of the target environment to test NetBackup connectivity from. master_server_name=string The name of the NetBackup master server to attempt to connect to. --body=PARAM The api to check connectivity of NetBackup master server and client on an environment. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: commvault_connectivity_check ======================================== Usage: dct-toolkit commvault_connectivity_check[-hVw] [-cs] [-jh] ([commserve_host_name=string staging_client_name=string source_client_name=string environment_id=string environment_user_id=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. commserve_host_name=string The hostname of the CommServe server to connect to. staging_client_name=string The name of the Staging Client in CommServe. source_client_name=string The name of the Source Client in CommServe. environment_id=string Id of the target environment to test Commvault connectivity from. environment_user_id=string Id of the environment user. --body=PARAM The api to check connectivity to the CommServe host and staging client from an environment. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: Connectors ================================================================================ Commands (7): get_connectors, get_connector_by_id, search_connector_jobs, get_connector_tags, create_connector_tags, delete_connector_tag, search_connectors COMMAND: get_connectors ======================================== Usage: dct-toolkit get_connectors[-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 a 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: get_connector_by_id ======================================== Usage: dct-toolkit get_connector_by_id[-hVw] [-cs] [-jh] connector_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. connectorId, connector_id= The ID of the Connector. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_connector_jobs ======================================== Usage: dct-toolkit search_connector_jobs[-hVw] connector_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [--[no-]is_on_the_fly_masking] [last_execution_time=string] [last_execution_status=string] [creation_date=string] [tags[=array[object]...]]... [connector_role=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. connectorId, connector_id= The ID of the Connector. 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 a 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 --[no-]is_on_the_fly_masking Filter by is_on_the_fly_masking last_execution_time=string Filter by last_execution_time last_execution_status=string Filter by last_execution_status creation_date=string Filter by creation_date tags[=array[object]...] Filter by tags connector_role=string Filter by connector_role -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_connector_tags ======================================== Usage: dct-toolkit get_connector_tags[-hVw] [-cs] [-jh] connector_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. connectorId, connector_id= The ID of the Connector. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_connector_tags ======================================== Usage: dct-toolkit create_connector_tags[-hVw] connector_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. connectorId, connector_id= The ID of the Connector. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Connector. -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_connector_tag ======================================== Usage: dct-toolkit delete_connector_tag[-hVw] connector_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. connectorId, connector_id= The ID of the Connector. 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: search_connectors ======================================== Usage: dct-toolkit search_connectors[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [engine_id=string] [engine_name=string] [type=string] [platform=string] [database_type=string] [name=string] [hostname=string] [username=string] [port=integer] [--[no-]auth_present] [custom_driver_name=string] [database_name=string] [instance_name=string] [jdbc=string] [schema_name=string] [sid=string] [--[no-] kerberos_auth] [service_principal=string] [--[no-]enable_logger] [file_type=string] [connection_mode=string] [path=string] [ssh_key=string] [--[no-]user_dir_is_root] [data_connection_id=string] [account_id=integer] [account_name=string] [--[no-]dct_managed] [job_orchestrator_id=string] [job_orchestrator_name=string] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 engine_id=string Filter by engine_id engine_name=string Filter by engine_name type=string Filter by type platform=string Filter by platform database_type=string Filter by database_type name=string Filter by name hostname=string Filter by hostname username=string Filter by username port=integer Filter by port --[no-]auth_present Filter by auth_present custom_driver_name=string Filter by custom_driver_name database_name=string Filter by database_name instance_name=string Filter by instance_name jdbc=string Filter by jdbc schema_name=string Filter by schema_name sid=string Filter by sid --[no-]kerberos_auth Filter by kerberos_auth service_principal=string Filter by service_principal --[no-]enable_logger Filter by enable_logger file_type=string Filter by file_type connection_mode=string Filter by connection_mode path=string Filter by path ssh_key=string Filter by ssh_key --[no-]user_dir_is_root Filter by user_dir_is_root data_connection_id=string Filter by data_connection_id account_id=integer Filter by account_id account_name=string Filter by account_name --[no-]dct_managed Filter by dct_managed job_orchestrator_id=string Filter by job_orchestrator_id job_orchestrator_name=string Filter by job_orchestrator_name tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ 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 ======================================== ================================================================================ TOPIC: DataClasses ================================================================================ Commands (9): get_data_classes, search_data_classes, get_data_class_by_id, update_data_class, get_data_class_algorithms, search_data_class_algorithms, get_data_class_tags, create_data_class_tags, delete_data_class_tags COMMAND: get_data_classes ======================================== Usage: dct-toolkit get_data_classes[-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 a 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_data_classes ======================================== Usage: dct-toolkit search_data_classes[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [default_algorithm_id=string] [default_algorithm_name=string] [default_token_algorithm_id=string] [default_token_algorithm_name=string] [algorithm_ids=array[string]] [description=string] [example=string] [revision_hash=string] [engine_id=string] [engine_name=string] [account_id=integer] [account_name=string] [--[no-] dct_managed] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 default_algorithm_id=string Filter by default_algorithm_id default_algorithm_name=string Filter by default_algorithm_name default_token_algorithm_id=string Filter by default_token_algorithm_id default_token_algorithm_name=string Filter by default_token_algorithm_name algorithm_ids=array[string] Filter by algorithm_ids description=string Filter by description example=string Filter by example revision_hash=string Filter by revision_hash engine_id=string Filter by engine_id engine_name=string Filter by engine_name account_id=integer Filter by account_id account_name=string Filter by account_name --[no-]dct_managed Filter by dct_managed tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_data_class_by_id ======================================== Usage: dct-toolkit get_data_class_by_id[-hVw] [-cs] [-jh] data_class_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. dataClassId, data_class_id= The ID of the Data Class. -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_data_class ======================================== Usage: dct-toolkit update_data_class[-hVw] data_class_id= [-cs] [-jh] [[[description=string] [example=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dataClassId, data_class_id= The ID of the Data Class. description=string A description of this data class. example=string An example data value for this data class. --body=PARAM Update a Data Class. -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_data_class_algorithms ======================================== Usage: dct-toolkit get_data_class_algorithms[-hVw] [-cs] [-jh] [cursor=] data_class_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. dataClassId, data_class_id= The ID of the Data Class. -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 a 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_data_class_algorithms ======================================== Usage: dct-toolkit search_data_class_algorithms[-hVw] data_class_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [description=string] [framework_name=string] [framework_id=string] [plugin_name=string] [plugin_id=string] [engine_name=string] [engine_id=string] [revision_hash=string] [create_date=string] [--[no-]config_invalid] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dataClassId, data_class_id= The ID of the Data Class. 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 a 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 description=string Filter by description framework_name=string Filter by framework_name framework_id=string Filter by framework_id plugin_name=string Filter by plugin_name plugin_id=string Filter by plugin_id engine_name=string Filter by engine_name engine_id=string Filter by engine_id revision_hash=string Filter by revision_hash create_date=string Filter by create_date --[no-]config_invalid Filter by config_invalid tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_data_class_tags ======================================== Usage: dct-toolkit get_data_class_tags[-hVw] [-cs] [-jh] data_class_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. dataClassId, data_class_id= The ID of the Data Class. -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_data_class_tags ======================================== Usage: dct-toolkit create_data_class_tags[-hVw] data_class_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. dataClassId, data_class_id= The ID of the Data Class. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Data Class. -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_data_class_tags ======================================== Usage: dct-toolkit delete_data_class_tags[-hVw] data_class_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. dataClassId, data_class_id= The ID of the Data Class. 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 ======================================== ================================================================================ TOPIC: DataConnections ================================================================================ Commands (10): get_data_connections, search_data_connections, get_data_connection_by_id, update_data_connection, get_data_connection_tags, create_data_connection_tags, delete_data_connection_tags, get_sub_connections, reassign_sub_connection, search_sub_connections COMMAND: get_data_connections ======================================== Usage: dct-toolkit get_data_connections[-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_data_connections ======================================== Usage: dct-toolkit search_data_connections[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [status=string] [type=string] [platform=string] [dsource_count=integer] [capabilities=array[string]] [tags[=array [object]...]]... [hostname=string] [database_name=string] [custom_driver_name=string] [path=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name status=string Filter by status type=string Filter by type platform=string Filter by platform dsource_count=integer Filter by dsource_count capabilities=array[string] Filter by capabilities tags[=array[object]...] Filter by tags hostname=string Filter by hostname database_name=string Filter by database_name custom_driver_name=string Filter by custom_driver_name path=string Filter by path -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_data_connection_by_id ======================================== Usage: dct-toolkit get_data_connection_by_id[-hVw] [-cs] [-jh] data_connection_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. dataConnectionId, data_connection_id= The ID of the data connection. -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_data_connection ======================================== Usage: dct-toolkit update_data_connection[-hVw] data_connection_id= [-cs] [-jh] [[[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. dataConnectionId, data_connection_id= The ID of the data connection. name=string The data connection name --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_data_connection_tags ======================================== Usage: dct-toolkit get_data_connection_tags[-hVw] [-cs] [-jh] data_connection_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. dataConnectionId, data_connection_id= The ID of the data connection. -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_data_connection_tags ======================================== Usage: dct-toolkit create_data_connection_tags[-hVw] data_connection_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. dataConnectionId, data_connection_id= The ID of the data connection. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for data connections. -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_data_connection_tags ======================================== Usage: dct-toolkit delete_data_connection_tags[-hVw] data_connection_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. dataConnectionId, data_connection_id= The ID of the data connection. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_sub_connections ======================================== Usage: dct-toolkit get_sub_connections[-hVw] [-cs] [-jh] [cursor=] data_connection_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. dataConnectionId, data_connection_id= The ID of the data connection. -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: reassign_sub_connection ======================================== Usage: dct-toolkit reassign_sub_connection[-hVw] data_connection_id= sub_connection_id= [-cs] [-jh] [[[new_data_connection_id=string] [name=string] [tags[=array...]]... [-- [no-]make_current_account_owner]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dataConnectionId, data_connection_id= The ID of the data connection. subConnectionId, sub_connection_id= The ID of the sub connection. new_data_connection_id=string The ID of the existing DataConnection to move the SubConnection to. If null, then a new DataConnection will be created. name=string The new DataConnection name. Only applicable if new_data_connection_id is null. tags[=array...] The tags to add to the newly created DataConnection. Only applicable if new_data_connection_id is null. --[no-]make_current_account_owner Whether the current Account must be configured as owner of the newly created DataConnection. Only applicable if new_data_connection_id is null. --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_sub_connections ======================================== Usage: dct-toolkit search_sub_connections[-hVw] data_connection_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [capability=string] [schema_name=string] [platform=string] [hostnames=array[string]] [source_object_type=string] [source_object_id=string] [metadata_home_type=string] [metadata_home_id=string] [metadata_home_name=string] [username=string] [database_name=string] [instance_name=string] [database_type=string] [jdbc_url=string] [--[no-]is_replica] [custom_driver_name=string] [virtualization_environment_id=string] [path=string] [connection_mode=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dataConnectionId, data_connection_id= The ID of the data connection. 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 capability=string Filter by capability schema_name=string Filter by schema_name platform=string Filter by platform hostnames=array[string] Filter by hostnames source_object_type=string Filter by source_object_type source_object_id=string Filter by source_object_id metadata_home_type=string Filter by metadata_home_type metadata_home_id=string Filter by metadata_home_id metadata_home_name=string Filter by metadata_home_name username=string Filter by username database_name=string Filter by database_name instance_name=string Filter by instance_name database_type=string Filter by database_type jdbc_url=string Filter by jdbc_url --[no-]is_replica Filter by is_replica custom_driver_name=string Filter by custom_driver_name virtualization_environment_id=string Filter by virtualization_environment_id path=string Filter by path connection_mode=string Filter by connection_mode tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: DataLayouts ================================================================================ Commands (8): get_data_layouts, search_data_layouts, get_data_layout_by_id, get_data_layout_tags, create_data_layout_tags, delete_data_layout_tags, convert_and_drop_bookmarks, import_engine_accounts COMMAND: get_data_layouts ======================================== Usage: dct-toolkit get_data_layouts[-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_data_layouts ======================================== Usage: dct-toolkit search_data_layouts[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [type=string] [engine_id=string] [engine_name=string]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name type=string Filter by type engine_id=string Filter by engine_id engine_name=string Filter by engine_name -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_data_layout_by_id ======================================== Usage: dct-toolkit get_data_layout_by_id[-hVw] [-cs] [-jh] data_layout_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. dataLayoutId, data_layout_id= The ID of the data-layout. -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_data_layout_tags ======================================== Usage: dct-toolkit get_data_layout_tags[-hVw] [-cs] [-jh] data_layout_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. dataLayoutId, data_layout_id= The ID of the data-layout. -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_data_layout_tags ======================================== Usage: dct-toolkit create_data_layout_tags[-hVw] data_layout_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. dataLayoutId, data_layout_id= The ID of the data-layout. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for data-layout. -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_data_layout_tags ======================================== Usage: dct-toolkit delete_data_layout_tags[-hVw] data_layout_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. dataLayoutId, data_layout_id= The ID of the data-layout. 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: convert_and_drop_bookmarks ======================================== Usage: dct-toolkit convert_and_drop_bookmarks[-hVw] data_layout_id= [-cs] [-jh] [[[--[no-] skip_account_import]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. dataLayoutId, data_layout_id= The ID of the data-layout. --[no-]skip_account_import Skip running the account import process. If this flag is not set, then accounts from self-service will overwrite existing accounts if any. --body=PARAM Import engine accounts request. -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: import_engine_accounts ======================================== Usage: dct-toolkit import_engine_accounts[-hVw] [-cs] [-jh] [[[data_layout_ids=array[,array...]]... [engine_ids=array[,array...]]... [--[no-]import_all]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. data_layout_ids=array[,array...] List of data-layout ids for which accounts should be imported to DCT. This is mutually exclusive with `engine_ids` and `import_all`. engine_ids=array[,array...] List of engine ids for which accounts should be imported to DCT. This is mutually exclusive with `data_layout_ids` and `import_all`. --[no-]import_all All self-service accounts across engines should imported to DCT. This is mutually exclusive with `data_layout_ids` and `engine_ids`. --body=PARAM Import engine accounts request. -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 ======================================== ================================================================================ TOPIC: DatabaseTemplates ================================================================================ Commands (11): get_database_templates, create_database_template, get_database_template_by_id, delete_database_template, update_database_template, get_database_template_tags, create_database_template_tags, delete_database_template_tag, search_database_templates, import_database_templates, undo_import_database_templates COMMAND: get_database_templates ======================================== Usage: dct-toolkit get_database_templates[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_database_template ======================================== Usage: dct-toolkit create_database_template[-hVw] [-cs] [-jh] ([name=string source_type=string [description=string] [parameters[=object...]]... [-- [no-]make_current_account_owner] [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. name=string The DatabaseTemplate name. source_type=string Values: [OracleVirtualSource, OracleLinkedSource, MSSqlVirtualSource, MSSqlLinkedSource]The type of the source associated with the template. description=string User provided description for this template. parameters[=object...] A name/value map of string configuration parameters. --[no-]make_current_account_owner Whether the account creating this database template must be configured as owner of the database template. tags[=array...] --body=PARAM The parameters to create a database template. -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_database_template_by_id ======================================== Usage: dct-toolkit get_database_template_by_id[-hVw] [-cs] [-jh] database_template_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. databaseTemplateId, database_template_id= The ID of the Database Template. -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: delete_database_template ======================================== Usage: dct-toolkit delete_database_template[-hVw] [-cs] [-jh] database_template_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. databaseTemplateId, database_template_id= The ID of the Database Template. -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_database_template ======================================== Usage: dct-toolkit update_database_template[-hVw] database_template_id= [-cs] [-jh] [[[name=string] [description=string] [source_type=string] [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. databaseTemplateId, database_template_id= The ID of the Database Template. name=string The DatabaseTemplate name. description=string User provided description for this template. source_type=string Values: [OracleVirtualSource, OracleLinkedSource, MSSqlVirtualSource, MSSqlLinkedSource]The type of the source associated with the template. parameters[=object...] A name/value map of string configuration parameters. --body=PARAM The new data to update a VDB. -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_database_template_tags ======================================== Usage: dct-toolkit get_database_template_tags[-hVw] [-cs] [-jh] database_template_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. databaseTemplateId, database_template_id= The ID of the Database Template. -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_database_template_tags ======================================== Usage: dct-toolkit create_database_template_tags[-hVw] database_template_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. databaseTemplateId, database_template_id= The ID of the Database Template. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for a DatabaseTemplate. -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_database_template_tag ======================================== Usage: dct-toolkit delete_database_template_tag[-hVw] database_template_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. databaseTemplateId, database_template_id= The ID of the Database Template. 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: search_database_templates ======================================== Usage: dct-toolkit search_database_templates[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [description=string] [source_type=string] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c= [,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name description=string Filter by description source_type=string Filter by source_type tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: import_database_templates ======================================== Usage: dct-toolkit import_database_templates[-hVw] [-cs] [-jh] [[[engine_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. engine_id=string --body=PARAM Body containing the ID of the registered engine. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: undo_import_database_templates ======================================== Usage: dct-toolkit undo_import_database_templates[-hVw] [-cs] [-jh] [[[engine_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. engine_id=string --body=PARAM Body containing the ID of the registered engine. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: DiscoveryExpressions ================================================================================ Commands (6): get_discovery_expressions, search_discovery_expressions, get_discovery_expression_by_id, get_discovery_expression_tags, create_discovery_expression_tags, delete_discovery_expression_tags COMMAND: get_discovery_expressions ======================================== Usage: dct-toolkit get_discovery_expressions[-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 -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_discovery_expressions ======================================== Usage: dct-toolkit search_discovery_expressions[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [regular_expression=string] [--[no-]data_level_profiling] [min_data_length=integer] [engine_id=string] [engine_name=string] [data_class_id=string] [data_class_name=string] [data_type=string] [expression_type=string] [level=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The 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 regular_expression=string Filter by regular_expression --[no-]data_level_profiling Filter by data_level_profiling min_data_length=integer Filter by min_data_length engine_id=string Filter by engine_id engine_name=string Filter by engine_name data_class_id=string Filter by data_class_id data_class_name=string Filter by data_class_name data_type=string Filter by data_type expression_type=string Filter by expression_type level=string Filter by level tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_discovery_expression_by_id ======================================== Usage: dct-toolkit get_discovery_expression_by_id[-hVw] [-cs] [-jh] expression_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. expressionId, expression_id= The ID of the discovery expression. -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_discovery_expression_tags ======================================== Usage: dct-toolkit get_discovery_expression_tags[-hVw] [-cs] [-jh] expression_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. expressionId, expression_id= The ID of the discovery expression. -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_discovery_expression_tags ======================================== Usage: dct-toolkit create_discovery_expression_tags[-hVw] expression_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. expressionId, expression_id= The ID of the discovery expression. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for discovery expression. -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_discovery_expression_tags ======================================== Usage: dct-toolkit delete_discovery_expression_tags[-hVw] expression_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. expressionId, expression_id= The ID of the discovery expression. 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 ======================================== ================================================================================ TOPIC: DiscoveryPolicies ================================================================================ Commands (10): get_discovery_policies, search_discovery_policies, get_discovery_policy_by_id, get_discovery_policy_classifiers, search_discovery_policy_classifiers, get_discovery_policy_expressions, search_discovery_policy_expressions, get_discovery_policy_tags, create_discovery_policy_tags, delete_discovery_policy_tags COMMAND: get_discovery_policies ======================================== Usage: dct-toolkit get_discovery_policies[-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 a 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_discovery_policies ======================================== Usage: dct-toolkit search_discovery_policies[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [description=string] [account_id=integer] [account_name=string] [--[no-]dct_managed] [discovery_method=string] [assignment_threshold=integer] [engine_id=string] [engine_name=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 description=string Filter by description account_id=integer Filter by account_id account_name=string Filter by account_name --[no-]dct_managed Filter by dct_managed discovery_method=string Filter by discovery_method assignment_threshold=integer Filter by assignment_threshold engine_id=string Filter by engine_id engine_name=string Filter by engine_name tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_discovery_policy_by_id ======================================== Usage: dct-toolkit get_discovery_policy_by_id[-hVw] [-cs] [-jh] discovery_policy_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. discoveryPolicyId, discovery_policy_id= The ID of the Discovery Policy. -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_discovery_policy_classifiers ======================================== Usage: dct-toolkit get_discovery_policy_classifiers[-hVw] [-cs] [-jh] [cursor=] discovery_policy_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. discoveryPolicyId, discovery_policy_id= The ID of the Discovery Policy. -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 a 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_discovery_policy_classifiers ======================================== Usage: dct-toolkit search_discovery_policy_classifiers[-hVw] discovery_policy_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [framework=string] [description=string] [data_class_id=string] [data_class_name=string] [engine_id=string] [engine_name=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. discoveryPolicyId, discovery_policy_id= The ID of the Discovery Policy. 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 a 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 framework=string Filter by framework description=string Filter by description data_class_id=string Filter by data_class_id data_class_name=string Filter by data_class_name engine_id=string Filter by engine_id engine_name=string Filter by engine_name tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_discovery_policy_expressions ======================================== Usage: dct-toolkit get_discovery_policy_expressions[-hVw] [-cs] [-jh] [cursor=] discovery_policy_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. discoveryPolicyId, discovery_policy_id= The ID of the Discovery Policy. -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 -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_discovery_policy_expressions ======================================== Usage: dct-toolkit search_discovery_policy_expressions[-hVw] discovery_policy_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [regular_expression=string] [--[no-]data_level_profiling] [min_data_length=integer] [engine_id=string] [engine_name=string] [data_class_id=string] [data_class_name=string] [data_type=string] [expression_type=string] [level=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. discoveryPolicyId, discovery_policy_id= The ID of the Discovery Policy. 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 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 regular_expression=string Filter by regular_expression --[no-]data_level_profiling Filter by data_level_profiling min_data_length=integer Filter by min_data_length engine_id=string Filter by engine_id engine_name=string Filter by engine_name data_class_id=string Filter by data_class_id data_class_name=string Filter by data_class_name data_type=string Filter by data_type expression_type=string Filter by expression_type level=string Filter by level tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_discovery_policy_tags ======================================== Usage: dct-toolkit get_discovery_policy_tags[-hVw] [-cs] [-jh] discovery_policy_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. discoveryPolicyId, discovery_policy_id= The ID of the Discovery Policy. -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_discovery_policy_tags ======================================== Usage: dct-toolkit create_discovery_policy_tags[-hVw] discovery_policy_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. discoveryPolicyId, discovery_policy_id= The ID of the Discovery Policy. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for discovery policy. -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_discovery_policy_tags ======================================== Usage: dct-toolkit delete_discovery_policy_tags[-hVw] discovery_policy_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. discoveryPolicyId, discovery_policy_id= The ID of the Discovery Policy. 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 ======================================== ================================================================================ TOPIC: Environments ================================================================================ Commands (30): get_environments, create_environment, compatible_repositories_by_snapshot, compatible_repositories_by_timestamp, compatible_repositories_from_bookmark, compatible_repositories_by_location, delete_repository, update_repository, create_repository, create_host, delete_host, update_host, get_tags_environment, create_environment_tags, delete_environment_tags, get_environment_by_id, delete_environment, update_environment, search_environments, enable_environment, disable_environment, refresh_environment, list_environment_users, create_environment_user, update_environment_user, delete_environment_user, primary_environment_user, create_oracle_listener, delete_oracle_listener, update_oracle_listener COMMAND: get_environments ======================================== Usage: dct-toolkit get_environments[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_environment ======================================== Usage: dct-toolkit create_environment[-hVw] [-cs] [-jh] ([engine_id=string os_name=string hostname=string [name=string] [--[no-]is_cluster] [cluster_home=string] [staging_environment=string] [connector_port=integer] [connector_authentication_key=string] [-- [no-]is_target] [ssh_port=integer] [toolkit_path=string] [username=string] [password=string] [vault=string] [vault_username=string] [hashicorp_vault_engine=string] [hashicorp_vault_secret_path=string] [hashicorp_vault_username_key=string] [hashicorp_vault_secret_key=string] [cyberark_vault_query_string=string] [azure_vault_name=string] [azure_vault_username_key=string] [azure_vault_secret_key=string] [--[no-] use_kerberos_authentication] [--[no-] use_engine_public_key] [nfs_addresses=array[,array...]]... [ase_db_vault_username=string] [ase_db_username=string] [ase_db_password=string] [--[no-] ase_enable_tls] [--[no-] ase_skip_server_certificate_validation] [ase_db_vault=string] [ase_db_hashicorp_vault_engine=string] [ase_db_hashicorp_vault_secret_path=string ] [ase_db_hashicorp_vault_username_key=strin g] [ase_db_hashicorp_vault_secret_key=string] [ase_db_cyberark_vault_query_string=string ] [--[no-] ase_db_use_kerberos_authentication] [ase_db_azure_vault_name=string] [ase_db_azure_vault_username_key=string] [ase_db_azure_vault_secret_key=string] [java_home=string] [dsp_keystore_path=string] [dsp_keystore_password=string] [dsp_keystore_alias=string] [dsp_truststore_path=string] [dsp_truststore_password=string] [description=string] [tags[=array...]]... [--[no-]make_current_account_owner]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id=string The ID of the Engine onto which to create the environment. os_name=string Values: [UNIX, WINDOWS]Operating system type of the environment. hostname=string host address of the machine. name=string The name of the environment. --[no-]is_cluster Whether the environment to be created is a cluster. cluster_home=string Absolute path to cluster home drectory. This parameter is mandatory for UNIX cluster environments. staging_environment=string Id of the connector environment which is used to connect to this source environment. This is mandatory parameter when creating Windows source environments. connector_port=integer Specify port on which Delphix connector will run. This is mandatory parameter when creating Windows target environments. connector_authentication_key=string Unique per Delphix key used to authenticate with the remote Delphix Connector. --[no-]is_target Whether the environment to be created is a target cluster environment. This property is used only when creating Windows cluster environments. ssh_port=integer ssh port of the host. toolkit_path=string The path for the toolkit that resides on the host. username=string Username of the OS. password=string Password of the OS. vault=string The name or reference of the vault from which to read the host credentials. vault_username=string Delphix display name for the vault user hashicorp_vault_engine=string Vault engine name where the credential is stored. hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. hashicorp_vault_username_key=string Key for the username in the key-value store. hashicorp_vault_secret_key=string Key for the password in the key-value store. cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. azure_vault_name=string Azure key vault name. azure_vault_username_key=string Azure vault key for the username in the key-value store. azure_vault_secret_key=string Azure vault key for the password in the key-value store. --[no-]use_kerberos_authentication Whether to use kerberos authentication. --[no-]use_engine_public_key Whether to use public key authentication. nfs_addresses=array[,array...] array of ip address or hostnames ase_db_vault_username=string Delphix display name for the vault user ase_db_username=string username of the SAP ASE database. ase_db_password=string password of the SAP ASE database. --[no-]ase_enable_tls True if you want to discover the SAP ASE instances configured with TLS/SSL. --[no-]ase_skip_server_certificate_validation Only valid for SAP ASE. Setting it to true will skip the server certificate validation during the SSL handshake. Only set it if you do not want to add the required certificate into the Delphix Engine truststore but still want to use the TLS/SSL-enabled database connection. This is not recommended for a production environment as it is less secure. ase_db_vault=string The name or reference of the vault from which to read the ASE database credentials. ase_db_hashicorp_vault_engine=string Vault engine name where the credential is stored. ase_db_hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. ase_db_hashicorp_vault_username_key=string Key for the username in the key-value store. ase_db_hashicorp_vault_secret_key=string Key for the password in the key-value store. ase_db_cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. --[no-]ase_db_use_kerberos_authentication Whether to use kerberos authentication for ASE DB discovery. ase_db_azure_vault_name=string Azure key vault name. ase_db_azure_vault_username_key=string Azure vault key for the username in the key-value store. ase_db_azure_vault_secret_key=string Azure vault key for the password in the key-value store. java_home=string The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. dsp_keystore_path=string DSP keystore path. dsp_keystore_password=string DSP keystore password. dsp_keystore_alias=string DSP keystore alias. dsp_truststore_path=string DSP truststore path. dsp_truststore_password=string DSP truststore password. description=string The environment description. tags[=array...] The tags to be created for this environment. --[no-]make_current_account_owner Whether the account creating this environment must be configured as owner of the environment. --body=PARAM The parameters to create an environment. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: compatible_repositories_by_snapshot ======================================== Usage: dct-toolkit compatible_repositories_by_snapshot[-hVw] [-cs] [-jh] [[[source_data_id=string] [engine_id=string] [snapshot_id=string] [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. source_data_id=string The ID of the source object (dSource or VDB) to get the compatible repos. All other objects referenced by the parameters must live on the same engine as the source. engine_id=string The ID of the Engine from where to get the compatible repos. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. snapshot_id=string The ID of the snapshot from which to execute the operation. environment_id=string The ID or name of the target environment. --body=PARAM The request to get compatible repositories for provisioning a new VDB by snapshot. -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: compatible_repositories_by_timestamp ======================================== Usage: dct-toolkit compatible_repositories_by_timestamp[-hVw] [-cs] [-jh] [[[source_data_id=string] [engine_id=string] [timestamp=string] [timeflow_id=string] [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. source_data_id=string The ID of the source object (dSource or VDB) to get the compatible repos. All other objects referenced by the parameters must live on the same engine as the source. engine_id=string The ID of the Engine from where to get the compatible repos. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. timestamp=string The point in time from which to execute the operation. If the timestamp is not set, selects the latest point. timeflow_id=string ID of the timeflow from which compatible repos need to be fetched, mutually exclusive with source_data_id. environment_id=string The ID or name of the target environment. --body=PARAM The request to get compatible repositories for provisioning a new VDB by timestamp. -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: compatible_repositories_from_bookmark ======================================== Usage: dct-toolkit compatible_repositories_from_bookmark[-hVw] [-cs] [-jh] ([bookmark_id=string [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. bookmark_id=string The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB. environment_id=string The ID or name of the target environment. --body=PARAM The request to get compatible repositories for provisioning a new VDB by bookmark. -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: compatible_repositories_by_location ======================================== Usage: dct-toolkit compatible_repositories_by_location[-hVw] [-cs] [-jh] [[[source_data_id=string] [engine_id=string] [location=string] [timeflow_id=string] [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. source_data_id=string The ID of the source object (dSource or VDB) to get the compatible repos. All other objects referenced by the parameters must live on the same engine as the source. engine_id=string The ID of the Engine from where to get the compatible repos. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. location=string location from where compatible repo to be fetched. timeflow_id=string ID of the timeflow from which compatible repos need to be fetched. environment_id=string The ID or name of the target environment. --body=PARAM The request to get compatible repositories for provisioning a new VDB by location. -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_repository ======================================== Usage: dct-toolkit delete_repository[-hVw] [-cs] [-jh] environment_id= repository_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. environmentId, environment_id= The ID of the environment. -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. repositoryId, repository_id= The ID of the repository. -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_repository ======================================== Usage: dct-toolkit update_repository[-hVw] environment_id= repository_id= [-cs] [-jh] [[[--[no-]allow_provisioning] [--[no-] is_staging] [version=string] [oracle_base=string] [bits=integer] [port=integer] [instance_owner=string] [installation_path=string] [dump_history_file=string] [database_username=string] [database_password=string] [service_principal_name=string] [isql_path=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. environmentId, environment_id= The ID of the environment. repositoryId, repository_id= The ID of the repository. --[no-]allow_provisioning Flag indicating whether the repository should be used for provisioning. --[no-]is_staging Flag indicating whether this repository can be used by the Delphix Engine for internal processing. version=string Version of the repository. oracle_base=string The Oracle base where database binaries are located. bits=integer 32 or 64 bits. port=integer The network port for connecting to the SAP ASE or SQL Server instance. instance_owner=string The username of the account the SAP ASE or SQL Server instance is running as. installation_path=string The SAP ASE instance home. dump_history_file=string Fully qualified name of the dump history file. database_username=string The username of the ASE instance database. database_password=string The credentials of the ASE instance database user. service_principal_name=string The Kerberos Service Principal Name (SPN) of the database. isql_path=string The path to the isql binary to use for this SAP ASE instance. --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: create_repository ========================================  java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String at picocli.CommandLine$Model$ArgSpec.expandVariables(CommandLine.java:8977) at picocli.CommandLine$Model$ArgSpec.description(CommandLine.java:8946) at picocli.CommandLine$Help$DefaultOptionRenderer.renderDescriptionLines(CommandLine.java:16710) at picocli.CommandLine$Help$DefaultOptionRenderer.render(CommandLine.java:16683) at picocli.CommandLine$Help.calcLongOptionColumnWidth(CommandLine.java:16509) at picocli.CommandLine$Help.createDefaultLayout(CommandLine.java:16487) at picocli.CommandLine$Help.createDefaultLayout(CommandLine.java:16478) at picocli.CommandLine$Help.parameterList(CommandLine.java:16141) at picocli.CommandLine$Help.parameterList(CommandLine.java:16131) at picocli.CommandLine$Model$UsageMessageSpec$10.render(CommandLine.java:8028) at picocli.CommandLine.usage(CommandLine.java:2787) at picocli.CommandLine.usage(CommandLine.java:2765) at picocli.CommandLine.executeHelpRequest(CommandLine.java:1993) at picocli.CommandLine.executeHelpRequest(CommandLine.java:1983) at picocli.CommandLine$AbstractParseResultHandler.execute(CommandLine.java:2268) at picocli.CommandLine$RunLast.execute(CommandLine.java:2417) at picocli.CommandLine.execute(CommandLine.java:2170) at dct.toolkit.DctToolkit.main(DctToolkit.java:178) ======================================== COMMAND: create_host ======================================== Usage: dct-toolkit create_host[-hVw] environment_id= [-cs] [-jh] [[[ssh_port=integer] [dsp_keystore_alias=string] [ssh_verification_strategy.raw_key=string] [ssh_verification_strategy.fingerprint=string] [privilege_elevation_profile_reference=string] [java_home=string] [dsp_truststore_password=string] [dsp_truststore_path=string] [ssh_verification_strategy.key_type=string] [toolkit_path=string] [ssh_verification_strategy. name=string] [nfs_addresses=array[,array...]]... [oracle_cluster_node_virtual_ips=array] [oracle_jdbc_keystore_password=string] [oracle_tde_keystores_root_path=string] [hostname=string] [dsp_keystore_password=string] [dsp_keystore_path=string] [name=string] [ssh_verification_strategy. fingerprint_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. environmentId, environment_id= The ID of the environment. ssh_port=integer The port number used to connect to the host via SSH. dsp_keystore_alias=string The lowercase alias to use inside the user managed DSP keystore. ssh_verification_strategy.raw_key=string Base64-encoded ssh key of the host for RAW_KEY verification. ssh_verification_strategy.fingerprint=string Base-64 encoded fingerprint of the ssh key of the host for FINGERPRINT verification. privilege_elevation_profile_reference=string Reference to a profile for escalating user privileges. java_home=string The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. dsp_truststore_password=string The password for the user managed DSP truststore. dsp_truststore_path=string The path to the user managed DSP truststore. ssh_verification_strategy.key_type=string Values: [RSA, DSA, ECDSA, ED25519]The type of SSH key. toolkit_path=string The path for the toolkit that resides on the host. ssh_verification_strategy.name=string Values: [RAW_KEY, FINGERPRINT, ACCEPT_ALWAYS]The name of the verification strategy. nfs_addresses=array[,array...] The list of host/IP addresses to use for NFS export. oracle_cluster_node_virtual_ips=array The Virtual IP addresses associated with the OracleClusterNode. oracle_jdbc_keystore_password=string The password for the user managed Oracle JDBC keystore. oracle_tde_keystores_root_path=string The path to the root of the Oracle TDE keystores artifact directories. hostname=string The hostname or IP address of this host. dsp_keystore_password=string The password for the user managed DSP keystore. dsp_keystore_path=string The path to the user managed DSP keystore. name=string The name to associate with the host. ssh_verification_strategy.fingerprint_type=string Values: [SHA256, SHA512]Hash function for the fingerprint for FINGERPRINT verification. --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_host ======================================== Usage: dct-toolkit delete_host[-hVw] [-cs] [-jh] environment_id= host_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. environmentId, environment_id= The ID of the environment. -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. hostId, host_id= The ID of the host. -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_host ======================================== Usage: dct-toolkit update_host[-hVw] environment_id= host_id= [-cs] [-jh] [[[connector_port=integer] [oracle_tde_external_key_manager_credential=strin g] [ssh_port=integer] [dsp_keystore_alias=string] [ssh_verification_strategy.raw_key=string] [ssh_verification_strategy.fingerprint=string] [java_home=string] [dsp_truststore_path=string] [dsp_truststore_password=string] [oracle_cluster_node_name=string] [ssh_verification_strategy.key_type=string] [toolkit_path=string] [ssh_verification_strategy. name=string] [nfs_addresses=array[,array...]]... [oracle_cluster_node_virtual_ips=array] [oracle_jdbc_keystore_password=string] [oracle_tde_keystores_root_path=string] [oracle_tde_okv_home_path=string] [hostname=string] [dsp_keystore_password=string] [dsp_keystore_path=string] [--[no-] oracle_cluster_node_enabled] [connector_authentication_key=string] [ssh_verification_strategy. fingerprint_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. environmentId, environment_id= The ID of the environment. hostId, host_id= The ID of the host. connector_port=integer Specify port on which Delphix connector will run. oracle_tde_external_key_manager_credential=string The credential of the tde keystore external keys management system like Oracle Key Vault or Hardware Security Module. ssh_port=integer ssh port of the host. dsp_keystore_alias=string DSP keystore alias. ssh_verification_strategy.raw_key=string Base64-encoded ssh key of the host for RAW_KEY verification. ssh_verification_strategy.fingerprint=string Base-64 encoded fingerprint of the ssh key of the host for FINGERPRINT verification. java_home=string The path to the user managed Java Development Kit (JDK). If not specified, then the OpenJDK will be used. dsp_truststore_path=string DSP truststore path. dsp_truststore_password=string DSP truststore password. oracle_cluster_node_name=string The name of the associated OracleClusterNode. ssh_verification_strategy.key_type=string Values: [RSA, DSA, ECDSA, ED25519]The type of SSH key. toolkit_path=string The path for the toolkit that resides on the host. ssh_verification_strategy.name=string Values: [RAW_KEY, FINGERPRINT, ACCEPT_ALWAYS]The name of the verification strategy. nfs_addresses=array[,array...] array of ip addresses or hostnames oracle_cluster_node_virtual_ips=array The Virtual IP addresses associated with the OracleClusterNode. oracle_jdbc_keystore_password=string The password for the user managed Oracle JDBC keystore. oracle_tde_keystores_root_path=string The path to the root of the Oracle TDE keystores artifact directories. oracle_tde_okv_home_path=string The path to the Oracle Key Vault library installation on the database node. hostname=string host address of the machine. dsp_keystore_password=string DSP keystore password. dsp_keystore_path=string DSP keystore path. --[no-]oracle_cluster_node_enabled Whether the associated OracleClusterNode is enabled. connector_authentication_key=string Unique per Delphix key used to authenticate with the remote Delphix Connector. ssh_verification_strategy.fingerprint_type=string Values: [SHA256, SHA512]Hash function for the fingerprint for FINGERPRINT verification. --body=PARAM the parameters to update a host. -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_environment ======================================== Usage: dct-toolkit get_tags_environment[-hVw] [-cs] [-jh] environment_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. environmentId, environment_id= The ID of the environment. -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_environment_tags ======================================== Usage: dct-toolkit create_environment_tags[-hVw] environment_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. environmentId, environment_id= The ID of the environment. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Environment. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: delete_environment_tags ======================================== Usage: dct-toolkit delete_environment_tags[-hVw] environment_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. environmentId, environment_id= The ID of the environment. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_environment_by_id ======================================== Usage: dct-toolkit get_environment_by_id[-hVw] [-cs] [-jh] environment_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. environmentId, environment_id= The ID of the environment. -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: delete_environment ======================================== Usage: dct-toolkit delete_environment[-hVw] [-cs] [-jh] environment_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. environmentId, environment_id= The ID of the environment. -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_environment ======================================== Usage: dct-toolkit update_environment[-hVw] environment_id= [-cs] [-jh] [[[name=string] [staging_environment=string] [cluster_address=string] [cluster_home=string] [cluster_user=string] [scan=string] [remote_listener=string] [ase_db_username=string] [ase_db_password=string] [--[no-] ase_enable_tls] [--[no-] ase_skip_server_certificate_validation] [ase_db_vault=string] [ase_db_vault_username=string] [ase_db_hashicorp_vault_engine=string] [ase_db_hashicorp_vault_secret_path=string ] [ase_db_hashicorp_vault_username_key=strin g] [ase_db_hashicorp_vault_secret_key=string] [ase_db_cyberark_vault_query_string=string ] [ase_db_azure_vault_name=string] [ase_db_azure_vault_username_key=string] [ase_db_azure_vault_secret_key=string] [-- [no-]ase_db_use_kerberos_authentication] [--[no-]encryption_enabled] [description=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. environmentId, environment_id= The ID of the environment. name=string The name of the environment. staging_environment=string Id of the connector environment which is used to connect to this source environment. cluster_address=string Address of the cluster. This property can be modified for Windows cluster only. cluster_home=string Absolute path to cluster home directory. This parameter is for UNIX cluster environments. cluster_user=string A reference of the cluster user. scan=string remote_listener=string ase_db_username=string username of the SAP ASE database. ase_db_password=string password of the SAP ASE database. --[no-]ase_enable_tls True if you want to discover the SAP ASE instances configured with TLS/SSL. --[no-]ase_skip_server_certificate_validation Setting it to true will skip the server certificate validation during the SSL handshake. Only set it if you do not want to add the required certificate into the Delphix Engine truststore but still want to use the TLS/SSL-enabled database connection. This is not recommended for a production environment as it is less secure. ase_db_vault=string The name or reference of the vault from which to read the ASE database credentials. ase_db_vault_username=string Delphix display name for the vault user ase_db_hashicorp_vault_engine=string Vault engine name where the credential is stored. ase_db_hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. ase_db_hashicorp_vault_username_key=string Key for the username in the key-value store. ase_db_hashicorp_vault_secret_key=string Key for the password in the key-value store. ase_db_cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. ase_db_azure_vault_name=string Azure key vault name. ase_db_azure_vault_username_key=string Azure vault key for the username in the key-value store. ase_db_azure_vault_secret_key=string Azure vault key for the password in the key-value store. --[no-]ase_db_use_kerberos_authentication Whether to use kerberos authentication for ASE DB discovery. --[no-]encryption_enabled Flag indicating whether the data transfer is encrypted or not. description=string The environment description. --body=PARAM the parameters to update an environment -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: search_environments ======================================== Usage: dct-toolkit search_environments[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [namespace=string] [--[no-] is_cluster] [cluster_home=string] [cluster_name=string] [scan=string] [remote_listener=string] [--[no-] is_windows_target] [staging_environment=string] [--[no-] enabled] [--[no-]encryption_enabled] [description=string] [namespace_id=string] [namespace_name=string] [--[no-] is_replica] [engine_id=string] [engine_name=string] [ase_db_user_name=string] [--[no-] ase_enable_tls] [--[no-] ase_skip_server_certificate_validation] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name namespace=string Filter by namespace --[no-]is_cluster Filter by is_cluster cluster_home=string Filter by cluster_home cluster_name=string Filter by cluster_name scan=string Filter by scan remote_listener=string Filter by remote_listener --[no-]is_windows_target Filter by is_windows_target staging_environment=string Filter by staging_environment --[no-]enabled Filter by enabled --[no-]encryption_enabled Filter by encryption_enabled description=string Filter by description namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica engine_id=string Filter by engine_id engine_name=string Filter by engine_name ase_db_user_name=string Filter by ase_db_user_name --[no-]ase_enable_tls Filter by ase_enable_tls --[no-]ase_skip_server_certificate_validation Filter by ase_skip_server_certificate_validation tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: enable_environment ======================================== Usage: dct-toolkit enable_environment[-hVw] [-cs] [-jh] environment_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. environmentId, environment_id= The ID of the environment. -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: disable_environment ======================================== Usage: dct-toolkit disable_environment[-hVw] [-cs] [-jh] environment_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. environmentId, environment_id= The ID of the environment. -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: refresh_environment ======================================== Usage: dct-toolkit refresh_environment[-hVw] [-cs] [-jh] environment_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. environmentId, environment_id= The ID of the environment. -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: list_environment_users ======================================== Usage: dct-toolkit list_environment_users[-hVw] [-cs] [-jh] environment_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. environmentId, environment_id= The ID of the environment. -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_environment_user ======================================== Usage: dct-toolkit create_environment_user[-hVw] environment_id= [-cs] [-jh] [[[username=string] [password=string] [vault=string] [vault_username=string] [hashicorp_vault_engine=string] [hashicorp_vault_secret_path=string] [hashicorp_vault_username_key=string] [hashicorp_vault_secret_key=string] [cyberark_vault_query_string=string] [azure_vault_name=string] [azure_vault_username_key=string] [azure_vault_secret_key=string] [--[no-]use_kerberos_authentication] [-- [no-]use_engine_public_key]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. environmentId, environment_id= The ID of the environment. username=string Username of the OS. password=string Password of the OS. vault=string The name or reference of the vault from which to read the host credentials. vault_username=string Delphix display name for the vault user hashicorp_vault_engine=string Vault engine name where the credential is stored. hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. hashicorp_vault_username_key=string Key for the username in the key-value store. hashicorp_vault_secret_key=string Key for the password in the key-value store. cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. azure_vault_name=string Azure key vault name. azure_vault_username_key=string Azure vault key for the username in the key-value store. azure_vault_secret_key=string Azure vault key for the password in the key-value store. --[no-]use_kerberos_authentication Whether to use kerberos authentication. --[no-]use_engine_public_key Whether to use public key authentication. --body=PARAM The parameters to create an environment user. -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_environment_user ======================================== Usage: dct-toolkit update_environment_user[-hVw] environment_id= user_ref= [-cs] [-jh] [[[username=string] [password=string] [vault=string] [vault_username=string] [hashicorp_vault_engine=string] [hashicorp_vault_secret_path=string] [hashicorp_vault_username_key=string] [hashicorp_vault_secret_key=string] [cyberark_vault_query_string=string] [azure_vault_name=string] [azure_vault_username_key=string] [azure_vault_secret_key=string] [--[no-]use_kerberos_authentication] [-- [no-]use_engine_public_key]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. environmentId, environment_id= The ID of the environment. userRef, user_ref= Environment user reference. username=string Username of the OS. password=string Password of the OS. vault=string The name or reference of the vault from which to read the host credentials. vault_username=string Delphix display name for the vault user hashicorp_vault_engine=string Vault engine name where the credential is stored. hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. hashicorp_vault_username_key=string Key for the username in the key-value store. hashicorp_vault_secret_key=string Key for the password in the key-value store. cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. azure_vault_name=string Azure key vault name. azure_vault_username_key=string Azure vault key for the username in the key-value store. azure_vault_secret_key=string Azure vault key for the password in the key-value store. --[no-]use_kerberos_authentication Whether to use kerberos authentication. --[no-]use_engine_public_key Whether to use public key authentication. --body=PARAM The parameters to create an environment user. -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_environment_user ======================================== Usage: dct-toolkit delete_environment_user[-hVw] [-cs] [-jh] environment_id= user_ref= [-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. environmentId, environment_id= The ID of the environment. -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. userRef, user_ref= Environment user reference. -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: primary_environment_user ======================================== Usage: dct-toolkit primary_environment_user[-hVw] [-cs] [-jh] environment_id= user_ref= [-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. environmentId, environment_id= The ID of the environment. -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. userRef, user_ref= Environment user reference. -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_oracle_listener ======================================== Usage: dct-toolkit create_oracle_listener[-hVw] environment_id= [-cs] [-jh] ([type=string [name=string] [protocol_addresses=array[, array...]]... [host_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. environmentId, environment_id= The ID of the environment. type=string Values: [NODE, SCAN] name=string The name of the Oracle listener. protocol_addresses=array[,array...] The protocol addresses of the Oracle listener. host_id=string The id of the host on which the Oracle listener runs. --body=PARAM The parameters to create an Oracle listener. -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_oracle_listener ======================================== Usage: dct-toolkit delete_oracle_listener[-hVw] [-cs] [-jh] environment_id= listener_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. environmentId, environment_id= The ID of the environment. -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. listenerId, listener_id= Oracle listener id. -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_oracle_listener ======================================== Usage: dct-toolkit update_oracle_listener[-hVw] environment_id= listener_id= [-cs] [-jh] [[[name=string] [protocol_addresses=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. environmentId, environment_id= The ID of the environment. listenerId, listener_id= Oracle listener id. name=string The name of the Oracle listener. protocol_addresses=array[,array...] The protocol addresses of the Oracle listener. --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 ======================================== ================================================================================ TOPIC: Executions ================================================================================ Commands (15): get_executions, search_executions, get_execution_by_id, cancel_execution, restart_execution, cleanup_execution, get_execution_events, search_execution_events, get_execution_log, get_execution_components, search_execution_components, get_execution_component_by_id, get_execution_component_log, get_discovery_results, search_discovery_results COMMAND: get_executions ======================================== Usage: dct-toolkit get_executions[-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 a 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_executions ======================================== Usage: dct-toolkit search_executions[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [engine_id=string] [engine_name=string] [job_orchestrator_id=string] [job_orchestrator_name=string] [masking_job_id=string] [masking_job_name=string] [--[no-] dct_managed] [source_connector_id=string] [target_connector_id=string] [status=string] [rows_masked=integer] [rows_total=integer] [bytes_processed=integer] [bytes_total=integer] [start_time=string] [submit_time=string] [end_time=string] [run_duration=integer] [queue_duration=integer] [total_duration=integer] [account_id=integer] [account_name=string] [hyperscale_instance_id=string] [collection_execution_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 a 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 engine_id=string Filter by engine_id engine_name=string Filter by engine_name job_orchestrator_id=string Filter by job_orchestrator_id job_orchestrator_name=string Filter by job_orchestrator_name masking_job_id=string Filter by masking_job_id masking_job_name=string Filter by masking_job_name --[no-]dct_managed Filter by dct_managed source_connector_id=string Filter by source_connector_id target_connector_id=string Filter by target_connector_id status=string Filter by status rows_masked=integer Filter by rows_masked rows_total=integer Filter by rows_total bytes_processed=integer Filter by bytes_processed bytes_total=integer Filter by bytes_total start_time=string Filter by start_time submit_time=string Filter by submit_time end_time=string Filter by end_time run_duration=integer Filter by run_duration queue_duration=integer Filter by queue_duration total_duration=integer Filter by total_duration account_id=integer Filter by account_id account_name=string Filter by account_name hyperscale_instance_id=string Filter by hyperscale_instance_id collection_execution_id=string Filter by collection_execution_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_execution_by_id ======================================== Usage: dct-toolkit get_execution_by_id[-hVw] [-cs] [-jh] execution_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. executionId, execution_id= The ID of the Execution. -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: cancel_execution ======================================== Usage: dct-toolkit cancel_execution[-hVw] execution_id= [-cs] [-jh] [[[expected_status=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. executionId, execution_id= The ID of the Execution. expected_status=string Values: [QUEUED, RUNNING]The expected status of the execution to cancel to prevent cancelling a queued job that has transitioned to a running state since the request was issued (Standard Job only). --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: restart_execution ======================================== Usage: dct-toolkit restart_execution[-hVw] [-cs] [-jh] execution_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. executionId, execution_id= The ID of the Execution. -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: cleanup_execution ======================================== Usage: dct-toolkit cleanup_execution[-hVw] [-cs] [-jh] execution_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. executionId, execution_id= The ID of the Execution. -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_execution_events ======================================== Usage: dct-toolkit get_execution_events[-hVw] [-cs] [-jh] [cursor=] execution_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. executionId, execution_id= The ID of the Execution. -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 a 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_execution_events ======================================== Usage: dct-toolkit search_execution_events[-hVw] execution_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [execution_component_id=string] [event_type=string] [severity=string] [cause=string] [count=integer] [timestamp=string] [masked_object_name=string] [algorithm_name=string] [exception_type=string] [exception_detail=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. executionId, execution_id= The ID of the Execution. 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 a 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 execution_component_id=string Filter by execution_component_id event_type=string Filter by event_type severity=string Filter by severity cause=string Filter by cause count=integer Filter by count timestamp=string Filter by timestamp masked_object_name=string Filter by masked_object_name algorithm_name=string Filter by algorithm_name exception_type=string Filter by exception_type exception_detail=string Filter by exception_detail -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_execution_log ======================================== Usage: dct-toolkit get_execution_log[-hVw] [-cs] [-jh] execution_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. executionId, execution_id= The ID of the Execution. -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_execution_components ======================================== Usage: dct-toolkit get_execution_components[-hVw] [-cs] [-jh] [cursor=] execution_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. executionId, execution_id= The ID of the Execution. -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 a 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_execution_components ======================================== Usage: dct-toolkit search_execution_components[-hVw] execution_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [status=string] [rows_masked=integer] [rows_total=integer] [bytes_processed=integer] [bytes_total=integer] [start_time=string] [end_time=string] [non_conforming_data_count=integer]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. executionId, execution_id= The ID of the Execution. 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 a 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 status=string Filter by status rows_masked=integer Filter by rows_masked rows_total=integer Filter by rows_total bytes_processed=integer Filter by bytes_processed bytes_total=integer Filter by bytes_total start_time=string Filter by start_time end_time=string Filter by end_time non_conforming_data_count=integer Filter by non_conforming_data_count -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_execution_component_by_id ======================================== Usage: dct-toolkit get_execution_component_by_id[-hVw] [-cs] [-jh] execution_component_id= execution_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. executionComponentId, execution_component_id= The ID of the Execution Component. executionId, execution_id= The ID of the Execution. -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_execution_component_log ======================================== Usage: dct-toolkit get_execution_component_log[-hVw] [-cs] [-jh] execution_component_id= execution_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. executionComponentId, execution_component_id= The ID of the Execution Component. executionId, execution_id= The ID of the Execution. -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_discovery_results ======================================== Usage: dct-toolkit get_discovery_results[-hVw] [-cs] [-jh] [cursor=] execution_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. executionId, execution_id= The ID of the Execution. -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 a 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_discovery_results ======================================== Usage: dct-toolkit search_discovery_results[-hVw] execution_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [table_name=string] [file_name=string] [column_name=string] [field_name=string] [data_class_name=string] [algorithm_name=string] [data_type=string] [confidence=integer] [--[no-]is_profiler_writable]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. executionId, execution_id= The ID of the Execution. 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 a 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 table_name=string Filter by table_name file_name=string Filter by file_name column_name=string Filter by column_name field_name=string Filter by field_name data_class_name=string Filter by data_class_name algorithm_name=string Filter by algorithm_name data_type=string Filter by data_type confidence=integer Filter by confidence --[no-]is_profiler_writable Filter by is_profiler_writable -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 ======================================== ================================================================================ TOPIC: File Mapping ================================================================================ Commands (4): get_file_mapping_by_snapshot, get_file_mapping_by_location, get_file_mapping_by_timestamp, get_file_mapping_by_bookmark COMMAND: get_file_mapping_by_snapshot ======================================== Usage: dct-toolkit get_file_mapping_by_snapshot[-hVw] [-cs] [-jh] ([file_mapping_rules=string snapshot_ids=array[,array...] [snapshot_ids=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. file_mapping_rules=string File mapping rules for the VDB provisioning. snapshot_ids=array[,array...] The list of snapshots to use for source files to be mapped. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_file_mapping_by_location ======================================== Usage: dct-toolkit get_file_mapping_by_location[-hVw] [-cs] [-jh] ([locations=array[,array...] [locations=array[,array...]]... file_mapping_rules=string source_data_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. locations=array[,array...] The list of locations to use for source files to be mapped. file_mapping_rules=string File mapping rules for the VDB provisioning. source_data_id=string The ID of the source object (dSource or VDB) to provision from. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_file_mapping_by_timestamp ======================================== Usage: dct-toolkit get_file_mapping_by_timestamp[-hVw] [-cs] [-jh] ([timestamps=array[,array...] [timestamps=array[,array...]]... file_mapping_rules=string source_data_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. timestamps=array[,array...] The list of timestamps to use for source files to be mapped. file_mapping_rules=string File mapping rules for the VDB provisioning. source_data_id=string The ID of the source object (dSource or VDB) to provision from. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_file_mapping_by_bookmark ======================================== Usage: dct-toolkit get_file_mapping_by_bookmark[-hVw] [-cs] [-jh] ([file_mapping_rules=string bookmark_ids=array[,array...] [bookmark_ids=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. file_mapping_rules=string File mapping rules for the VDB provisioning. bookmark_ids=array[,array...] The list of bookmark IDs to use for file mapping. --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 ======================================== ================================================================================ TOPIC: Groups ================================================================================ Commands (3): get_dataset_groups, search_dataset_groups, get_dataset_group_by_id COMMAND: get_dataset_groups ======================================== Usage: dct-toolkit get_dataset_groups[-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_dataset_groups ======================================== Usage: dct-toolkit search_dataset_groups[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [engine_name=string] [engine_id=string] [namespace=string] [namespace_id=string] [namespace_name=string] [--[no-]is_replica]]] [-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 engine_name=string Filter by engine_name engine_id=string Filter by engine_id namespace=string Filter by namespace namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica -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_dataset_group_by_id ======================================== Usage: dct-toolkit get_dataset_group_by_id[-hVw] [-cs] [-jh] group_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. groupId, group_id= The ID of the dataset group. -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. ======================================== ================================================================================ TOPIC: HeldSpace ================================================================================ Commands (2): get_heldspace_deletion_dependencies, delete_heldspace_by_id COMMAND: get_heldspace_deletion_dependencies ======================================== Usage: dct-toolkit get_heldspace_deletion_dependencies[-hVw] [-cs] [-jh] heldspace_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. heldspaceId, heldspace_id= The heldspace id to filter by. -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: delete_heldspace_by_id ======================================== Usage: dct-toolkit delete_heldspace_by_id[-hVw] [-cs] [-jh] heldspace_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. heldspaceId, heldspace_id= The heldspace id to filter by. -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. ======================================== ================================================================================ TOPIC: HookTemplates ================================================================================ Commands (9): list_hook_templates, create_hook_template, get_hook_template_by_id, delete_hook_template, update_hook_template, search_hook_templates, get_hook_template_tags, create_hook_template_tags, delete_hook_template_tags COMMAND: list_hook_templates ======================================== Usage: dct-toolkit list_hook_templates[-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 a descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_hook_template ======================================== Usage: dct-toolkit create_hook_template[-hVw] [-cs] [-jh] ([name=string command=string [description=string] [shell=string] [credentials_env_vars=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. name=string Name of the hook template. command=string description=string Description of the hook template. shell=string Values: [bash, shell, expect, ps, psd] credentials_env_vars=array List of environment variables that will contain credentials for this operation. tags[=array...] The tags to be created for the hook template. --body=PARAM The parameters to create a hook template. -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_hook_template_by_id ======================================== Usage: dct-toolkit get_hook_template_by_id[-hVw] [-cs] [-jh] hook_template_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. hookTemplateId, hook_template_id= The ID of the Hook Template. -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: delete_hook_template ======================================== Usage: dct-toolkit delete_hook_template[-hVw] [-cs] [-jh] hook_template_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. hookTemplateId, hook_template_id= The ID of the Hook Template. -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_hook_template ======================================== Usage: dct-toolkit update_hook_template[-hVw] hook_template_id= [-cs] [-jh] [[[name=string] [description=string] [shell=string] [command=string] [credentials_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. hookTemplateId, hook_template_id= The ID of the Hook Template. name=string Name of the hook template. description=string Description of the hook template. shell=string Values: [bash, shell, expect, ps, psd] command=string credentials_env_vars=array List of environment variables that will contain credentials for this operation. --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_hook_templates ======================================== Usage: dct-toolkit search_hook_templates[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [description=string] [shell=string] [command=string] [-- [no-]dct_managed] [engine_id=integer] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 description=string Filter by description shell=string Filter by shell command=string Filter by command --[no-]dct_managed Filter by dct_managed engine_id=integer Filter by engine_id tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_hook_template_tags ======================================== Usage: dct-toolkit get_hook_template_tags[-hVw] [-cs] [-jh] hook_template_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. hookTemplateId, hook_template_id= The ID of the Hook Template. -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_hook_template_tags ======================================== Usage: dct-toolkit create_hook_template_tags[-hVw] hook_template_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. hookTemplateId, hook_template_id= The ID of the Hook Template. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Hook Template. -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_hook_template_tags ======================================== Usage: dct-toolkit delete_hook_template_tags[-hVw] hook_template_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. hookTemplateId, hook_template_id= The ID of the Hook Template. 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 ======================================== ================================================================================ TOPIC: HyperscaleInstance ================================================================================ Commands (12): get_hyperscale_instances, register_hyperscale_instance, search_hyperscale_instances, get_hyperscale_instance_by_id, unregister_hyperscale_instance, update_hyperscale_instance, get_hyperscale_instance_tags, create_hyperscale_instance_tags, delete_hyperscale_instance_tags, sync_engines_hyperscale_instance, add_engine_to_hyperscale_instance, remove_engine_from_hyperscale_instance COMMAND: get_hyperscale_instances ======================================== Usage: dct-toolkit get_hyperscale_instances[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: register_hyperscale_instance ======================================== Usage: dct-toolkit register_hyperscale_instance[-hVw] [-cs] [-jh] ([data_type=string api_key=string name=string hostname=string [--[no-] insecure_ssl] [--[no-]unsafe_ssl_hostname_check] [tags[=array...]]... [-- [no-]make_current_account_owner]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. data_type=string Values: [ORACLE, MSSQL, DELIMITED_FILES, MONGO_DB] The data type designation for the hyperscale deployment. api_key=string API key to connect to the Hyperscale instance. name=string Name in DCT of the Hyperscale instance. hostname=string Hostname of the Hyperscale instance. If the Hyperscale instance is running on a custom port (not 443), the port can be specified using the "hostname:port" format, for instance "hyperscale-1.mycompany.co:1765" --[no-]insecure_ssl Allow connections to the hyperscale instance over HTTPs without validating the TLS certificate. Even though the connection to the hyperscale instance might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the hyperscale instance over HTTPs. Setting this value must only be done if the TLS certificate of the hyperscale instance does not match the hostname, and the TLS configuration of the hyperscale instance cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. tags[=array...] The tags to be created for this engine. --[no-]make_current_account_owner Whether the account creating this Hyperscale instance must be configured as owner of it. --body=PARAM The parameters to register a Hyperscale instance. -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_hyperscale_instances ======================================== Usage: dct-toolkit search_hyperscale_instances[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [hostname=string] [creation_date=string] [data_type=string] [--[no-]insecure_ssl] [--[no-] unsafe_ssl_hostname_check] [status=string] [connection_status=string] [connection_status_details=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name hostname=string Filter by hostname creation_date=string Filter by creation_date data_type=string Filter by data_type --[no-]insecure_ssl Filter by insecure_ssl --[no-]unsafe_ssl_hostname_check Filter by unsafe_ssl_hostname_check status=string Filter by status connection_status=string Filter by connection_status connection_status_details=string Filter by connection_status_details tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_hyperscale_instance_by_id ======================================== Usage: dct-toolkit get_hyperscale_instance_by_id[-hVw] [-cs] [-jh] hyperscale_instance_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. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. -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: unregister_hyperscale_instance ======================================== Usage: dct-toolkit unregister_hyperscale_instance[-hVw] [-cs] [-jh] hyperscale_instance_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. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. -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_hyperscale_instance ======================================== Usage: dct-toolkit update_hyperscale_instance[-hVw] hyperscale_instance_id= [-cs] [-jh] [[[name=string] [hostname=string] [api_key=string] [data_type=string] [-- [no-]insecure_ssl] [--[no-]unsafe_ssl_hostname_check]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. name=string Name in DCT of the Hyperscale instance. hostname=string Hostname of the Hyperscale instance. If the Hyperscale instance is running on a custom port (not 443), the port can be specified using the "hostname:port" format, for instance "hyperscale-1.mycompany.co:1765" api_key=string API key to connect to the Hyperscale instance. data_type=string Values: [ORACLE, MSSQL, DELIMITED_FILES, MONGO_DB] The data type designation for the hyperscale deployment. --[no-]insecure_ssl Allow connections to the hyperscale instance over HTTPs without validating the TLS certificate. Even though the connection to the hyperscale instance might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the hyperscale instance over HTTPs. Setting this value must only be done if the TLS certificate of the hyperscale instance does not match the hostname, and the TLS configuration of the hyperscale instance cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. --body=PARAM Update parameters for a hyperscale instance. -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_hyperscale_instance_tags ======================================== Usage: dct-toolkit get_hyperscale_instance_tags[-hVw] [-cs] [-jh] hyperscale_instance_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. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. -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_hyperscale_instance_tags ======================================== Usage: dct-toolkit create_hyperscale_instance_tags[-hVw] hyperscale_instance_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. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Hyperscale Instance. -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_hyperscale_instance_tags ======================================== Usage: dct-toolkit delete_hyperscale_instance_tags[-hVw] hyperscale_instance_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. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. 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: sync_engines_hyperscale_instance ======================================== Usage: dct-toolkit sync_engines_hyperscale_instance[-hVw] hyperscale_instance_id= [-cs] [-jh] ([target_engine_ids=array[,array...] [target_engine_ids=array[, array...]]... source_engine_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. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. target_engine_ids=array[,array...] The IDs of the target engines to copy the data into. source_engine_id=string The ID of the engine to copy the data from. --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: add_engine_to_hyperscale_instance ======================================== Usage: dct-toolkit add_engine_to_hyperscale_instance[-hVw] hyperscale_instance_id= [-cs] [-jh] [[[engine_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. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. engine_id=string --body=PARAM Body containing the ID of the registered engine. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: remove_engine_from_hyperscale_instance ======================================== Usage: dct-toolkit remove_engine_from_hyperscale_instance[-hVw] hyperscale_instance_id= [-cs] [-jh] [[[engine_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. hyperscaleInstanceId, hyperscale_instance_id= The ID of hyperscale instance. engine_id=string --body=PARAM Body containing the ID of the registered engine. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: HyperscaleObjects ================================================================================ Commands (26): get_hyperscale_mount_points, create_hyperscale_mount_point, get_hyperscale_mount_point_by_id, delete_hyperscale_mount_point, update_hyperscale_mount_point_by_id, search_hyperscale_mount_points, get_hyperscale_connectors, create_hyperscale_connector, get_hyperscale_connector_by_id, delete_hyperscale_connector, update_hyperscale_connector_by_id, get_hyperscale_connector_tags, create_hyperscale_connector_tags, delete_hyperscale_connector_tags, search_hyperscale_connectors, get_hyperscale_datasets, get_hyperscale_dataset_by_id, update_hyperscale_dataset_by_id, get_hyperscale_dataset_tags, create_hyperscale_dataset_tags, delete_hyperscale_dataset_tags, get_hyperscale_dataset_table_or_file_by_id, update_hyperscale_dataset_table_or_file_by_id, get_hyperscale_dataset_tables_or_files, search_hyperscale_dataset_tables_or_files, search_hyperscale_datasets COMMAND: get_hyperscale_mount_points ======================================== Usage: dct-toolkit get_hyperscale_mount_points[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_hyperscale_mount_point ======================================== Usage: dct-toolkit create_hyperscale_mount_point[-hVw] [-cs] [-jh] ([hyperscale_instance_id=string [id=string] [name=string] [hostname=string] [mount_path=string] [mount_type=string] [options=string] [staging_storage_type=string] [auth_mechanism=string] [aws_bucket_name=string] [aws_bucket_region=string] [aws_bucket_prefix=string] [aws_bucket_delimiter=string] [blob_auth_type=string] [blob_account_name=string] [blob_container_name=string] [blob_container_prefix=string] [blob_container_delimiter=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. hyperscale_instance_id=string The ID of the Hyperscale instance of this Mount Point. id=string The ID of the Hyperscale Mount Point. name=string Name of the mount, unique for a hyperscale instance. This name will be used as a directory name by the Hyperscale instance. hostname=string The host name of the server. mount_path=string The path to the directory on the filesystem to mount. mount_type=string Values: [CIFS, NFS3, NFS4]The type of mount filesystem. Enum having values- CIFS, NFS3, NFS4. options=string The options for mount. The endpoint will return all default options and user specified options. staging_storage_type=string Values: [MOUNT, AWS_S3, AZURE_BLOB_STORAGE]The type of staging storage. auth_mechanism=string Values: [AWS_ROLE, AWS_SECRET]The authentication mechanism for AWS_S3 storage. aws_bucket_name=string The aws bucket name for AWS_S3 storage. aws_bucket_region=string The aws bucket region for AWS_S3 storage. aws_bucket_prefix=string The aws bucket prefix for AWS_S3 storage. aws_bucket_delimiter=string The aws bucket delimiter for AWS_S3 storage. blob_auth_type=string Values: [AZURE_SECRET, AZURE_MANAGED_IDENTITY]The authentication type for Azure blob storage. blob_account_name=string The storage account name for Azure blob storage. blob_container_name=string The blob container name for Azure blob storage. blob_container_prefix=string The blob container prefix for Azure blob storage. blob_container_delimiter=string The blob container delimiter for Azure blob storage. --body=PARAM Request to create a Hyperscale Mount Point. -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_hyperscale_mount_point_by_id ======================================== Usage: dct-toolkit get_hyperscale_mount_point_by_id[-hVw] [-cs] [-jh] hyperscale_mount_point_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. hyperscaleMountPointId, hyperscale_mount_point_id= The ID of the Hyperscale Mount Point. -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: delete_hyperscale_mount_point ======================================== Usage: dct-toolkit delete_hyperscale_mount_point[-hVw] [-cs] [-jh] hyperscale_mount_point_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. hyperscaleMountPointId, hyperscale_mount_point_id= The ID of the Hyperscale Mount Point. -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_hyperscale_mount_point_by_id ======================================== Usage: dct-toolkit update_hyperscale_mount_point_by_id[-hVw] hyperscale_mount_point_id= [-cs] [-jh] [[[name=string] [hostname=string] [mount_path=string] [mount_type=string] [options=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. hyperscaleMountPointId, hyperscale_mount_point_id= The ID of the Hyperscale Mount Point. name=string Name of the mount, unique for a hyperscale instance. hostname=string The host name of the server. mount_path=string The path to the directory on the filesystem to mount. mount_type=string Values: [CIFS, NFS3, NFS4]The type of filesystem. options=string The mount options. --body=PARAM The new data to update a Hyperscale Mount Point. -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_hyperscale_mount_points ======================================== Usage: dct-toolkit search_hyperscale_mount_points[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [hyperscale_instance_id=string] [name=string] [hostname=string] [mount_type=string] [mount_path=string] [options=string] [staging_storage_type=string] [auth_mechanism=string] [aws_bucket_name=string] [aws_bucket_region=string] [aws_bucket_prefix=string] [aws_bucket_delimiter=string] [blob_auth_type=string] [blob_account_name=string] [blob_container_name=string] [blob_container_prefix=string] [blob_container_delimiter=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id hyperscale_instance_id=string Filter by hyperscale_instance_id name=string Filter by name hostname=string Filter by hostname mount_type=string Filter by mount_type mount_path=string Filter by mount_path options=string Filter by options staging_storage_type=string Filter by staging_storage_type auth_mechanism=string Filter by auth_mechanism aws_bucket_name=string Filter by aws_bucket_name aws_bucket_region=string Filter by aws_bucket_region aws_bucket_prefix=string Filter by aws_bucket_prefix aws_bucket_delimiter=string Filter by aws_bucket_delimiter blob_auth_type=string Filter by blob_auth_type blob_account_name=string Filter by blob_account_name blob_container_name=string Filter by blob_container_name blob_container_prefix=string Filter by blob_container_prefix blob_container_delimiter=string Filter by blob_container_delimiter -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_hyperscale_connectors ======================================== Usage: dct-toolkit get_hyperscale_connectors[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_hyperscale_connector ======================================== Usage: dct-toolkit create_hyperscale_connector[-hVw] [-cs] [-jh] [[[hyperscale_instance_id=string] [data_type=string] [name=string] [source_username=string] [source_password=string] [source_jdbc_url=string] [source_mongo_url=string] [source_filesystem_path=string] [source_connection_properties [=object...]]... [target_username=string] [target_password=string] [target_jdbc_url=string] [target_mongo_url=string] [target_filesystem_path=string] [target_connection_properties [=object...]]... [tags[=array...]]... [--[no-] make_current_account_owner]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. hyperscale_instance_id=string The ID of the Hyperscale instance of this Connector. data_type=string Values: [ORACLE, MSSQL, DELIMITED_FILES, MONGO_DB] The data type designation for the hyperscale deployment. name=string source_username=string The username this Connector will use to connect to the source database. source_password=string The password this Connector will use to connect to the source database. source_jdbc_url=string The JDBC URL used to connect to the source database. source_mongo_url=string The MongoDB URL used to connect to the source database. source_filesystem_path=string The path on the filesystem where source files must be read (Delimited files Only). source_connection_properties[=object...] target_username=string The username this Connector will use to connect to the target database. target_password=string The username this Connector will use to connect to the target database. target_jdbc_url=string The JDBC URL used to connect to the target database. target_mongo_url=string The MongoDB URL used to connect to the target database. target_filesystem_path=string The path on the filesystem where target files must be written (Delimited files Only). target_connection_properties[=object...] tags[=array...] --[no-]make_current_account_owner Whether the account creating this Hyperscale Connector must be configured as owner of it. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_hyperscale_connector_by_id ======================================== Usage: dct-toolkit get_hyperscale_connector_by_id[-hVw] [-cs] [-jh] hyperscale_connector_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. hyperscaleConnectorId, hyperscale_connector_id= The ID of the Hyperscale Connector. -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: delete_hyperscale_connector ======================================== Usage: dct-toolkit delete_hyperscale_connector[-hVw] [-cs] [-jh] hyperscale_connector_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. hyperscaleConnectorId, hyperscale_connector_id= The ID of the Hyperscale Connector. -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_hyperscale_connector_by_id ======================================== Usage: dct-toolkit update_hyperscale_connector_by_id[-hVw] hyperscale_connector_id= [-cs] [-jh] [[[name=string] [source_username=string] [source_password=string] [source_jdbc_url=string] [source_mongo_url=string] [source_filesystem_path=string] [source_connection_properties [=object...]]... [target_username=string] [target_password=string] [target_jdbc_url=string] [target_mongo_url=string] [target_filesystem_path=string] [target_connection_properties [=object...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. hyperscaleConnectorId, hyperscale_connector_id= The ID of the Hyperscale Connector. name=string source_username=string The username this Connector will use to connect to the source database. source_password=string The password this Connector will use to connect to the source database. source_jdbc_url=string The JDBC URL used to connect to the source database. source_mongo_url=string The MongoDB URL used to connect to the source database. source_filesystem_path=string The path on the filesystem where source files must be read (Delimited files Only). source_connection_properties[=object...] target_username=string The username this Connector will use to connect to the target database. target_password=string The username this Connector will use to connect to the target database. target_jdbc_url=string The JDBC URL used to connect to the target database. target_mongo_url=string The MongoDB URL used to connect to the target database. target_filesystem_path=string The path on the filesystem where target files must be written (Delimited files Only). target_connection_properties[=object...] --body=PARAM The new data to update a Hyperscale Connector. -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_hyperscale_connector_tags ======================================== Usage: dct-toolkit get_hyperscale_connector_tags[-hVw] [-cs] [-jh] hyperscale_connector_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. hyperscaleConnectorId, hyperscale_connector_id= The ID of the Hyperscale Connector. -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_hyperscale_connector_tags ======================================== Usage: dct-toolkit create_hyperscale_connector_tags[-hVw] hyperscale_connector_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. hyperscaleConnectorId, hyperscale_connector_id= The ID of the Hyperscale Connector. tags[=array...] Array of tags with key value pairs --body=PARAM Tag information for a Hyperscale Connector. -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_hyperscale_connector_tags ======================================== Usage: dct-toolkit delete_hyperscale_connector_tags[-hVw] hyperscale_connector_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. hyperscaleConnectorId, hyperscale_connector_id= The ID of the Hyperscale Connector. 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: search_hyperscale_connectors ======================================== Usage: dct-toolkit search_hyperscale_connectors[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [hyperscale_instance_id=string] [data_type=string] [source_username=string] [source_jdbc_url=string] [source_mongo_url=string] [source_filesystem_path=string] [target_username=string] [target_jdbc_url=string] [target_mongo_url=string] [target_filesystem_path=string] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c= [,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name hyperscale_instance_id=string Filter by hyperscale_instance_id data_type=string Filter by data_type source_username=string Filter by source_username source_jdbc_url=string Filter by source_jdbc_url source_mongo_url=string Filter by source_mongo_url source_filesystem_path=string Filter by source_filesystem_path target_username=string Filter by target_username target_jdbc_url=string Filter by target_jdbc_url target_mongo_url=string Filter by target_mongo_url target_filesystem_path=string Filter by target_filesystem_path tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_hyperscale_datasets ======================================== Usage: dct-toolkit get_hyperscale_datasets[-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: get_hyperscale_dataset_by_id ======================================== Usage: dct-toolkit get_hyperscale_dataset_by_id[-hVw] [-cs] [-jh] hyperscale_dataset_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. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. -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_hyperscale_dataset_by_id ======================================== Usage: dct-toolkit update_hyperscale_dataset_by_id[-hVw] hyperscale_dataset_id= [-cs] [-jh] [[[mount_point_id=string] [connector_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. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. mount_point_id=string The Id of the Hyperscale Mount Point used for this Dataset. connector_id=string Id the Hyperscale Connector used to read sensitive data and write masked data. --body=PARAM The new data to update a Hyperscale Dataset. -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_hyperscale_dataset_tags ======================================== Usage: dct-toolkit get_hyperscale_dataset_tags[-hVw] [-cs] [-jh] hyperscale_dataset_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. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. -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_hyperscale_dataset_tags ======================================== Usage: dct-toolkit create_hyperscale_dataset_tags[-hVw] hyperscale_dataset_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. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. tags[=array...] Array of tags with key value pairs --body=PARAM Tag information for a Hyperscale Dataset. -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_hyperscale_dataset_tags ======================================== Usage: dct-toolkit delete_hyperscale_dataset_tags[-hVw] hyperscale_dataset_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. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_hyperscale_dataset_table_or_file_by_id ======================================== Usage: dct-toolkit get_hyperscale_dataset_table_or_file_by_id[-hVw] [-cs] [-jh] hyperscale_dataset_id= hyperscale_dataset_table_or_file_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. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. hyperscaleDatasetTableOrFileId, hyperscale_dataset_table_or_file_id= The ID of the Hyperscale Dataset table or file. -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_hyperscale_dataset_table_or_file_by_id ======================================== Usage: dct-toolkit update_hyperscale_dataset_table_or_file_by_id[-hVw] hyperscale_dataset_id= hyperscale_dataset_table_or_file_id= [-cs] [-jh] [[[filter_key=string] [column_array_rows=integer] [unload_split=integer] [stream_size=integer] [end_of_record=string] [delimiter=string] [enclosure=string] [enclosure_escape_character=string] [--[no-] escape_enclosure_escape_character] [--[no-]has_headers] [unique_source_files_identifier=string] [source_files=array[, array...]]... [--[no-]perform_join]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. hyperscaleDatasetTableOrFileId, hyperscale_dataset_table_or_file_id= The ID of the Hyperscale Dataset table or file. filter_key=string The unique database column field to filter the source data. Set this property to an empty string to clear the value. column_array_rows=integer The number of column array rows to be used by the sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built. unload_split=integer The number of unloaded files to be generated from the source database. stream_size=integer Long The stream size to be used by the sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server. end_of_record=string The end of line character. Support values are \n, \r and \r\n (Delimited files only). delimiter=string The single character length delimiter used in source files (Delimited files only). enclosure=string The single character length quote character used in the source files (Delimited files only). enclosure_escape_character=string The escape character used to escape quote characters (Delimited files only). --[no-]escape_enclosure_escape_character Whether to escape the enclosure escape character (Delimited files only). --[no-]has_headers Whether source files have header column names or not (Delimited files only). If set to true, format files with the same column names are created and the same can be used for the masking inventory. If set to false, the column names of pattern f0, f1, f2, and so on are used to create the format files for delimited file masking. unique_source_files_identifier=string This is the source key that maps the load-service and masking-service data sets with the unload-service data set (Delimited files only). Please ensure that this value is different for each HyperscaleDatasetTableOrFile. source_files=array[,array...] List of all source files that need to be masked (Delimited files only). All files should have the same delimiter character and other helper characters. All files should have the same number of columns and same column names if it has a header line. --[no-]perform_join Whether the split files must be joined (Delimited files only). --body=PARAM The new data to update a Hyperscale Dataset table or file. -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_hyperscale_dataset_tables_or_files ======================================== Usage: dct-toolkit get_hyperscale_dataset_tables_or_files[-hVw] [-cs] [-jh] [cursor=] hyperscale_dataset_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -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. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. -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_hyperscale_dataset_tables_or_files ======================================== Usage: dct-toolkit search_hyperscale_dataset_tables_or_files[-hVw] hyperscale_dataset_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [schema_name=string] [table_name=string] [filter_key=string] [column_array_rows=integer] [unload_split=integer] [stream_size=integer]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. hyperscaleDatasetId, hyperscale_dataset_id= The ID of the Hyperscale Dataset. 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 schema_name=string Filter by schema_name table_name=string Filter by table_name filter_key=string Filter by filter_key column_array_rows=integer Filter by column_array_rows unload_split=integer Filter by unload_split stream_size=integer Filter by stream_size -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_hyperscale_datasets ======================================== Usage: dct-toolkit search_hyperscale_datasets[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [hyperscale_instance_id=string] [data_type=string] [mount_point_id=string] [connector_id=string] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c= [,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id hyperscale_instance_id=string Filter by hyperscale_instance_id data_type=string Filter by data_type mount_point_id=string Filter by mount_point_id connector_id=string Filter by connector_id tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: JobCollectionExecutions ================================================================================ Commands (4): get_job_collection_executions, search_job_collection_executions, get_job_collection_execution_by_id, cancel_job_collection_execution COMMAND: get_job_collection_executions ======================================== Usage: dct-toolkit get_job_collection_executions[-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 a 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_job_collection_executions ======================================== Usage: dct-toolkit search_job_collection_executions[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [compliance_job_collection_id=string] [compliance_job_collection_name=string] [status=string] [status_reason=string] [start_time=string] [end_time=string] [run_duration=integer] [actual_execution_count=integer] [planned_execution_count=integer] [rows_processed=integer] [rows_total=integer] [bytes_processed=integer] [bytes_total=integer] [processed_tables_files_count=integer] [tables_files_count=integer] [processed_columns_fields_count=integer] [columns_fields_count=integer] [execute_account_id=integer] [execute_account_name=string] [cancel_account_id=integer] [cancel_account_name=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 a 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 compliance_job_collection_id=string Filter by compliance_job_collection_id compliance_job_collection_name=string Filter by compliance_job_collection_name status=string Filter by status status_reason=string Filter by status_reason start_time=string Filter by start_time end_time=string Filter by end_time run_duration=integer Filter by run_duration actual_execution_count=integer Filter by actual_execution_count planned_execution_count=integer Filter by planned_execution_count rows_processed=integer Filter by rows_processed rows_total=integer Filter by rows_total bytes_processed=integer Filter by bytes_processed bytes_total=integer Filter by bytes_total processed_tables_files_count=integer Filter by processed_tables_files_count tables_files_count=integer Filter by tables_files_count processed_columns_fields_count=integer Filter by processed_columns_fields_count columns_fields_count=integer Filter by columns_fields_count execute_account_id=integer Filter by execute_account_id execute_account_name=string Filter by execute_account_name cancel_account_id=integer Filter by cancel_account_id cancel_account_name=string Filter by cancel_account_name -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_job_collection_execution_by_id ======================================== Usage: dct-toolkit get_job_collection_execution_by_id[-hVw] [-cs] [-jh] job_collection_execution_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 jobCollectionExecutionId, job_collection_execution_id= The ID of the job collection execution. -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: cancel_job_collection_execution ======================================== Usage: dct-toolkit cancel_job_collection_execution[-hV] job_collection_execution_id= -h, --help Show this help message and exit. jobCollectionExecutionId, job_collection_execution_id= The ID of the job collection execution. -V, --version Print version information and exit. ======================================== ================================================================================ TOPIC: Jobs ================================================================================ Commands (8): get_jobs, search_jobs, get_job_by_id, abandon_job, get_job_result, get_job_tags, create_job_tags, delete_job_tag COMMAND: get_jobs ======================================== Usage: dct-toolkit get_jobs[-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_jobs ======================================== Usage: dct-toolkit search_jobs[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [status=string] [type=string] [localized_type=string] [target_id=string] [target_name=string] [start_time=string] [update_time=string] [error_details=string] [trace_id=string] [engine_ids=array[string]] [account_name=string]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id status=string Filter by status type=string Filter by type localized_type=string Filter by localized_type target_id=string Filter by target_id target_name=string Filter by target_name start_time=string Filter by start_time update_time=string Filter by update_time error_details=string Filter by error_details trace_id=string Filter by trace_id engine_ids=array[string] Filter by engine_ids account_name=string Filter by account_name -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_job_by_id ======================================== Usage: dct-toolkit get_job_by_id[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= The ID of the job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: abandon_job ======================================== Usage: dct-toolkit abandon_job[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= The ID of the job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_job_result ======================================== Usage: dct-toolkit get_job_result[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= The ID of the job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_job_tags ======================================== Usage: dct-toolkit get_job_tags[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= The ID of the job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_job_tags ======================================== Usage: dct-toolkit create_job_tags[-hVw] job_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. jobId, job_id= The ID of the job. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Job. -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_job_tag ======================================== Usage: dct-toolkit delete_job_tag[-hVw] job_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. jobId, job_id= The ID of the job. 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 ======================================== ================================================================================ TOPIC: KerberosConfig ================================================================================ Commands (3): get_kerberos_config_by_id, list_kerberos_configs, search_kerberos_configs COMMAND: get_kerberos_config_by_id ======================================== Usage: dct-toolkit get_kerberos_config_by_id[-hVw] [-cs] [-jh] kerberos_config_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. kerberosConfigId, kerberos_config_id= The ID of the kerberos config. -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: list_kerberos_configs ======================================== Usage: dct-toolkit list_kerberos_configs[-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_kerberos_configs ======================================== Usage: dct-toolkit search_kerberos_configs[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [engine_name=string] [engine_id=string] [namespace_id=string] [namespace_name=string] [--[no-]is_replica] [principal=string] [realm=string] [--[no-]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 engine_name=string Filter by engine_name engine_id=string Filter by engine_id namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica principal=string Filter by principal realm=string Filter by realm --[no-]enabled Filter by 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 ======================================== ================================================================================ TOPIC: License ================================================================================ Commands (2): get_license, change_license COMMAND: get_license ======================================== Usage: dct-toolkit get_license[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: change_license ======================================== Usage: dct-toolkit change_license[-hVw] [-cs] [-jh] ([tier=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. tier=string Values: [CORE, SELF_SERVICE, ENTERPRISE]The DCT license tiers. --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 ======================================== ================================================================================ TOPIC: Login ================================================================================ Commands (3): account_login, account_logout, token_info COMMAND: account_login ======================================== Usage: dct-toolkit account_login[-hVw] [-cs] [-jh] [[[username=string] [password=string] [api_key=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. username=string Username of the account that needs to login password=string Password of the account that needs to login. api_key=string API key (without 'apk ' prefix) of the account that needs to login. When api_key is set then username/password would be ignored if provided. --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: account_logout ======================================== Usage: dct-toolkit account_logout[-hVw] [-cs] [-jh] authorization= [-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. authorization, Authorization= Access token -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: token_info ======================================== Usage: dct-toolkit token_info[-hVw] [-cs] [-jh] ([token=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. token=string API Key or JWT token for fetching information --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 ======================================== ================================================================================ TOPIC: Management ================================================================================ Commands (45): validate_java_path, get_registered_engines, register_engine, get_registered_engine, update_registered_engine, unregister_engine, update_registered_engine_partial, get_engine_auto_tagging_config, update_engine_auto_tagging_config, get_compliance_application_settings, search_compliance_application_settings, search_engines, get_engine_tags, create_engine_tags, delete_engine_tags, get_hashicorp_vaults, create_hashicorp_vault, search_hashicorp_vaults, get_hashicorp_vault, delete_hashicorp_vault, get_hashicorp_vault_tags, create_hashicorp_vault_tags, delete_hashicorp_vault_tag, list_properties, update_properties, get_api_classification, update_api_classification, get_smtp_config, update_smtp_config, validate_smtp_config, get_metadata_database, get_ldap_config, update_ldap_config, validate_ldap_config, get_saml_config, update_saml_config, get_dct_product_telemetry_events, trigger_dct_product_telemetry_bundle_upload, get_proxy_configuration, update_proxy_configuration, get_product_registration_delphix_connectivity_check, get_product_registration_status, get_product_registration_key, register_product_offline, register_product_online COMMAND: validate_java_path ======================================== Usage: dct-toolkit validate_java_path[-hVw] engine_id= [-cs] [-jh] ([java_home=string port=integer host_name=string [username=string] [password=string] [--[no-] use_engine_public_key] [vault_id=string] [hashicorp_vault_engine=string] [hashicorp_vault_secret_path=string] [hashicorp_vault_username_key=string] [hashicorp_vault_secret_key=string] [azure_vault_name=string] [azure_vault_username_key=string] [azure_vault_secret_key=string] [cyberark_vault_query_string=string] [-- [no-]use_kerberos_authentication]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. java_home=string Path pointing to java home on the remote machine. port=integer SSH port of the remote host machine that will be used to establish SSH connection. host_name=string Hostname of the remote host machine that will be used to establish connection. username=string The username of the user that will be used to connect to the remote host machine. password=string The password of the user that will be used to connect to the remote host machine. --[no-]use_engine_public_key Whether to use public key authentication. vault_id=string The DCT id or name of the vault from which to read the host credentials. hashicorp_vault_engine=string Vault engine name where the credential is stored. hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. hashicorp_vault_username_key=string Key for the username in the key-value store. hashicorp_vault_secret_key=string Key for the password in the key-value store. azure_vault_name=string Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_username_key=string Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). azure_vault_secret_key=string Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. --[no-]use_kerberos_authentication Whether to use kerberos authentication. --body=PARAM The api to check connectivity of engine and a remote host on given port. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_registered_engines ======================================== Usage: dct-toolkit get_registered_engines[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: register_engine ======================================== Usage: dct-toolkit register_engine[-hVw] [-cs] [-jh] ([name=string hostname=string [hashicorp_vault_masking_username_command_arg s=array[,array...]]... [--auto_tagging_config.enable_engine_name] [masking_password=string] [--[no-] unsafe_ssl_hostname_check] [hashicorp_vault_masking_password_command_arg s=array[,array...]]... [hashicorp_vault_id=integer] [hashicorp_vault_username_command_args=array [,array...]]... [tags[=array...]]... [--auto_tagging_config. enable_masking_applications] [hashicorp_vault_password_command_args=array [,array...]]... [password=string] [auto_tagging_config.custom_tags=array] [-- [no-]insecure_ssl] [--auto_tagging_config. enable_virtualization_dataset_groups] [masking_hashicorp_vault_id=integer] [--auto_tagging_config. enable_masking_environments] [username=string] [masking_username=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. name=string hostname=string hashicorp_vault_masking_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine. --auto_tagging_config.enable_engine_name Include the engine name as a tag on discovered objects (key 'dlpx-engine'). masking_password=string The masking admin password. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. hashicorp_vault_masking_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine. hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve virtualization engine credentials. hashicorp_vault_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualzation username for the engine. tags[=array...] The tags to be created for this engine. --auto_tagging_config.enable_masking_applications Include masking app names as tags for masking Jobs and Connectors (key 'dlpx-application'). hashicorp_vault_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine. password=string The virtualization domain admin password. auto_tagging_config.custom_tags=array List of custom tags to add to discovered objects. --[no-]insecure_ssl Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates.. --auto_tagging_config.enable_virtualization_dataset_groups Include dataset group names as tags for dSources, VDBs, and vCDBs (key 'dlpx-dataset-group'). masking_hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve masking engine credentials. --auto_tagging_config.enable_masking_environments Include masking environment names as tags for masking Jobs and Connectors (key 'dlpx-environment'). username=string The virtualization domain admin username. masking_username=string The masking admin username. --body=PARAM The parameters to register an engine. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_registered_engine ======================================== Usage: dct-toolkit get_registered_engine[-hVw] [-cs] [-jh] engine_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. engineId, engine_id= The ID of the registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_registered_engine ======================================== Usage: dct-toolkit update_registered_engine[-hVw] engine_id= [-cs] [-jh] [[[id=string] [uuid=string] [type=string] [version=string] [name=string] [ssh_public_key=string] [hostname=string] [cpu_core_count=integer] [memory_size=integer] [data_storage_capacity=integer] [data_storage_used=integer] [--[no-] insecure_ssl] [--[no-]unsafe_ssl_hostname_check] [status=string] [connection_status=string] [engine_connection_status=string] [connection_status_details=string] [engine_connection_status_details=string] [username=string] [password=string] [masking_username=string] [masking_password=string] [hashicorp_vault_username_command_args=array[,array...]]... [hashicorp_vault_masking_username_command_args=array[,array...]]... [hashicorp_vault_password_command_args=array[,array...]]... [hashicorp_vault_masking_password_command_args=array[,array...]]... [masking_hashicorp_vault_id=integer] [hashicorp_vault_id=integer] [tags [=array...]]... [masking_memory_used=integer] [masking_allocated_memory=integer] [masking_jobs_running=integer] [masking_max_concurrent_jobs=integer] [masking_available_cores=integer] [hyperscale_instance_ids=array[,array...]]... [hyperscale_truststore_filename=string] [hyperscale_truststore_password=string] [--[no-]using_object_storage] [-- [no-]using_continuous_vault] [platform=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. id=string The Engine object entity ID. uuid=string The unique identifier generated by this engine. type=string Values: [VIRTUALIZATION, MASKING, BOTH, UNSET]The type of this engine. version=string The engine version. name=string The name of this engine. ssh_public_key=string The ssh public key of this engine. hostname=string The hostname of this engine. cpu_core_count=integer The total number of CPU cores on this engine. memory_size=integer The total amount of memory on this engine, in bytes. data_storage_capacity=integer The total amount of storage allocated for engine objects and system metadata, in bytes. data_storage_used=integer The amount of storage used by engine objects and system metadata, in bytes. --[no-]insecure_ssl Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. status=string Values: [CREATED, DELETING]the status of the engine connection_status=string Values: [ONLINE, OFFLINE]The status of the connection to the engine. Deprecated; use "engine_connection_status" instead. engine_connection_status=string Values: [ONLINE, CONNECTION_ERROR, MISSING_CREDENTIALS, BAD_CREDENTIALS]The state of the connection to the engine. connection_status_details=string If set, details about the status of the connection to the engine. Deprecated; use "engine_connection_status_details" instead. engine_connection_status_details=string If set, details about the state of the connection to the engine. username=string The virtualization domain admin username. password=string The virtualization domain admin password. masking_username=string The masking admin username. masking_password=string The masking admin password. hashicorp_vault_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization username for the engine. hashicorp_vault_masking_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine. hashicorp_vault_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine. hashicorp_vault_masking_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine. masking_hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve masking engine credentials. hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve virtualization engine credentials. tags[=array...] The tags to be created for this engine. masking_memory_used=integer The current amount of memory used by running masking jobs in bytes. masking_allocated_memory=integer The maximum amount of memory available for running masking jobs in bytes. masking_jobs_running=integer The number of masking jobs currently running. masking_max_concurrent_jobs=integer The maximum number of masking jobs that can be running at the same time. masking_available_cores=integer The number of CPU cores available to the masking engine. hyperscale_instance_ids=array[,array...] List of Hyperscale Instances that this engine is connected to. hyperscale_truststore_filename=string File name of a truststore which can be used to validate the TLS certificate of the engine as expected by associated hyperscale instances. hyperscale_truststore_password=string Password to read the truststore as expected by associated hyperscale instances. --[no-]using_object_storage true if the engine is using an object store (like AWS S3) to store data | false if the engine is using block storage to store its data | null if the engine is not initialized (unlikely) or the engine API version does not provide that information --[no-]using_continuous_vault true if the engine is using an object store (like AWS S3) to store data | false if the engine is using block storage to store its data | null if the engine is not initialized (unlikely) or the engine API version does not provide that information platform=string The infrastructure or environment where the engine is deployed or built, including cloud provider and instance type. --body=PARAM The updated registration engine information. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: unregister_engine ======================================== Usage: dct-toolkit unregister_engine[-hVw] [-cs] [-jh] engine_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. engineId, engine_id= The ID of the registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_registered_engine_partial ======================================== Usage: dct-toolkit update_registered_engine_partial[-hVw] engine_id= [-cs] [-jh] [[[id=string] [uuid=string] [type=string] [version=string] [name=string] [ssh_public_key=string] [hostname=string] [cpu_core_count=integer] [memory_size=integer] [data_storage_capacity=integer] [data_storage_used=integer] [--[no-] insecure_ssl] [--[no-]unsafe_ssl_hostname_check] [status=string] [connection_status=string] [engine_connection_status=string] [connection_status_details=string] [engine_connection_status_details=string] [username=string] [password=string] [masking_username=string] [masking_password=string] [hashicorp_vault_username_command_args=array[,array...]]... [hashicorp_vault_masking_username_command_args=array[,array...]]... [hashicorp_vault_password_command_args=array[,array...]]... [hashicorp_vault_masking_password_command_args=array[,array...]]... [masking_hashicorp_vault_id=integer] [hashicorp_vault_id=integer] [tags [=array...]]... [masking_memory_used=integer] [masking_allocated_memory=integer] [masking_jobs_running=integer] [masking_max_concurrent_jobs=integer] [masking_available_cores=integer] [hyperscale_instance_ids=array[,array...]]... [hyperscale_truststore_filename=string] [hyperscale_truststore_password=string] [--[no-]using_object_storage] [-- [no-]using_continuous_vault] [platform=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. id=string The Engine object entity ID. uuid=string The unique identifier generated by this engine. type=string Values: [VIRTUALIZATION, MASKING, BOTH, UNSET]The type of this engine. version=string The engine version. name=string The name of this engine. ssh_public_key=string The ssh public key of this engine. hostname=string The hostname of this engine. cpu_core_count=integer The total number of CPU cores on this engine. memory_size=integer The total amount of memory on this engine, in bytes. data_storage_capacity=integer The total amount of storage allocated for engine objects and system metadata, in bytes. data_storage_used=integer The amount of storage used by engine objects and system metadata, in bytes. --[no-]insecure_ssl Allow connections to the engine over HTTPs without validating the TLS certificate. Even though the connection to the engine might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the engine over HTTPs. Setting this value must only be done if the TLS certificate of the engine does not match the hostname, and the TLS configuration of the engine cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. status=string Values: [CREATED, DELETING]the status of the engine connection_status=string Values: [ONLINE, OFFLINE]The status of the connection to the engine. Deprecated; use "engine_connection_status" instead. engine_connection_status=string Values: [ONLINE, CONNECTION_ERROR, MISSING_CREDENTIALS, BAD_CREDENTIALS]The state of the connection to the engine. connection_status_details=string If set, details about the status of the connection to the engine. Deprecated; use "engine_connection_status_details" instead. engine_connection_status_details=string If set, details about the state of the connection to the engine. username=string The virtualization domain admin username. password=string The virtualization domain admin password. masking_username=string The masking admin username. masking_password=string The masking admin password. hashicorp_vault_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization username for the engine. hashicorp_vault_masking_username_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking username for the engine. hashicorp_vault_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the virtualization password for the engine. hashicorp_vault_masking_password_command_args=array[,array...] Arguments to pass to the Vault CLI tool to retrieve the masking password for the engine. masking_hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve masking engine credentials. hashicorp_vault_id=integer Reference to the Hashicorp vault to use to retrieve virtualization engine credentials. tags[=array...] The tags to be created for this engine. masking_memory_used=integer The current amount of memory used by running masking jobs in bytes. masking_allocated_memory=integer The maximum amount of memory available for running masking jobs in bytes. masking_jobs_running=integer The number of masking jobs currently running. masking_max_concurrent_jobs=integer The maximum number of masking jobs that can be running at the same time. masking_available_cores=integer The number of CPU cores available to the masking engine. hyperscale_instance_ids=array[,array...] List of Hyperscale Instances that this engine is connected to. hyperscale_truststore_filename=string File name of a truststore which can be used to validate the TLS certificate of the engine as expected by associated hyperscale instances. hyperscale_truststore_password=string Password to read the truststore as expected by associated hyperscale instances. --[no-]using_object_storage true if the engine is using an object store (like AWS S3) to store data | false if the engine is using block storage to store its data | null if the engine is not initialized (unlikely) or the engine API version does not provide that information --[no-]using_continuous_vault true if the engine is using an object store (like AWS S3) to store data | false if the engine is using block storage to store its data | null if the engine is not initialized (unlikely) or the engine API version does not provide that information platform=string The infrastructure or environment where the engine is deployed or built, including cloud provider and instance type. --body=PARAM The updated registration engine information. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_engine_auto_tagging_config ======================================== Usage: dct-toolkit get_engine_auto_tagging_config[-hVw] [-cs] [-jh] engine_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. engineId, engine_id= The ID of the registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_engine_auto_tagging_config ======================================== Usage: dct-toolkit update_engine_auto_tagging_config[-hVw] engine_id= [-cs] [-jh] [[[--[no-] enable_virtualization_dataset_groups] [--[no-] enable_masking_environments] [--[no-]enable_masking_applications] [-- [no-]enable_engine_name] [custom_tags_to_add=array] [custom_tags_to_remove=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. --[no-]enable_virtualization_dataset_groups Include dataset group names as tags for dSources, VDBs, and vCDBs (key 'dlpx-dataset-group'). --[no-]enable_masking_environments Include masking environment names as tags for masking Jobs and Connectors (key 'dlpx-environment'). --[no-]enable_masking_applications Include masking app names as tags for masking Jobs and Connectors (key 'dlpx-application'). --[no-]enable_engine_name Include the engine name as a tag on discovered objects (key 'dlpx-engine'). custom_tags_to_add=array List of new custom tags to be added to discovered objects. These are appended to the AutoTaggingConfig's custom_tags list. custom_tags_to_remove=array List of tags to remove from the AutoTaggingConfig's custom_tags list (applied AFTER custom_tags_to_add). --body=PARAM The auto tagging config update parameters. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_compliance_application_settings ======================================== Usage: dct-toolkit get_compliance_application_settings[-hVw] [-cs] [-jh] [cursor=] engine_id= [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. engineId, engine_id= The ID of the registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_compliance_application_settings ======================================== Usage: dct-toolkit search_compliance_application_settings[-hVw] engine_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [group=string] [name=string] [value=string]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id group=string Filter by group name=string Filter by name value=string Filter by value -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: search_engines ======================================== Usage: dct-toolkit search_engines[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [uuid=string] [ssh_public_key=string] [type=string] [name=string] [hostname=string] [cpu_core_count=integer] [memory_size=integer] [data_storage_capacity=integer] [data_storage_used=integer] [--[no-] insecure_ssl] [--[no-] unsafe_ssl_hostname_check] [hyperscale_truststore_filename=string] [status=string] [username=string] [hashicorp_vault_id=string] [tags[=array [object]...]]... [connection_status=string] [connection_status_details=string] [engine_connection_status=string] [engine_connection_status_details=string] [masking_memory_used=integer] [masking_allocated_memory=integer] [masking_jobs_running=integer] [masking_max_concurrent_jobs=integer] [masking_available_cores=integer] [hyperscale_instance_ids=array[string]]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id uuid=string Filter by uuid ssh_public_key=string Filter by ssh_public_key type=string Filter by type name=string Filter by name hostname=string Filter by hostname cpu_core_count=integer Filter by cpu_core_count memory_size=integer Filter by memory_size data_storage_capacity=integer Filter by data_storage_capacity data_storage_used=integer Filter by data_storage_used --[no-]insecure_ssl Filter by insecure_ssl --[no-]unsafe_ssl_hostname_check Filter by unsafe_ssl_hostname_check hyperscale_truststore_filename=string Filter by hyperscale_truststore_filename status=string Filter by status username=string Filter by username hashicorp_vault_id=string Filter by hashicorp_vault_id tags[=array[object]...] Filter by tags connection_status=string Filter by connection_status connection_status_details=string Filter by connection_status_details engine_connection_status=string Filter by engine_connection_status engine_connection_status_details=string Filter by engine_connection_status_details masking_memory_used=integer Filter by masking_memory_used masking_allocated_memory=integer Filter by masking_allocated_memory masking_jobs_running=integer Filter by masking_jobs_running masking_max_concurrent_jobs=integer Filter by masking_max_concurrent_jobs masking_available_cores=integer Filter by masking_available_cores hyperscale_instance_ids=array[string] Filter by hyperscale_instance_ids -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_engine_tags ======================================== Usage: dct-toolkit get_engine_tags[-hVw] [-cs] [-jh] engine_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. engineId, engine_id= The ID of the registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_engine_tags ======================================== Usage: dct-toolkit create_engine_tags[-hVw] engine_id= [-cs] [-jh] ([tags[=array...] [tags[=array...]]...] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Engine. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: delete_engine_tags ======================================== Usage: dct-toolkit delete_engine_tags[-hVw] engine_id= [-cs] [-jh] [[[key=string] [value=string] [tags [=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engineId, engine_id= The ID of the registered engine. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_hashicorp_vaults ======================================== Usage: dct-toolkit get_hashicorp_vaults[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_hashicorp_vault ======================================== Usage: dct-toolkit create_hashicorp_vault[-hVw] [-cs] [-jh] [[[id=integer] [env_variables[=object...]]... [login_command_args=array[,array...]]... [tags[=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. id=integer env_variables[=object...] Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both to login to the vault (if this step is required) and to retrieve engine username and passwords. login_command_args=array[,array...] Arguments to the "vault" CLI tool to be used to fetch a client token (or "login"). If supporting files, such as TLS certificates, must be used to authenticate, they can be mounted to the /etc/config directory. This property must not be set when using the TOKEN authentication method as login is not required. tags[=array...] --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: search_hashicorp_vaults ======================================== Usage: dct-toolkit search_hashicorp_vaults[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=integer] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=integer Filter by id tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_hashicorp_vault ======================================== Usage: dct-toolkit get_hashicorp_vault[-hVw] [-cs] [-jh] vault_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. vaultId, vault_id= Numeric ID of the Hashicorp vault -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: delete_hashicorp_vault ======================================== Usage: dct-toolkit delete_hashicorp_vault[-hVw] [-cs] [-jh] vault_id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. vaultId, vault_id= Numeric ID of the Hashicorp vault -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_hashicorp_vault_tags ======================================== Usage: dct-toolkit get_hashicorp_vault_tags[-hVw] [-cs] [-jh] vault_id= [-jp= | -ex=] [-A | -c= [,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. vaultId, vault_id= Numeric ID of the Hashicorp vault -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_hashicorp_vault_tags ======================================== Usage: dct-toolkit create_hashicorp_vault_tags[-hVw] vault_id= [-cs] [-jh] ([tags[=array...] [tags[=array...]]...] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vaultId, vault_id= Numeric ID of the Hashicorp vault tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Hashicorp vault. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: delete_hashicorp_vault_tag ======================================== Usage: dct-toolkit delete_hashicorp_vault_tag[-hVw] vault_id= [-cs] [-jh] [[[key=string] [value=string] [tags[=array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vaultId, vault_id= Numeric ID of the Hashicorp vault key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: list_properties ======================================== Usage: dct-toolkit list_properties[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_properties ======================================== Usage: dct-toolkit update_properties[-hVw] [-cs] [-jh] [[[--[no-] disable_username_password] [dct_product_telemetry_upload_cadence=integ er] [dct_product_telemetry_maximum_transfer_siz e=integer] [token_expiry_time=integer] [token_maximum_inactivity_time=integer] [feature_flags=array[,array...]]... [api_key_expiry_time=integer] [allowed_ip_ranges=array[,array...]]...] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]disable_username_password Property to define either username & password based authentication disabled or not. dct_product_telemetry_upload_cadence=integer Property to define the DCT Product Telemetry bundle upload cadence, in days, if Delphix services are reachable. dct_product_telemetry_maximum_transfer_size=integer Property to define the maximum uncompressed bundle transfer size, in bytes, for DCT Product Telemetry. token_expiry_time=integer Property to define the expiry time for login token, in seconds. Specify -1 to indicate never expiry of token. token_maximum_inactivity_time=integer Property to define the maximum user inactivity time for login token, in seconds. Specify -1 to indicate never invalidate of token due to inactivity. feature_flags=array[,array...] List of enabled features. api_key_expiry_time=integer Property to define the expiry time for API key, in seconds. Specify -1 to indicate never expiry of tapi key. allowed_ip_ranges=array[,array...] Restricts the IP ranges DCT will connect to when registering engines. --body=PARAM The parameters to update property value. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_api_classification ======================================== Usage: dct-toolkit get_api_classification[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_api_classification ======================================== Usage: dct-toolkit update_api_classification[-hVw] [-cs] [-jh] [[[version=string] [api_classification=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. version=string Api Classification Config Version. api_classification=array The classification of each APIs, either it is automation or not. --body=PARAM Request to update api classification config. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_smtp_config ======================================== Usage: dct-toolkit get_smtp_config[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_smtp_config ======================================== Usage: dct-toolkit update_smtp_config[-hVw] [-cs] [-jh] [[[--[no-]enabled] [server=string] [port=integer] [--[no-] authentication_enabled] [--[no-] tls_enabled] [username=string] [password=string] [from_address=string] [send_timeout=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled True if outbound email is enabled. server=string IP address or hostname of SMTP relay server. port=integer Port number to use. A value of -1 indicates the default (25 or 587 for TLS). --[no-]authentication_enabled True if username/password authentication should be used. --[no-]tls_enabled True if TLS (transport layer security) should be used. username=string If authentication is enabled, username to use when authenticating to the server. password=string If authentication is enabled, password to use when authenticating to the server. from_address=string From address to use when sending mail. If unspecified, 'noreply@delphix.com' is used. send_timeout=integer Maximum timeout to wait, in seconds, when sending mail. --body=PARAM The parameters to update the SMTP config. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: validate_smtp_config ======================================== Usage: dct-toolkit validate_smtp_config[-hVw] [-cs] [-jh] ([to_address=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. to_address=string --body=PARAM The parameters to validate the SMTP config. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_metadata_database ======================================== Usage: dct-toolkit get_metadata_database[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_ldap_config ======================================== Usage: dct-toolkit get_ldap_config[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_ldap_config ======================================== Usage: dct-toolkit update_ldap_config[-hVw] [-cs] [-jh] [[[--[no-]enabled] [-- [no-]auto_create_users] [hostname=string] [port=integer] [domains=array] [--[no-] enable_ssl] [--[no-]insecure_ssl] [--[no-] unsafe_ssl_hostname_check]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled When set, these settings are enabled. True by default. --[no-]auto_create_users When set, the system will automatically create new Accounts for those who have logged in using LDAP. This must be true if LDAP user is not already registered in system. True by default. hostname=string The hostname of the LDAP server. port=integer The port of the LDAP server. Default port is 389 for non-SSL and 636 for SSL. domains=array DCT will try to authenticate using each Domain given in this list. --[no-]enable_ssl True if LDAP should be used over SSL. --[no-]insecure_ssl Allow connections to the LDAP server over LDAPS without validating the TLS certificate. Even though the connection to the server might be performed over LDAPS, setting this property eliminates the protection against a man-in-the-middle attach for connections to this server. Instead, consider configuring DCT with Certificate Authority certificates. --[no-]unsafe_ssl_hostname_check Ignore validation of the name associated to the TLS certificate when connecting to the LDAP server over LDAPS. Setting this value must only be done if the TLS certificate of the server does not match the hostname, and the TLS configuration of the server cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this server. This is ignored if insecure_ssl is set. --body=PARAM The parameters to update the LDAP config. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: validate_ldap_config ======================================== Usage: dct-toolkit validate_ldap_config[-hVw] [-cs] [-jh] [[[username=string] [password=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. username=string Username of the account to validate the ldap optional attributes. password=string Password of the account to validate the ldap optional attributes. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_saml_config ======================================== Usage: dct-toolkit get_saml_config[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_saml_config ======================================== Usage: dct-toolkit update_saml_config[-hVw] [-cs] [-jh] [[[--[no-]enabled] [-- [no-]auto_create_users] [metadata=string] [entity_id=string] [response_skew=integer] [group_attr=string] [first_name_attr=string] [last_name_attr=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled When set, SAML settings are enabled. False by default. --[no-]auto_create_users When set, the system will automatically create new Accounts for those who have logged in using SAML. This must be true if SAML user is not already registered in system. True by default. metadata=string IdP metadata for this service provider. This is a required property for successful SAML authentication. entity_id=string Unique identifier of this instance as a SAML/SSO service provider. response_skew=integer Maximum time difference allowed between a SAML response and the DCT's current time, in seconds. If not set, it defaults to 120 seconds. group_attr=string Group mapped attribute on SAML to create account tags in DCT. first_name_attr=string First name attribute mapped on SAML used for mapping on DCT account. last_name_attr=string Last name attribute mapped on SAML used for mapping on DCT account. --body=PARAM The parameters to update the SAML config. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_dct_product_telemetry_events ======================================== Usage: dct-toolkit get_dct_product_telemetry_events[-hVw] [-cs] [-jh] [limit=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= The maximum number of items to return. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: trigger_dct_product_telemetry_bundle_upload ======================================== Usage: dct-toolkit trigger_dct_product_telemetry_bundle_upload[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_proxy_configuration ======================================== Usage: dct-toolkit get_proxy_configuration[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: update_proxy_configuration ======================================== Usage: dct-toolkit update_proxy_configuration[-hVw] [-cs] [-jh] ([host=string --[no-]enabled port=integer [username=string] [password=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. host=string The host name or IP address of the proxy server. --[no-]enabled When set, these settings are enabled. True by default. port=integer The port number of the proxy server. username=string The username to use when authenticating with the proxy server. password=string The password to use when authenticating with the proxy server. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_product_registration_delphix_connectivity_check ======================================== Usage: dct-toolkit get_product_registration_delphix_connectivity_check[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_product_registration_status ======================================== Usage: dct-toolkit get_product_registration_status[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: get_product_registration_key ======================================== Usage: dct-toolkit get_product_registration_key[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: register_product_offline ======================================== Usage: dct-toolkit register_product_offline[-hVw] [-cs] [-jh] ([authentication_token=string data_key=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. authentication_token=string data_key=string --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: register_product_online ======================================== Usage: dct-toolkit register_product_online[-hVw] [-cs] [-jh] ([token=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. token=string --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: MaskingEnvironments ================================================================================ Commands (3): get_masking_environments, search_masking_environments, get_masking_environment_by_id COMMAND: get_masking_environments ======================================== Usage: dct-toolkit get_masking_environments[-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 a 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_masking_environments ======================================== Usage: dct-toolkit search_masking_environments[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [engine_id=string] [engine_name=string] [purpose=string] [--[no-]is_workflow_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 a 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 engine_id=string Filter by engine_id engine_name=string Filter by engine_name purpose=string Filter by purpose --[no-]is_workflow_enabled Filter by is_workflow_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_masking_environment_by_id ======================================== Usage: dct-toolkit get_masking_environment_by_id[-hVw] [-cs] [-jh] masking_environment_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. maskingEnvironmentId, masking_environment_id= The ID of the Masking Environment. -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. ======================================== ================================================================================ TOPIC: MaskingFiles ================================================================================ Commands (9): get_masking_files, get_masking_file_by_id, update_masking_file_upload_by_id, search_masking_files, get_masking_file_tags, create_masking_file_tags, delete_masking_file_tags, get_masking_file_consumers, search_masking_file_consumers COMMAND: get_masking_files ======================================== Usage: dct-toolkit get_masking_files[-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 a 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: get_masking_file_by_id ======================================== Usage: dct-toolkit get_masking_file_by_id[-hVw] [-cs] [-jh] masking_file_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. maskingFileId, masking_file_id= The ID or name of the masking file. -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_masking_file_upload_by_id ======================================== Usage: dct-toolkit update_masking_file_upload_by_id[-hVw] masking_file_id= [-cs] [-jh] ([description=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. maskingFileId, masking_file_id= The ID or name of the masking file. description=string A description for this masking file. --body=PARAM The new data to update a masking file upload. -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_masking_files ======================================== Usage: dct-toolkit search_masking_files[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [description=string] [filename=string] [file_size=string] [file_checksum=string] [created_date=string] [engine_file_uuid=string] [engine_name=string] [engine_id=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 description=string Filter by description filename=string Filter by filename file_size=string Filter by file_size file_checksum=string Filter by file_checksum created_date=string Filter by created_date engine_file_uuid=string Filter by engine_file_uuid engine_name=string Filter by engine_name engine_id=string Filter by engine_id tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_masking_file_tags ======================================== Usage: dct-toolkit get_masking_file_tags[-hVw] [-cs] [-jh] masking_file_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. maskingFileId, masking_file_id= The ID or name of the masking file. -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_masking_file_tags ======================================== Usage: dct-toolkit create_masking_file_tags[-hVw] masking_file_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. maskingFileId, masking_file_id= The ID or name of the masking file. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for masking file upload. -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_masking_file_tags ======================================== Usage: dct-toolkit delete_masking_file_tags[-hVw] masking_file_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. maskingFileId, masking_file_id= The ID or name of the masking file. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_masking_file_consumers ======================================== Usage: dct-toolkit get_masking_file_consumers[-hVw] [-cs] [-jh] [cursor=] [limit=] masking_file_id= [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. maskingFileId, masking_file_id= The ID or name of the masking file. sort= The field to sort results by. A property name with a prepended '-' signifies a 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_masking_file_consumers ======================================== Usage: dct-toolkit search_masking_file_consumers[-hVw] masking_file_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[parent_id=string] [parent_type=string] [parent_name=string]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. maskingFileId, masking_file_id= The ID or name of the masking file. 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 a 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. parent_id=string Filter by parent_id parent_type=string Filter by parent_type parent_name=string Filter by parent_name -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 ======================================== ================================================================================ TOPIC: MaskingJobs ================================================================================ Commands (18): get_masking_jobs, create_masking_job, search_masking_jobs, get_masking_job_source_engines, search_masking_job_source_engines, get_masking_job_by_id, delete_masking_job, update_masking_job_by_id, copy_masking_job, migrate_masking_job, get_masking_job_connectors, execute_masking_job, re_import_masking_job, get_masking_job_tag, create_masking_job_tag, delete_masking_job_tag, add_engine_to_masking_job, remove_engine_from_masking_job COMMAND: get_masking_jobs ======================================== Usage: dct-toolkit get_masking_jobs[-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 a descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_masking_job ======================================== Usage: dct-toolkit create_masking_job[-hVw] [-cs] [-jh] [[[name=string] [description=string] [job_type=string] [hyperscale_instance_id=string] [source_masking_job_id=string] [hyperscale_source_connector_username=stri ng] [hyperscale_source_connector_password=stri ng] [hyperscale_target_connector_username=stri ng] [hyperscale_target_connector_password=stri ng] [mount_point_id=string] [unload_split=integer] [stream_size=integer] [retain_execution_data=string] [max_memory=integer] [min_memory=integer] [feedback_size=integer] [stream_row_limit=integer] [num_input_streams=integer] [max_concurrent_source_connections=integer ] [max_concurrent_target_connections=integer ] [parallelism_degree=integer] [tags [=array...]]... [--[no-] make_current_account_owner]] | [--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 The name to give the Masking Job. description=string The description of the Job (Hyperscale Job only). job_type=string Values: [HYPERSCALE]The type of Job. hyperscale_instance_id=string The ID of the HyperscaleInstance to create this Job on (Hyperscale Job only). source_masking_job_id=string The ID of the Masking Job to use as the source (Hyperscale Job only). hyperscale_source_connector_username=string The username to set for the Source Connector that will be imported (Hyperscale Job only). hyperscale_source_connector_password=string The password to set for the Source Connector that will be imported (Hyperscale Job only). hyperscale_target_connector_username=string The username to set for the Target Connector that will be imported (Hyperscale Job only). hyperscale_target_connector_password=string The password to set for the Target Connector that will be imported (Hyperscale Job only). mount_point_id=string The ID of the MountPoint to use for the resulting dataset (Hyperscale Job only). unload_split=integer The number of unloaded files to be generated from the source database (Hyperscale Job only). stream_size=integer The stream size to be used by the sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server (Hyperscale Job only). retain_execution_data=string Values: [NO, ON_ERROR, ALWAYS]Defines whether execution data will be stored after execution is complete (Hyperscale Job only). max_memory=integer Maximum memory, in MB, to be allocated for each Masking job (Hyperscale Job only). min_memory=integer Minimum memory, in MB, to be allocated for each Masking job (Hyperscale Job only). feedback_size=integer The granularity with which the masking engine provides updates on the progress of the masking job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the masking phase (Hyperscale Job only). stream_row_limit=integer The stream row limit constrains the total number of rows that may enter the job for each masking stream. Setting this value to 0 allows unlimited rows into each stream, while leaving it blank will select a default limit based on job type (Hyperscale Job only). num_input_streams=integer Number of input streams to be configured for Masking Job (Hyperscale Job only). max_concurrent_source_connections=integer Maximum number of parallel connection that the Hyperscale instance can have with the source datasource (Hyperscale Job only). max_concurrent_target_connections=integer Maximum number of parallel connection that the Hyperscale instance can have with the target datasource (Hyperscale Job only). parallelism_degree=integer The degree of parallelism (DOP) per Oracle job to recreate the index in the post-load process (Hyperscale Job only). tags[=array...] --[no-]make_current_account_owner Whether the account creating this Masking job must be configured as owner of it (Hyperscale Job only). --body=PARAM Input params to create a masking job. -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_masking_jobs ======================================== Usage: dct-toolkit search_masking_jobs[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [--[no-] is_on_the_fly_masking] [creation_date=string] [last_completed_execution_date=string] [last_execution_status=string] [last_execution_id=string] [connector_username=string] [on_the_fly_source_connector_username=str ing] [rule_set_id=string] [rule_set_name=string] [ruleset. connector_id=string] [ruleset. type=string] [ruleset.name=string] [--ruleset.refresh_drops_table] [ruleset. algorithms=array[string]] [hyperscale_instance_id=string] [description=string] [dataset_id=string] [retain_execution_data=string] [max_memory=integer] [min_memory=integer] [feedback_size=integer] [stream_row_limit=integer] [num_input_streams=integer] [max_concurrent_source_connections=intege r] [max_concurrent_target_connections=intege r] [parallelism_degree=integer] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 --[no-]is_on_the_fly_masking Filter by is_on_the_fly_masking creation_date=string Filter by creation_date last_completed_execution_date=string Filter by last_completed_execution_date last_execution_status=string Filter by last_execution_status last_execution_id=string Filter by last_execution_id connector_username=string Filter by connector_username on_the_fly_source_connector_username=string Filter by on_the_fly_source_connector_username rule_set_id=string Filter by rule_set_id rule_set_name=string Filter by rule_set_name ruleset.connector_id=string Filter by ruleset.connector_id ruleset.type=string Filter by ruleset.type ruleset.name=string Filter by ruleset.name --ruleset.refresh_drops_table Filter by ruleset.refresh_drops_table ruleset.algorithms=array[string] Filter by ruleset.algorithms hyperscale_instance_id=string Filter by hyperscale_instance_id description=string Filter by description dataset_id=string Filter by dataset_id retain_execution_data=string Filter by retain_execution_data max_memory=integer Filter by max_memory min_memory=integer Filter by min_memory feedback_size=integer Filter by feedback_size stream_row_limit=integer Filter by stream_row_limit num_input_streams=integer Filter by num_input_streams max_concurrent_source_connections=integer Filter by max_concurrent_source_connections max_concurrent_target_connections=integer Filter by max_concurrent_target_connections parallelism_degree=integer Filter by parallelism_degree tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_masking_job_source_engines ======================================== Usage: dct-toolkit get_masking_job_source_engines[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies a 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_masking_job_source_engines ======================================== Usage: dct-toolkit search_masking_job_source_engines[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[masking_job_id=string] [source_engine_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 a 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. masking_job_id=string Filter by masking_job_id source_engine_id=string Filter by source_engine_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_masking_job_by_id ======================================== Usage: dct-toolkit get_masking_job_by_id[-hVw] [-cs] [-jh] masking_job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -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. maskingJobId, masking_job_id= The ID of the Masking Job. -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: delete_masking_job ======================================== Usage: dct-toolkit delete_masking_job[-hVw] [-cs] [force] [-jh] masking_job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. force If true, ignores any failures to remove a masking job on an engine. -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. maskingJobId, masking_job_id= The ID of the Masking Job. -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_masking_job_by_id ======================================== Usage: dct-toolkit update_masking_job_by_id[-hVw] masking_job_id= [-cs] [-jh] [[[name=string] [connector_username=string] [connector_password=string] [on_the_fly_source_connector_username=string] [on_the_fly_source_connector_password=string] [description=string] [dataset_id=string] [retain_execution_data=string] [max_memory=integer] [min_memory=integer] [feedback_size=integer] [stream_row_limit=integer] [num_input_streams=integer] [max_concurrent_source_connections=integer] [max_concurrent_target_connections=integer] [parallelism_degree=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. maskingJobId, masking_job_id= The ID of the Masking Job. name=string The name of the MaskingJob. connector_username=string The username of the Connector used by the MaskingJob. (Standard Job only). connector_password=string The password of the Connector used by the MaskingJob. (Standard Job only). on_the_fly_source_connector_username=string The username of the source Connector used by the on-the-fly MaskingJob. (Standard Job only). on_the_fly_source_connector_password=string The password of the source Connector used by the on-the-fly MaskingJob. (Standard Job only). description=string Description of the Job (Hyperscale Job only). dataset_id=string Dataset of the Hyperscale Job (Hyperscale Job only). retain_execution_data=string Values: [NO, ON_ERROR, ALWAYS]Defines whether execution data will be stored after execution is complete (Hyperscale Job only). max_memory=integer Maximum memory to be allocated for each Masking job (Hyperscale Job only). min_memory=integer Minimum memory to be allocated for each Masking job (Hyperscale Job only). feedback_size=integer Feedback Size for each Masking job (Hyperscale Job only). stream_row_limit=integer Stream Row Limit for each Masking job (Hyperscale Job only). num_input_streams=integer Number of input streams to be configured for Masking Job (Hyperscale Job only). max_concurrent_source_connections=integer Maximum number of parallel connection that the Hyperscale instance can have with the source datasource (Hyperscale Job only). max_concurrent_target_connections=integer Maximum number of parallel connection that the Hyperscale instance can have with the target datasource (Hyperscale Job only). parallelism_degree=integer The degree of parallelism (DOP) per Oracle job to recreate the index in the post-load process (Hyperscale Job only). --body=PARAM The new data to update a Masking Job. -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: copy_masking_job ======================================== Usage: dct-toolkit copy_masking_job[-hVw] masking_job_id= [-cs] [-jh] ([target_engine_id=string [source_environment_id=string] [target_environment_id=string] [--[no-] force_overwrite]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. maskingJobId, masking_job_id= The ID of the Masking Job. target_engine_id=string The ID of the engine to copy the job to. source_environment_id=string The ID or name of the source environment on the target engine. This only applies to On-The-Fly jobs. target_environment_id=string The ID or name of the target environment on the target engine to copy the job into. --[no-]force_overwrite Whether to overwrite objects that already exist on the target engine. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: migrate_masking_job ======================================== Usage: dct-toolkit migrate_masking_job[-hVw] masking_job_id= [-cs] [-jh] ([target_engine_id=string [source_environment_id=string] [target_environment_id=string] [--[no-] force_overwrite]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. maskingJobId, masking_job_id= The ID of the Masking Job. target_engine_id=string The ID of the engine to migrate the job to. source_environment_id=string The ID or name of the source environment on the target engine. This only applies to On-The-Fly jobs. target_environment_id=string The ID or name of the target environment on the target engine to migrate the job into. --[no-]force_overwrite Whether to overwrite objects that already exist on the target engine. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_masking_job_connectors ======================================== Usage: dct-toolkit get_masking_job_connectors[-hVw] [-cs] [-jh] masking_job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -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. maskingJobId, masking_job_id= The ID of the Masking Job. -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: execute_masking_job ======================================== Usage: dct-toolkit execute_masking_job[-hVw] masking_job_id= [-cs] [-jh] [[[engine_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. maskingJobId, masking_job_id= The ID of the Masking Job. engine_id=string The ID of the Engine to execute this MaskingJob on (Standard job only). --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: re_import_masking_job ======================================== Usage: dct-toolkit re_import_masking_job[-hVw] [-cs] [-jh] masking_job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -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. maskingJobId, masking_job_id= The ID of the Masking Job. -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_masking_job_tag ======================================== Usage: dct-toolkit get_masking_job_tag[-hVw] [-cs] [-jh] masking_job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -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. maskingJobId, masking_job_id= The ID of the Masking Job. -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_masking_job_tag ======================================== Usage: dct-toolkit create_masking_job_tag[-hVw] masking_job_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. maskingJobId, masking_job_id= The ID of the Masking Job. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Masking Job. -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_masking_job_tag ======================================== Usage: dct-toolkit delete_masking_job_tag[-hVw] masking_job_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. maskingJobId, masking_job_id= The ID of the Masking Job. 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: add_engine_to_masking_job ======================================== Usage: dct-toolkit add_engine_to_masking_job[-hVw] masking_job_id= [-cs] [-jh] [[[engine_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. maskingJobId, masking_job_id= The ID of the Masking Job. engine_id=string --body=PARAM Body containing the ID of the registered engine. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: remove_engine_from_masking_job ======================================== Usage: dct-toolkit remove_engine_from_masking_job[-hVw] masking_job_id= [-cs] [-jh] [[[engine_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. maskingJobId, masking_job_id= The ID of the Masking Job. engine_id=string --body=PARAM Body containing the ID of the registered engine. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: Namespace ================================================================================ Commands (9): list_namespaces, search_namespaces, get_namespace_by_id, delete_namespace, update_namespace, failover_namespace, commit_failover_namespace, failback_namespace, discard_namespace COMMAND: list_namespaces ======================================== Usage: dct-toolkit list_namespaces[-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_namespaces ======================================== Usage: dct-toolkit search_namespaces[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [tag=string] [engine_id=string] [description=string] [-- [no-]secure_namespace] [--[no-] failed_over] [failover_report=string] [-- [no-]locked] [--[no-]failback_possible] [failback_capability=string] [failback_incapability_reason=string] [replication_mode=string] [last_execution_status=string] [last_execution_status_timestamp=date-time] [source_engine_name=string] [source_engine_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. 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 tag=string Filter by tag engine_id=string Filter by engine_id description=string Filter by description --[no-]secure_namespace Filter by secure_namespace --[no-]failed_over Filter by failed_over failover_report=string Filter by failover_report --[no-]locked Filter by locked --[no-]failback_possible Filter by failback_possible failback_capability=string Filter by failback_capability failback_incapability_reason=string Filter by failback_incapability_reason replication_mode=string Filter by replication_mode last_execution_status=string Filter by last_execution_status last_execution_status_timestamp=date-time Filter by last_execution_status_timestamp source_engine_name=string Filter by source_engine_name source_engine_id=string Filter by source_engine_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_namespace_by_id ======================================== Usage: dct-toolkit get_namespace_by_id[-hVw] [-cs] [-jh] namespace_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. namespaceId, namespace_id= The ID of the namespace. -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: delete_namespace ======================================== Usage: dct-toolkit delete_namespace[-hVw] [-cs] [-jh] namespace_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. namespaceId, namespace_id= The ID of the namespace. -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_namespace ======================================== Usage: dct-toolkit update_namespace[-hVw] namespace_id= [-cs] [-jh] [[[name=string] [description=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. namespaceId, namespace_id= The ID of the namespace. name=string The Namespace name. description=string The description of the namespace. --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: failover_namespace ======================================== Usage: dct-toolkit failover_namespace[-hVw] namespace_id= [-cs] [-jh] [[[--[no-]enable_failback]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. namespaceId, namespace_id= The ID of the namespace. --[no-]enable_failback Whether to enable failback for the datasets being failed over. --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: commit_failover_namespace ======================================== Usage: dct-toolkit commit_failover_namespace[-hVw] [-cs] [-jh] namespace_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. namespaceId, namespace_id= The ID of the namespace. -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: failback_namespace ======================================== Usage: dct-toolkit failback_namespace[-hVw] [-cs] [-jh] namespace_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. namespaceId, namespace_id= The ID of the namespace. -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: discard_namespace ======================================== Usage: dct-toolkit discard_namespace[-hVw] [-cs] [-jh] namespace_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. namespaceId, namespace_id= The ID of the namespace. -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. ======================================== ================================================================================ TOPIC: Network Performance Tool ================================================================================ Commands (6): create_latency_test, get_latency_test_result, create_dsp_test, get_dsp_test_result, create_throughput_test, get_throughput_test_result COMMAND: create_latency_test ======================================== Usage: dct-toolkit create_latency_test[-hVw] [-cs] [-jh] ([engine_id=string host_id=string [request_count=integer] [request_size=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id=string The ID of the engine where the test is to be executed. host_id=string Identifier of host that must exist within an associated with engine. request_count=integer Number of requests to send. request_size=integer The size of requests to send (bytes). --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_latency_test_result ======================================== Usage: dct-toolkit get_latency_test_result[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= Unique identifier of the network test job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_dsp_test ======================================== Usage: dct-toolkit create_dsp_test[-hVw] [-cs] [-jh] ([engine_id=string [host_id=string] [direction=string] [num_connections=integer] [duration=integer] [destination_type=string] [--[no-] compression] [--[no-]encryption] [queue_depth=integer] [block_size=integer] [send_socket_buffer=integer] [receive_socket_buffer=integer] [xport_scheduler=string] [target_engine_id=string] [target_engine_address=string] [target_engine_user=string] [target_engine_password=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id=string The ID of the engine where the test is to be executed. host_id=string Identifier of host that must exist within an associated with engine. direction=string Values: [TRANSMIT, RECEIVE]Whether the test is a transmit or receive test. num_connections=integer The number of connections to use for the test. The special value 0 (the default) causes the test to automatically discover duration=integer The duration of the test in seconds. Note that when numConnections is 0, an initial period of time will be spent calculating the optimal number of connections, and that time does not count toward the duration of the test. destination_type=string Values: [REMOTE_HOST, DELPHIX_ENGINE]Whether the test is testing connectivity to a Delphix Engine or remote host. --[no-]compression Whether or not compression is used for the test. --[no-]encryption Whether or not encryption is used for the test. queue_depth=integer The queue depth used for the DSP throughput test. block_size=integer The size of each transmit request in bytes. send_socket_buffer=integer The size of the send socket buffer in bytes. receive_socket_buffer=integer The size of the receive socket buffer in bytes. xport_scheduler=string Values: [ROUND_ROBIN, LEAST_QUEUE]The transport scheduler to use. target_engine_id=string engine id which test exc target_engine_address=string Address of other target Delphix Engine. target_engine_user=string Username for the other target Delphix Engine. target_engine_password=string Password for the other target Delphix Engine. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_dsp_test_result ======================================== Usage: dct-toolkit get_dsp_test_result[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= Unique identifier of the network test job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_throughput_test ======================================== Usage: dct-toolkit create_throughput_test[-hVw] [-cs] [-jh] ([engine_id=string host_id=string [direction=string] [num_connections=integer] [duration=integer] [port=integer] [block_size=integer] [send_socket_buffer=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id=string The ID of the engine where the test is to be executed. host_id=string Identifier of host that must exist within an associated with engine. direction=string Values: [TRANSMIT, RECEIVE]Whether the test is a transmit or receive test. num_connections=integer The number of connections to use for the test. The special value 0 (the default) causes the test to automatically discover duration=integer The duration of the test in seconds. Note that when numConnections is 0, an initial period of time will be spent calculating the optimal number of connections, and that time does not count toward the duration of the test. port=integer The TCP port number that the server (the receiver) will be listening on. block_size=integer The size of each transmit request in bytes. send_socket_buffer=integer The size of the send socket buffer in bytes. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_throughput_test_result ======================================== Usage: dct-toolkit get_throughput_test_result[-hVw] [-cs] [-jh] job_id= [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure jobId, job_id= Unique identifier of the network test job. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== ================================================================================ TOPIC: PasswordVaults ================================================================================ Commands (3): get_password_vaults, search_password_vaults, get_password_vault_by_id COMMAND: get_password_vaults ======================================== Usage: dct-toolkit get_password_vaults[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_password_vaults ======================================== Usage: dct-toolkit search_password_vaults[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [engine_name=string] [engine_id=string] [namespace=string] [type=string] [namespace_id=string] [namespace_name=string] [--[no-] is_replica]]] [-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 engine_name=string Filter by engine_name engine_id=string Filter by engine_id namespace=string Filter by namespace type=string Filter by type namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica -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_password_vault_by_id ======================================== Usage: dct-toolkit get_password_vault_by_id[-hVw] [-cs] [-jh] password_vault_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. passwordVaultId, password_vault_id= The ID of the password vault. -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. ======================================== ================================================================================ TOPIC: Replication ================================================================================ Commands (12): get_replication_profiles, create_replication_profile, search_replication_profiles, execute_replication_profile, get_replication_profile_by_id, delete_replication_profile, update_replication_profile, get_replication_profile_tags, create_replication_profile_tags, delete_replication_profile_tags, enable_tag_replication, disable_tag_replication COMMAND: get_replication_profiles ======================================== Usage: dct-toolkit get_replication_profiles[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_replication_profile ======================================== Usage: dct-toolkit create_replication_profile[-hVw] [-cs] [-jh] ([replication_mode=string engine_id=string [name=string] [target_engine_id=string] [target_host=string] [target_port=integer] [nfs_share=string] [offline_send_profile_tag=string] [description=string] [schedule=string] [tags[=array...]]... [--[no-] enable_tag_replication] [bandwidth_limit=integer] [number_of_connections=integer] [--[no-]encrypted] [--[no-] automatic_replication] [--[no-]use_system_socks_setting] [vdb_ids=array[, array...]]... [dsource_ids=array[,array...]]... [cdb_ids=array[, array...]]... [vcdb_ids=array[,array...]]... [group_ids=array[, array...]]... [--[no-]replicate_entire_engine]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. replication_mode=string Values: [ENGINE_DATA_REPLICATION, MASKED_DATA_DISTRIBUTION, CONTINUOUS_VAULT, OFFLINE_SEND, OFFLINE_RECEIVE]The ReplicationProfile mode. engine_id=string The ID of the engine that the ReplicationProfile belongs to. name=string The ReplicationProfile name. target_engine_id=string The ID of the replication target engine. This field is specific to network replication. target_host=string Hostname of the replication target engine. If none is provided, the hostname for the engine referenced by target_engine_id will be used. This field is specific to network replication. target_port=integer Target TCP port number for the Delphix Session Protocol. This field is specific to network replication. nfs_share=string The NFS share path for the replication target. This field is specific to offline replication. offline_send_profile_tag=string The unique tag identifier for the offline send profile. This field is specific to offline replication receive profiles. description=string The ReplicationProfile description. schedule=string Replication schedule in the form of a quartz-formatted string. tags[=array...] The tags that are applied to this ReplicationProfile. --[no-]enable_tag_replication Indicates whether tag replication from primary object to replica object is enabled or disabled for this ReplicationProfile. bandwidth_limit=integer Bandwidth limit (MB/s) for replication network traffic. A value of 0 means no limit. This field is specific to network replication. number_of_connections=integer Total number of transport connections to use. This field is specific to network replication. --[no-]encrypted Encrypt replication network traffic. This field is specific to network replication. --[no-]automatic_replication Indication whether the replication spec schedule is enabled or not. --[no-]use_system_socks_setting Connect to the replication target host via the system-wide SOCKS proxy. This field is specific to network replication. vdb_ids=array[,array...] The VDBs that are replicated by this ReplicationProfile. dsource_ids=array[,array...] The dSources that are replicated by this ReplicationProfile. cdb_ids=array[,array...] The CDBs that are replicated by this ReplicationProfile. vcdb_ids=array[,array...] The vCDBs that are replicated by this ReplicationProfile. group_ids=array[,array...] The groups that are replicated by this ReplicationProfile. --[no-]replicate_entire_engine Whether to replicate the entire engine. This is mutually exclusive with the vdb_ids, dsource_ids, cdb_ids, vcdb_ids, and group_ids properties. --body=PARAM The parameters to create a ReplicationProfile. -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_replication_profiles ======================================== Usage: dct-toolkit search_replication_profiles[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [replication_mode=string] [target_engine_id=string] [target_port=integer] [nfs_share=string] [engine_id=string] [replication_tag=string] [last_execution_status=string] [last_execution_status_timestamp=date-time] [description=string] [schedule=string] [tags[=array[object]...]]... [--[no-] enable_tag_replication] [--[no-]encrypted] [--[no-] use_system_socks_setting] [--[no-]automatic_replication] [number_of_connections=integer] [bandwidth_limit=integer]]] [-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 replication_mode=string Filter by replication_mode target_engine_id=string Filter by target_engine_id target_port=integer Filter by target_port nfs_share=string Filter by nfs_share engine_id=string Filter by engine_id replication_tag=string Filter by replication_tag last_execution_status=string Filter by last_execution_status last_execution_status_timestamp=date-time Filter by last_execution_status_timestamp description=string Filter by description schedule=string Filter by schedule tags[=array[object]...] Filter by tags --[no-]enable_tag_replication Filter by enable_tag_replication --[no-]encrypted Filter by encrypted --[no-]use_system_socks_setting Filter by use_system_socks_setting --[no-]automatic_replication Filter by automatic_replication number_of_connections=integer Filter by number_of_connections bandwidth_limit=integer Filter by bandwidth_limit -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: execute_replication_profile ======================================== Usage: dct-toolkit execute_replication_profile[-hVw] [-cs] [-jh] replication_profile_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. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. -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_replication_profile_by_id ======================================== Usage: dct-toolkit get_replication_profile_by_id[-hVw] [-cs] [-jh] replication_profile_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. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. -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: delete_replication_profile ======================================== Usage: dct-toolkit delete_replication_profile[-hVw] [-cs] [-jh] replication_profile_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. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. -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_replication_profile ======================================== Usage: dct-toolkit update_replication_profile[-hVw] replication_profile_id= [-cs] [-jh] [[[name=string] [description=string] [target_engine_id=string] [target_host=string] [target_port=integer] [nfs_share=string] [replication_mode=string] [schedule=string] [vdb_ids=array[, array...]]... [dsource_ids=array[,array...]]... [cdb_ids=array[, array...]]... [vcdb_ids=array[,array...]]... [group_ids=array[, array...]]... [--[no-]enable_tag_replication] [--[no-] replicate_entire_engine] [bandwidth_limit=integer] [number_of_connections=integer] [--[no-]encrypted] [--[no-] automatic_replication] [--[no-]use_system_socks_setting]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. name=string The ReplicationProfile name. description=string The ReplicationProfile description. target_engine_id=string The ID of the replication target engine. This field is specific to network replication. target_host=string Hostname of the replication target engine. If none is provided and the target_engine_id is set, the hostname for the engine referenced by target_engine_id will be used. This field is specific to network replication. target_port=integer Target TCP port number for the Delphix Session Protocol. This field is specific to network replication. nfs_share=string The NFS share path for the replication target. This field is specific to offline replication. replication_mode=string Values: [ENGINE_DATA_REPLICATION, MASKED_DATA_DISTRIBUTION, CONTINUOUS_VAULT, OFFLINE_SEND, OFFLINE_RECEIVE]The ReplicationProfile mode. schedule=string Replication schedule in the form of a quartz-formatted string. vdb_ids=array[,array...] The VDBs that are replicated by this ReplicationProfile. dsource_ids=array[,array...] The dSources that are replicated by this ReplicationProfile. cdb_ids=array[,array...] The CDBs that are replicated by this ReplicationProfile. vcdb_ids=array[,array...] The vCDBs that are replicated by this ReplicationProfile. group_ids=array[,array...] The groups that are replicated by this ReplicationProfile. --[no-]enable_tag_replication Indicates whether tag replication from primary object to replica object is enabled or disabled for this ReplicationProfile. --[no-]replicate_entire_engine Whether to replicate the entire engine. This is mutually exclusive with the vdb_ids, dsource_ids, cdb_ids, vcdb_ids, and group_ids properties. bandwidth_limit=integer Bandwidth limit (MB/s) for replication network traffic. A value of 0 means no limit. This field is specific to network replication. number_of_connections=integer Total number of transport connections to use. This field is specific to network replication. --[no-]encrypted Encrypt replication network traffic. This field is specific to network replication. --[no-]automatic_replication Indication whether the replication spec schedule is enabled or not. --[no-]use_system_socks_setting Connect to the replication target host via the system-wide SOCKS proxy. This field is specific to network replication. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_replication_profile_tags ======================================== Usage: dct-toolkit get_replication_profile_tags[-hVw] [-cs] [-jh] replication_profile_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. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. -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_replication_profile_tags ======================================== Usage: dct-toolkit create_replication_profile_tags[-hVw] replication_profile_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. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for ReplicationProfiles. -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_replication_profile_tags ======================================== Usage: dct-toolkit delete_replication_profile_tags[-hVw] replication_profile_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. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. 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_tag_replication ======================================== Usage: dct-toolkit enable_tag_replication[-hVw] [-cs] [-jh] replication_profile_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. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. -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: disable_tag_replication ======================================== Usage: dct-toolkit disable_tag_replication[-hVw] [-cs] [-jh] replication_profile_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. replicationProfileId, replication_profile_id= The ID of the ReplicationProfile. -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. ======================================== ================================================================================ TOPIC: Reporting ================================================================================ Commands (34): search_storage_savings_summary_report, get_vdb_inventory_report, search_vdb_inventory_report, get_dsource_usage_report, search_dsource_usage_report, get_dsource_consumption_report, search_dsource_consumption_report, get_storage_capacity_data, search_storage_capacity_data, search_dataset_performance_analytics_summary, get_dataset_performance_analytics, get_masking_execution_metrics_report, search_masking_execution_metrics_report, get_engine_global_object_state_report, search_engine_global_object_state_report, get_data_risk_report, search_data_risk_report, get_audit_logs_summary_report, get_virtualization_storage_summary_report, search_virtualization_storage_summary_report, get_api_usage_report, get_reporting_schedules, create_reporting_schedule, search_reporting_schedules, get_reporting_schedule_by_id, update_reporting_schedule, delete_reporting_schedule, get_reporting_schedule_tags, create_reporting_schedule_tags, delete_reporting_schedule_tag, get_engine_performance_analytics_report, search_engine_performance_analytics_report, search_engine_performance_analytic_trends, get_product_info COMMAND: search_storage_savings_summary_report ======================================== Usage: dct-toolkit search_storage_savings_summary_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[dsource_id=string] [dependant_vdbs=integer] [engine_name=string] [unvirtualized_space=integer] [current_timeflows_unvirtualized_space=integer] [virtualized_space=integer] [name=string] [estimated_savings=integer] [estimated_savings_perc=number] [estimated_current_timeflows_savings=integer] [estimated_current_timeflows_savings_perc=number] [--[no-]is_replica]]] [-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 10000. 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. dsource_id=string Filter by dsource_id dependant_vdbs=integer Filter by dependant_vdbs engine_name=string Filter by engine_name unvirtualized_space=integer Filter by unvirtualized_space current_timeflows_unvirtualized_space=integer Filter by current_timeflows_unvirtualized_space virtualized_space=integer Filter by virtualized_space name=string Filter by name estimated_savings=integer Filter by estimated_savings estimated_savings_perc=number Filter by estimated_savings_perc estimated_current_timeflows_savings=integer Filter by estimated_current_timeflows_savings estimated_current_timeflows_savings_perc=number Filter by estimated_current_timeflows_savings_perc --[no-]is_replica Filter by is_replica -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_vdb_inventory_report ======================================== Usage: dct-toolkit get_vdb_inventory_report[-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 10000. 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_vdb_inventory_report ======================================== Usage: dct-toolkit search_vdb_inventory_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[name=string] [type=string] [parent_name=string] [parent_id=string] [creation_date=string] [last_refreshed_date=string] [parent_timeflow_location=string] [parent_timeflow_timestamp=string] [parent_timeflow_timezone=string] [--[no-]enabled] [status=string] [engine_name=string] [storage_size=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 10000. 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. name=string Filter by name type=string Filter by type parent_name=string Filter by parent_name parent_id=string Filter by parent_id creation_date=string Filter by creation_date last_refreshed_date=string Filter by last_refreshed_date parent_timeflow_location=string Filter by parent_timeflow_location parent_timeflow_timestamp=string Filter by parent_timeflow_timestamp parent_timeflow_timezone=string Filter by parent_timeflow_timezone --[no-]enabled Filter by enabled status=string Filter by status engine_name=string Filter by engine_name storage_size=string Filter by storage_size -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_usage_report ======================================== Usage: dct-toolkit get_dsource_usage_report[-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 10000. 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_dsource_usage_report ======================================== Usage: dct-toolkit search_dsource_usage_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[name=string] [unvirtualized_space=integer] [actual_space=integer] [dependant_vdbs=integer] [engine_name=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 10000. 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. name=string Filter by name unvirtualized_space=integer Filter by unvirtualized_space actual_space=integer Filter by actual_space dependant_vdbs=integer Filter by dependant_vdbs engine_name=string Filter by engine_name -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_consumption_report ======================================== Usage: dct-toolkit get_dsource_consumption_report[-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 10000. 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_dsource_consumption_report ======================================== Usage: dct-toolkit search_dsource_consumption_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[name=string] [status=string] [database_type=string] [engine_id=string] [engine_name=string] [last_consumption_date=string] [ingested_size=integer]]] [-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 10000. 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. name=string Filter by name status=string Filter by status database_type=string Filter by database_type engine_id=string Filter by engine_id engine_name=string Filter by engine_name last_consumption_date=string Filter by last_consumption_date ingested_size=integer Filter by ingested_size -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_storage_capacity_data ======================================== Usage: dct-toolkit get_storage_capacity_data[-hVw] [-cs] [-jh] [cursor=] [engine_id=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. engine_id= ID of a registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: search_storage_capacity_data ======================================== Usage: dct-toolkit search_storage_capacity_data[-hVw] [engine_id=] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[dataset_id=string] [captured_timestamp=string] [dataset_type=string] [dataset_name=string] [--[no-]is_replica] [total_size=integer] [base_size=integer] [snapshot_size=integer] [logs_size=integer] [unvirtualized_size=integer] [current_timeflow_unvirtualized_size=integer] [timeflow_unvirtualized_size=integer] [descendant_size=integer] [policy_size=integer] [manual_size=integer] [unowned_snapshot_size=integer] [ingested_size=integer] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c= [,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id= ID of a registered engine. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. dataset_id=string Filter by dataset_id captured_timestamp=string Filter by captured_timestamp dataset_type=string Filter by dataset_type dataset_name=string Filter by dataset_name --[no-]is_replica Filter by is_replica total_size=integer Filter by total_size base_size=integer Filter by base_size snapshot_size=integer Filter by snapshot_size logs_size=integer Filter by logs_size unvirtualized_size=integer Filter by unvirtualized_size current_timeflow_unvirtualized_size=integer Filter by current_timeflow_unvirtualized_size timeflow_unvirtualized_size=integer Filter by timeflow_unvirtualized_size descendant_size=integer Filter by descendant_size policy_size=integer Filter by policy_size manual_size=integer Filter by manual_size unowned_snapshot_size=integer Filter by unowned_snapshot_size ingested_size=integer Filter by ingested_size tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: search_dataset_performance_analytics_summary ======================================== Usage: dct-toolkit search_dataset_performance_analytics_summary[-hVw] engine_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[dataset_id=string] [dataset_name=string] [dataset_type=string] [--[no-] is_replica] [environment_id=string] [environment_name=string] [average_throughput_of_1_h=number] [average_throughput_of_6_h=number] [average_throughput_of_24_h=number] [current_throughput_of_1_h=number] [current_throughput_of_6_h=number] [current_throughput_of_24_h=number] [percentile=number] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. engine_id= ID of a registered engine. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. dataset_id=string Filter by dataset_id dataset_name=string Filter by dataset_name dataset_type=string Filter by dataset_type --[no-]is_replica Filter by is_replica environment_id=string Filter by environment_id environment_name=string Filter by environment_name average_throughput_of_1_h=number Filter by average_throughput_of_1_h average_throughput_of_6_h=number Filter by average_throughput_of_6_h average_throughput_of_24_h=number Filter by average_throughput_of_24_h current_throughput_of_1_h=number Filter by current_throughput_of_1_h current_throughput_of_6_h=number Filter by current_throughput_of_6_h current_throughput_of_24_h=number Filter by current_throughput_of_24_h percentile=number Filter by percentile tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_dataset_performance_analytics ======================================== Usage: dct-toolkit get_dataset_performance_analytics[-hVw] [-cs] [-jh] ([interval=integer start=string dataset_ids=array[,array...] [dataset_ids=array[,array...]]... end=string] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. interval=integer Desired time interval in timestamp format. start=string Start time in UTC from which to fetch analytics data. dataset_ids=array[,array...] List of dataset ids for which dataset performance analytics should be fetched. end=string End time in UTC up to which analytics data will be fetched. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_masking_execution_metrics_report ======================================== Usage: dct-toolkit get_masking_execution_metrics_report[-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 10000. sort= The field to sort results by. A property name with a prepended '-' signifies a 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_masking_execution_metrics_report ======================================== Usage: dct-toolkit search_masking_execution_metrics_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [masking_job_name=string] [masking_job_type=string] [connector_type=string] [--[no-]dct_managed] [ruleset_name=string] [rows_masked=integer] [rows_total=integer] [bytes_masked=integer] [bytes_total=integer] [duration=integer] [tables_files_count=integer] [masked_tables_files_count=integer] [columns_fields_count=integer] [masked_columns_fields_count=integer]]] [-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 10000. 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 a 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 masking_job_name=string Filter by masking_job_name masking_job_type=string Filter by masking_job_type connector_type=string Filter by connector_type --[no-]dct_managed Filter by dct_managed ruleset_name=string Filter by ruleset_name rows_masked=integer Filter by rows_masked rows_total=integer Filter by rows_total bytes_masked=integer Filter by bytes_masked bytes_total=integer Filter by bytes_total duration=integer Filter by duration tables_files_count=integer Filter by tables_files_count masked_tables_files_count=integer Filter by masked_tables_files_count columns_fields_count=integer Filter by columns_fields_count masked_columns_fields_count=integer Filter by masked_columns_fields_count -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_engine_global_object_state_report ======================================== Usage: dct-toolkit get_engine_global_object_state_report[-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 10000. 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_engine_global_object_state_report ======================================== Usage: dct-toolkit search_engine_global_object_state_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_id=string] [engine_name=string] [jobs_count=integer] [connectors_count=integer] [rulesets_count=integer] [global_object_revision_hash=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 10000. 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. engine_id=string Filter by engine_id engine_name=string Filter by engine_name jobs_count=integer Filter by jobs_count connectors_count=integer Filter by connectors_count rulesets_count=integer Filter by rulesets_count global_object_revision_hash=string Filter by global_object_revision_hash -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_data_risk_report ======================================== Usage: dct-toolkit get_data_risk_report[-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 10000. 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_data_risk_report ======================================== Usage: dct-toolkit search_data_risk_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[connector_id=string] [engine_connector_id=integer] [connector_name=string] [connector_type=string] [last_profiled_date=string] [last_masked_date=string] [--[no-]dct_managed] [engine_id=string] [engine_name=string] [--[no-]is_profiled] [--[no-]is_sensitive_data] [-- [no-]is_masked] [--[no-]is_at_risk] [data_elements_total=integer] [data_elements_not_sensitive=integer] [data_elements_sensitive_masked=integer] [data_elements_sensitive_unmasked=integer] [records_total=integer] [records_not_sensitive=integer] [records_sensitive_masked=integer] [records_sensitive_unmasked=integer] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. 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. connector_id=string Filter by connector_id engine_connector_id=integer Filter by engine_connector_id connector_name=string Filter by connector_name connector_type=string Filter by connector_type last_profiled_date=string Filter by last_profiled_date last_masked_date=string Filter by last_masked_date --[no-]dct_managed Filter by dct_managed engine_id=string Filter by engine_id engine_name=string Filter by engine_name --[no-]is_profiled Filter by is_profiled --[no-]is_sensitive_data Filter by is_sensitive_data --[no-]is_masked Filter by is_masked --[no-]is_at_risk Filter by is_at_risk data_elements_total=integer Filter by data_elements_total data_elements_not_sensitive=integer Filter by data_elements_not_sensitive data_elements_sensitive_masked=integer Filter by data_elements_sensitive_masked data_elements_sensitive_unmasked=integer Filter by data_elements_sensitive_unmasked records_total=integer Filter by records_total records_not_sensitive=integer Filter by records_not_sensitive records_sensitive_masked=integer Filter by records_sensitive_masked records_sensitive_unmasked=integer Filter by records_sensitive_unmasked tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_audit_logs_summary_report ======================================== Usage: dct-toolkit get_audit_logs_summary_report[-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 10000. 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: get_virtualization_storage_summary_report ======================================== Usage: dct-toolkit get_virtualization_storage_summary_report[-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 10000. 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_virtualization_storage_summary_report ======================================== Usage: dct-toolkit search_virtualization_storage_summary_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_id=string] [engine_name=string] [engine_hostname=string] [total_capacity=integer] [free_storage=integer] [used_storage=integer] [used_percentage=number] [dsource_count=integer] [vdb_count=integer] [total_object_count=integer] [reserved_storage=integer] [dsource_used_storage=integer] [vdb_used_storage=integer]]] [-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 10000. 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. engine_id=string Filter by engine_id engine_name=string Filter by engine_name engine_hostname=string Filter by engine_hostname total_capacity=integer Filter by total_capacity free_storage=integer Filter by free_storage used_storage=integer Filter by used_storage used_percentage=number Filter by used_percentage dsource_count=integer Filter by dsource_count vdb_count=integer Filter by vdb_count total_object_count=integer Filter by total_object_count reserved_storage=integer Filter by reserved_storage dsource_used_storage=integer Filter by dsource_used_storage vdb_used_storage=integer Filter by vdb_used_storage -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_api_usage_report ======================================== Usage: dct-toolkit get_api_usage_report[-hVw] [-cs] [-jh] [api_metric_kind=] [client_name=] [dct_version=] [end_date=] [group_by=] [start_date=] [user_agent=] [-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. api_metric_kind= Restrict the list to API usage metric of the given kind -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. client_name= The Client names to be included in the report. -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. dct_version= The DCT versions to be included in the report. end_date= Report end date/time. Defaults to current time. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. group_by= The field to group results by. -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. start_date= Report start date/time. Defaults to first API request. user_agent= The UserAgent names to be included in the report. -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_reporting_schedules ======================================== Usage: dct-toolkit get_reporting_schedules[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_reporting_schedule ======================================== Usage: dct-toolkit create_reporting_schedule[-hVw] [-cs] [-jh] ([--[no-] enabled message=string report_type=string file_format=string recipients=array[,array...] [recipients=array[,array...]]... cron_expression=string [time_zone=string] [sort_column=string] [row_count=integer] [--[no-]make_current_account_owner]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. --[no-]enabled message=string report_type=string Values: [VIRTUALIZATION_STORAGE_SUMMARY, ENGINE_PERFORMANCE_ANALYTIC, VDB_INVENTORY_DATA, DSOURCE_USAGE_DATA, DSOURCE_CONSUMPTION_DATA, MASKING_EXECUTION_METRICS, AUDIT_LOGS_SUMMARY, STORAGE_SAVINGS_SUMMARY, DATA_RISK_SUMMARY] file_format=string Values: [CSV] recipients=array[,array...] cron_expression=string Standard cron expressions are supported e.g. 0 15 10 L * ? - Schedule at 10:15 AM on the last day of every month, 0 0 2 ? * Mon-Fri - Schedule at 2:00 AM every Monday, Tuesday, Wednesday, Thursday and Friday. For more details kindly refer- "http://www.quartz-scheduler. org/documentation/" time_zone=string Timezones are specified according to the Olson tzinfo database - "https://en.wikipedia. org/wiki/List_of_tz_database_time_zones". sort_column=string Values: [engine_id, engine_name, engine_hostname, total_capacity, free_storage, used_storage, used_percentage, dsource_count, vdb_count, total_object_count, name, unvirtualized_space, actual_space, dependant_vdbs, type, version, parent_id, parent_name, creation_date, parent_timeflow_location, parent_timeflow_timestamp, parent_timeflow_timezone, enabled, status, connector_id, connector_name, connector_type, last_profiled_date, last_masked_date, is_profiled, is_sensitive_data, is_masked, is_at_risk, data_elements_total, data_elements_not_sensitive, data_elements_sensitive_masked, data_elements_sensitive_unmasked, records_total, records_not_sensitive, records_sensitive_masked, records_sensitive_unmasked, -engine_id, -engine_name, -engine_hostname, -total_capacity, -free_storage, -used_storage, -used_percentage, -dsource_count, -vdb_count, -total_object_count, -unvirtualized_space, -actual_space, -dependant_vdbs, -name, -type, -version, -parent_id, -parent_name, -creation_date, -parent_timeflow_location, -parent_timeflow_timestamp, -parent_timeflow_timezone, -enabled, -status, -connector_id, -connector_name, -connector_type, -last_profiled_date, -last_masked_date, -is_profiled, -is_sensitive_data, -is_masked, -is_at_risk, -data_elements_total, -data_elements_not_sensitive, -data_elements_sensitive_masked, -data_elements_sensitive_unmasked, -records_total, -records_not_sensitive, -records_sensitive_masked, -records_sensitive_unmasked] row_count=integer --[no-]make_current_account_owner Whether the account creating this reporting schedule must be configured as owner of the reporting schedule. --body=PARAM The parameters to create a reporting schedule. -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_reporting_schedules ======================================== Usage: dct-toolkit search_reporting_schedules[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[report_id=integer] [report_type=string] [cron_expression=string] [time_zone=string] [message=string] [file_format=string] [--[no-]enabled] [sort_column=string] [tags[=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. report_id=integer Filter by report_id report_type=string Filter by report_type cron_expression=string Filter by cron_expression time_zone=string Filter by time_zone message=string Filter by message file_format=string Filter by file_format --[no-]enabled Filter by enabled sort_column=string Filter by sort_column tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_reporting_schedule_by_id ======================================== Usage: dct-toolkit get_reporting_schedule_by_id[-hVw] [-cs] [-jh] report_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. reportId, report_id= The ID of the report schedule. -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_reporting_schedule ======================================== Usage: dct-toolkit update_reporting_schedule[-hVw] report_id= [-cs] [-jh] ([--[no-]enabled message=string report_type=string file_format=string recipients=array[,array...] [recipients=array[, array...]]... cron_expression=string [time_zone=string] [tags [=array...]]... [sort_column=string] [row_count=integer]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. reportId, report_id= The ID of the report schedule. --[no-]enabled message=string report_type=string Values: [VIRTUALIZATION_STORAGE_SUMMARY, ENGINE_PERFORMANCE_ANALYTIC, VDB_INVENTORY_DATA, DSOURCE_USAGE_DATA, DSOURCE_CONSUMPTION_DATA, MASKING_EXECUTION_METRICS, AUDIT_LOGS_SUMMARY, STORAGE_SAVINGS_SUMMARY, DATA_RISK_SUMMARY] file_format=string Values: [CSV] recipients=array[,array...] cron_expression=string Standard cron expressions are supported e.g. 0 15 10 L * ? - Schedule at 10:15 AM on the last day of every month, 0 0 2 ? * Mon-Fri - Schedule at 2:00 AM every Monday, Tuesday, Wednesday, Thursday and Friday. For more details kindly refer- "http://www.quartz-scheduler. org/documentation/" time_zone=string Timezones are specified according to the Olson tzinfo database - "https://en.wikipedia. org/wiki/List_of_tz_database_time_zones". tags[=array...] sort_column=string Values: [engine_id, engine_name, engine_hostname, total_capacity, free_storage, used_storage, used_percentage, dsource_count, vdb_count, total_object_count, name, unvirtualized_space, actual_space, dependant_vdbs, type, version, parent_id, parent_name, creation_date, parent_timeflow_location, parent_timeflow_timestamp, parent_timeflow_timezone, enabled, status, connector_id, connector_name, connector_type, last_profiled_date, last_masked_date, is_profiled, is_sensitive_data, is_masked, is_at_risk, data_elements_total, data_elements_not_sensitive, data_elements_sensitive_masked, data_elements_sensitive_unmasked, records_total, records_not_sensitive, records_sensitive_masked, records_sensitive_unmasked, -engine_id, -engine_name, -engine_hostname, -total_capacity, -free_storage, -used_storage, -used_percentage, -dsource_count, -vdb_count, -total_object_count, -unvirtualized_space, -actual_space, -dependant_vdbs, -name, -type, -version, -parent_id, -parent_name, -creation_date, -parent_timeflow_location, -parent_timeflow_timestamp, -parent_timeflow_timezone, -enabled, -status, -connector_id, -connector_name, -connector_type, -last_profiled_date, -last_masked_date, -is_profiled, -is_sensitive_data, -is_masked, -is_at_risk, -data_elements_total, -data_elements_not_sensitive, -data_elements_sensitive_masked, -data_elements_sensitive_unmasked, -records_total, -records_not_sensitive, -records_sensitive_masked, -records_sensitive_unmasked] row_count=integer --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_reporting_schedule ======================================== Usage: dct-toolkit delete_reporting_schedule[-hVw] [-cs] [-jh] report_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. reportId, report_id= The ID of the report schedule. -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_reporting_schedule_tags ======================================== Usage: dct-toolkit get_reporting_schedule_tags[-hVw] [-cs] [-jh] report_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. reportId, report_id= The ID of the report schedule. -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_reporting_schedule_tags ======================================== Usage: dct-toolkit create_reporting_schedule_tags[-hVw] report_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. reportId, report_id= The ID of the report schedule. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for report schedule. -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_reporting_schedule_tag ======================================== Usage: dct-toolkit delete_reporting_schedule_tag[-hVw] report_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. reportId, report_id= The ID of the report schedule. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_engine_performance_analytics_report ======================================== Usage: dct-toolkit get_engine_performance_analytics_report[-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 10000. 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_engine_performance_analytics_report ======================================== Usage: dct-toolkit search_engine_performance_analytics_report[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_id=string] [engine_name=string] [engine_type=string] [aggregation_period=integer] [cpu_cores_count=integer] [cpu_utilization=number] [total_memory=integer] [average_disk_latency_read=integer] [average_disk_latency_write=integer] [average_disk_latency_total=integer] [average_disk_throughput_read=integer] [average_disk_throughput_write=integer] [average_disk_throughput_total=integer] [average_disk_iops_read=integer] [average_disk_iops_write=integer] [average_disk_iops_total=integer] [average_nfs_latency_read=integer] [average_nfs_latency_write=integer] [average_nfs_latency_total=integer] [average_nfs_throughput_read=integer] [average_nfs_throughput_write=integer] [average_nfs_throughput_total=integer] [average_nfs_iops_read=integer] [average_nfs_iops_write=integer] [average_nfs_iops_total=integer] [average_iscsi_latency_read=integer] [average_iscsi_latency_write=integer] [average_iscsi_latency_total=integer] [average_iscsi_throughput_read=integer] [average_iscsi_throughput_write=integer] [average_iscsi_throughput_total=integer] [average_iscsi_iops_read=integer] [average_iscsi_iops_write=integer] [average_iscsi_iops_total=integer] [average_network_throughput_transmit=number] [average_network_throughput_receive=number]]] [-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 10000. 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. engine_id=string Filter by engine_id engine_name=string Filter by engine_name engine_type=string Filter by engine_type aggregation_period=integer Filter by aggregation_period cpu_cores_count=integer Filter by cpu_cores_count cpu_utilization=number Filter by cpu_utilization total_memory=integer Filter by total_memory average_disk_latency_read=integer Filter by average_disk_latency_read average_disk_latency_write=integer Filter by average_disk_latency_write average_disk_latency_total=integer Filter by average_disk_latency_total average_disk_throughput_read=integer Filter by average_disk_throughput_read average_disk_throughput_write=integer Filter by average_disk_throughput_write average_disk_throughput_total=integer Filter by average_disk_throughput_total average_disk_iops_read=integer Filter by average_disk_iops_read average_disk_iops_write=integer Filter by average_disk_iops_write average_disk_iops_total=integer Filter by average_disk_iops_total average_nfs_latency_read=integer Filter by average_nfs_latency_read average_nfs_latency_write=integer Filter by average_nfs_latency_write average_nfs_latency_total=integer Filter by average_nfs_latency_total average_nfs_throughput_read=integer Filter by average_nfs_throughput_read average_nfs_throughput_write=integer Filter by average_nfs_throughput_write average_nfs_throughput_total=integer Filter by average_nfs_throughput_total average_nfs_iops_read=integer Filter by average_nfs_iops_read average_nfs_iops_write=integer Filter by average_nfs_iops_write average_nfs_iops_total=integer Filter by average_nfs_iops_total average_iscsi_latency_read=integer Filter by average_iscsi_latency_read average_iscsi_latency_write=integer Filter by average_iscsi_latency_write average_iscsi_latency_total=integer Filter by average_iscsi_latency_total average_iscsi_throughput_read=integer Filter by average_iscsi_throughput_read average_iscsi_throughput_write=integer Filter by average_iscsi_throughput_write average_iscsi_throughput_total=integer Filter by average_iscsi_throughput_total average_iscsi_iops_read=integer Filter by average_iscsi_iops_read average_iscsi_iops_write=integer Filter by average_iscsi_iops_write average_iscsi_iops_total=integer Filter by average_iscsi_iops_total average_network_throughput_transmit=number Filter by average_network_throughput_transmit average_network_throughput_receive=number Filter by average_network_throughput_receive -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_engine_performance_analytic_trends ======================================== Usage: dct-toolkit search_engine_performance_analytic_trends[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_id=string] [trend_type=string] [aggregation_period=integer]]] [-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 10000. 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. engine_id=string Filter by engine_id trend_type=string Filter by trend_type aggregation_period=integer Filter by aggregation_period -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_product_info ======================================== Usage: dct-toolkit get_product_info[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== ================================================================================ TOPIC: RuleSets ================================================================================ Commands (12): get_rule_sets, search_rule_sets, get_rule_set_by_id, get_rule_set_tags, create_rule_set_tags, delete_rule_set_tags, get_database_table_metadata, search_database_table_metadata, get_database_table_metadata_by_id, get_database_column_metadata, search_database_column_metadata, get_database_column_metadata_by_id COMMAND: get_rule_sets ======================================== Usage: dct-toolkit get_rule_sets[-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 a 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_rule_sets ======================================== Usage: dct-toolkit search_rule_sets[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [type=string] [platform=string] [connector_id=string] [connector_name=string] [engine_id=string] [engine_name=string] [data_elements_total=integer] [data_elements_sensitive=integer] [records_total=integer] [records_sensitive=integer] [creation_date=string] [account_id=integer] [account_name=string] [--[no-]dct_managed] [job_orchestrator_id=string] [job_orchestrator_name=string] [last_attempted_refresh_status=string] [last_attempted_refresh_time=string] [last_refresh_time=string] [tags[=array [object]...]]...]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies a 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 type=string Filter by type platform=string Filter by platform connector_id=string Filter by connector_id connector_name=string Filter by connector_name engine_id=string Filter by engine_id engine_name=string Filter by engine_name data_elements_total=integer Filter by data_elements_total data_elements_sensitive=integer Filter by data_elements_sensitive records_total=integer Filter by records_total records_sensitive=integer Filter by records_sensitive creation_date=string Filter by creation_date account_id=integer Filter by account_id account_name=string Filter by account_name --[no-]dct_managed Filter by dct_managed job_orchestrator_id=string Filter by job_orchestrator_id job_orchestrator_name=string Filter by job_orchestrator_name last_attempted_refresh_status=string Filter by last_attempted_refresh_status last_attempted_refresh_time=string Filter by last_attempted_refresh_time last_refresh_time=string Filter by last_refresh_time tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_rule_set_by_id ======================================== Usage: dct-toolkit get_rule_set_by_id[-hVw] [-cs] [-jh] rule_set_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. ruleSetId, rule_set_id= The ID of the Rule Set. -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_rule_set_tags ======================================== Usage: dct-toolkit get_rule_set_tags[-hVw] [-cs] [-jh] rule_set_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. ruleSetId, rule_set_id= The ID of the Rule Set. -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_rule_set_tags ======================================== Usage: dct-toolkit create_rule_set_tags[-hVw] rule_set_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. ruleSetId, rule_set_id= The ID of the Rule Set. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Rule Set. -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_rule_set_tags ======================================== Usage: dct-toolkit delete_rule_set_tags[-hVw] rule_set_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. ruleSetId, rule_set_id= The ID of the Rule Set. key=string Key of the tag value=string Value of the tag tags[=array...] List of tags to be deleted --body=PARAM The parameters to delete tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_database_table_metadata ======================================== Usage: dct-toolkit get_database_table_metadata[-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 a 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_database_table_metadata ======================================== Usage: dct-toolkit search_database_table_metadata[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [table_name=string] [rule_set_id=string] [rule_set_name=string] [custom_sql=string] [where_clause=string] [having_clause=string] [key_column=string] [--[no-]is_sensitive] [row_count=integer] [last_refresh_time=string] [last_row_count_time=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 a 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 table_name=string Filter by table_name rule_set_id=string Filter by rule_set_id rule_set_name=string Filter by rule_set_name custom_sql=string Filter by custom_sql where_clause=string Filter by where_clause having_clause=string Filter by having_clause key_column=string Filter by key_column --[no-]is_sensitive Filter by is_sensitive row_count=integer Filter by row_count last_refresh_time=string Filter by last_refresh_time last_row_count_time=string Filter by last_row_count_time -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_database_table_metadata_by_id ======================================== Usage: dct-toolkit get_database_table_metadata_by_id[-hVw] [-cs] [-jh] database_table_metadata_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. databaseTableMetadataId, database_table_metadata_id= The ID of the database table metadata. -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_database_column_metadata ======================================== Usage: dct-toolkit get_database_column_metadata[-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 a 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_database_column_metadata ======================================== Usage: dct-toolkit search_database_column_metadata[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=integer] [column_name=string] [database_table_metadata_id=integer] [table_name=string] [engine_id=string] [engine_name=string] [rule_set_id=string] [rule_set_name=string] [algorithm_id=string] [algorithm_name=string] [data_class_id=string] [data_class_name=string] [data_type=string] [date_format=string] [column_length=integer] [--[no-] is_sensitive] [--[no-]is_profiler_writable] [--[no-]is_primary_key] [-- [no-]is_identity] [--[no-]is_index] [--[no-]is_foreign_key]]] [-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 a descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=integer Filter by id column_name=string Filter by column_name database_table_metadata_id=integer Filter by database_table_metadata_id table_name=string Filter by table_name engine_id=string Filter by engine_id engine_name=string Filter by engine_name rule_set_id=string Filter by rule_set_id rule_set_name=string Filter by rule_set_name algorithm_id=string Filter by algorithm_id algorithm_name=string Filter by algorithm_name data_class_id=string Filter by data_class_id data_class_name=string Filter by data_class_name data_type=string Filter by data_type date_format=string Filter by date_format column_length=integer Filter by column_length --[no-]is_sensitive Filter by is_sensitive --[no-]is_profiler_writable Filter by is_profiler_writable --[no-]is_primary_key Filter by is_primary_key --[no-]is_identity Filter by is_identity --[no-]is_index Filter by is_index --[no-]is_foreign_key Filter by is_foreign_key -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_database_column_metadata_by_id ======================================== Usage: dct-toolkit get_database_column_metadata_by_id[-hVw] [-cs] [-jh] database_column_metadata_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. databaseColumnMetadataId, database_column_metadata_id= The ID of the database column metadata. -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. ======================================== ================================================================================ TOPIC: SamlLogin ================================================================================ Commands (1): checkSaml COMMAND: checkSaml ======================================== Usage: dct-toolkit checkSaml[-hVw] [-cs] [-jh] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== ================================================================================ TOPIC: Snapshots ================================================================================ Commands (17): get_snapshots, get_snapshot_by_id, delete_snapshot, update_snapshot, delete_snapshot_by_id, unset_snapshot_retention, get_snapshot_tags, create_snapshot_tags, delete_snapshot_tags, search_snapshots, find_by_location, find_by_timestamp, get_snapshot_timeflow_range, get_snapshot_runtime_by_id, get_snapshots_capacity_data, get_shared_snapshot_space, get_snapshot_deletion_dependencies COMMAND: get_snapshots ======================================== Usage: dct-toolkit get_snapshots[-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: get_snapshot_by_id ======================================== Usage: dct-toolkit get_snapshot_by_id[-hVw] [-cs] [-jh] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. -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: delete_snapshot ======================================== Usage: dct-toolkit delete_snapshot[-hVw] [-cs] [-jh] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. -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_snapshot ======================================== Usage: dct-toolkit update_snapshot[-hVw] snapshot_id= [-cs] [-jh] [[[expiration=string] [--[no-] retain_forever]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. snapshotId, snapshot_id= The ID of the snapshot. expiration=string The expiration for this snapshot. Mutually exclusive with retain_forever. --[no-]retain_forever Indicates that the snapshot should be retained forever. --body=PARAM The new data to update a Snapshot. -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_snapshot_by_id ======================================== Usage: dct-toolkit delete_snapshot_by_id[-hVw] snapshot_id= [-cs] [-jh] [[[--[no-]delete_all_dependencies]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. snapshotId, snapshot_id= The ID of the snapshot. --[no-]delete_all_dependencies Whether to delete the snapshot along with all of its dependencies. --body=PARAM The parameters to delete a Snapshot. -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: unset_snapshot_retention ======================================== Usage: dct-toolkit unset_snapshot_retention[-hVw] [-cs] [-jh] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. -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_snapshot_tags ======================================== Usage: dct-toolkit get_snapshot_tags[-hVw] [-cs] [-jh] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. -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_snapshot_tags ======================================== Usage: dct-toolkit create_snapshot_tags[-hVw] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Snapshot. -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_snapshot_tags ======================================== Usage: dct-toolkit delete_snapshot_tags[-hVw] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. 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: search_snapshots ======================================== Usage: dct-toolkit search_snapshots[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [engine_id=string] [namespace=string] [name=string] [namespace_id=string] [namespace_name=string] [--[no-]is_replica] [consistency=string] [--[no-] missing_non_logged_data] [dataset_id=string] [creation_time=string] [start_timestamp=string] [start_location=string] [timestamp=string] [location=string] [expiration=date] [--[no-] retain_forever] [effective_expiration=date] [--[no-]effective_retain_forever] [timeflow_id=string] [timezone=string] [-- [no-]temporary] [appdata_toolkit=string] [appdata_metadata=string] [ase_db_encryption_key=string] [mssql_internal_version=integer] [mssql_backup_set_uuid=string] [mssql_backup_software_type=string] [mssql_backup_location_type=string] [--[no-] mssql_empty_snapshot] [--[no-] oracle_from_physical_standby_vdb] [oracle_redo_log_size_in_bytes=integer]]] [-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 engine_id=string Filter by engine_id namespace=string Filter by namespace name=string Filter by name namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica consistency=string Filter by consistency --[no-]missing_non_logged_data Filter by missing_non_logged_data dataset_id=string Filter by dataset_id creation_time=string Filter by creation_time start_timestamp=string Filter by start_timestamp start_location=string Filter by start_location timestamp=string Filter by timestamp location=string Filter by location expiration=date Filter by expiration --[no-]retain_forever Filter by retain_forever effective_expiration=date Filter by effective_expiration --[no-]effective_retain_forever Filter by effective_retain_forever timeflow_id=string Filter by timeflow_id timezone=string Filter by timezone --[no-]temporary Filter by temporary appdata_toolkit=string Filter by appdata_toolkit appdata_metadata=string Filter by appdata_metadata ase_db_encryption_key=string Filter by ase_db_encryption_key mssql_internal_version=integer Filter by mssql_internal_version mssql_backup_set_uuid=string Filter by mssql_backup_set_uuid mssql_backup_software_type=string Filter by mssql_backup_software_type mssql_backup_location_type=string Filter by mssql_backup_location_type --[no-]mssql_empty_snapshot Filter by mssql_empty_snapshot --[no-]oracle_from_physical_standby_vdb Filter by oracle_from_physical_standby_vdb oracle_redo_log_size_in_bytes=integer Filter by oracle_redo_log_size_in_bytes -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: find_by_location ======================================== Usage: dct-toolkit find_by_location[-hVw] [-cs] [-jh] dataset_id= location= [-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. dataset_id= The ID of the dSource or VDB. -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. location= The location -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: find_by_timestamp ======================================== Usage: dct-toolkit find_by_timestamp[-hVw] [-cs] [-jh] dataset_id= timestamp= [-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. dataset_id= The ID of the dSource or VDB. -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. timestamp= The desired point in time. -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_snapshot_timeflow_range ======================================== Usage: dct-toolkit get_snapshot_timeflow_range[-hVw] [-cs] [-jh] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. -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_snapshot_runtime_by_id ======================================== Usage: dct-toolkit get_snapshot_runtime_by_id[-hVw] [-cs] [-jh] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. -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_snapshots_capacity_data ======================================== Usage: dct-toolkit get_snapshots_capacity_data[-hVw] [-cs] [-jh] [cursor=] [dataset_id=] [engine_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. dataset_id= The ID of the dSource or VDB. engine_id= ID of a registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. -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_shared_snapshot_space ======================================== Usage: dct-toolkit get_shared_snapshot_space[-hVw] [-cs] [-jh] dataset_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. dataset_id= The ID of the dSource or VDB. -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_snapshot_deletion_dependencies ======================================== Usage: dct-toolkit get_snapshot_deletion_dependencies[-hVw] [-cs] [-jh] snapshot_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. snapshotId, snapshot_id= The ID of the snapshot. -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. ======================================== ================================================================================ TOPIC: Sources ================================================================================ Commands (18): get_sources, create_oracle_source, update_oracle_source_by_id, verify_source_jdbc_connection_string, create_postgres_source, create_app_data_source, update_appdata_source_by_id, update_postgres_source_by_id, create_ase_source, update_ase_source_by_id, search_sources, get_source_by_id, delete_source, update_source_by_id, get_source_tags, create_source_tags, get_source_compatible_repo, delete_source_tags COMMAND: get_sources ======================================== Usage: dct-toolkit get_sources[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_oracle_source ======================================== Usage: dct-toolkit create_oracle_source[-hVw] [-cs] [-jh] ([repository_id=string oracle_config_type=string [engine_id=string] [environment_id=string] [database_name=string] [instances=array] [unique_name=string] [instance_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. repository_id=string The id of the containing repository where this database is created. oracle_config_type=string Values: [OracleRACConfig, OracleSIConfig, OraclePDBConfig] engine_id=string The ID of the engine to create the source on. environment_id=string The ID of the environment to create the source on. database_name=string The name of the database. instances=array The instances of this RAC database. unique_name=string The unique name of this database. instance_name=string The instance name of this single instance database. --body=PARAM The parameters to create an Oracle source. -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_source_by_id ======================================== Usage: dct-toolkit update_oracle_source_by_id[-hVw] source_id= [-cs] [-jh] [[[oracle_services=array[,array...]]... [user=string] [password=string] [--[no-]linking_enabled]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. sourceId, source_id= The ID of the Source. oracle_services=array[,array...] List of jdbc connection strings which are used to connect with the database. user=string Database user for accessing this source. password=string Password for the database user. --[no-]linking_enabled Whether this source should be used for linking. --body=PARAM The parameters to update a Oracle source -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_source_jdbc_connection_string ======================================== Usage: dct-toolkit verify_source_jdbc_connection_string[-hVw] source_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. sourceId, source_id= The ID of the Source. 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 ======================================== COMMAND: create_postgres_source ======================================== Usage: dct-toolkit create_postgres_source[-hVw] [-cs] [-jh] ([name=string [repository_id=string] [engine_id=string] [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. name=string The name of the source. repository_id=string The ID of the Repository onto which the source will be created. engine_id=string The ID of the engine to create the source on. environment_id=string The ID of the environment to create the source on. --body=PARAM The parameters to create a PostgreSQL source. -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: create_app_data_source ======================================== Usage: dct-toolkit create_app_data_source[-hVw] [-cs] [-jh] ([type=string name=string repository_id=string [--[no-]linking_enabled] [environment_user=string] [parameters=object] [path=string] [environment_id=string] [engine_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. type=string Values: [DIRECT, STAGED]The type of source to create. Default is DIRECT. name=string The name of the source. repository_id=string The ID of the Repository onto which the source will be created. --[no-]linking_enabled Whether this source should be used for linking. environment_user=string The environment user reference. parameters=object The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. path=string The path to the data to be synced. This should only be passed for type=DIRECT. environment_id=string The ID of the environment to create the source on. engine_id=string The ID of the engine to create the source on. --body=PARAM The parameters to create a AppData source. -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_source_by_id ======================================== Usage: dct-toolkit update_appdata_source_by_id[-hVw] source_id= [-cs] [-jh] [[[name=string] [repository_id=string] [environment_id=string] [--[no-]linking_enabled] [environment_user=string] [parameters=object] [path=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. sourceId, source_id= The ID of the Source. name=string The name of the source. repository_id=string The ID of the Repository onto which the source will be created. environment_id=string The ID of the environment to create the source on. --[no-]linking_enabled Whether this source should be used for linking. environment_user=string The environment user reference. parameters=object The JSON payload conforming to the DraftV4 schema based on the type of application data being manipulated. path=string The path to the data to be synced. This should only be passed for type=DIRECT. --body=PARAM The parameters to update an AppData source. -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_postgres_source_by_id ======================================== Usage: dct-toolkit update_postgres_source_by_id[-hVw] source_id= [-cs] [-jh] [[[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. sourceId, source_id= The ID of the Source. name=string The name of the source. --body=PARAM The parameters to update a PostgreSQL source -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: create_ase_source ======================================== Usage: dct-toolkit create_ase_source[-hVw] [-cs] [-jh] ([database_name=string repository_id=string [--[no-] linking_enabled] [environment_id=string] [environment_user=string] [engine_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. database_name=string The database name of the source. repository_id=string The ID of the Repository onto which the source will be created. --[no-]linking_enabled Whether this source should be used for linking. environment_id=string The ID of the environment to create the source on. environment_user=string The environment user reference. engine_id=string The ID of the engine to create the source on. --body=PARAM The parameters to create an ASE source. -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_source_by_id ======================================== Usage: dct-toolkit update_ase_source_by_id[-hVw] source_id= [-cs] [-jh] [[[database_name=string] [repository_id=string] [--[no-] linking_enabled] [environment_id=string] [environment_user=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. sourceId, source_id= The ID of the Source. database_name=string The database name of the source. repository_id=string The ID of the Repository onto which the source will be created. --[no-]linking_enabled Whether this source should be used for linking. environment_id=string The ID of the environment to create the source on. environment_user=string The environment user reference. database_username=string The username of the ASE instance database. database_password=string The credentials of the ASE instance database user. --body=PARAM The parameters to update an ASE source. -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_sources ======================================== Usage: dct-toolkit search_sources[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [database_type=string] [name=string] [database_version=string] [environment_id=string] [environment_name=string] [data_uuid=string] [ip_address=string] [fqdn=string] [size=integer] [jdbc_connection_string=string] [plugin_version=string] [--[no-]is_dsource] [namespace_id=string] [namespace_name=string] [--[no-]is_replica] [recovery_model=string] [mssql_source_type=string] [appdata_source_type=string] [--[no-]is_pdb] [instance_name=string] [instance_number=integer] [user=string] [environment_user_ref=string] [non_sys_user=string] [--[no-]discovered] [-- [no-]linking_enabled] [repository=string] [cdb_type=string] [data_connection_id=string] [database_name=string] [database_unique_name=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id database_type=string Filter by database_type name=string Filter by name database_version=string Filter by database_version environment_id=string Filter by environment_id environment_name=string Filter by environment_name data_uuid=string Filter by data_uuid ip_address=string Filter by ip_address fqdn=string Filter by fqdn size=integer Filter by size jdbc_connection_string=string Filter by jdbc_connection_string plugin_version=string Filter by plugin_version --[no-]is_dsource Filter by is_dsource namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica recovery_model=string Filter by recovery_model mssql_source_type=string Filter by mssql_source_type appdata_source_type=string Filter by appdata_source_type --[no-]is_pdb Filter by is_pdb instance_name=string Filter by instance_name instance_number=integer Filter by instance_number user=string Filter by user environment_user_ref=string Filter by environment_user_ref non_sys_user=string Filter by non_sys_user --[no-]discovered Filter by discovered --[no-]linking_enabled Filter by linking_enabled repository=string Filter by repository cdb_type=string Filter by cdb_type data_connection_id=string Filter by data_connection_id database_name=string Filter by database_name database_unique_name=string Filter by database_unique_name -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_source_by_id ======================================== Usage: dct-toolkit get_source_by_id[-hVw] [-cs] [-jh] source_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. sourceId, source_id= The ID of the Source. -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: delete_source ======================================== Usage: dct-toolkit delete_source[-hVw] [-cs] [-jh] source_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. sourceId, source_id= The ID of the Source. -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_source_by_id ======================================== Usage: dct-toolkit update_source_by_id[-hVw] source_id= [-cs] [-jh] [[[oracle_services=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. sourceId, source_id= The ID of the Source. oracle_services=array[,array...] List of jdbc connection strings which are used to connect with the database. --body=PARAM The parameters to update a Source. -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_source_tags ======================================== Usage: dct-toolkit get_source_tags[-hVw] [-cs] [-jh] source_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. sourceId, source_id= The ID of the Source. -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_source_tags ======================================== Usage: dct-toolkit create_source_tags[-hVw] source_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. sourceId, source_id= The ID of the Source. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Source. -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_source_compatible_repo ======================================== Usage: dct-toolkit get_source_compatible_repo[-hVw] [-cs] [-jh] source_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. sourceId, source_id= The ID of the Source. -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: delete_source_tags ======================================== Usage: dct-toolkit delete_source_tags[-hVw] source_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. sourceId, source_id= The ID of the Source. 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 ======================================== ================================================================================ TOPIC: StagingCdbs ================================================================================ Commands (9): get_staging_cdbs, search_staging_cdbs, get_staging_cdb_by_id, delete_staging_cdb, get_staging_cdb_tags, create_staging_cdb_tags, delete_staging_cdb_tags, enable_staging_cdb, disable_staging_cdb COMMAND: get_staging_cdbs ======================================== Usage: dct-toolkit get_staging_cdbs[-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_staging_cdbs ======================================== Usage: dct-toolkit search_staging_cdbs[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [database_version=string] [environment_id=string] [size=integer] [jdbc_connection_string=string] [engine_id=string] [namespace_id=string] [namespace_name=string] [--[no-] is_replica] [group_name=string] [status=string] [--[no-]enabled] [instance_name=string] [instance_number=integer] [repository_id=string] [tde_keystore_config_type=string] [database_name=string] [database_unique_name=string] [tde_kms_pkcs11_config_path=string] [-- [no-]is_tde_keystore_password_set] [mount_base=string] [datafile_mount_path=string] [archive_mount_path=string] [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_version=string Filter by database_version environment_id=string Filter by environment_id size=integer Filter by size jdbc_connection_string=string Filter by jdbc_connection_string engine_id=string Filter by engine_id namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica group_name=string Filter by group_name status=string Filter by status --[no-]enabled Filter by enabled instance_name=string Filter by instance_name instance_number=integer Filter by instance_number repository_id=string Filter by repository_id tde_keystore_config_type=string Filter by tde_keystore_config_type database_name=string Filter by database_name database_unique_name=string Filter by database_unique_name tde_kms_pkcs11_config_path=string Filter by tde_kms_pkcs11_config_path --[no-]is_tde_keystore_password_set Filter by is_tde_keystore_password_set mount_base=string Filter by mount_base datafile_mount_path=string Filter by datafile_mount_path archive_mount_path=string Filter by archive_mount_path 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_staging_cdb_by_id ======================================== Usage: dct-toolkit get_staging_cdb_by_id[-hVw] [-cs] [-jh] staging_cdb_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. stagingCdbId, staging_cdb_id= The Staging CDB ID. -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: delete_staging_cdb ======================================== Usage: dct-toolkit delete_staging_cdb[-hVw] staging_cdb_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. stagingCdbId, staging_cdb_id= The Staging CDB ID. --[no-]force Whether to continue the operation upon failures. --[no-]delete_all_dependent_datasets Whether to delete all dependent datasets of the Staging CDB. --body=PARAM The parameters to delete a staging CDB. -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_staging_cdb_tags ======================================== Usage: dct-toolkit get_staging_cdb_tags[-hVw] [-cs] [-jh] staging_cdb_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. stagingCdbId, staging_cdb_id= The Staging CDB ID. -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_staging_cdb_tags ======================================== Usage: dct-toolkit create_staging_cdb_tags[-hVw] staging_cdb_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. stagingCdbId, staging_cdb_id= The Staging CDB ID. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for staging CDB. -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_staging_cdb_tags ======================================== Usage: dct-toolkit delete_staging_cdb_tags[-hVw] staging_cdb_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. stagingCdbId, staging_cdb_id= The Staging CDB ID. 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_staging_cdb ======================================== Usage: dct-toolkit enable_staging_cdb[-hVw] staging_cdb_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. stagingCdbId, staging_cdb_id= The Staging CDB ID. --[no-]attempt_start Whether to attempt a startup of the CDB after the enable. --body=PARAM The parameters to enable a staging CDB. -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_staging_cdb ======================================== Usage: dct-toolkit disable_staging_cdb[-hVw] staging_cdb_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. stagingCdbId, staging_cdb_id= The Staging CDB ID. --[no-]attempt_cleanup Whether to attempt a cleanup of the CDB before the disable. --body=PARAM The parameters to disable a staging CDB. -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 ======================================== ================================================================================ TOPIC: StagingSources ================================================================================ Commands (7): get_staging_sources, search_staging_sources, get_staging_source_by_id, update_staging_source_by_id, get_staging_source_tags, create_staging_source_tags, delete_staging_source_tags COMMAND: get_staging_sources ======================================== Usage: dct-toolkit get_staging_sources[-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_staging_sources ======================================== Usage: dct-toolkit search_staging_sources[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [database_type=string] [database_name=string] [database_version=string] [environment_id=string] [data_uuid=string] [ip_address=string] [fqdn=string] [repository=string] [oracle_config_type=string] [cdb_type=string] [dsource_id=string] [environment_user_ref=string] [recovery_model=string] [mount_base=string] [data_connection_id=string] [datafile_mount_path=string] [archive_mount_path=string] [database_unique_name=string] [size=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_type=string Filter by database_type database_name=string Filter by database_name database_version=string Filter by database_version environment_id=string Filter by environment_id data_uuid=string Filter by data_uuid ip_address=string Filter by ip_address fqdn=string Filter by fqdn repository=string Filter by repository oracle_config_type=string Filter by oracle_config_type cdb_type=string Filter by cdb_type dsource_id=string Filter by dsource_id environment_user_ref=string Filter by environment_user_ref recovery_model=string Filter by recovery_model mount_base=string Filter by mount_base data_connection_id=string Filter by data_connection_id datafile_mount_path=string Filter by datafile_mount_path archive_mount_path=string Filter by archive_mount_path database_unique_name=string Filter by database_unique_name size=integer Filter by size 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_staging_source_by_id ======================================== Usage: dct-toolkit get_staging_source_by_id[-hVw] [-cs] [-jh] staging_source_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. stagingSourceId, staging_source_id= The ID of the staging Source. -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_staging_source_by_id ======================================== Usage: dct-toolkit update_staging_source_by_id[-hVw] staging_source_id= [-cs] [-jh] [[[oracle_services=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. stagingSourceId, staging_source_id= The ID of the staging Source. oracle_services=array[,array...] List of jdbc connection strings which are used to connect with the database. --body=PARAM The parameters to update a Staging Source. -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_staging_source_tags ======================================== Usage: dct-toolkit get_staging_source_tags[-hVw] [-cs] [-jh] staging_source_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. stagingSourceId, staging_source_id= The ID of the staging Source. -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_staging_source_tags ======================================== Usage: dct-toolkit create_staging_source_tags[-hVw] staging_source_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. stagingSourceId, staging_source_id= The ID of the staging Source. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Staging Source. -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_staging_source_tags ======================================== Usage: dct-toolkit delete_staging_source_tags[-hVw] staging_source_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. stagingSourceId, staging_source_id= The ID of the staging Source. 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 ======================================== ================================================================================ TOPIC: StorageUsage ================================================================================ Commands (2): get_historical_storage_summary_aggregate, get_historical_storage_summary_by_engine COMMAND: get_historical_storage_summary_aggregate ======================================== Usage: dct-toolkit get_historical_storage_summary_aggregate[-hVw] [-cs] [include_projection] [-jh] [cdb_ids=] [dsource_ids=] [end_date=] [engine_ids=] [start_date=] [vcdb_ids=] [vdb_ids=] [-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. cdb_ids= The list of CDB ids to aggregate data for. By default aggregating data for all CDBs. -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. dsource_ids= The list of dSource ids to aggregate data for. By default aggregating data for all dSources. end_date= Report end date/time. Defaults to current time. engine_ids= The list of engine ids to aggregate data for. By default aggregating data for all engines. -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. include_projection Whether to compute a projection of future storage usage. -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. start_date= Report start date/time. Defaults to first API request. -V, --version Print version information and exit. vcdb_ids= The list of VCDB ids to aggregate data for. By default aggregating data for all VCDBs. vdb_ids= The list of VDB ids to aggregate data for. By default aggregating data for all VDBs. -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_historical_storage_summary_by_engine ======================================== Usage: dct-toolkit get_historical_storage_summary_by_engine[-hVw] [-cs] [include_projection] [-jh] [end_date=] [engine_ids=] [start_date=] [-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. end_date= Report end date/time. Defaults to current time. engine_ids= The list of engine ids to include in the response. By default returning data for all engines. -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. include_projection Whether to compute a projection of future storage usage. -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. start_date= Report start date/time. Defaults to first API request. -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. ======================================== ================================================================================ TOPIC: Tags ================================================================================ Commands (7): get_tags, search_tags, get_tag, get_tag_usages, search_tag_usages, get_tag_permissions, search_tag_permissions COMMAND: get_tags ======================================== Usage: dct-toolkit get_tags[-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_tags ======================================== Usage: dct-toolkit search_tags[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [key=string] [value=string] [--[no-] used_for_access] [usage_count=integer]]] [-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 key=string Filter by key value=string Filter by value --[no-]used_for_access Filter by used_for_access usage_count=integer Filter by usage_count -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_tag ======================================== Usage: dct-toolkit get_tag[-hVw] [-cs] [-jh] tag_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. tagId, tag_id= The ID of the global tag. -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_tag_usages ======================================== Usage: dct-toolkit get_tag_usages[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] tag_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. 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. tagId, tag_id= The ID of the global tag. -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_tag_usages ======================================== Usage: dct-toolkit search_tag_usages[-hVw] tag_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[object_type=string] [object_id=string] [object_name=string] [creator_account_id=integer] [creator_account_name=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. tagId, tag_id= The ID of the global tag. 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. object_type=string Filter by object_type object_id=string Filter by object_id object_name=string Filter by object_name creator_account_id=integer Filter by creator_account_id creator_account_name=string Filter by creator_account_name -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_tag_permissions ======================================== Usage: dct-toolkit get_tag_permissions[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] tag_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. 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. tagId, tag_id= The ID of the global tag. -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_tag_permissions ======================================== Usage: dct-toolkit search_tag_permissions[-hVw] tag_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[access_group_name=string] [access_group_id=string] [scope_name=string] [scope_id=string] [role_name=string] [object_type=string] [permissions=array[string]]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. tagId, tag_id= The ID of the global tag. 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. access_group_name=string Filter by access_group_name access_group_id=string Filter by access_group_id scope_name=string Filter by scope_name scope_id=string Filter by scope_id role_name=string Filter by role_name object_type=string Filter by object_type permissions=array[string] Filter by permissions -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 ======================================== ================================================================================ TOPIC: Timeflows ================================================================================ Commands (10): get_timeflows, get_timeflow_by_id, delete_timeflow, update_timeflow, get_timeflow_snapshot_day_range, get_timeflow_tags, create_timeflow_tags, delete_timeflow_tags, search_timeflows, timeflow_repair COMMAND: get_timeflows ======================================== Usage: dct-toolkit get_timeflows[-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: get_timeflow_by_id ======================================== Usage: dct-toolkit get_timeflow_by_id[-hVw] [-cs] [-jh] timeflow_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. timeflowId, timeflow_id= The ID of the timeflow. -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: delete_timeflow ======================================== Usage: dct-toolkit delete_timeflow[-hVw] timeflow_id= [-cs] [-jh] [[[--[no-]force_delete]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. timeflowId, timeflow_id= The ID of the timeflow. --[no-]force_delete Whether to delete all the dependent Bookmarks. --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_timeflow ======================================== Usage: dct-toolkit update_timeflow[-hVw] timeflow_id= [-cs] [-jh] [[[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. timeflowId, timeflow_id= The ID of the timeflow. name=string The name of the timeflow. --body=PARAM The new data to update a timeflow. -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_timeflow_snapshot_day_range ======================================== Usage: dct-toolkit get_timeflow_snapshot_day_range[-hVw] [-cs] [-jh] timeflow_id= [timezone=] [timezone_offset=] [-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. timeflowId, timeflow_id= The ID of the timeflow. timezone= The timezone in which the snapshot timestamps are to be interpreted. This property gets precedence over timezone_offset. If the timezone in this property is unknown to the application, the timezone_offset is used as fallback to interpret the snapshot timestamps. timezone_offset= The offset in seconds of timezone in which the snapshot timestamps are to be interpreted. This property is used as fallback to interpret the snapshot timestamps if timezone is not valid. -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_timeflow_tags ======================================== Usage: dct-toolkit get_timeflow_tags[-hVw] [-cs] [-jh] timeflow_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. timeflowId, timeflow_id= The ID of the timeflow. -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_timeflow_tags ======================================== Usage: dct-toolkit create_timeflow_tags[-hVw] timeflow_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. timeflowId, timeflow_id= The ID of the timeflow. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Timeflow. -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_timeflow_tags ======================================== Usage: dct-toolkit delete_timeflow_tags[-hVw] timeflow_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. timeflowId, timeflow_id= The ID of the timeflow. 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: search_timeflows ======================================== Usage: dct-toolkit search_timeflows[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [engine_id=string] [namespace=string] [name=string] [namespace_id=string] [namespace_name=string] [--[no-]is_replica] [dataset_id=string] [creation_type=string] [parent_snapshot_id=string] [parent_point_location=string] [parent_point_timestamp=string] [parent_point_timeflow_id=string] [source_data_timestamp=string] [oracle_incarnation_id=string] [oracle_cdb_timeflow_id=string] [oracle_tde_uuid=integer] [mssql_database_guid=string] [--[no-] is_active] [creation_timestamp=string] [activation_timestamp=string] [parent_vdb_id=string] [parent_dsource_id=string] [source_vdb_id=string] [source_dsource_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. 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 engine_id=string Filter by engine_id namespace=string Filter by namespace name=string Filter by name namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica dataset_id=string Filter by dataset_id creation_type=string Filter by creation_type parent_snapshot_id=string Filter by parent_snapshot_id parent_point_location=string Filter by parent_point_location parent_point_timestamp=string Filter by parent_point_timestamp parent_point_timeflow_id=string Filter by parent_point_timeflow_id source_data_timestamp=string Filter by source_data_timestamp oracle_incarnation_id=string Filter by oracle_incarnation_id oracle_cdb_timeflow_id=string Filter by oracle_cdb_timeflow_id oracle_tde_uuid=integer Filter by oracle_tde_uuid mssql_database_guid=string Filter by mssql_database_guid --[no-]is_active Filter by is_active creation_timestamp=string Filter by creation_timestamp activation_timestamp=string Filter by activation_timestamp parent_vdb_id=string Filter by parent_vdb_id parent_dsource_id=string Filter by parent_dsource_id source_vdb_id=string Filter by source_vdb_id source_dsource_id=string Filter by source_dsource_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: timeflow_repair ======================================== Usage: dct-toolkit timeflow_repair[-hVw] timeflow_id= [-cs] [-jh] ([host=string end_location=string username=string start_location=string directory=string [sshVerificationStrategy. key_type=string] [cyberark_vault_query_string=string] [sshVerificationStrategy.raw_key=string] [hashicorp_vault_engine=string] [key_pair_private_key=string] [azure_vault_username_key=string] [hashicorp_vault_secret_key=string] [azure_vault_secret_key=string] [sshVerificationStrategy.fingerprint=string] [sshVerificationStrategy.name=string] [password=string] [hashicorp_vault_secret_path=string] [key_pair_public_key=string] [azure_vault_name=string] [--[no-] use_engine_public_key] [vault_id=string] [-- [no-]use_kerberos_authentication] [sshVerificationStrategy. fingerprint_type=string] [port=integer] [hashicorp_vault_username_key=string]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. timeflowId, timeflow_id= The ID of the timeflow. host=string Hostname of the remote host. end_location=string The database specific identifier specifying the end location of the missing log. username=string Username to connect to remote host. start_location=string The database specific identifier specifying the start location of the missing log. directory=string Location of the missing logs on the host. sshVerificationStrategy.key_type=string Values: [RSA, DSA, ECDSA, ED25519]The type of SSH key. cyberark_vault_query_string=string Query to find a credential in the CyberArk vault. sshVerificationStrategy.raw_key=string Base64-encoded ssh key of the host for RAW_KEY verification. hashicorp_vault_engine=string Vault engine name where the credential is stored. key_pair_private_key=string The private key of the key pair credentials. azure_vault_username_key=string Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). hashicorp_vault_secret_key=string Key for the password in the key-value store. azure_vault_secret_key=string Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only). sshVerificationStrategy.fingerprint=string Base-64 encoded fingerprint of the ssh key of the host for FINGERPRINT verification. sshVerificationStrategy.name=string Values: [RAW_KEY, FINGERPRINT, ACCEPT_ALWAYS]The name of the verification strategy. password=string The password of the user to connect to remote host machine. hashicorp_vault_secret_path=string Path in the vault engine where the credential is stored. key_pair_public_key=string The public key of the key pair credentials. azure_vault_name=string Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only). --[no-]use_engine_public_key Whether to use public key authentication. vault_id=string The DCT id or name of the vault from which to read the host credentials. --[no-]use_kerberos_authentication Whether to use kerberos authentication. sshVerificationStrategy.fingerprint_type=string Values: [SHA256, SHA512]Hash function for the fingerprint for FINGERPRINT verification. port=integer Port to connect to remote host. hashicorp_vault_username_key=string Key for the username in the key-value store. --body=PARAM Timeflow repair information. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== ================================================================================ TOPIC: Toolkits ================================================================================ Commands (8): get_toolkits, search_toolkits, get_toolkit_by_id, delete_toolkit_by_id, get_toolkit_tags, create_toolkit_tags, delete_toolkit_tags, upload_toolkit COMMAND: get_toolkits ======================================== Usage: dct-toolkit get_toolkits[-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_toolkits ======================================== Usage: dct-toolkit search_toolkits[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [type=string] [pretty_name=string] [name=string] [reference=string] [display_name=string] [plugin_id=string] [external_version=string] [engine_name=string] [engine_id=string] [build_api=string] [namespace=string] [identifier=string] [root_squash_enabled=string] [default_locale=string] [status=string] [language=string] [lua_name=string] [minimum_lua_version=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id type=string Filter by type pretty_name=string Filter by pretty_name name=string Filter by name reference=string Filter by reference display_name=string Filter by display_name plugin_id=string Filter by plugin_id external_version=string Filter by external_version engine_name=string Filter by engine_name engine_id=string Filter by engine_id build_api=string Filter by build_api namespace=string Filter by namespace identifier=string Filter by identifier root_squash_enabled=string Filter by root_squash_enabled default_locale=string Filter by default_locale status=string Filter by status language=string Filter by language lua_name=string Filter by lua_name minimum_lua_version=string Filter by minimum_lua_version -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_toolkit_by_id ======================================== Usage: dct-toolkit get_toolkit_by_id[-hVw] [-cs] [-jh] toolkit_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. toolkitId, toolkit_id= The ID of the toolkit. -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: delete_toolkit_by_id ======================================== Usage: dct-toolkit delete_toolkit_by_id[-hVw] [-cs] [-jh] toolkit_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. toolkitId, toolkit_id= The ID of the toolkit. -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_toolkit_tags ======================================== Usage: dct-toolkit get_toolkit_tags[-hVw] [-cs] [-jh] toolkit_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. toolkitId, toolkit_id= The ID of the toolkit. -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_toolkit_tags ======================================== Usage: dct-toolkit create_toolkit_tags[-hVw] toolkit_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. toolkitId, toolkit_id= The ID of the toolkit. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for Toolkit. -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_toolkit_tags ======================================== Usage: dct-toolkit delete_toolkit_tags[-hVw] toolkit_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. toolkitId, toolkit_id= The ID of the toolkit. 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: upload_toolkit ======================================== Usage: dct-toolkit upload_toolkit[-hV] -h, --help Show this help message and exit. -V, --version Print version information and exit. ======================================== ================================================================================ 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 ======================================== ================================================================================ TOPIC: VDBGroups ================================================================================ Commands (25): get_vdb_groups, create_vdb_group, provision_vdb_group_from_bookmark, search_vdb_groups, get_vdb_group, delete_vdb_group, update_vdb_group_by_id, get_vdb_group_vdbs_latest_snapshots, get_vdb_group_timestamp_summary, get_vdb_group_tags, create_vdb_groups_tags, delete_vdb_group_tags, refresh_vdb_group, refresh_vdb_group_from_bookmark, refresh_vdb_group_by_snapshot, refresh_vdb_group_by_timestamp, rollback_vdb_group, get_bookmarks_by_vdb_group, search_bookmarks_by_vdb_group, lock_vdb_group, unlock_vdb_group, start_vdb_group, stop_vdb_group, enable_vdb_group, disable_vdb_group COMMAND: get_vdb_groups ======================================== Usage: dct-toolkit get_vdb_groups[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_vdb_group ======================================== Usage: dct-toolkit create_vdb_group[-hVw] [-cs] [-jh] ([name=string [vdb_ids=array[,array...]]... [vdbs=array] [tags[=array...]]... [--[no-] make_current_account_owner] [--[no-] refresh_immediately]] | [--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 vdb_ids=array[,array...] vdbs=array Dictates order of operations on VDBs. Operations can be performed in parallel
for all VDBs or sequentially. Below are possible valid and invalid orderings given an example
VDB group with 3 vdbs (A, B, and C).
Valid:
{"vdb_id":"vdb-1", "order":"1"} {"vdb_id":" vdb-2", order:"1"} {vdb_id:"vdb-3", order:"1"} (parallel)
{vdb_id:"vdb-1", order:"1"} {vdb_id:"vdb-2", order:"2"} {vdb_id:"vdb-3", order:"3"} (sequential)
Invalid:
{vdb_id:"vdb-1", order:"A"} {vdb_id:"vdb-2", order:"B"} {vdb_id:"vdb-3", order:"C"} (sequential)

In the sequential case the vdbs with priority 1 is the first to be started and the last to
be stopped. This value is set on creation of VDB groups. tags[=array...] The tags to be created for VDB Group. --[no-]make_current_account_owner Whether the account creating this VDB group must be configured as owner of the VDB group. --[no-]refresh_immediately If true, VDB Group will be refreshed immediately after creation. --body=PARAM The parameters to create a VDB Group. -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: provision_vdb_group_from_bookmark ======================================== Usage: dct-toolkit provision_vdb_group_from_bookmark[-hVw] [-cs] [-jh] ([name=string bookmark_id=string provision_parameters=object [tags [=array...]]... [--[no-]make_current_account_owner]] | [--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 created VDB group name. bookmark_id=string ID of a bookmark to provision this VDB Group from. provision_parameters=object Provision parameters for each of the VDBs which will need to be provisioned. The key must be the vdb_id of the corresponding entry from the bookmark, and the value the provision parameters for the VDB which will be cloned from the bookmark. tags[=array...] The tags to be created for VDB Group. --[no-]make_current_account_owner Whether the account provisioning this VDB group must be configured as owner of the VDB group. --body=PARAM The parameters to provision a VDB group from a Bookmark. -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_vdb_groups ======================================== Usage: dct-toolkit search_vdb_groups[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [--[no-]is_locked] [locked_by=integer] [locked_by_name=string] [vdb_group_source=string] [ss_data_layout_id=string] [vdb_ids=array [string]]]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id name=string Filter by name --[no-]is_locked Filter by is_locked locked_by=integer Filter by locked_by locked_by_name=string Filter by locked_by_name vdb_group_source=string Filter by vdb_group_source ss_data_layout_id=string Filter by ss_data_layout_id vdb_ids=array[string] Filter by vdb_ids -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_vdb_group ======================================== Usage: dct-toolkit get_vdb_group[-hVw] [-cs] [-jh] vdb_group_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. -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_vdb_group ======================================== Usage: dct-toolkit delete_vdb_group[-hVw] [-cs] [-jh] vdb_group_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. -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_vdb_group_by_id ======================================== Usage: dct-toolkit update_vdb_group_by_id[-hVw] vdb_group_id= [-cs] [-jh] [[[name=string] [vdb_ids=array[,array...]]... [vdbs=array] [--[no-]refresh_immediately]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. name=string The name of the VDB group. vdb_ids=array[,array...] vdbs=array Dictates order of operations on VDBs. Operations can be performed in parallel
for all VDBs or sequentially. Below are possible valid and invalid orderings given an example
VDB group with 3 vdbs (A, B, and C).
Valid:
{"vdb_id":"vdb-1", "order":"1"} {"vdb_id":" vdb-2", order:"1"} {vdb_id:"vdb-3", order:"1"} (parallel)
{vdb_id:"vdb-1", order:"1"} {vdb_id:"vdb-2", order:"2"} {vdb_id:"vdb-3", order:"3"} (sequential)
Invalid:
{vdb_id:"vdb-1", order:"A"} {vdb_id:"vdb-2", order:"B"} {vdb_id:"vdb-3", order:"C"} (sequential)

In the sequential case the vdbs with priority 1 is the first to be started and the last to
be stopped. This value is set on creation of VDB groups. --[no-]refresh_immediately If true, the VDB Group will be refreshed immediately after the update. --body=PARAM The new data to update a VDB group. -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_vdb_group_vdbs_latest_snapshots ======================================== Usage: dct-toolkit get_vdb_group_vdbs_latest_snapshots[-hVw] [-cs] [-jh] vdb_group_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. -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_vdb_group_timestamp_summary ======================================== Usage: dct-toolkit get_vdb_group_timestamp_summary[-hVw] vdb_group_id= [-cs] [-jh] [[[timestamp=string] [vdb_ids=array [,array...]]... [mode=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. timestamp=string The timestamp to get the summary for. vdb_ids=array[,array...] vdb ids for which summary is needed. mode=string Values: [PARENT, SELF]Refresh Mode either self or parent, if PARENT then VDB Group is refreshed from parent of each VDB, else refreshed from self. --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_vdb_group_tags ======================================== Usage: dct-toolkit get_vdb_group_tags[-hVw] [-cs] [-jh] vdb_group_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. -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_vdb_groups_tags ======================================== Usage: dct-toolkit create_vdb_groups_tags[-hVw] vdb_group_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for VDB Group. -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_vdb_group_tags ======================================== Usage: dct-toolkit delete_vdb_group_tags[-hVw] vdb_group_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. 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: refresh_vdb_group ======================================== Usage: dct-toolkit refresh_vdb_group[-hVw] vdb_group_id= [-cs] [-jh] ([bookmark_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. bookmark_id=string ID of a bookmark to refresh this VDB Group to. --body=PARAM The parameters to refresh a VDB Group. -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: refresh_vdb_group_from_bookmark ======================================== Usage: dct-toolkit refresh_vdb_group_from_bookmark[-hVw] vdb_group_id= [-cs] [-jh] ([bookmark_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. bookmark_id=string ID of a bookmark to refresh this VDB Group to. --body=PARAM The parameters to refresh a VDB Group. -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: refresh_vdb_group_by_snapshot ======================================== Usage: dct-toolkit refresh_vdb_group_by_snapshot[-hVw] vdb_group_id= [-cs] [-jh] [[[vdb_snapshot_mappings=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. vdb_snapshot_mappings=array List of the pair of VDB and snapshot to refresh from. If this is not set, all VDBs will be refreshed from latest snapshot of their parent. --body=PARAM The parameters to refresh a VDB Group by snapshot. -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: refresh_vdb_group_by_timestamp ======================================== Usage: dct-toolkit refresh_vdb_group_by_timestamp[-hVw] vdb_group_id= [-cs] [-jh] [[[vdb_timestamp_mappings=array] [--[no-]is_refresh_to_nearest]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. vdb_timestamp_mappings=array List of the pair of VDB and timestamp to refresh from. If this is not set, all VDBs will be refreshed from latest timestamp of their parent. --[no-]is_refresh_to_nearest If true, and the provided timestamp is not found for the VDB mapping, the system will attempt to find the nearest previous refresh point. --body=PARAM The parameters to refresh a VDB Group by timestamp. -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: rollback_vdb_group ======================================== Usage: dct-toolkit rollback_vdb_group[-hVw] vdb_group_id= [-cs] [-jh] ([bookmark_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. bookmark_id=string ID of a bookmark to rollback this VDB Group to. --body=PARAM The parameters to rollback a VDB Group. -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_bookmarks_by_vdb_group ======================================== Usage: dct-toolkit get_bookmarks_by_vdb_group[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] vdb_group_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. 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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. -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_bookmarks_by_vdb_group ======================================== Usage: dct-toolkit search_bookmarks_by_vdb_group[-hVw] vdb_group_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [vdb_group_name=string] [creation_date=string] [vdb_ids=array[string]] [retention=integer] [expiration=string] [ss_data_layout_id=string] [ss_bookmark_reference=string] [ss_bookmark_errors=array[string]] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. 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 vdb_group_name=string Filter by vdb_group_name creation_date=string Filter by creation_date vdb_ids=array[string] Filter by vdb_ids retention=integer Filter by retention expiration=string Filter by expiration ss_data_layout_id=string Filter by ss_data_layout_id ss_bookmark_reference=string Filter by ss_bookmark_reference ss_bookmark_errors=array[string] Filter by ss_bookmark_errors tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: lock_vdb_group ======================================== Usage: dct-toolkit lock_vdb_group[-hVw] vdb_group_id= [-cs] [-jh] [[[account_id=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. account_id=integer Id of the account on whose behalf this request is being made. Only accounts having LOCK_FOR_OTHER_ACCOUNT permission can lock VDB Groups on behalf of other accounts. If this property is not specified then the account id of the authenticated user making the request is used. --body=PARAM The parameters to lock a VDB Group. -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: unlock_vdb_group ======================================== Usage: dct-toolkit unlock_vdb_group[-hVw] [-cs] [-jh] vdb_group_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. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. -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: start_vdb_group ======================================== Usage: dct-toolkit start_vdb_group[-hVw] vdb_group_id= [-cs] [-jh] [[[vdb_start_param_mappings=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. vdb_start_param_mappings=array --body=PARAM The parameters to start a VDB Group. -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_vdb_group ======================================== Usage: dct-toolkit stop_vdb_group[-hVw] vdb_group_id= [-cs] [-jh] [[[vdb_stop_param_mappings=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. vdb_stop_param_mappings=array --body=PARAM The parameters to stop a VDB Group. -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_vdb_group ======================================== Usage: dct-toolkit enable_vdb_group[-hVw] vdb_group_id= [-cs] [-jh] [[[vdb_enable_param_mappings=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. vdb_enable_param_mappings=array --body=PARAM The parameters to enable a VDB Group. -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_vdb_group ======================================== Usage: dct-toolkit disable_vdb_group[-hVw] vdb_group_id= [-cs] [-jh] [[[vdb_disable_param_mappings=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbGroupId, vdb_group_id= The ID or name of the VDB Group. vdb_disable_param_mappings=array --body=PARAM The parameters to disable a VDB Group. -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 ======================================== ================================================================================ TOPIC: VDBs ================================================================================ Commands (53): get_vdbs, search_vdbs, get_vdb_by_id, update_vdb_by_id, get_vdb_snapshots, snapshot_vdb, get_bookmarks_by_vdb, search_bookmarks_by_vdb, get_vdb_deletion_dependencies, get_tags_vdb, create_vdb_tags, delete_vdb_tags, start_vdb, stop_vdb, enable_vdb, disable_vdb, migrate_vdb, get_migrate_compatible_repo, lock_vdb, unlock_vdb, delete_vdb, rollback_vdb_by_timestamp, rollback_vdb_by_snapshot, rollback_vdb_from_bookmark, refresh_vdb_by_timestamp, refresh_vdb_by_snapshot, refresh_vdb_from_bookmark, refresh_vdb_by_location, undo_refresh, switch_timeflow, upgrade_oracle_vdb, upgrade_vdb, get_upgrade_compatible_repo_for_vdb, verify_vdb_jdbc_connection_string, provision_vdb_by_timestamp, provision_vdb_by_timestamp_defaults, provision_vdb_by_location, provision_vdb_by_location_defaults, provision_vdb_by_snapshot, provision_vdb_by_snapshot_defaults, provision_vdb_from_bookmark, provision_vdb_from_bookmark_defaults, empty_vdb, oracle_asm_in_place_vdb_export, export_vdb_in_place, export_vdb_to_asm_by_snapshot, export_vdb_to_asm_by_location, export_vdb_to_asm_by_timestamp, export_vdb_from_bookmark, export_vdb_to_asm_by_bookmark, export_vdb_by_timestamp, export_vdb_by_snapshot, export_vdb_by_location COMMAND: get_vdbs ======================================== Usage: dct-toolkit get_vdbs[-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: search_vdbs ======================================== Usage: dct-toolkit search_vdbs[-hVw] [limit=] [cursor=] [sort=] [permission=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [database_type=string] [name=string] [database_name=string] [database_version=string] [jdbc_connection_string=string] [size=integer] [storage_size=integer] [unvirtualized_space=integer] [engine_id=string] [status=string] [environment_id=string] [ip_address=string] [fqdn=string] [parent_id=string] [parent_dsource_id=string] [group_name=string] [creation_date=string] [last_refreshed_date=string] [current_timeflow_id=string] [previous_timeflow_id=string] [--[no-]masked] [namespace_id=string] [namespace_name=string] [-- [no-]is_replica] [--[no-]is_locked] [exported_data_directory=string] [vcdb_exported_data_directory=string] [locked_by=integer] [locked_by_name=string] [content_type=string] [template_id=string] [template_name=string] [tags[=array [object]...]]... [engine_name=string] [cdb_id=string] [appdata_source_params=string] [config_params=string] [primary_object_id=string] [primary_engine_id=string] [primary_engine_name=string] [--[no-] invoke_datapatch] [node_listeners=array[string]] [instance_name=string] [instance_number=integer] [repository_id=string] [containerization_state=string] [parent_tde_keystore_path=string] [target_vcdb_tde_keystore_path=string] [tde_key_identifier=string] [parent_pdb_tde_keystore_path=string] [target_pdb_tde_keystore_path=string] [environment_user_ref=string] [recovery_model=string] [--[no-] cdc_on_provision] [data_connection_id=string] [mssql_ag_backup_location=string] [--[no-] mssql_ag_backup_based] [database_unique_name=string] [db_username=string] [--[no-]new_db_id] [redo_log_groups=integer] [redo_log_size_in_mb=integer] [toolkit_id=string] [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. 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 database_type=string Filter by database_type name=string Filter by name database_name=string Filter by database_name database_version=string Filter by database_version jdbc_connection_string=string Filter by jdbc_connection_string size=integer Filter by size storage_size=integer Filter by storage_size unvirtualized_space=integer Filter by unvirtualized_space engine_id=string Filter by engine_id status=string Filter by status environment_id=string Filter by environment_id ip_address=string Filter by ip_address fqdn=string Filter by fqdn parent_id=string Filter by parent_id parent_dsource_id=string Filter by parent_dsource_id group_name=string Filter by group_name creation_date=string Filter by creation_date last_refreshed_date=string Filter by last_refreshed_date current_timeflow_id=string Filter by current_timeflow_id previous_timeflow_id=string Filter by previous_timeflow_id --[no-]masked Filter by masked namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica --[no-]is_locked Filter by is_locked exported_data_directory=string Filter by exported_data_directory vcdb_exported_data_directory=string Filter by vcdb_exported_data_directory locked_by=integer Filter by locked_by locked_by_name=string Filter by locked_by_name content_type=string Filter by content_type template_id=string Filter by template_id template_name=string Filter by template_name tags[=array[object]...] Filter by tags engine_name=string Filter by engine_name cdb_id=string Filter by cdb_id appdata_source_params=string Filter by appdata_source_params config_params=string Filter by config_params 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 --[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 parent_tde_keystore_path=string Filter by parent_tde_keystore_path target_vcdb_tde_keystore_path=string Filter by target_vcdb_tde_keystore_path tde_key_identifier=string Filter by tde_key_identifier parent_pdb_tde_keystore_path=string Filter by parent_pdb_tde_keystore_path target_pdb_tde_keystore_path=string Filter by target_pdb_tde_keystore_path environment_user_ref=string Filter by environment_user_ref recovery_model=string Filter by recovery_model --[no-]cdc_on_provision Filter by cdc_on_provision data_connection_id=string Filter by data_connection_id mssql_ag_backup_location=string Filter by mssql_ag_backup_location --[no-]mssql_ag_backup_based Filter by mssql_ag_backup_based database_unique_name=string Filter by database_unique_name db_username=string Filter by db_username --[no-]new_db_id Filter by new_db_id redo_log_groups=integer Filter by redo_log_groups redo_log_size_in_mb=integer Filter by redo_log_size_in_mb toolkit_id=string Filter by toolkit_id 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_vdb_by_id ======================================== Usage: dct-toolkit get_vdb_by_id[-hVw] [-cs] [-jh] vdb_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. vdbId, vdb_id= The ID of the VDB. -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_vdb_by_id ======================================== Usage: dct-toolkit update_vdb_by_id[-hVw] vdb_id= [-cs] [-jh] [[[--[no-] cdc_on_provision] [hooks. configure_clone=array] [target_vcdb_tde_keystore_path=string] [hooks.pre_self_refresh=array] [instances=array] [post_script=string] [parent_pdb_tde_keystore_path=string] [-- [no-]new_dbid] [parent_tde_keystore_password=string] [hooks.post_refresh=array] [hooks. post_self_refresh=array] [environment_user_id=string] [--[no-] mssql_ag_backup_based] [parent_pdb_tde_keystore_password=string] [db_password=string] [pre_script=string] [cdb_tde_keystore_password=string] [hooks. pre_refresh=array] [tde_key_identifier=string] [additional_mount_points=array] [oracle_rac_custom_env_vars=array] [hooks. post_start=array] [mount_point=string] [hooks.pre_snapshot=array] [mssql_ag_backup_location=string] [--[no-] validate_db_credentials] [hooks. post_stop=array] [hooks. post_rollback=array] [oracle_services=array [,array...]]... [custom_env_files=array[, array...]]... [parent_tde_keystore_path=string] [db_username=string] [target_pdb_tde_keystore_password=string] [hooks.pre_start=array] [--[no-] invoke_datapatch] [name=string] [hooks. pre_stop=array] [hooks.post_snapshot=array] [template_id=string] [--[no-]auto_restart] [oracle_rac_custom_env_files=array] [listener_ids=array[,array...]]... [hooks. pre_rollback=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. --[no-]cdc_on_provision Whether to enable CDC on provision for MSSql hooks.configure_clone=array The commands to execute on the target environment when the VDB is created or refreshed. target_vcdb_tde_keystore_path=string Path to the keystore of the target vCDB. (Oracle Multitenant Only) hooks.pre_self_refresh=array The commands to execute on the target environment before refreshing the VDB with data from itself. instances=array The instances of this RAC database. post_script=string Post script for MSSql. parent_pdb_tde_keystore_path=string Path to a copy of the parent PDB's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots of PDB containing encrypted database files with isolated mode keystore. (Oracle Multitenant Only) --[no-]new_dbid Whether to enable new DBID for Oracle parent_tde_keystore_password=string The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only) hooks.post_refresh=array The commands to execute on the target environment after refreshing the VDB. hooks.post_self_refresh=array The commands to execute on the target environment after refreshing the VDB with data from itself. environment_user_id=string The environment user ID to use to connect to the target environment. --[no-]mssql_ag_backup_based Indicates whether to do fast operations for VDB on AG which will use a healthy secondary replica to recreate the AG or backup based operations which will use the primary replica to recreate the AG using backup and restore process. parent_pdb_tde_keystore_password=string The password of the parent PDB keystore. (Oracle Multitenant Only) db_password=string The password of the database user (Oracle, ASE Only). pre_script=string Pre script for MSSql. cdb_tde_keystore_password=string The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only) hooks.pre_refresh=array The commands to execute on the target environment before refreshing the VDB. tde_key_identifier=string ID of the key created by Delphix. (Oracle Multitenant Only) additional_mount_points=array Specifies additional locations on which to mount a subdirectory of an AppData container. Can only be updated while the VDB is disabled. oracle_rac_custom_env_vars=array Environment variable to be set when the engine administers an Oracle RAC VDB. 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 VDB is disabled. hooks.post_start=array The commands to execute on the target environment after starting a virtual source. mount_point=string Mount point for the VDB (AppData only), can only be updated while the VDB is disabled. hooks.pre_snapshot=array The commands to execute on the target environment before snapshotting a virtual source. These commands can quiesce any data prior to snapshotting. mssql_ag_backup_location=string Shared backup location to be used for VDB provision on AG Cluster. --[no-]validate_db_credentials Whether db_username and db_password must be validated, if present, against the VDB. This must be set to false when credentials validation is not possible, for instance if the VDB is known to be disabled. hooks.post_stop=array The commands to execute on the target environment after stopping a virtual source. hooks.post_rollback=array The commands to execute on the target environment after rewinding the VDB. oracle_services=array[,array...] List of jdbc connection strings which are used to connect with the database. custom_env_files=array[,array...] Environment files to be sourced when the Engine administers a VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled. parent_tde_keystore_path=string Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only) db_username=string The username of the database user (Oracle, ASE Only). target_pdb_tde_keystore_password=string The password for the isolated mode TDE keystore of the target virtual PDB. (Oracle Multitenant Only) hooks.pre_start=array The commands to execute on the target environment before starting a virtual source. --[no-]invoke_datapatch Indicates whether datapatch should be invoked. name=string The unique name of the VDB within a group. hooks.pre_stop=array The commands to execute on the target environment before stopping a virtual source. hooks.post_snapshot=array The commands to execute on the target environment after snapshotting a virtual source. template_id=string The ID of the target VDB Template (Oracle and MSSql Only). --[no-]auto_restart Whether to enable VDB restart. oracle_rac_custom_env_files=array Environment files to be sourced when the Engine administers an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces. Custom environment variables can only be updated while the VDB is disabled. listener_ids=array[,array...] The listener IDs for this provision operation (Oracle Only). hooks.pre_rollback=array The commands to execute on the target environment before rewinding the VDB. --body=PARAM The new data to update a VDB. -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_vdb_snapshots ======================================== Usage: dct-toolkit get_vdb_snapshots[-hVw] [-cs] [-jh] [cursor=] [limit=] vdb_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. 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. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. -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_vdb ======================================== Usage: dct-toolkit snapshot_vdb[-hVw] [-cs] [-jh] vdb_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. vdbId, vdb_id= The ID of the VDB. -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_bookmarks_by_vdb ======================================== Usage: dct-toolkit get_bookmarks_by_vdb[-hVw] [-cs] [-jh] [cursor=] [limit=] [sort=] vdb_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. 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. vdbId, vdb_id= The ID of the VDB. -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_bookmarks_by_vdb ======================================== Usage: dct-toolkit search_bookmarks_by_vdb[-hVw] vdb_id= [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [creation_date=date-time] [vdb_ids=array[string]] [retention=integer] [expiration=date] [ss_data_layout_id=string] [ss_bookmark_reference=string] [ss_bookmark_errors=array[string]] [tags [=array[object]...]]...]] [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. 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 creation_date=date-time Filter by creation_date vdb_ids=array[string] Filter by vdb_ids retention=integer Filter by retention expiration=date Filter by expiration ss_data_layout_id=string Filter by ss_data_layout_id ss_bookmark_reference=string Filter by ss_bookmark_reference ss_bookmark_errors=array[string] Filter by ss_bookmark_errors tags[=array[object]...] Filter by tags -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: get_vdb_deletion_dependencies ======================================== Usage: dct-toolkit get_vdb_deletion_dependencies[-hVw] [-cs] [-jh] vdb_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. vdbId, vdb_id= The ID of the VDB. -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_vdb ======================================== Usage: dct-toolkit get_tags_vdb[-hVw] [-cs] [-jh] vdb_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. vdbId, vdb_id= The ID of the VDB. -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_vdb_tags ======================================== Usage: dct-toolkit create_vdb_tags[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for VDB. -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_vdb_tags ======================================== Usage: dct-toolkit delete_vdb_tags[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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: start_vdb ======================================== Usage: dct-toolkit start_vdb[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. instances=array[,array...] List of specific Oracle Virtual 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_vdb ======================================== Usage: dct-toolkit stop_vdb[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. instances=array[,array...] List of specific Oracle Virtual Database Instances to stop. --[no-]abort Whether to issue 'shutdown abort' to shutdown Oracle Virtual 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: enable_vdb ======================================== Usage: dct-toolkit enable_vdb[-hVw] vdb_id= [-cs] [-jh] [[[--[no-] attempt_start] [--[no-]container_mode] [ownership_spec=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. --[no-]attempt_start Whether to attempt a startup of the VDB after the enable. --[no-]container_mode Whether the database is running inside a container. ownership_spec=string The uid:gid string that NFS mounts should belong to. --body=PARAM The parameters to enable a VDB. -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_vdb ======================================== Usage: dct-toolkit disable_vdb[-hVw] vdb_id= [-cs] [-jh] [[[--[no-] attempt_cleanup] [--[no-]container_mode]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. --[no-]attempt_cleanup Whether to attempt a cleanup of the VDB before the disable. --[no-]container_mode Whether the database is running inside a container. --body=PARAM The parameters to disable a VDB. -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: migrate_vdb ======================================== Usage: dct-toolkit migrate_vdb[-hVw] vdb_id= [-cs] [-jh] [[[environment_id=string] [environment_user_ref=string] [repository_id=string] [cdb_id=string] [cluster_node_ids=array[,array...]]... [cluster_node_instances=array]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. environment_id=string Id of the environment. environment_user_ref=string Reference of the environment user. repository_id=string Id of the environment repository. cdb_id=string Id of the container database. cluster_node_ids=array[,array...] The cluster node ids, name or addresses for this migrate operation (Oracle RAC Only). cluster_node_instances=array The cluster node instances details for this migrate operation(Oracle RAC Only).This property is mutually exclusive with cluster_node_ids. --body=PARAM The parameters to migrate a VDB. -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_migrate_compatible_repo ======================================== Usage: dct-toolkit get_migrate_compatible_repo[-hVw] [-cs] [-jh] vdb_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. vdbId, vdb_id= The ID of the VDB. -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: lock_vdb ======================================== Usage: dct-toolkit lock_vdb[-hVw] vdb_id= [-cs] [-jh] [[[account_id=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. account_id=integer Id of the account on whose behalf this request is being made. Only accounts having LOCK_FOR_OTHER_ACCOUNT permission can lock VDBs on behalf of other accounts. If this property is not specified then the account id of the authenticated user making the request is used. --body=PARAM The parameters to lock a VDB. -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: unlock_vdb ======================================== Usage: dct-toolkit unlock_vdb[-hVw] [-cs] [-jh] vdb_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. vdbId, vdb_id= The ID of the VDB. -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_vdb ======================================== Usage: dct-toolkit delete_vdb[-hVw] vdb_id= [-cs] [-jh] [[[--[no-] force] [--[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. vdbId, vdb_id= The ID of the VDB. --[no-]force Whether to continue the operation upon failures. --[no-]delete_all_dependent_vdbs Flag indicating whether to delete all dependent VDBs before deleting the VDB. --body=PARAM The parameters to delete a VDB. -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: rollback_vdb_by_timestamp ======================================== Usage: dct-toolkit rollback_vdb_by_timestamp[-hVw] vdb_id= [-cs] [-jh] [[[timestamp=string] [timestamp_in_database_timezone=string] [timeflow_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. vdbId, vdb_id= The ID of the VDB. timestamp=string The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. timestamp_in_database_timezone=string The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp. timeflow_id=string The Timeflow ID. --body=PARAM The parameters to rollback a VDB. -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: rollback_vdb_by_snapshot ======================================== Usage: dct-toolkit rollback_vdb_by_snapshot[-hVw] vdb_id= [-cs] [-jh] [[[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. vdbId, vdb_id= The ID of the VDB. snapshot_id=string The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot. --body=PARAM The parameters to rollback a VDB. -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: rollback_vdb_from_bookmark ======================================== Usage: dct-toolkit rollback_vdb_from_bookmark[-hVw] vdb_id= [-cs] [-jh] ([bookmark_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. vdbId, vdb_id= The ID of the VDB. bookmark_id=string The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB. --body=PARAM The parameters to rollback a VDB. -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: refresh_vdb_by_timestamp ======================================== Usage: dct-toolkit refresh_vdb_by_timestamp[-hVw] vdb_id= [-cs] [-jh] [[[timestamp=string] [timestamp_in_database_timezone=string] [timeflow_id=string] [dataset_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. vdbId, vdb_id= The ID of the VDB. timestamp=string The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. timestamp_in_database_timezone=string The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp. timeflow_id=string ID of the timeflow to refresh to, mutually exclusive with dataset_id. dataset_id=string ID of the dataset to refresh to, mutually exclusive with timeflow_id. --body=PARAM The parameters to refresh a VDB. -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: refresh_vdb_by_snapshot ======================================== Usage: dct-toolkit refresh_vdb_by_snapshot[-hVw] vdb_id= [-cs] [-jh] [[[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. vdbId, vdb_id= The ID of the VDB. snapshot_id=string The ID of the snapshot from which to execute the operation. If the snapshot_id is not, selects the latest snapshot. --body=PARAM The parameters to refresh a VDB. -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: refresh_vdb_from_bookmark ======================================== Usage: dct-toolkit refresh_vdb_from_bookmark[-hVw] vdb_id= [-cs] [-jh] ([bookmark_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. vdbId, vdb_id= The ID of the VDB. bookmark_id=string The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB. --body=PARAM The parameters to refresh a VDB. -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: refresh_vdb_by_location ======================================== Usage: dct-toolkit refresh_vdb_by_location[-hVw] vdb_id= [-cs] [-jh] [[[location=string] [dataset_id=string] [timeflow_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. vdbId, vdb_id= The ID of the VDB. location=string The database specific identifier for tracking transactions (SCN, LSN, etc). dataset_id=string ID of the dataset to refresh to, mutually exclusive with timeflow_id. timeflow_id=string ID of the timeflow to refresh to, mutually exclusive with dataset_id. --body=PARAM The parameters to refresh a VDB. -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: undo_refresh ======================================== Usage: dct-toolkit undo_refresh[-hVw] [-cs] [-jh] vdb_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. vdbId, vdb_id= The ID of the VDB. -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: switch_timeflow ======================================== Usage: dct-toolkit switch_timeflow[-hVw] vdb_id= [-cs] [-jh] [[[timeflow_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. vdbId, vdb_id= The ID of the VDB. timeflow_id=string The ID of the timeflow to switch to. --body=PARAM The parameters to switch the timeflow of a VDB. -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_vdb ======================================== Usage: dct-toolkit upgrade_oracle_vdb[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 API to upgrade Oracle VDB -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_vdb ======================================== Usage: dct-toolkit upgrade_vdb[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 VDB -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_vdb ======================================== Usage: dct-toolkit get_upgrade_compatible_repo_for_vdb[-hVw] [-cs] [-jh] vdb_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. vdbId, vdb_id= The ID of the VDB. -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: verify_vdb_jdbc_connection_string ======================================== Usage: dct-toolkit verify_vdb_jdbc_connection_string[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 COMMAND: provision_vdb_by_timestamp ======================================== Usage: dct-toolkit provision_vdb_by_timestamp[-hV] [COMMAND] -h, --help Show this help message and exit. -V, --version Print version information and exit. Commands: oracle sybase mssql appdata postgres ======================================== COMMAND: provision_vdb_by_timestamp_defaults ======================================== Usage: dct-toolkit provision_vdb_by_timestamp_defaults[-hVw] [-cs] [-jh] ([source_data_id=string [timestamp=string] [timestamp_in_database_timezone=string] [engine_id=string] [timeflow_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_data_id=string The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. timestamp=string The point in time from which to execute the operation. Mutually exclusive with timestamp_in_database_timezone. If the timestamp is not set, selects the latest point. timestamp_in_database_timezone=string The point in time from which to execute the operation, expressed as a date-time in the timezone of the source database. Mutually exclusive with timestamp. engine_id=string The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. timeflow_id=string The Timeflow ID. --body=PARAM The request to get default VDB provision parameters for provisioning a new VDB by timestamp. -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: provision_vdb_by_location ======================================== Usage: dct-toolkit provision_vdb_by_location[-hV] [COMMAND] -h, --help Show this help message and exit. -V, --version Print version information and exit. Commands: oracle sybase mssql appdata postgres ======================================== COMMAND: provision_vdb_by_location_defaults ======================================== Usage: dct-toolkit provision_vdb_by_location_defaults[-hVw] [-cs] [-jh] [[[source_data_id=string] [engine_id=string] [location=string] [timeflow_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_data_id=string The ID of the source object (dSource or VDB) to provision from. All other objects referenced by the parameters must live on the same engine as the source. engine_id=string The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. location=string The location to get the defaults from. timeflow_id=string ID of the timeflow to provision from. --body=PARAM The request to get default VDB provision parameters for provisioning a new VDB by location. -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: provision_vdb_by_snapshot ======================================== Usage: dct-toolkit provision_vdb_by_snapshot[-hV] [COMMAND] -h, --help Show this help message and exit. -V, --version Print version information and exit. Commands: oracle sybase mssql appdata postgres ======================================== COMMAND: provision_vdb_by_snapshot_defaults ======================================== Usage: dct-toolkit provision_vdb_by_snapshot_defaults[-hVw] [-cs] [-jh] [[[snapshot_id=string] [engine_id=string] [source_data_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. snapshot_id=string The ID of the snapshot from which to execute the operation. engine_id=string The ID of the Engine onto which to provision. If the source ID unambiguously identifies a source object, this parameter is unnecessary and ignored. source_data_id=string The ID of the source object (dSource or VDB) to provision from. If this property is not set, the data_source of the snapshot_id will be used. --body=PARAM The request to get default VDB provision parameters for provisioning a new VDB by snapshot. -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: provision_vdb_from_bookmark ======================================== Usage: dct-toolkit provision_vdb_from_bookmark[-hV] [COMMAND] -h, --help Show this help message and exit. -V, --version Print version information and exit. Commands: oracle sybase mssql appdata postgres ======================================== COMMAND: provision_vdb_from_bookmark_defaults ======================================== Usage: dct-toolkit provision_vdb_from_bookmark_defaults[-hVw] [-cs] [-jh] ([bookmark_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. bookmark_id=string The ID of the bookmark from which to execute the operation. The bookmark must contain only one VDB. --body=PARAM The request to get default VDB provision parameters for provisioning a new VDB from a bookmark. -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: empty_vdb ======================================== Usage: dct-toolkit empty_vdb[-hV] [COMMAND] -h, --help Show this help message and exit. -V, --version Print version information and exit. Commands: oracle sybase mssql appdata postgres ======================================== COMMAND: oracle_asm_in_place_vdb_export ======================================== Usage: dct-toolkit oracle_asm_in_place_vdb_export[-hVw] vdb_id= [-cs] [-jh] ([default_data_diskgroup=string [redo_diskgroup=string] [rman_channels=integer] [rman_file_section_size_in_gb=integer] [db_unique_name=string] [pdb_name=string] [--[no-]operations_postV2P]] | [--body=PARAM]) [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. default_data_diskgroup=string Default diskgroup for datafiles. 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. db_unique_name=string Unique name to be given to the database after it is converted to physical. pdb_name=string The name to be given to the PDB after it is exported in-place. --[no-]operations_postV2P Indicates operations allowed on virtual source post V2P. --body=PARAM The parameters to perform Oracle ASM inplace VDB/VPDB export. -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_vdb_in_place ======================================== Usage: dct-toolkit export_vdb_in_place[-hVw] vdb_id= [-cs] [-jh] [[[targetDirectory=string] [dataDirectory=string] [archiveDirectory=string] [externalDirectory=string] [tempDirectory=string] [scriptDirectory=string] [--[no-] useAbsolutePathForDataFiles] [rman_channels=integer] [rman_file_section_size_in_gb=integer] [db_unique_name=string] [pdb_name=string] [--[no-] operations_postV2P]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. vdbId, vdb_id= The ID of the VDB. 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. db_unique_name=string Unique name to be given to the database after it is converted to physical. pdb_name=string The name to be given to the PDB after it is exported in-place. --[no-]operations_postV2P Indicates operations allowed on virtual source post V2P. --body=PARAM The parameters to perform an in-place export of a virtual database to a physical file system. -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_vdb_to_asm_by_snapshot ======================================== Usage: dct-toolkit export_vdb_to_asm_by_snapshot[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 vdb. -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_vdb_to_asm_by_location ======================================== Usage: dct-toolkit export_vdb_to_asm_by_location[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 vdb. -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_vdb_to_asm_by_timestamp ======================================== Usage: dct-toolkit export_vdb_to_asm_by_timestamp[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 vdb. -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_vdb_from_bookmark ======================================== Usage: dct-toolkit export_vdb_from_bookmark[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 VDB. -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_vdb_to_asm_by_bookmark ======================================== Usage: dct-toolkit export_vdb_to_asm_by_bookmark[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 vdb. -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_vdb_by_timestamp ======================================== Usage: dct-toolkit export_vdb_by_timestamp[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 vdb. -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_vdb_by_snapshot ======================================== Usage: dct-toolkit export_vdb_by_snapshot[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 vdb. -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_vdb_by_location ======================================== Usage: dct-toolkit export_vdb_by_location[-hVw] vdb_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. vdbId, vdb_id= The ID of the VDB. 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 vdb. -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 ======================================== ================================================================================ TOPIC: VirtualizationActions ================================================================================ Commands (2): get_virtualization_action_history, search_virtualization_action_history COMMAND: get_virtualization_action_history ======================================== Usage: dct-toolkit get_virtualization_action_history[-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_virtualization_action_history ======================================== Usage: dct-toolkit search_virtualization_action_history[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [engine_id=string] [action_type=string] [title=string] [details=string] [start_time=date-time] [end_time=date-time] [user=string] [user_agent=string] [origin_ip=string] [parent_action=string] [state=string] [work_source=string] [work_source_name=string] [work_source_principal=string] [failure_description=string] [failure_action=string] [failure_message_code=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id engine_id=string Filter by engine_id action_type=string Filter by action_type title=string Filter by title details=string Filter by details start_time=date-time Filter by start_time end_time=date-time Filter by end_time user=string Filter by user user_agent=string Filter by user_agent origin_ip=string Filter by origin_ip parent_action=string Filter by parent_action state=string Filter by state work_source=string Filter by work_source work_source_name=string Filter by work_source_name work_source_principal=string Filter by work_source_principal failure_description=string Filter by failure_description failure_action=string Filter by failure_action failure_message_code=string Filter by failure_message_code -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 ======================================== ================================================================================ TOPIC: VirtualizationAlerts ================================================================================ Commands (2): get_virtualization_alerts_history, search_virtualization_alerts_history COMMAND: get_virtualization_alerts_history ======================================== Usage: dct-toolkit get_virtualization_alerts_history[-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_virtualization_alerts_history ======================================== Usage: dct-toolkit search_virtualization_alerts_history[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [engine_id=string] [event_severity=string] [target_name=string] [target_object_type=string] [alert_timestamp=date-time] [event=string] [event_description=string] [event_title=string] [event_response=string] [event_action=string] [event_command_output=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id engine_id=string Filter by engine_id event_severity=string Filter by event_severity target_name=string Filter by target_name target_object_type=string Filter by target_object_type alert_timestamp=date-time Filter by alert_timestamp event=string Filter by event event_description=string Filter by event_description event_title=string Filter by event_title event_response=string Filter by event_response event_action=string Filter by event_action event_command_output=string Filter by event_command_output -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 ======================================== ================================================================================ TOPIC: VirtualizationFaults ================================================================================ Commands (5): get_virtualization_faults_history, search_virtualization_faults_history, resolve_or_ignore_virtualization_faults, resolve_all_virtualization_faults, resolve_virtualization_fault COMMAND: get_virtualization_faults_history ======================================== Usage: dct-toolkit get_virtualization_faults_history[-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_virtualization_faults_history ======================================== Usage: dct-toolkit search_virtualization_faults_history[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [engine_id=string] [bundle_id=string] [target_name=string] [target_object_type=string] [target_object_id=string] [title=date-time] [description=string] [fault_action=string] [response=string] [severity=string] [status=string] [date_diagnosed=string] [date_resolved=string] [resolution_comments=string]]] [-jp= | -ex=] [-A | -c=[,...] [-c= [,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. limit= Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. cursor= Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. sort= The field to sort results by. A property name with a prepended '-' signifies descending order. filter_expression=string --body=PARAM A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339] (https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. id=string Filter by id engine_id=string Filter by engine_id bundle_id=string Filter by bundle_id target_name=string Filter by target_name target_object_type=string Filter by target_object_type target_object_id=string Filter by target_object_id title=date-time Filter by title description=string Filter by description fault_action=string Filter by fault_action response=string Filter by response severity=string Filter by severity status=string Filter by status date_diagnosed=string Filter by date_diagnosed date_resolved=string Filter by date_resolved resolution_comments=string Filter by resolution_comments -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: resolve_or_ignore_virtualization_faults ======================================== Usage: dct-toolkit resolve_or_ignore_virtualization_faults[-hVw] [-cs] [-jh] [[[engine_id=string] [--[no-]ignore] [fault_ids=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. engine_id=string The ID of the engine that the faults belong to. --[no-]ignore Flag indicating whether to ignore the selected faults if they are detected on the same objects in the future. fault_ids=array[,array...] The IDs of the faults to resolve or ignore. --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: resolve_all_virtualization_faults ======================================== Usage: dct-toolkit resolve_all_virtualization_faults[-hVw] [-cs] [-jh] engine_id= [-jp= | -ex=] [-A | -c=[,...] [-c=[, ...]]... | -js] -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. engineId, engine_id= The ID of the registered engine. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -h, --help Show this help message and exit. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: resolve_virtualization_fault ======================================== Usage: dct-toolkit resolve_virtualization_fault[-hVw] fault_id= [-cs] [-jh] [[[--[no-]ignore] [resolution_comments=string]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. faultId, fault_id= The ID of the Virtualization Fault. --[no-]ignore Flag indicating whether to ignore this fault if it is detected on the same object in the future. resolution_comments=string The comments describing the steps taken to resolve a fault. --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 ======================================== ================================================================================ TOPIC: VirtualizationJobs ================================================================================ Commands (2): get_virtualization_job_history, search_virtualization_job_history COMMAND: get_virtualization_job_history ======================================== Usage: dct-toolkit get_virtualization_job_history[-hVw] [-cs] [-jh] [cursor=] [job_type=] [limit=] [object_id=] [object_type=] [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 job_type= The job type to filter by. -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. object_id= The object id to filter by. object_type= The object type to filter by. 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_virtualization_job_history ======================================== Usage: dct-toolkit search_virtualization_job_history[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[engine_job_id=string] [engine_id=string] [legacy_job_type=string] [job_type=string] [target_object_id=string] [legacy_target_object_type=string] [target_object_type=string] [job_state=string] [start_time=date-time] [update_time=date-time] [--[no-]suspendable] [--[no-]cancelable] [--[no-] queued] [title=string] [cancel_reason=string] [percent_complete=integer] [run_duration=integer]]] [-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. engine_job_id=string Filter by engine_job_id engine_id=string Filter by engine_id legacy_job_type=string Filter by legacy_job_type job_type=string Filter by job_type target_object_id=string Filter by target_object_id legacy_target_object_type=string Filter by legacy_target_object_type target_object_type=string Filter by target_object_type job_state=string Filter by job_state start_time=date-time Filter by start_time update_time=date-time Filter by update_time --[no-]suspendable Filter by suspendable --[no-]cancelable Filter by cancelable --[no-]queued Filter by queued title=string Filter by title cancel_reason=string Filter by cancel_reason percent_complete=integer Filter by percent_complete run_duration=integer Filter by run_duration -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 ======================================== ================================================================================ TOPIC: VirtualizationPolicies ================================================================================ Commands (13): list_virtualization_policies, create_virtualization_policy, search_virtualization_policies, search_virtualization_policy_targets, get_virtualization_policy_by_id, delete_virtualization_policy, update_virtualization_policy, convert_virtualization_policy, get_virtualization_policy_tags, create_virtualization_policy_tags, delete_virtualization_policy_tags, apply_virtualization_policy_by_id_or_name, unapply_virtualization_policy_by_id_or_name COMMAND: list_virtualization_policies ======================================== Usage: dct-toolkit list_virtualization_policies[-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 a descending order. -V, --version Print version information and exit. -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. ======================================== COMMAND: create_virtualization_policy ======================================== Usage: dct-toolkit create_virtualization_policy[-hVw] [-cs] [-jh] ([policy_type=string name=string [policy_targets=array] [provision_source=string] [timezone_id=string] [data_duration=integer] [data_unit=string] [log_duration=integer] [log_unit=string] [num_of_daily=integer] [num_of_weekly=integer] [day_of_week=string] [num_of_monthly=integer] [day_of_month=integer] [num_of_yearly=integer] [day_of_year=string] [schedules=array] [size=integer] [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. policy_type=string Values: [REFRESH_POLICY, SNAPSHOT_POLICY, SYNC_POLICY, RETENTION_POLICY, REPLICA_RETENTION_POLICY, QUOTA_POLICY]The type of a virtualization policy. name=string The name of the virtualization policy. policy_targets=array The target objects that will have this policy applied to them upon creation of the policy. provision_source=string Values: [LATEST_SNAPSHOT, LATEST_TIME_FLOW_LOG]The source of the data to provision from [Refresh Policy]. timezone_id=string The timezone to use for scheduling. data_duration=integer Amount of time to keep source data [Retention Policy]. data_unit=string Values: [DAY, WEEK, MONTH, QUARTER, YEAR]Time unit for data_duration [Retention Policy]. log_duration=integer Amount of time to keep log data [Retention Policy]. log_unit=string Values: [DAY, WEEK, MONTH, QUARTER, YEAR]Time unit for log_duration [Retention Policy]. num_of_daily=integer Number of daily snapshots to keep [Retention Policy]. num_of_weekly=integer Number of weekly snapshots to keep [Retention Policy]. day_of_week=string Values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]Day of week upon which to enforce weekly snapshot retention [Retention Policy]. num_of_monthly=integer Number of monthly snapshots to keep [Retention Policy]. day_of_month=integer Day of month upon which to enforce monthly snapshot retention [Retention Policy]. num_of_yearly=integer Number of yearly snapshots to keep [Retention Policy]. day_of_year=string Day of year upon which to enforce yearly snapshot retention, expressed a month / day string (e.g., "Jan 1") [Retention Policy]. schedules=array The schedules for this policy. size=integer Size of the quota, in bytes. [Quota Policy]. tags[=array...] The tags to be created for the policy. --body=PARAM The parameters to create a DCT-managed VirtualizationPolicy. -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_virtualization_policies ======================================== Usage: dct-toolkit search_virtualization_policies[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[id=string] [name=string] [--[no-]dct_managed] [create_user=string] [create_timestamp=string] [namespace=string] [engine_id=string] [engine_name=string] [policy_type=string] [timezone_id=string] [namespace_id=string] [namespace_name=string] [--[no-]is_replica] [-- [no-]default_policy] [effective_type=string] [data_duration=integer] [data_unit=string] [log_duration=integer] [log_unit=string] [num_of_daily=integer] [num_of_weekly=integer] [day_of_week=string] [num_of_monthly=integer] [day_of_month=integer] [num_of_yearly=integer] [day_of_year=string] [size=integer] [--[no-]customized] [tags[=array [object]...]]... [num_targets=integer]]] [-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 a 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 --[no-]dct_managed Filter by dct_managed create_user=string Filter by create_user create_timestamp=string Filter by create_timestamp namespace=string Filter by namespace engine_id=string Filter by engine_id engine_name=string Filter by engine_name policy_type=string Filter by policy_type timezone_id=string Filter by timezone_id namespace_id=string Filter by namespace_id namespace_name=string Filter by namespace_name --[no-]is_replica Filter by is_replica --[no-]default_policy Filter by default_policy effective_type=string Filter by effective_type data_duration=integer Filter by data_duration data_unit=string Filter by data_unit log_duration=integer Filter by log_duration log_unit=string Filter by log_unit num_of_daily=integer Filter by num_of_daily num_of_weekly=integer Filter by num_of_weekly day_of_week=string Filter by day_of_week num_of_monthly=integer Filter by num_of_monthly day_of_month=integer Filter by day_of_month num_of_yearly=integer Filter by num_of_yearly day_of_year=string Filter by day_of_year size=integer Filter by size --[no-]customized Filter by customized tags[=array[object]...] Filter by tags num_targets=integer Filter by num_targets -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_virtualization_policy_targets ======================================== Usage: dct-toolkit search_virtualization_policy_targets[-hVw] [limit=] [cursor=] [sort=] [-cs] [-jh] [[[filter_expression=string]] | [--body=PARAM] | [[policy_id=string] [target_id=string] [engine_id=string] [policy_type=string] [target_type=string] [target_name=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 a 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. policy_id=string Filter by policy_id target_id=string Filter by target_id engine_id=string Filter by engine_id policy_type=string Filter by policy_type target_type=string Filter by target_type target_name=string Filter by target_name -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_virtualization_policy_by_id ======================================== Usage: dct-toolkit get_virtualization_policy_by_id[-hVw] [-cs] [-jh] policy_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. policyId, policy_id= The ID of the Virtualization Policy. -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: delete_virtualization_policy ======================================== Usage: dct-toolkit delete_virtualization_policy[-hVw] [-cs] [-jh] policy_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. policyId, policy_id= The ID of the Virtualization Policy. -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_virtualization_policy ======================================== Usage: dct-toolkit update_virtualization_policy[-hVw] policy_id= [-cs] [-jh] [[[name=string] [timezone_id=string] [data_duration=integer] [data_unit=string] [log_duration=integer] [log_unit=string] [num_of_daily=integer] [num_of_weekly=integer] [day_of_week=string] [num_of_monthly=integer] [day_of_month=integer] [num_of_yearly=integer] [day_of_year=string] [schedules=array] [size=integer]] | [--body=PARAM]] [-jp= | -ex=] [-A | -c=[, ...] [-c=[,...]]... | -js] -h, --help Show this help message and exit. -V, --version Print version information and exit. policyId, policy_id= The ID of the Virtualization Policy. name=string The name of the virtualization policy. timezone_id=string The timezone to use for scheduling. data_duration=integer Amount of time to keep source data [Retention Policy]. data_unit=string Values: [DAY, WEEK, MONTH, QUARTER, YEAR]Time unit for data_duration [Retention Policy]. log_duration=integer Amount of time to keep log data [Retention Policy]. log_unit=string Values: [DAY, WEEK, MONTH, QUARTER, YEAR]Time unit for log_duration [Retention Policy]. num_of_daily=integer Number of daily snapshots to keep [Retention Policy]. num_of_weekly=integer Number of weekly snapshots to keep [Retention Policy]. day_of_week=string Values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]Day of week upon which to enforce weekly snapshot retention [Retention Policy]. num_of_monthly=integer Number of monthly snapshots to keep [Retention Policy]. day_of_month=integer Day of month upon which to enforce monthly snapshot retention [Retention Policy]. num_of_yearly=integer Number of yearly snapshots to keep [Retention Policy]. day_of_year=string Day of year upon which to enforce yearly snapshot retention, expressed a month / day string (e.g., "Jan 1") [Retention Policy]. schedules=array The schedules for this policy. size=integer Size of the quota, in bytes. (QUOTA_POLICY only). --body=PARAM JSON request body payload -w, --[no-]wait Wait for asynchronous job completion. Default value of this option is true meaning that asynchronous jobs will wait unless specified. This option is a noop for synchronous commands. -jp, --jsonpath= Json path notation to extract specific object from the successful response. Mutually exclusive with --expand option. -ex, --expand= Property name of the nested array/object which needs to be rendered. Mutually exclusive with --jsonpath option. -A, --[no-]all-columns Whether to print all of the properties while rendering response in table format. By default not all properties from the response will be printed in table format. This option is mutually exclusive with --columns/-c and --json/-js options. -c, --columns=[,...] Comma separated list of property names that needs to be selected while rendering response in table format. By default not all properties from the response will be printed in table format. Mutually exclusive with --all-columns/-A and and --json/-js options. -js, --[no-]json Whether to output the response in JSON format. Mutually exclusive with --all-columns/-A and --columns/-c options. -cs, --[no-]csv Whether to output the response in CSV format. This option is only applicable to list responses that are rendered in table format by default.By default this will print all of the properties from the response so providing --all-columns/-A is a noop. -jh, --[no-]jsonhelp Option to print help message which contains request body and response body JSON structure ======================================== COMMAND: convert_virtualization_policy ======================================== Usage: dct-toolkit convert_virtualization_policy[-hVw] [-cs] [-jh] policy_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. policyId, policy_id= The ID of the Virtualization Policy. -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_virtualization_policy_tags ======================================== Usage: dct-toolkit get_virtualization_policy_tags[-hVw] [-cs] [-jh] policy_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. policyId, policy_id= The ID of the Virtualization Policy. -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_virtualization_policy_tags ======================================== Usage: dct-toolkit create_virtualization_policy_tags[-hVw] policy_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. policyId, policy_id= The ID of the Virtualization Policy. tags[=array...] Array of tags with key value pairs --body=PARAM Tags information for VirtualizationPolicies. -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_virtualization_policy_tags ======================================== Usage: dct-toolkit delete_virtualization_policy_tags[-hVw] policy_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. policyId, policy_id= The ID of the Virtualization Policy. 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: apply_virtualization_policy_by_id_or_name ======================================== Usage: dct-toolkit apply_virtualization_policy_by_id_or_name[-hV] policy_id= -h, --help Show this help message and exit. policyId, policy_id= The ID of the Virtualization Policy. -V, --version Print version information and exit. ======================================== COMMAND: unapply_virtualization_policy_by_id_or_name ======================================== Usage: dct-toolkit unapply_virtualization_policy_by_id_or_name[-hV] policy_id= -h, --help Show this help message and exit. policyId, policy_id= The ID of the Virtualization Policy. -V, --version Print version information and exit. ========================================