Class Sddc

An Oracle Cloud VMware Solution software-defined data center (SDDC) contains the resources required for a functional VMware environment. Instances in an SDDC (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 SDDC.
The SDDC uses a single management subnet for provisioning the SDDC. 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

Sddc

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 Sddc

Properties

ClustersCount

Declaration

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

Property Value

Type	Description
int?	The number of Clusters in the SDDC.

Remarks

Required

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

Remarks

Required

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 SDDC. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.

Remarks

Required

EsxiSoftwareVersion

Declaration

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

Property Value

Type Description

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 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 {@link #updateSddc(UpdateSddcRequest) updateSddc} to update the SDDC's `vmwareSoftwareVersion` with that new version.

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 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 {@link #updateSddc(UpdateSddcRequest) updateSddc} to update the SDDC's vmwareSoftwareVersion 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

HcxFqdn

Declaration

[JsonProperty(PropertyName = "hcxFqdn")]
public string HcxFqdn { get; set; }

Property Value

Type	Description
string	The FQDN for HCX Manager. Example: hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com

HcxMode

Declaration

[Required(ErrorMessage = "HcxMode is required.")]
[JsonProperty(PropertyName = "hcxMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public HcxModes? HcxMode { get; set; }

Property Value

Type	Description
HcxModes?	HCX configuration of the SDDC.

Remarks

Required

HcxOnPremLicenses

Declaration

[JsonProperty(PropertyName = "hcxOnPremLicenses")]
public List<HcxLicenseSummary> HcxOnPremLicenses { get; set; }

Property Value

Type	Description
List<HcxLicenseSummary>	The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution.

HcxPrivateIpId

Declaration

[JsonProperty(PropertyName = "hcxPrivateIpId")]
public string HcxPrivateIpId { get; set; }

Property Value

Type	Description
string	The OCID of the `PrivateIp` object that is the virtual IP (VIP) for HCX Manager. For information about `PrivateIp` objects, see the Core Services API.

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the SDDC.

Remarks

Required

InitialConfiguration

Declaration

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

Property Value

Type	Description
InitialConfiguration

Remarks

Required

IsHcxPendingDowngrade

Declaration

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

Property Value

Type	Description
bool?	Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.

IsSingleHostSddc

Declaration

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

Property Value

Type	Description
bool?	Indicates whether this SDDC is designated for only single ESXi host.

LifecycleState

Declaration

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

Property Value

Type	Description
LifecycleStates?	The current state of the SDDC.

NsxEdgeUplinkIpId

Declaration

[JsonProperty(PropertyName = "nsxEdgeUplinkIpId")]
public string NsxEdgeUplinkIpId { get; set; }

Property Value

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

NsxManagerFqdn

Declaration

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

Property Value

Type	Description
string	The FQDN for NSX Manager. Example: nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com

Remarks

Required

NsxManagerPrivateIpId

Declaration

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

Property Value

Type	Description
string	The OCID of the `PrivateIp` object that is the virtual IP (VIP) for NSX Manager. For information about `PrivateIp` objects, see the Core Services API.

Remarks

Required

NsxManagerUsername

Declaration

[JsonProperty(PropertyName = "nsxManagerUsername")]
public string NsxManagerUsername { get; set; }

Property Value

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

SshAuthorizedKeys

Declaration

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

Property Value

Type Description

Type	Description
string	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 {@link #createEsxiHost(CreateEsxiHostRequest) createEsxiHost}. Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different SSH keys, you should use {@link #updateSddc(UpdateSddcRequest) updateSddc} to update the SDDC's `sshAuthorizedKeys` with the new public keys.

string

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 {@link #createEsxiHost(CreateEsxiHostRequest) createEsxiHost}.
Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different SSH keys, you should use {@link #updateSddc(UpdateSddcRequest) updateSddc} to update the SDDC's sshAuthorizedKeys with the new public keys.

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 SDDC was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeHcxBillingCycleEnd

Declaration

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

Property Value

Type	Description
DateTime?	The date and time current HCX Enterprise billing cycle ends, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeHcxLicenseStatusUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the SDDC's HCX on-premise license status was updated, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeUpdated

Declaration

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

Property Value

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

VcenterFqdn

Declaration

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

Property Value

Type	Description
string	The FQDN for vCenter. Example: vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com

Remarks

Required

VcenterPrivateIpId

Declaration

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

Property Value

Type	Description
string	The OCID of the `PrivateIp` object that is the virtual IP (VIP) for vCenter. For information about `PrivateIp` objects, see the Core Services API.

Remarks

Required

VcenterUsername

Declaration

[JsonProperty(PropertyName = "vcenterUsername")]
public string VcenterUsername { get; set; }

Property Value

Type	Description
string	The SDDC includes an administrator username and password for vCenter. You can change this initial username to a different value in vCenter.

VmwareSoftwareVersion

Declaration

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

Property Value

Type Description

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 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}. 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 {@link #updateSddc(UpdateSddcRequest) updateSddc} to update the SDDC's `vmwareSoftwareVersion` with that new version.

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 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}.
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 {@link #updateSddc(UpdateSddcRequest) updateSddc} to update the SDDC's vmwareSoftwareVersion with that new version.

Remarks

Required