"update"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Only desiredCapacity may change. If desiredCapacity is omitted, the
current desired capacity is preserved. An empty update object is
allowed; an explicit null value for desiredCapacity is not allowed.
Named MANAGED and CUSTOM pools and reserved MANAGED defaults can be
resized. Default-pool updates use the existing Project configuration
workflow; no separate desired configuration is created for those
entries. CP persists UPDATING and a Work Request, applies the desired
replica count, then returns the pool to ACTIVE after verifying the
configuration. The workflow does not wait for ready members. Zero
pauses idle prewarming. Once the pool is ACTIVE, named-pool Sandbox
creation can still cold-start from its available applied template when
no eligible warm member is available, regardless of the capacity
target. Already-admitted Sandboxes continue. Unnamed Sandbox creation
retains its existing behavior. Concurrent management operations return
409. If provided, if-match must match the current configuration ETag;
otherwise this operation returns 412.


Usage
=====

   oci generative-ai sandbox-warm-pool update [OPTIONS]


Required Parameters
===================

--name [text]

Immutable name within the Project.

--project-id [text]

Owning Generative AI Project OCID. Resolve parent compartment for
authorization.


Optional Parameters
===================

--desired-capacity [integer]

Replacement idle target. If omitted, the current desired capacity is
preserved. An empty update object is allowed; an explicit null value
is not allowed. Image, shape, name and type are immutable. Zero pauses
idle prewarming. Once the pool is ACTIVE, named-pool Sandbox creation
can still cold-start from its available applied template when no
eligible warm member is available. Reserved MANAGED default entries
may be resized through the existing Project configuration workflow.
Named MANAGED and CUSTOM pools use the same warm-pool lifecycle
workflows. Existing customer Sandboxes continue, and unnamed Sandbox
creation keeps its existing behavior.

--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* parameter 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.

--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.

--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" ACCEPTED
"--wait-for-state" CANCELED 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, WAITING

--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", "--federation-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 name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/sandbox-warm-pool/update.html#cmdoption-name
       export project_id=<substitute-value-of-project_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/sandbox-warm-pool/update.html#cmdoption-project-id

       oci generative-ai sandbox-warm-pool update --name $name --project-id $project_id
