Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Properties

clustersCount

clustersCount: number

The number of Clusters in the SDDC. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

compartmentId

compartmentId: string

The OCID of the compartment that contains the SDDC.

definedTags

definedTags: object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

displayName

displayName: 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.

Optional esxiSoftwareVersion

esxiSoftwareVersion: undefined | 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 {@code vmwareSoftwareVersion} with that new version.

freeformTags

freeformTags: object

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: {@code {\"Department\": \"Finance\"}}

Type declaration

  • [key: string]: string

Optional hcxFqdn

hcxFqdn: undefined | string

The FQDN for HCX Manager.

Example: {@code hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com}

hcxMode

hcxMode: HcxModes

HCX configuration of the SDDC.

Optional hcxOnPremLicenses

hcxOnPremLicenses: Array<HcxLicenseSummary>

The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution.

Optional hcxPrivateIpId

hcxPrivateIpId: undefined | string

The OCID of the {@code PrivateIp} object that is the virtual IP (VIP) for HCX Manager. For information about {@code PrivateIp} objects, see the Core Services API.

id

id: string

The OCID of the SDDC.

initialConfiguration

initialConfiguration: InitialConfiguration

Optional isHcxPendingDowngrade

isHcxPendingDowngrade: undefined | false | true

Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.

Optional isSingleHostSddc

isSingleHostSddc: undefined | false | true

Indicates whether this SDDC is designated for only single ESXi host.

Optional lifecycleState

lifecycleState: model.LifecycleStates

The current state of the SDDC.

Optional nsxEdgeUplinkIpId

nsxEdgeUplinkIpId: undefined | string

The OCID of the {@code 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 {@code PrivateIp} objects, see the Core Services API.

nsxManagerFqdn

nsxManagerFqdn: string

The FQDN for NSX Manager.

Example: {@code nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com}

nsxManagerPrivateIpId

nsxManagerPrivateIpId: string

The OCID of the {@code PrivateIp} object that is the virtual IP (VIP) for NSX Manager. For information about {@code PrivateIp} objects, see the Core Services API.

Optional nsxManagerUsername

nsxManagerUsername: undefined | 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

sshAuthorizedKeys: string

One or more public SSH keys to be included in the {@code ~/.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 {@code 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 {@code sshAuthorizedKeys} with the new public keys.

timeCreated

timeCreated: Date

The date and time the SDDC was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeHcxBillingCycleEnd

timeHcxBillingCycleEnd: Date

The date and time current HCX Enterprise billing cycle ends, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeHcxLicenseStatusUpdated

timeHcxLicenseStatusUpdated: Date

The date and time the SDDC's HCX on-premise license status was updated, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The date and time the SDDC was updated, in the format defined by RFC3339.

vcenterFqdn

vcenterFqdn: string

The FQDN for vCenter.

Example: {@code vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com}

vcenterPrivateIpId

vcenterPrivateIpId: string

The OCID of the {@code PrivateIp} object that is the virtual IP (VIP) for vCenter. For information about {@code PrivateIp} objects, see the Core Services API.

Optional vcenterUsername

vcenterUsername: undefined | string

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

vmwareSoftwareVersion

vmwareSoftwareVersion: 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 {@code vmwareSoftwareVersion} with that new version.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Sddc): object

getJsonObj

  • getJsonObj(obj: Sddc): object