update

Description

Update the VM cluster network on Database Infrastructure that has the specified OCID.

Usage

oci datacc vm-cluster-network update [OPTIONS]

Required Parameters

--vm-cluster-network-id [text]

The OCID of the VM cluster network.

Optional Parameters

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}} 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 VM cluster network. The name does not need to be unique.

--dns-servers [complex type]

The list of DNS server IP addresses. Maximum of 3 allowed. 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]

Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: {“bar-key”: “value”} 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/Content/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 is updated or deleted only if the Etag that you provide matches the current Etag value for the resource.

--listener-port [integer]

The listener TCP/IP port.

--listener-port-ssl [integer]

The listener TCP/IP SSL port. Default is 2484.

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

--ntp-servers [complex type]

The list of NTP server IP addresses. Maximum of 3 allowed. 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.

--scans [complex type]

The SCAN details.

This option is a JSON list with items of type ScanDetails. For documentation on ScanDetails please see our API reference: https://docs.oracle.com/en-us/iaas/api/#/en/baseinfra/20251101/datatypes/ScanDetails. 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.

--vm-networks [complex type]

Details of the client and backup networks.

This option is a JSON list with items of type VmNetworkDetails. For documentation on VmNetworkDetails please see our API reference: https://docs.oracle.com/en-us/iaas/api/#/en/baseinfra/20251101/datatypes/VmNetworkDetails. 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.

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

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci datacc infrastructure create --generate-param-json-input dns-servers > dns-servers.json
    oci datacc infrastructure create --generate-param-json-input ntp-servers > ntp-servers.json

    oci datacc vm-cluster-network create --generate-param-json-input vm-networks > vm-networks.json

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/datacc/infrastructure/create.html#cmdoption-compartment-id
    export control_plane_server1=<substitute-value-of-control_plane_server1> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-control-plane-server1
    export control_plane_server2=<substitute-value-of-control_plane_server2> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-control-plane-server2
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-display-name
    export gateway=<substitute-value-of-gateway> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-gateway
    export netmask=<substitute-value-of-netmask> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-netmask
    export shape=<substitute-value-of-shape> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-shape
    export system_model=<substitute-value-of-system_model> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-system-model

    infrastructure_id=$(oci datacc infrastructure create --compartment-id $compartment_id --control-plane-server1 $control_plane_server1 --control-plane-server2 $control_plane_server2 --display-name $display_name --dns-servers file://dns-servers.json --gateway $gateway --netmask $netmask --ntp-servers file://ntp-servers.json --shape $shape --system-model $system_model --query data.id --raw-output)

    vm_cluster_network_id=$(oci datacc vm-cluster-network create --compartment-id $compartment_id --display-name $display_name --infrastructure-id $infrastructure_id --vm-networks file://vm-networks.json --query data.id --raw-output)

    oci datacc vm-cluster-network update --vm-cluster-network-id $vm_cluster_network_id