Class Cluster

An Oracle Cloud VMware Solution Cluster contains the resources required for a functional VMware environment. Instances in a Cluster (see {@link 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.

Inheritance

object

Cluster

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OcvpService.Models

Assembly: OCI.DotNetSDK.Ocvp.dll

Syntax

public class Cluster

Properties

CapacityReservationId

Declaration

[JsonProperty(PropertyName = "capacityReservationId")]
public string CapacityReservationId { get; set; }

Property Value

Type	Description
string	The OCID of the Capacity Reservation.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the Cluster.

Remarks

Required

ComputeAvailabilityDomain

Declaration

[Required(ErrorMessage = "ComputeAvailabilityDomain is required.")]
[JsonProperty(PropertyName = "computeAvailabilityDomain")]
public string ComputeAvailabilityDomain { get; set; }

Property Value

Type	Description
string	The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD

Remarks

Required

Datastores

Declaration

[JsonProperty(PropertyName = "datastores")]
public List<DatastoreDetails> Datastores { get; set; }

Property Value

Type	Description
List<DatastoreDetails>	Datastores used for the Cluster.

DefinedTags

Declaration

[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required

EsxiHostsCount

Declaration

[Required(ErrorMessage = "EsxiHostsCount is required.")]
[JsonProperty(PropertyName = "esxiHostsCount")]
public int? EsxiHostsCount { get; set; }

Property Value

Type	Description
int?	The number of ESXi hosts in the Cluster.

Remarks

Required

EsxiSoftwareVersion

Declaration

[JsonProperty(PropertyName = "esxiSoftwareVersion")]
public string EsxiSoftwareVersion { get; set; }

Property Value

Type

Description

string

In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see {@link #listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest) 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 {@link #createEsxiHost(CreateEsxiHostRequest) 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 {@link #updateCluster(UpdateClusterRequest) updateCluster} to update the Cluster's esxiSoftwareVersion with that new version.

FreeformTags

Declaration

[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the Cluster.

Remarks

Required

InitialCommitment

Declaration

[JsonProperty(PropertyName = "initialCommitment")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Commitment? InitialCommitment { get; set; }

Property Value

Type	Description
Commitment?	The billing option selected during Cluster creation. {@link #listSupportedCommitments(ListSupportedCommitmentsRequest) listSupportedCommitments}.

InitialHostOcpuCount

Declaration

[JsonProperty(PropertyName = "initialHostOcpuCount")]
public float? InitialHostOcpuCount { get; set; }

Property Value

Type	Description
float?	The initial OCPU count of the Cluster's ESXi hosts.

InitialHostShapeName

Declaration

[Required(ErrorMessage = "InitialHostShapeName is required.")]
[JsonProperty(PropertyName = "initialHostShapeName")]
public string InitialHostShapeName { get; set; }

Property Value

Type	Description
string	The initial compute shape of the Cluster's ESXi hosts. {@link #listSupportedHostShapes(ListSupportedHostShapesRequest) listSupportedHostShapes}.

Remarks

Required

InstanceDisplayNamePrefix

Declaration

[JsonProperty(PropertyName = "instanceDisplayNamePrefix")]
public string InstanceDisplayNamePrefix { get; set; }

Property Value

Type	Description
string	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.

IsShieldedInstanceEnabled

Declaration

[JsonProperty(PropertyName = "isShieldedInstanceEnabled")]
public bool? IsShieldedInstanceEnabled { get; set; }

Property Value

Type	Description
bool?	Indicates whether shielded instance is enabled at the Cluster level.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleStates? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleStates?	The current state of the Cluster.

NetworkConfiguration

Declaration

[Required(ErrorMessage = "NetworkConfiguration is required.")]
[JsonProperty(PropertyName = "networkConfiguration")]
public NetworkConfiguration NetworkConfiguration { get; set; }

Property Value

Type	Description
NetworkConfiguration

Remarks

Required

SddcId

Declaration

[Required(ErrorMessage = "SddcId is required.")]
[JsonProperty(PropertyName = "sddcId")]
public string SddcId { get; set; }

Property Value

Type	Description
string	The OCID of the SDDC that the Cluster belongs to.

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the Cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the Cluster was updated, in the format defined by RFC3339.

UpgradeLicenses

Declaration

[JsonProperty(PropertyName = "upgradeLicenses")]
public List<VsphereLicense> UpgradeLicenses { get; set; }

Property Value

Type	Description
List<VsphereLicense>	The vSphere licenses to use when upgrading the Cluster.

VmwareSoftwareVersion

Declaration

[Required(ErrorMessage = "VmwareSoftwareVersion is required.")]
[JsonProperty(PropertyName = "vmwareSoftwareVersion")]
public string VmwareSoftwareVersion { get; set; }

Property Value

Type

Description

string

In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see {@link #listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest) 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 {@link #createEsxiHost(CreateEsxiHostRequest) 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 {@link #updateCluster(UpdateClusterRequest) updateCluster} to update the Cluster's vmwareSoftwareVersion with that new version.

Remarks

Required

VsphereType

Declaration

[Required(ErrorMessage = "VsphereType is required.")]
[JsonProperty(PropertyName = "vsphereType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VsphereTypes? VsphereType { get; set; }

Property Value

Type	Description
VsphereTypes?	vSphere Cluster types.

Remarks

Required

VsphereUpgradeObjects

Declaration

[JsonProperty(PropertyName = "vsphereUpgradeObjects")]
public List<VsphereUpgradeObject> VsphereUpgradeObjects { get; set; }

Property Value

Type	Description
List<VsphereUpgradeObject>	The links to binary objects needed to upgrade vSphere.

WorkloadNetworkCidr

Declaration

[JsonProperty(PropertyName = "workloadNetworkCidr")]
public string WorkloadNetworkCidr { get; set; }

Property Value

Type	Description
string	The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.