Package com.oracle.bmc.ocvp.model

Class Cluster

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public final class Cluster
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    An Oracle Cloud VMware Solution Cluster contains the resources required for a functional VMware environment.

    Instances in a Cluster (see EsxiHost) run in a virtual cloud network (VCN) and are preconfigured with VMware and storage. Use the vCenter utility to manage and deploy VMware virtual machines (VMs) in the Cluster.

    The Cluster uses a single management subnet for provisioning the Cluster. It also uses a set of VLANs for various components of the VMware environment (vSphere, vMotion, vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.
    Note: Objects should always be created or deserialized using the Cluster.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Cluster.Builder, which maintain a set of all explicitly set fields called Cluster.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the Cluster.
        Returns:
        the value

      • getComputeAvailabilityDomain

        public String getComputeAvailabilityDomain()
        The availability domain the ESXi hosts are running in.

        For Multi-AD Cluster, it is multi-AD.

        Example: Uocm:PHX-AD-1, multi-AD

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        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.

        Returns:
        the value

      • getInstanceDisplayNamePrefix

        public String getInstanceDisplayNamePrefix()
        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.

        Returns:
        the value

      • getVmwareSoftwareVersion

        public String getVmwareSoftwareVersion()
        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.

        Returns:
        the value

      • getEsxiSoftwareVersion

        public String getEsxiSoftwareVersion()
        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.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the Cluster.
        Returns:
        the value

      • getSddcId

        public String getSddcId()
        The OCID of the SDDC that the Cluster belongs to.
        Returns:
        the value

      • getEsxiHostsCount

        public Integer getEsxiHostsCount()
        The number of ESXi hosts in the Cluster.
        Returns:
        the value

      • getInitialCommitment

        public Commitment getInitialCommitment()
        The billing option selected during Cluster creation.

        listSupportedCommitments.

        Returns:
        the value

      • getWorkloadNetworkCidr

        public String getWorkloadNetworkCidr()
        The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the Cluster was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the Cluster was updated, in the format defined by RFC3339.
        Returns:
        the value

      • getLifecycleState

        public LifecycleStates getLifecycleState()
        The current state of the Cluster.
        Returns:
        the value

      • getUpgradeLicenses

        public List<VsphereLicense> getUpgradeLicenses()
        The vSphere licenses to use when upgrading the Cluster.
        Returns:
        the value

      • getVsphereUpgradeObjects

        public List<VsphereUpgradeObject> getVsphereUpgradeObjects()
        The links to binary objects needed to upgrade vSphere.
        Returns:
        the value

      • getInitialHostShapeName

        public String getInitialHostShapeName()
        The initial compute shape of the Cluster’s ESXi hosts.

        listSupportedHostShapes.

        Returns:
        the value

      • getInitialHostOcpuCount

        public Float getInitialHostOcpuCount()
        The initial OCPU count of the Cluster’s ESXi hosts.
        Returns:
        the value

      • getIsShieldedInstanceEnabled

        public Boolean getIsShieldedInstanceEnabled()
        Indicates whether shielded instance is enabled at the Cluster level.
        Returns:
        the value

      • getCapacityReservationId

        public String getCapacityReservationId()
        The OCID of the Capacity Reservation.
        Returns:
        the value

      • getDatastores

        public List<DatastoreDetails> getDatastores()
        Datastores used for the Cluster.
        Returns:
        the value

      • getDatastoreClusterIds

        public List<String> getDatastoreClusterIds()
        A list of datastore clusters.
        Returns:
        the value

      • getVsphereType

        public VsphereTypes getVsphereType()
        vSphere Cluster types.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

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

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

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

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel