"update"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


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

Updates the specified cloud VM cluster. Applies to Exadata Cloud
Service instances and Autonomous Database on dedicated Exadata
infrastructure only.


Usage
=====

   oci db cloud-vm-cluster update [OPTIONS]


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

--cloud-vm-cluster-id [text]

The cloud VM cluster OCID.


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

--backup-network-nsg-ids [complex type]

A list of the OCIDs of the network security groups (NSGs) that the
backup network of this DB system belongs to. Setting this to an empty
array after the list is created removes the resource from all NSGs.
For more information about NSGs, see Security Rules. Applicable only
to Exadata systems. 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.

--cloud-automation-update-details [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.

--compute-nodes [complex type]

The list of compute servers to be added to the cloud VM cluster. 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.

--cpu-core-count [integer]

For fixed shapes, this is the total number of OCPUs to enable across
the VM cluster.

   * Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.  -
     Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.  -
     Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.  -
     Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.  -
     Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.  -
     Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.  -
     Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.  -
     Exadata.Quarter3.100 - Specify a multiple of 2, from 0 to 100.  -
     Exadata.Half3.200 - Specify a multiple of 4, from 0 to 200.  -
     Exadata.Full3.400 - Specify a multiple of 8, from 0 to 400.

The API specification for fixed shape values is
https://docs.oracle.com/en-
us/iaas/api/#/en/database/20160918/DbSystemShapeSummary

   For flexible shapes X8M and X9M, this is the total number of OCPUs
   to enable across the VM cluster. The number available for the VM
   cluster will be based on the number of database servers selected
   for provisioning the VM cluster on the Exadata Infrastructure.

   * Exadata.X8M - Specify a multiple of 2, from 2 to 50 per X8M
     database server.  - Exadata.X9M - Specify a multiple of 2, from 2
     to 126 per X9M database server.

For flexible shapes X11M and higher, this is the total number of ECPUs
to enable across the VM cluster. The number available for the VM
cluster will be based on the number of database servers selected for
provisioning the VM cluster on the Exadata Infrastructure.

   * Exadata.X11M - Specify a multiple of 8, from 8 to 760 per X11M
     database server.

The API specification for flexible shape values is
https://docs.oracle.com/en-
us/iaas/api/#/en/database/20160918/datatypes/FlexComponentSummary

--data-collection-options [complex type]

Available options are “isDiagnosticsEventsEnabled”,
“isHealthMonitoringEnabled” and “isIncidentLogsEnabled”. Provide a
value true or false to enable or disable a particular option.

Example:

   {"isDiagnosticsEventsEnabled":true, "isHealthMonitoringEnabled":true, "isIncidentLogsEnabled":true}

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.

--data-storage-size-in-tbs [text]

The data disk group size to be allocated in TBs.

--db-node-storage-size-in-gbs [integer]

The local node storage to be allocated in GBs.

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags. 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.

--display-name [text]

The user-friendly name for the cloud VM cluster. The name does not
need to be unique.

--file-system-configuration-details [complex type]

Details of the file system configuration of the VM cluster.

This option is a JSON list with items of type
FileSystemConfigurationDetail.  For documentation on
FileSystemConfigurationDetail please see our API reference: https://d
ocs.cloud.oracle.com/api/#/en/database/20160918/datatypes/FileSystemC
onfigurationDetail. 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.

--force

Perform update without prompting for confirmation.

--freeform-tags [complex type]

Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace. For more information, see
Resource Tags.

Example:

   {"Department": "Finance"}

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

--gi-image-id [text]

The OCID (/Content/General/Concepts/identifiers.htm) of the grid
infrastructure software image. This is a database software image of
type *GRID_IMAGE*.

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

--license-model [text]

The Oracle license model that applies to the cloud VM cluster. The
default is BRING_YOUR_OWN_LICENSE. Applies to Exadata Cloud Service
instances only.

Accepted values are:

   BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state
defined by "--wait-for-state". Defaults to 1200 seconds.

--memory-size-in-gbs [integer]

The memory to be allocated in GBs.

--nsg-ids [complex type]

The list of OCIDs for the network security groups (NSGs) to which this
resource belongs. Setting this to an empty list removes all resources
from all NSGs. For more information about NSGs, see Security Rules.
**NsgIds restrictions:** - A network security group (NSG) is optional
for Autonomous Databases with private access. The nsgIds list can be
empty. 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.

--ocpu-count [float]

The number of OCPU cores to enable for a cloud VM cluster. Only 1
decimal place is allowed for the fractional part.

--security-attributes [complex type]

Security Attributes for this resource. Each key is predefined and
scoped to a namespace. For more information, see Resource Tags.
Example: *{“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”:
“audit”}}}* 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.

--ssh-authorized-keys-file [filename]

A file containing one or more public SSH keys to use for SSH access to
the cloud VM cluster. Use a newline character to separate multiple
keys. The length of the combined keys cannot exceed 10,000 characters.

--storage-size-in-gbs [integer]

The disk group size to be allocated in GBs.

--update-action [text]

The action to perform on the update.

--update-id [text]

The OCID (/Content/General/Concepts/identifiers.htm) of the
maintenance update.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a
defined lifecycle state. Specify this option to perform the action and
then wait until the resource reaches a given lifecycle 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:

   AVAILABLE, FAILED, MAINTENANCE_IN_PROGRESS, PROVISIONING, TERMINATED, TERMINATING, UPDATING

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the resource has
reached the lifecycle 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", "--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 availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-exa-infra/create.html#cmdoption-availability-domain
       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-exa-infra/create.html#cmdoption-compartment-id
       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-exa-infra/create.html#cmdoption-display-name
       export shape=<substitute-value-of-shape> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-exa-infra/create.html#cmdoption-shape
       export backup_subnet_id=<substitute-value-of-backup_subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-vm-cluster/create.html#cmdoption-backup-subnet-id
       export cpu_core_count=<substitute-value-of-cpu_core_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-vm-cluster/create.html#cmdoption-cpu-core-count
       export gi_version=<substitute-value-of-gi_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-vm-cluster/create.html#cmdoption-gi-version
       export hostname=<substitute-value-of-hostname> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-vm-cluster/create.html#cmdoption-hostname
       export ssh_authorized_keys_file=<substitute-value-of-ssh_authorized_keys_file> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-vm-cluster/create.html#cmdoption-ssh-authorized-keys-file
       export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/cloud-vm-cluster/create.html#cmdoption-subnet-id

       cloud_exa_infra_id=$(oci db cloud-exa-infra create --availability-domain $availability_domain --compartment-id $compartment_id --display-name $display_name --shape $shape --query data.id --raw-output)

       cloud_vm_cluster_id=$(oci db cloud-vm-cluster create --backup-subnet-id $backup_subnet_id --cloud-exa-infra-id $cloud_exa_infra_id --compartment-id $compartment_id --cpu-core-count $cpu_core_count --display-name $display_name --gi-version $gi_version --hostname $hostname --ssh-authorized-keys-file $ssh_authorized_keys_file --subnet-id $subnet_id --query data.id --raw-output)

       oci db cloud-vm-cluster update --cloud-vm-cluster-id $cloud_vm_cluster_id
