oci-cli 3.65.1__py3-none-any.whl → 3.66.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request/list.txt

@@ -0,0 +1,140 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the work requests in a compartment.
+
+
+Usage
+=====
+
+   oci ai-data-platform work-request list [OPTIONS]
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--limit [integer]
+
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. For important details about how
+pagination works, see List Pagination.
+
+--page [text]
+
+For list pagination. The value of the opc-next-page response header
+from the previous “List” call. For important details about how
+pagination works, see List Pagination.
+
+--page-size [integer]
+
+When fetching results, the number of results to fetch per call. Only
+valid when used with "--all" or "--limit", and ignored otherwise.
+
+--resource-id [text]
+
+The OCID of the resource affected by the work request.
+
+--sort-by [text]
+
+The field to sort by. Only one sort order may be provided. Default
+order for *timeAccepted* is descending.
+
+Accepted values are:
+
+   timeAccepted
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
+
+Accepted values are:
+
+   ASC, DESC
+
+--status [text]
+
+A filter to return only the resources that match the given lifecycle
+state.
+
+Accepted values are:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+--work-request-id [text]
+
+The OCID of the asynchronous work request.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--endpoint", "--generate-full-command-json-input", "
+--generate-param-json-input", "--help", "--latest-version", "--max-
+retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
+"--output", "--profile", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       oci ai-data-platform work-request list

oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request-error/list.txt

@@ -0,0 +1,131 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the errors for a work request.
+
+
+Usage
+=====
+
+   oci ai-data-platform work-request-error list [OPTIONS]
+
+
+Required Parameters
+===================
+
+--work-request-id [text]
+
+The OCID of the asynchronous work request.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--limit [integer]
+
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. For important details about how
+pagination works, see List Pagination.
+
+--page [text]
+
+For list pagination. The value of the opc-next-page response header
+from the previous “List” call. For important details about how
+pagination works, see List Pagination.
+
+--page-size [integer]
+
+When fetching results, the number of results to fetch per call. Only
+valid when used with "--all" or "--limit", and ignored otherwise.
+
+--sort-by [text]
+
+The field to sort by. Only one sort order may be provided. Default
+order for *timestamp* is descending.
+
+Accepted values are:
+
+   timestamp
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
+
+Accepted values are:
+
+   ASC, DESC
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--endpoint", "--generate-full-command-json-input", "
+--generate-param-json-input", "--help", "--latest-version", "--max-
+retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
+"--output", "--profile", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-data-platform/work-request-error/list.html#cmdoption-work-request-id
+
+       oci ai-data-platform work-request-error list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request-error.txt

@@ -0,0 +1,15 @@
+work-request-error
+******************
+
+
+Description
+===========
+
+An error encountered while performing an operation that is tracked by
+a work request.
+
+
+Available Commands
+==================
+
+* list

oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request-log-entry/list-work-request-logs.txt

@@ -0,0 +1,131 @@
+"list-work-request-logs"
+************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the logs for a work request.
+
+
+Usage
+=====
+
+   oci ai-data-platform work-request-log-entry list-work-request-logs [OPTIONS]
+
+
+Required Parameters
+===================
+
+--work-request-id [text]
+
+The OCID of the asynchronous work request.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--limit [integer]
+
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. For important details about how
+pagination works, see List Pagination.
+
+--page [text]
+
+For list pagination. The value of the opc-next-page response header
+from the previous “List” call. For important details about how
+pagination works, see List Pagination.
+
+--page-size [integer]
+
+When fetching results, the number of results to fetch per call. Only
+valid when used with "--all" or "--limit", and ignored otherwise.
+
+--sort-by [text]
+
+The field to sort by. Only one sort order may be provided. Default
+order for *timestamp* is descending.
+
+Accepted values are:
+
+   timestamp
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
+
+Accepted values are:
+
+   ASC, DESC
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--endpoint", "--generate-full-command-json-input", "
+--generate-param-json-input", "--help", "--latest-version", "--max-
+retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
+"--output", "--profile", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-data-platform/work-request-log-entry/list-work-request-logs.html#cmdoption-work-request-id
+
+       oci ai-data-platform work-request-log-entry list-work-request-logs --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request-log-entry.txt

@@ -0,0 +1,15 @@
+work-request-log-entry
+**********************
+
+
+Description
+===========
+
+A log message from performing an operation that is tracked by a work
+request.
+
+
+Available Commands
+==================
+
+* list-work-request-logs

oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform/work-request.txt

@@ -0,0 +1,23 @@
+work-request
+************
+
+
+Description
+===========
+
+An asynchronous work request. Work requests help you monitor long-
+running operations. When you start a long-running operation, the
+service creates a work request. A work request is an activity log that
+lets you track each step in the operation’s progress. Each work
+request has an OCID that lets you interact with it programmatically
+and use it for automation.
+
+
+Available Commands
+==================
+
+* cancel
+
+* get
+
+* list

oci_cli/help_text_producer/data_files/text/cmdref/ai-data-platform.txt

@@ -0,0 +1,44 @@
+ai-data-platform
+****************
+
+
+Description
+===========
+
+Use the AiDataPlatform Control Plane CLI to manage Data Lakes.
+
+
+Available Commands
+==================
+
+* ai-data-platform
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * update
+
+* ai-data-platform-collection
+
+  * list-ai-data-platforms
+
+* work-request
+
+  * cancel
+
+  * get
+
+  * list
+
+* work-request-error
+
+  * list
+
+* work-request-log-entry
+
+  * list-work-request-logs

oci_cli/help_text_producer/data_files/text/cmdref/db/autonomous-database/create-refreshable-clone.txt

@@ -133,6 +133,14 @@ WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5,
 ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS,
 ZHT32TRIS
 
+--clone-type [text]
+
+The Autonomous Database clone type.
+
+Accepted values are:
+
+   FULL, METADATA, PARTIAL
+
 --compute-count [float]
 
 The compute amount (CPUs) available to the database. Minimum and

oci_cli/help_text_producer/data_files/text/cmdref/db/autonomous-database/delete.txt

@@ -76,6 +76,11 @@ current etag value.
 The maximum time to wait for the work request to reach the state
 defined by "--wait-for-state". Defaults to 1200 seconds.
 
+--must-delete-associated-long-term-backups [boolean]
+
+If set to true, terminating the Autonomous Database also deletes its
+associated long-term backups if the retention lock is not enabled.
+
 --opc-dry-run [boolean]
 
 Indicates that the request is a dry run, if set to “true”. A dry run

oci_cli/help_text_producer/data_files/text/cmdref/db/autonomous-database-backup/list.txt

@@ -38,6 +38,11 @@ cannot provide the "--limit" option.
 
 The database OCID.
 
+--backup-destination-id [text]
+
+A filter to return only resources that have the given backup
+destination id.
+
 --compartment-id, -c [text]
 
 The compartment OCID.
@@ -69,6 +74,19 @@ For examples on usage of this option, please see our “using CLI with
 advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
 nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 
+--infrastructure-type [text]
+
+A filter to return only resources that match the given Infrastructure
+Type.
+
+Accepted values are:
+
+   CLOUD, CLOUD_AT_CUSTOMER
+
+--key-store-id [text]
+
+A filter to return only resources that have the given key store id.
+
 --lifecycle-state [text]
 
 A filter to return only resources that match the given lifecycle state

oci_cli/help_text_producer/data_files/text/cmdref/db/cloud-exa-infra/create.txt

@@ -55,7 +55,8 @@ Optional Parameters
 
 --cluster-placement-group-id [text]
 
-The OCID of the cluster placement group of the Exadata Infrastructure.
+The OCID of the cluster placement group of the Exadata Infrastructure
+or Db System.
 
 --compute-count [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/db/exascale-db-storage-vault/create.txt

@@ -56,7 +56,8 @@ Database Storage Vault.
 
 --cluster-placement-group-id [text]
 
-The OCID of the cluster placement group of the Exadata Infrastructure.
+The OCID of the cluster placement group of the Exadata Infrastructure
+or Db System.
 
 --defined-tags [complex type]