Skip to content

ocvp.oracle.com/v1beta1

Back to API Reference

APIVersion: ocvp.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes ocvp.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
Cluster Namespaced Sample -
EsxiHost Namespaced Sample -
Sddc Namespaced Sample -

Cluster

Cluster is the Schema for the clusters API.

  • Plural: clusters
  • Scope: Namespaced
  • APIVersion: ocvp.oracle.com/v1beta1
  • Sample: Sample (config/samples/ocvp_v1beta1_cluster.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ClusterSpec defines the desired state of Cluster.

Field Description Type Required Default Enum
capacityReservationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. string No - -
clusterByolAllocationDetails ClusterByolAllocationDetails defines nested fields for Cluster.ClusterByolAllocationDetails. object No - -
computeAvailabilityDomain The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to multi-AD. string Yes - -
datastoreClusterIds A list of datastore clusters. list[string] No - -
datastores A list of datastore info for the Cluster. This value is required only when initialHostShapeName is a standard shape. list[object] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A descriptive name for the Cluster. Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. Avoid entering confidential information. string No - -
esxiHostsCount The number of ESXi hosts to create in the Cluster. You can add more hosts later (see CreateEsxiHost). Note: If you later delete EXSi hosts from a production Cluster to make SDDC total host count less than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also, you cannot add more VMware workloads to the Cluster until the SDDC again has at least 3 ESXi hosts. integer Yes - -
esxiSoftwareVersion The ESXi software bundle to install on the ESXi hosts in the Cluster. Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions. string No - -
freeformTags 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
initialCommitment The billing option selected during Cluster creation. ListSupportedCommitments. string No - -
initialHostOcpuCount The initial OCPU count of the Cluster's ESXi hosts. number No - -
initialHostShapeName The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes. string No - -
initialVcfByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. string No - -
instanceDisplayNamePrefix A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix. For example, if the value is myCluster, the ESXi hosts are named myCluster-1, myCluster-2, and so on. string No - -
isShieldedInstanceEnabled Indicates whether shielded instance is enabled for this Cluster. boolean No - -
networkConfiguration ClusterNetworkConfiguration defines nested fields for Cluster.NetworkConfiguration. object Yes - -
sddcId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the Cluster belongs to. string Yes - -
vmwareSoftwareVersion The VMware software bundle to install on the ESXi hosts in the Cluster. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions. string No - -
workloadNetworkCidr The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads. string No - -

Spec.clusterByolAllocationDetails

Back to Cluster spec

ClusterByolAllocationDetails defines nested fields for Cluster.ClusterByolAllocationDetails.

Field Description Type Required Default Enum
firewallByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. string No - -
vsanByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. string No - -

Spec.datastores[]

Back to Cluster spec

ClusterDatastore defines nested fields for Cluster.Datastore.

Field Description Type Required Default Enum
blockVolumeIds A list of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. list[string] Yes - -
datastoreType Type of the datastore. string Yes - -

Spec.networkConfiguration

Back to Cluster spec

ClusterNetworkConfiguration defines nested fields for Cluster.NetworkConfiguration.

Field Description Type Required Default Enum
hcxVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. This attribute is not guaranteed to reflect the HCX VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the HCX VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the HCX component of the VMware environment, you should use UpdateSddc to update the SDDC's hcxVlanId with that new VLAN's OCID. string No - -
nsxEdgeUplink1VlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 1 component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeUplink1VlanId with that new VLAN's OCID. string No - -
nsxEdgeUplink2VlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 2 component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeUplink2VlanId with that new VLAN's OCID. string No - -
nsxEdgeVTepVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge VTEP component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeVTepVlanId with that new VLAN's OCID. string Yes - -
nsxVTepVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. This attribute is not guaranteed to reflect the NSX VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX VTEP component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxVTepVlanId with that new VLAN's OCID. string Yes - -
provisioningSubnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. string Yes - -
provisioningVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. string No - -
replicationVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. string No - -
vmotionVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. This attribute is not guaranteed to reflect the vMotion VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vMotion VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vMotion component of the VMware environment, you should use UpdateCluster to update the Cluster's vmotionVlanId with that new VLAN's OCID. string Yes - -
vsanVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. This attribute is not guaranteed to reflect the vSAN VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSAN VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSAN component of the VMware environment, you should use UpdateCluster to update the Cluster's vsanVlanId with that new VLAN's OCID. string Yes - -
vsphereVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the vSphere VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSphere VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSphere component of the VMware environment, you should use UpdateSddc to update the Cluster's vsphereVlanId with that new VLAN's OCID. string No - -

Status

ClusterStatus defines the observed state of Cluster.

Field Description Type Required Default Enum
capacityReservationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. string No - -
clusterByolAllocationDetails ClusterByolAllocationDetails defines nested fields for Cluster.ClusterByolAllocationDetails. object No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Cluster. string No - -
computeAvailabilityDomain The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD string No - -
datastoreClusterIds A list of datastore clusters. list[string] No - -
datastores Datastores used for the Cluster. list[object] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information. string No - -
esxiHostsCount The number of ESXi hosts in the Cluster. integer No - -
esxiSoftwareVersion In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost unless a different version is configured on the ESXi host level. Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you should use UpdateCluster to update the Cluster's esxiSoftwareVersion with that new version. string No - -
freeformTags 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster. string No - -
initialCommitment The billing option selected during Cluster creation. ListSupportedCommitments. string No - -
initialHostOcpuCount The initial OCPU count of the Cluster's ESXi hosts. number No - -
initialHostShapeName The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes. string No - -
initialVcfByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. string No - -
instanceDisplayNamePrefix A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix. For example, if the value is MyCluster, the ESXi hosts are named MyCluster-1, MyCluster-2, and so on. string No - -
isShieldedInstanceEnabled Indicates whether shielded instance is enabled at the Cluster level. boolean No - -
lifecycleState The current state of the Cluster. string No - -
networkConfiguration ClusterNetworkConfiguration defines nested fields for Cluster.NetworkConfiguration. object No - -
sddcId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the Cluster belongs to. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}} map[string, map[string, string]] No - -
timeCreated The date and time the Cluster was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -
timeUpdated The date and time the Cluster was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). string No - -
upgradeLicenses The vSphere licenses to use when upgrading the Cluster. list[object] No - -
vmwareSoftwareVersion In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the Cluster. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use UpdateCluster to update the Cluster's vmwareSoftwareVersion with that new version. string No - -
vsphereType vSphere Cluster types. string No - -
vsphereUpgradeObjects The links to binary objects needed to upgrade vSphere. list[object] No - -
workloadNetworkCidr The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads. string No - -

Status.clusterByolAllocationDetails

Back to Cluster status

ClusterByolAllocationDetails defines nested fields for Cluster.ClusterByolAllocationDetails.

Field Description Type Required Default Enum
firewallByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. string No - -
vsanByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. string No - -

Status.datastores[]

Back to Cluster status

ClusterDatastore defines nested fields for Cluster.Datastore.

Field Description Type Required Default Enum
blockVolumeIds A list of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. list[string] Yes - -
datastoreType Type of the datastore. string Yes - -

Status.networkConfiguration

Back to Cluster status

ClusterNetworkConfiguration defines nested fields for Cluster.NetworkConfiguration.

Field Description Type Required Default Enum
hcxVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. This attribute is not guaranteed to reflect the HCX VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the HCX VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the HCX component of the VMware environment, you should use UpdateSddc to update the SDDC's hcxVlanId with that new VLAN's OCID. string No - -
nsxEdgeUplink1VlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 1 component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeUplink1VlanId with that new VLAN's OCID. string No - -
nsxEdgeUplink2VlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 2 component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeUplink2VlanId with that new VLAN's OCID. string No - -
nsxEdgeVTepVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge VTEP component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeVTepVlanId with that new VLAN's OCID. string Yes - -
nsxVTepVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. This attribute is not guaranteed to reflect the NSX VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX VTEP component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxVTepVlanId with that new VLAN's OCID. string Yes - -
provisioningSubnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. string Yes - -
provisioningVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. string No - -
replicationVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. string No - -
vmotionVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. This attribute is not guaranteed to reflect the vMotion VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vMotion VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vMotion component of the VMware environment, you should use UpdateCluster to update the Cluster's vmotionVlanId with that new VLAN's OCID. string Yes - -
vsanVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. This attribute is not guaranteed to reflect the vSAN VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSAN VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSAN component of the VMware environment, you should use UpdateCluster to update the Cluster's vsanVlanId with that new VLAN's OCID. string Yes - -
vsphereVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the vSphere VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSphere VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSphere component of the VMware environment, you should use UpdateSddc to update the Cluster's vsphereVlanId with that new VLAN's OCID. string No - -

Status.status

Back to Cluster status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Cluster status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Cluster status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Cluster status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.upgradeLicenses[]

Back to Cluster status

ClusterUpgradeLicense defines nested fields for Cluster.UpgradeLicense.

Field Description Type Required Default Enum
licenseKey vSphere license key value. string No - -
licenseType vSphere license type. string No - -

Status.vsphereUpgradeObjects[]

Back to Cluster status

ClusterVsphereUpgradeObject defines nested fields for Cluster.VsphereUpgradeObject.

Field Description Type Required Default Enum
downloadLink Binary object download link. string No - -
linkDescription Binary object description. string No - -

EsxiHost

EsxiHost is the Schema for the esxihosts API.

  • Plural: esxihosts
  • Scope: Namespaced
  • APIVersion: ocvp.oracle.com/v1beta1
  • Sample: Sample (config/samples/ocvp_v1beta1_esxihost.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

EsxiHostSpec defines the desired state of EsxiHost.

Field Description Type Required Default Enum
billingDonorHostId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle. string No - -
capacityReservationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. string No - -
clusterId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster to add the ESXi host to. string Yes - -
computeAvailabilityDomain The availability domain to create the ESXi host in. If keep empty, for AD-specific Cluster, new ESXi host will be created in the same availability domain; for multi-AD Cluster, new ESXi host will be auto assigned to the next availability domain following evenly distribution strategy. string No - -
currentCommitment The billing option currently used by the ESXi host. ListSupportedCommitments. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A descriptive name for the ESXi host. It's changeable. Esxi Host name requirements are 1-25 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the Cluster. If this attribute is not specified, the Cluster's instanceDisplayNamePrefix attribute is used to name and incrementally number the ESXi host. For example, if you're creating the fourth ESXi host in the Cluster, and instanceDisplayNamePrefix is MyCluster, the host's display name is MyCluster-4. Avoid entering confidential information. string No - -
esxiSoftwareVersion The ESXi software bundle to install on the ESXi host. Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions. string No - -
freeformTags 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
hostOcpuCount The OCPU count of the ESXi host. number No - -
hostShapeName The compute shape name of the ESXi host. ListSupportedHostShapes. string No - -
isVsanByolEnabled Indicates whether this host embedded VMware vSAN with BYOL Allocation. boolean No - -
nextCommitment The billing option to switch to after the existing billing cycle ends. If nextCommitment is null or empty, currentCommitment continues to the next billing cycle. ListSupportedCommitments. string No - -
vcfByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Byol Allocation for VCF (VMware Cloud Foundation) deployment. string No - -

Status

EsxiHostStatus defines the observed state of EsxiHost.

Field Description Type Required Default Enum
billingContractEndDate Current billing cycle end date. If the value in currentCommitment and nextCommitment are different, the value specified in nextCommitment becomes the new currentCommitment when the contractEndDate is reached. Example: 2016-08-25T21:10:29.600Z string No - -
billingDonorHostId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle. string No - -
capacityReservationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. string No - -
clusterId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster that the ESXi host belongs to. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Cluster. string No - -
computeAvailabilityDomain The availability domain of the ESXi host. string No - -
computeInstanceId In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. The computeInstanceId is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that Compute instance. string No - -
currentCommitment The billing option currently used by the ESXi host. ListSupportedCommitments. string No - -
datastoreAttachments List of DatastoreAttachment objects containing information about attachment details list[object] No - -
datastoreClusterIds A list of datastore clusters. list[string] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A descriptive name for the ESXi host. Does not have to be unique, and it's changeable. Avoid entering confidential information. string No - -
esxiSoftwareVersion The version of ESXi software that Oracle Cloud VMware Solution installed on the ESXi hosts. string No - -
failedEsxiHostId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that failed. string No - -
freeformTags 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
gracePeriodEndDate The date and time when the new esxi host should start billing cycle. RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2021-07-25T21:10:29.600Z string No - -
hostOcpuCount The OCPU count of the ESXi host. number No - -
hostShapeName The compute shape name of the ESXi host. ListSupportedHostShapes. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host. string No - -
isBillingContinuationInProgress Indicates whether this host is in the progress of billing continuation. boolean No - -
isBillingSwappingInProgress Indicates whether this host is in the progress of swapping billing. boolean No - -
isVsanByolEnabled Indicates whether this host embedded VMware vSAN with BYOL Allocation. boolean No - -
lifecycleState The current state of the ESXi host. string No - -
nextCommitment The billing option to switch to after the current billing cycle ends. If nextCommitment is null or empty, currentCommitment continues to the next billing cycle. ListSupportedCommitments. string No - -
nonUpgradedEsxiHostId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that will be upgraded. string No - -
primaryVnicMacAddress MAC address of ESXi host's compute instance primary VNIC. string No - -
replacementEsxiHostId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that is created to replace the failed host. string No - -
sddcId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the ESXi host belongs to. string No - -
status - object Yes - -
swapBillingHostId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host. string No - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}} map[string, map[string, string]] No - -
timeCreated The date and time the ESXi host was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -
timeUpdated The date and time the ESXi host was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). string No - -
upgradedReplacementEsxiHostId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that is newly created to upgrade the original host. string No - -
vcfByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Byol Allocation for VCF (VMware Cloud Foundation) deployment. string No - -
vmwareSoftwareVersion The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts. string No - -

Status.datastoreAttachments[]

Back to EsxiHost status

EsxiHostDatastoreAttachment defines nested fields for EsxiHost.DatastoreAttachment.

Field Description Type Required Default Enum
blockVolumeId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Block Volume that belongs to the datastore. string No - -
datastoreId The OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore that ESXi host is attached to. string No - -
ipAddress The IP address of datastore attachment. string No - -
port The port of datastore attachment. integer No - -
volumeIqn An IQN of the Block Storage Volume. string No - -

Status.status

Back to EsxiHost status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to EsxiHost status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to EsxiHost status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to EsxiHost status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Sddc

Sddc is the Schema for the sddcs API.

  • Plural: sddcs
  • Scope: Namespaced
  • APIVersion: ocvp.oracle.com/v1beta1
  • Sample: Sample (config/samples/ocvp_v1beta1_sddc.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

SddcSpec defines the desired state of Sddc.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the SDDC. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A descriptive name for 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. Avoid entering confidential information. string No - -
esxiSoftwareVersion The ESXi software bundle to install on the ESXi hosts in the SDDC. Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions. string No - -
freeformTags 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
hcxMode HCX configuration of the SDDC. string Yes - -
initialConfiguration SddcInitialConfiguration defines nested fields for Sddc.InitialConfiguration. object Yes - -
isSingleHostSddc Indicates whether this SDDC is designated for only single ESXi host. boolean No - -
sddcByolAllocationDetails SddcByolAllocationDetails defines nested fields for Sddc.SddcByolAllocationDetails. object No - -
sshAuthorizedKeys One or more public SSH keys to be included in the ~/.ssh/authorized_keys file for the default user on each ESXi host. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the authorized_keys file string Yes - -
vmwareSoftwareVersion The VMware software bundle to install on the ESXi hosts in the SDDC. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions. string Yes - -

Spec.initialConfiguration

Back to Sddc spec

SddcInitialConfiguration defines nested fields for Sddc.InitialConfiguration.

Field Description Type Required Default Enum
initialClusterConfigurations The configurations for Clusters initially created in the SDDC. list[object] Yes - -

Spec.initialConfiguration.initialClusterConfigurations[]

Back to Sddc spec

SddcInitialConfigurationInitialClusterConfiguration defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.

Field Description Type Required Default Enum
capacityReservationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. string No - -
clusterByolAllocationDetails SddcInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetails defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.ClusterByolAllocationDetails. object No - -
computeAvailabilityDomain The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to multi-AD. string Yes - -
datastoreClusterIds A list of datastore clusters. list[string] No - -
datastores A list of datastore info for the Cluster. This value is required only when initialHostShapeName is a standard shape. list[object] No - -
displayName A descriptive name for the Cluster. Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. Avoid entering confidential information. string No - -
esxiHostsCount The number of ESXi hosts to create in the Cluster. You can add more hosts later (see CreateEsxiHost). Creating a Cluster with a ESXi host count of 1 will be considered a single ESXi host Cluster. Note: If you later delete EXSi hosts from a production Cluster to total less than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also, you cannot add more VMware workloads to the Cluster until it again has at least 3 ESXi hosts. integer Yes - -
initialCommitment The billing option selected during Cluster creation. ListSupportedCommitments. string No - -
initialHostOcpuCount The initial OCPU count of the Cluster's ESXi hosts. number No - -
initialHostShapeName The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes. string No - -
initialVcfByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. string No - -
instanceDisplayNamePrefix A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix. For example, if the value is myCluster, the ESXi hosts are named myCluster-1, myCluster-2, and so on. string No - -
isShieldedInstanceEnabled Indicates whether shielded instance is enabled for this Cluster. boolean No - -
networkConfiguration SddcInitialConfigurationInitialClusterConfigurationNetworkConfiguration defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.NetworkConfiguration. object Yes - -
vsphereType vSphere Cluster types. string Yes - -
workloadNetworkCidr The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads. string No - -

Spec.initialConfiguration.initialClusterConfigurations[].clusterByolAllocationDetails

Back to Sddc spec

SddcInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetails defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.ClusterByolAllocationDetails.

Field Description Type Required Default Enum
firewallByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. string No - -
vsanByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. string No - -

Spec.initialConfiguration.initialClusterConfigurations[].datastores[]

Back to Sddc spec

SddcInitialConfigurationInitialClusterConfigurationDatastore defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.Datastore.

Field Description Type Required Default Enum
blockVolumeIds A list of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. list[string] Yes - -
datastoreType Type of the datastore. string Yes - -

Spec.initialConfiguration.initialClusterConfigurations[].networkConfiguration

Back to Sddc spec

SddcInitialConfigurationInitialClusterConfigurationNetworkConfiguration defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.NetworkConfiguration.

Field Description Type Required Default Enum
hcxVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. This attribute is not guaranteed to reflect the HCX VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the HCX VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the HCX component of the VMware environment, you should use UpdateSddc to update the SDDC's hcxVlanId with that new VLAN's OCID. string No - -
nsxEdgeUplink1VlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 1 component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeUplink1VlanId with that new VLAN's OCID. string No - -
nsxEdgeUplink2VlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 2 component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeUplink2VlanId with that new VLAN's OCID. string No - -
nsxEdgeVTepVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge VTEP component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeVTepVlanId with that new VLAN's OCID. string Yes - -
nsxVTepVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. This attribute is not guaranteed to reflect the NSX VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX VTEP component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxVTepVlanId with that new VLAN's OCID. string Yes - -
provisioningSubnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. string Yes - -
provisioningVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. string No - -
replicationVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. string No - -
vmotionVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. This attribute is not guaranteed to reflect the vMotion VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vMotion VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vMotion component of the VMware environment, you should use UpdateCluster to update the Cluster's vmotionVlanId with that new VLAN's OCID. string Yes - -
vsanVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. This attribute is not guaranteed to reflect the vSAN VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSAN VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSAN component of the VMware environment, you should use UpdateCluster to update the Cluster's vsanVlanId with that new VLAN's OCID. string Yes - -
vsphereVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the vSphere VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSphere VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSphere component of the VMware environment, you should use UpdateSddc to update the Cluster's vsphereVlanId with that new VLAN's OCID. string No - -

Spec.sddcByolAllocationDetails

Back to Sddc spec

SddcByolAllocationDetails defines nested fields for Sddc.SddcByolAllocationDetails.

Field Description Type Required Default Enum
loadBalancerByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware Avi Load Balancer. string No - -
loadBalancerInstanceCount The number of VMware Avi Load Balancer instances to be deployed on VMware SDDC. integer No - -

Status

SddcStatus defines the observed state of Sddc.

Field Description Type Required Default Enum
clustersCount The number of Clusters in the SDDC. integer No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the SDDC. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A descriptive name for the SDDC. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information. string No - -
esxiSoftwareVersion In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost unless a different version is configured on the Cluster or ESXi host level. Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you should use UpdateSddc to update the SDDC's vmwareSoftwareVersion with that new version. string No - -
freeformTags 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
hcxFqdn The FQDN for HCX Manager. Example: hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com string No - -
hcxMode HCX configuration of the SDDC. string No - -
hcxOnPremLicenses The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution. list[object] No - -
hcxPrivateIpId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivateIp object that is the virtual IP (VIP) for HCX Manager. For information about PrivateIp objects, see the Core Services API. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC. string No - -
initialConfiguration SddcInitialConfiguration defines nested fields for Sddc.InitialConfiguration. object No - -
isHcxPendingDowngrade Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced. boolean No - -
isSingleHostSddc Indicates whether this SDDC is designated for only single ESXi host. boolean No - -
lifecycleState The current state of the SDDC. string No - -
nsxEdgeUplinkIpId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivateIp object that is the virtual IP (VIP) for the NSX Edge Uplink. Use this OCID as the route target for route table rules when setting up connectivity between the SDDC and other networks. For information about PrivateIp objects, see the Core Services API. string No - -
nsxManagerFqdn The FQDN for NSX Manager. Example: nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com string No - -
nsxManagerPrivateIpId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivateIp object that is the virtual IP (VIP) for NSX Manager. For information about PrivateIp objects, see the Core Services API. string No - -
nsxManagerUsername The SDDC includes an administrator username and initial password for NSX Manager. You can change this initial username to a different value in NSX Manager. string No - -
sddcByolAllocationDetails SddcByolAllocationDetails defines nested fields for Sddc.SddcByolAllocationDetails. object No - -
sshAuthorizedKeys One or more public SSH keys to be included in the ~/.ssh/authorized_keys file for the default user on each ESXi host. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the authorized_keys file. This attribute is not guaranteed to reflect the public SSH keys currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the public SSH keys that Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost. Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different SSH keys, you should use UpdateSddc to update the SDDC's sshAuthorizedKeys with the new public keys. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}} map[string, map[string, string]] No - -
timeCreated The date and time the SDDC was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -
timeHcxBillingCycleEnd The date and time current HCX Enterprise billing cycle ends, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -
timeHcxLicenseStatusUpdated The date and time the SDDC's HCX on-premise license status was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -
timeUpdated The date and time the SDDC was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). string No - -
vcenterFqdn The FQDN for vCenter. Example: vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com string No - -
vcenterPrivateIpId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivateIp object that is the virtual IP (VIP) for vCenter. For information about PrivateIp objects, see the Core Services API. string No - -
vcenterUsername The SDDC includes an administrator username and password for vCenter. You can change this initial username to a different value in vCenter. string No - -
vmwareSoftwareVersion In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost. Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use UpdateSddc to update the SDDC's vmwareSoftwareVersion with that new version. string No - -

Status.hcxOnPremLicenses[]

Back to Sddc status

SddcHcxOnPremLicense defines nested fields for Sddc.HcxOnPremLicense.

Field Description Type Required Default Enum
activationKey HCX on-premise license key value. string No - -
status status of HCX on-premise license. string No - -
systemName Name of the system that consumed the HCX on-premise license string No - -

Status.initialConfiguration

Back to Sddc status

SddcInitialConfiguration defines nested fields for Sddc.InitialConfiguration.

Field Description Type Required Default Enum
initialClusterConfigurations The configurations for Clusters initially created in the SDDC. list[object] Yes - -

Status.initialConfiguration.initialClusterConfigurations[]

Back to Sddc status

SddcInitialConfigurationInitialClusterConfiguration defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.

Field Description Type Required Default Enum
capacityReservationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. string No - -
clusterByolAllocationDetails SddcInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetails defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.ClusterByolAllocationDetails. object No - -
computeAvailabilityDomain The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to multi-AD. string Yes - -
datastoreClusterIds A list of datastore clusters. list[string] No - -
datastores A list of datastore info for the Cluster. This value is required only when initialHostShapeName is a standard shape. list[object] No - -
displayName A descriptive name for the Cluster. Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. Avoid entering confidential information. string No - -
esxiHostsCount The number of ESXi hosts to create in the Cluster. You can add more hosts later (see CreateEsxiHost). Creating a Cluster with a ESXi host count of 1 will be considered a single ESXi host Cluster. Note: If you later delete EXSi hosts from a production Cluster to total less than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also, you cannot add more VMware workloads to the Cluster until it again has at least 3 ESXi hosts. integer Yes - -
initialCommitment The billing option selected during Cluster creation. ListSupportedCommitments. string No - -
initialHostOcpuCount The initial OCPU count of the Cluster's ESXi hosts. number No - -
initialHostShapeName The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes. string No - -
initialVcfByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. string No - -
instanceDisplayNamePrefix A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix. For example, if the value is myCluster, the ESXi hosts are named myCluster-1, myCluster-2, and so on. string No - -
isShieldedInstanceEnabled Indicates whether shielded instance is enabled for this Cluster. boolean No - -
networkConfiguration SddcInitialConfigurationInitialClusterConfigurationNetworkConfiguration defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.NetworkConfiguration. object Yes - -
vsphereType vSphere Cluster types. string Yes - -
workloadNetworkCidr The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads. string No - -

Status.initialConfiguration.initialClusterConfigurations[].clusterByolAllocationDetails

Back to Sddc status

SddcInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetails defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.ClusterByolAllocationDetails.

Field Description Type Required Default Enum
firewallByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. string No - -
vsanByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. string No - -

Status.initialConfiguration.initialClusterConfigurations[].datastores[]

Back to Sddc status

SddcInitialConfigurationInitialClusterConfigurationDatastore defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.Datastore.

Field Description Type Required Default Enum
blockVolumeIds A list of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. list[string] Yes - -
datastoreType Type of the datastore. string Yes - -

Status.initialConfiguration.initialClusterConfigurations[].networkConfiguration

Back to Sddc status

SddcInitialConfigurationInitialClusterConfigurationNetworkConfiguration defines nested fields for Sddc.InitialConfiguration.InitialClusterConfiguration.NetworkConfiguration.

Field Description Type Required Default Enum
hcxVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. This attribute is not guaranteed to reflect the HCX VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the HCX VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the HCX component of the VMware environment, you should use UpdateSddc to update the SDDC's hcxVlanId with that new VLAN's OCID. string No - -
nsxEdgeUplink1VlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 1 component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeUplink1VlanId with that new VLAN's OCID. string No - -
nsxEdgeUplink2VlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 2 component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeUplink2VlanId with that new VLAN's OCID. string No - -
nsxEdgeVTepVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge VTEP component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxEdgeVTepVlanId with that new VLAN's OCID. string Yes - -
nsxVTepVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. This attribute is not guaranteed to reflect the NSX VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX VTEP component of the VMware environment, you should use UpdateCluster to update the Cluster's nsxVTepVlanId with that new VLAN's OCID. string Yes - -
provisioningSubnetId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. string Yes - -
provisioningVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. string No - -
replicationVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. string No - -
vmotionVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. This attribute is not guaranteed to reflect the vMotion VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vMotion VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vMotion component of the VMware environment, you should use UpdateCluster to update the Cluster's vmotionVlanId with that new VLAN's OCID. string Yes - -
vsanVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. This attribute is not guaranteed to reflect the vSAN VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSAN VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSAN component of the VMware environment, you should use UpdateCluster to update the Cluster's vsanVlanId with that new VLAN's OCID. string Yes - -
vsphereVlanId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. This attribute is not guaranteed to reflect the vSphere VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSphere VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSphere component of the VMware environment, you should use UpdateSddc to update the Cluster's vsphereVlanId with that new VLAN's OCID. string No - -

Status.sddcByolAllocationDetails

Back to Sddc status

SddcByolAllocationDetails defines nested fields for Sddc.SddcByolAllocationDetails.

Field Description Type Required Default Enum
loadBalancerByolAllocationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware Avi Load Balancer. string No - -
loadBalancerInstanceCount The number of VMware Avi Load Balancer instances to be deployed on VMware SDDC. integer No - -

Status.status

Back to Sddc status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Sddc status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Sddc status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Sddc status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -