NAME

DESCRIPTION

Important: Updating an SDDC affects only certain attributes in the Sddc object and does not affect the VMware environment currently running in the SDDC. For more information, see UpdateSddcDetails <https://docs.cloud.oracle.com/api/#/en/vmware/20200501/datatypes/UpdateSddcDetails>.

USAGE

oci ocvs sddc update [OPTIONS]

REQUIRED PARAMETERS

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN to use for the NSX Edge Uplink 1 component of the VMware environment.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN to use for the NSX Edge Uplink 2 component of the VMware environment.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN to use for the NSX Edge VTEP component of the VMware environment.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN to use for the NSX VTEP component of the VMware environment.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the SDDC.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN to use for the vMotion component of the VMware environment.

The VMware software bundle to install on the ESXi hosts in the SDDC. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions <https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/vmware-versions.html>.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN to use for the vSAN component of the VMware environment.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN to use for the vSphere component of the VMware environment.

OPTIONAL PARAMETERS

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags <https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm>.

Example:

{"Operations": {"CostCenter": "42"}}

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.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the SDDC. SDDC name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region.

Perform update without prompting for confirmation.

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 <https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm>.

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.

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

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN to use for the HCX component of the VMware environment when adding new ESXi hosts to the SDDC. This value can be updated only when isHcxEnabled is true.

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.

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

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN used by the SDDC for the Provisioning component of the VMware environment.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the VLAN used by the SDDC for the vSphere Replication component of the VMware environment.

One or more public SSH keys to be included in the ~/.ssh/authorized_keys file for the default user on each ESXi host, only when adding new ESXi hosts to this SDDC. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the authorized_keys file.

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:

ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING

Check every --wait-interval-seconds to see whether the resource to see if it has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

GLOBAL PARAMETERS

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --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, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

EXAMPLES

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> 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/ocvs/sddc/create.html#cmdoption-compartment-id
    export compute_availability_domain=<substitute-value-of-compute_availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-compute-availability-domain
    export esxi_count=<substitute-value-of-esxi_count> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-esxi-count
    export instance_prefix=<substitute-value-of-instance_prefix> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-instance-prefix
    export nsx_edge_up1_id=<substitute-value-of-nsx_edge_up1_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-nsx-edge-up1-id
    export nsx_edge_up2_id=<substitute-value-of-nsx_edge_up2_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-nsx-edge-up2-id
    export nsx_edge_vtep_id=<substitute-value-of-nsx_edge_vtep_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-nsx-edge-vtep-id
    export nsx_vtep_id=<substitute-value-of-nsx_vtep_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-nsx-vtep-id
    export prov_subnet_id=<substitute-value-of-prov_subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-prov-subnet-id
    export ssh_authorized_keys=<substitute-value-of-ssh_authorized_keys> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-ssh-authorized-keys
    export vmotion_id=<substitute-value-of-vmotion_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-vmotion-id
    export vmware_version=<substitute-value-of-vmware_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-vmware-version
    export vsan_id=<substitute-value-of-vsan_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-vsan-id
    export vsphere_id=<substitute-value-of-vsphere_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ocvs/sddc/create.html#cmdoption-vsphere-id
    sddc_id=$(oci ocvs sddc create --compartment-id $compartment_id --compute-availability-domain $compute_availability_domain --esxi-count $esxi_count --instance-prefix $instance_prefix --nsx-edge-up1-id $nsx_edge_up1_id --nsx-edge-up2-id $nsx_edge_up2_id --nsx-edge-vtep-id $nsx_edge_vtep_id --nsx-vtep-id $nsx_vtep_id --prov-subnet-id $prov_subnet_id --ssh-authorized-keys $ssh_authorized_keys --vmotion-id $vmotion_id --vmware-version $vmware_version --vsan-id $vsan_id --vsphere-id $vsphere_id --query data.id --raw-output)
    oci ocvs sddc update --nsx-edge-up1-id $nsx_edge_up1_id --nsx-edge-up2-id $nsx_edge_up2_id --nsx-edge-vtep-id $nsx_edge_vtep_id --nsx-vtep-id $nsx_vtep_id --sddc-id $sddc_id --vmotion-id $vmotion_id --vmware-version $vmware_version --vsan-id $vsan_id --vsphere-id $vsphere_id

AUTHOR

COPYRIGHT