oci-cli 3.72.1__py3-none-any.whl → 3.73.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent/tool/update-tool-rag-tool-config.txt

@@ -146,6 +146,17 @@ example of the JSON which must be provided. We recommend storing this
 example in a file, modifying it as needed and then passing it back in
 via the file:// syntax.
 
+--tool-config-embedding-llm-customization [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
 --tool-config-generation-llm-customization [complex type]
 
 This is a complex type whose value must be valid JSON. The value can
@@ -157,6 +168,32 @@ example of the JSON which must be provided. We recommend storing this
 example in a file, modifying it as needed and then passing it back in
 via the file:// syntax.
 
+--tool-config-reasoning-llm-customization [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--tool-config-reranking-llm-customization [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--tool-config-runtime-version [text]
+
+The runtimeVersion of the system prompt.
+
 --wait-for-state [text]
 
 This operation asynchronously creates, modifies or deletes a resource

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent/tool/update-tool-sql-tool-config.txt

@@ -194,6 +194,10 @@ Accepted values are:
 
    LARGE, SMALL
 
+--tool-config-runtime-version [text]
+
+The runtimeVersion of the system prompt.
+
 --tool-config-should-enable-self-correction [boolean]
 
 To enable/disable self correction.

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-agent.txt

@@ -108,6 +108,20 @@ Available Commands
 
   * update-oci-open-search-kb
 
+* provisioned-capacity
+
+  * change-compartment
+
+  * create
+
+  * delete
+
+  * get
+
+  * list
+
+  * update
+
 * tool
 
   * create

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request/{work-request-log-entry/list-work-request-logs.txt → work-request-log/list.txt}

@@ -1,5 +1,5 @@
-"list-work-request-logs"
-************************
+"list"
+******
 
 * Description
 
@@ -24,7 +24,7 @@ ID.
 Usage
 =====
 
-   oci governance-rules-control-plane work-request work-request-log-entry list-work-request-logs [OPTIONS]
+   oci governance-rules-control-plane work-request work-request-log list [OPTIONS]
 
 
 Required Parameters
@@ -125,6 +125,6 @@ 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/governance-rules-control-plane/work-request/work-request-log-entry/list-work-request-logs.html#cmdoption-work-request-id
+       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/governance-rules-control-plane/work-request/work-request-log/list.html#cmdoption-work-request-id
 
-       oci governance-rules-control-plane work-request work-request-log-entry list-work-request-logs --work-request-id $work_request_id
+       oci governance-rules-control-plane work-request work-request-log list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request/{work-request-log-entry.txt → work-request-log.txt}

@@ -1,5 +1,5 @@
-work-request-log-entry
-**********************
+work-request-log
+****************
 
 
 Description
@@ -11,4 +11,4 @@ A log message from the execution of a work request.
 Available Commands
 ==================
 
-* list-work-request-logs
+* list

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane/work-request.txt

@@ -23,6 +23,6 @@ Available Commands
 
   * list
 
-* work-request-log-entry
+* work-request-log
 
-  * list-work-request-logs
+  * list

oci_cli/help_text_producer/data_files/text/cmdref/governance-rules-control-plane.txt

@@ -79,6 +79,6 @@ Available Commands
 
     * list
 
-  * work-request-log-entry
+  * work-request-log
 
-    * list-work-request-logs
+    * list

oci_cli/help_text_producer/data_files/text/cmdref/kafka/cluster/list-node-shapes.txt

@@ -0,0 +1,129 @@
+"list-node-shapes"
+******************
+
+* Description
+
+* Usage
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Returns the list of shapes allowed in the region.
+
+
+Usage
+=====
+
+   oci kafka cluster list-node-shapes [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.
+
+--name [text]
+
+The name to filter on.
+
+--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. You can provide only one sort order. Default
+order for *timeCreated* is descending. Default order for *displayName*
+is ascending.
+
+Accepted values are:
+
+   displayName, timeCreated
+
+--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", "--enable-dual-stack", "--enable-propagation", "--
+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 kafka cluster list-node-shapes

oci_cli/help_text_producer/data_files/text/cmdref/kafka/cluster.txt

@@ -30,4 +30,6 @@ Available Commands
 
 * list
 
+* list-node-shapes
+
 * update

oci_cli/help_text_producer/data_files/text/cmdref/kafka.txt

@@ -28,6 +28,8 @@ Available Commands
 
   * list
 
+  * list-node-shapes
+
   * update
 
 * cluster-config

oci_cli/help_text_producer/data_files/text/cmdref/mysql/backup/export.txt

@@ -0,0 +1,154 @@
+"export"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Export logical data from a DB system backup to an Object Storage
+bucket.
+
+
+Usage
+=====
+
+   oci mysql backup export [OPTIONS]
+
+
+Required Parameters
+===================
+
+--backup-id [text]
+
+The OCID of the Backup
+
+--bucket-name [text]
+
+The Object Storage bucket name.
+
+--namespace-name [text]
+
+The Object Storage namespace.
+
+
+Optional Parameters
+===================
+
+--export-options [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--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
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the work request to reach the state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--subnet-id [text]
+
+The OCID of the subnet which the temporary MySQL instance is
+associated with. If not specified, the subnet OCID of the DB system
+from which the backup is taken will be used by default. To export a
+backup copied from another region, it is mandatory to specify a valid
+subnet OCID in the current region.
+
+--wait-for-state [text]
+
+This operation asynchronously creates, modifies or deletes a resource
+and uses a work request to track the progress of the operation.
+Specify this option to perform the action and then wait until the work
+request reaches a certain state. Multiple states can be specified,
+returning on the first state. For example, "--wait-for-state"
+SUCCEEDED "--wait-for-state" FAILED would return on whichever
+lifecycle state is reached first. If timeout is reached, a return code
+of 2 is returned. For any other error, a return code of 1 is returned.
+
+Accepted values are:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the work request
+has reached the state defined by "--wait-for-state". Defaults to 30
+seconds.
+
+
+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", "--enable-dual-stack", "--enable-propagation", "--
+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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/mysql/db-system/create.html#cmdoption-compartment-id
+       export shape_name=<substitute-value-of-shape_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/mysql/db-system/create.html#cmdoption-shape-name
+       export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/mysql/db-system/create.html#cmdoption-subnet-id
+       export bucket_name=<substitute-value-of-bucket_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/mysql/backup/export.html#cmdoption-bucket-name
+       export namespace_name=<substitute-value-of-namespace_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/mysql/backup/export.html#cmdoption-namespace-name
+
+       db_system_id=$(oci mysql db-system create --compartment-id $compartment_id --shape-name $shape_name --subnet-id $subnet_id --query data.id --raw-output)
+
+       backup_id=$(oci mysql backup create --db-system-id $db_system_id --query data.id --raw-output)
+
+       oci mysql backup export --backup-id $backup_id --bucket-name $bucket_name --namespace-name $namespace_name

oci_cli/help_text_producer/data_files/text/cmdref/mysql/backup.txt

@@ -27,6 +27,8 @@ Available Commands
 
 * delete
 
+* export
+
 * get
 
 * list

oci_cli/help_text_producer/data_files/text/cmdref/mysql/work-request/cancel.txt

@@ -0,0 +1,104 @@
+"cancel"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Cancels a work request.
+
+
+Usage
+=====
+
+   oci mysql work-request cancel [OPTIONS]
+
+
+Required Parameters
+===================
+
+--work-request-id [text]
+
+the ID of the WorkRequest
+
+
+Optional Parameters
+===================
+
+--force
+
+Perform deletion without prompting for confirmation.
+
+--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
+
+--if-match [text]
+
+For optimistic concurrency control. In the PUT or DELETE call for a
+resource, set the *If-Match* header to the value of the etag from a
+previous GET or POST response for that resource. The resource will be
+updated or deleted only if the etag you provide matches the resource’s
+current etag value.
+
+
+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", "--enable-dual-stack", "--enable-propagation", "--
+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/mysql/work-request/cancel.html#cmdoption-work-request-id
+
+       oci mysql work-request cancel --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/mysql/work-request.txt

@@ -11,6 +11,8 @@ The status of an asynchronous task in the system.
 Available Commands
 ==================
 
+* cancel
+
 * get
 
 * list

oci_cli/help_text_producer/data_files/text/cmdref/mysql.txt

@@ -23,6 +23,8 @@ Available Commands
 
   * delete
 
+  * export
+
   * get
 
   * list
@@ -125,6 +127,8 @@ Available Commands
 
 * work-request
 
+  * cancel
+
   * get
 
   * list

oci_cli/help_text_producer/data_files/text/cmdref/network/vcn/create.txt

@@ -240,7 +240,7 @@ Oracle will allocate one GUA of /56 size for an IPv6 enabled VCN.
 
 --is-zpr-only [boolean]
 
-Indicates whether Zpr Only Mode is enforced.
+Indicates whether ZPR Only mode is enforced.
 
 --max-wait-seconds [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/network/vcn/update.txt

@@ -115,7 +115,7 @@ current etag value.
 
 --is-zpr-only [boolean]
 
-Indicates whether Zpr Only Mode is enforced.
+Indicates whether ZPR Only mode is enforced.
 
 --max-wait-seconds [integer]