Class Sddc


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20230701")
    public final class Sddc
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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.
    Note: Objects should always be created or deserialized using the Sddc.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 Sddc.Builder, which maintain a set of all explicitly set fields called Sddc.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

      • builder

        public static Sddc.Builder builder()
        Create a new builder.
      • getId

        public String getId()
        The OCID of the SDDC.
        Returns:
        the value
      • getDisplayName

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

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

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

        Returns:
        the value
      • getCompartmentId

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

        public Integer getClustersCount()
        The number of Clusters in the SDDC.
        Returns:
        the value
      • getVcenterFqdn

        public String getVcenterFqdn()
        The FQDN for vCenter.

        Example: vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com

        Returns:
        the value
      • getNsxManagerFqdn

        public String getNsxManagerFqdn()
        The FQDN for NSX Manager.

        Example: nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com

        Returns:
        the value
      • getVcenterPrivateIpId

        public String getVcenterPrivateIpId()
        The OCID of the PrivateIp object that is the virtual IP (VIP) for vCenter.

        For information about PrivateIp objects, see the Core Services API.

        Returns:
        the value
      • getNsxManagerPrivateIpId

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

        Returns:
        the value
      • getVcenterUsername

        public String getVcenterUsername()
        The SDDC includes an administrator username and password for vCenter.

        You can change this initial username to a different value in vCenter.

        Returns:
        the value
      • getNsxManagerUsername

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

        Returns:
        the value
      • getSshAuthorizedKeys

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

        Returns:
        the value
      • getNsxEdgeUplinkIpId

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

        Returns:
        the value
      • getHcxPrivateIpId

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

        Returns:
        the value
      • getHcxFqdn

        public String getHcxFqdn()
        The FQDN for HCX Manager.

        Example: hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com

        Returns:
        the value
      • getHcxMode

        public HcxModes getHcxMode()
        HCX configuration of the SDDC.
        Returns:
        the value
      • getIsHcxPendingDowngrade

        public Boolean getIsHcxPendingDowngrade()
        Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.
        Returns:
        the value
      • getHcxOnPremLicenses

        public List<HcxLicenseSummary> getHcxOnPremLicenses()
        The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution.
        Returns:
        the value
      • getTimeHcxBillingCycleEnd

        public Date getTimeHcxBillingCycleEnd()
        The date and time current HCX Enterprise billing cycle ends, in the format defined by RFC3339.

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

        Returns:
        the value
      • getTimeHcxLicenseStatusUpdated

        public Date getTimeHcxLicenseStatusUpdated()
        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

        Returns:
        the value
      • getIsSingleHostSddc

        public Boolean getIsSingleHostSddc()
        Indicates whether this SDDC is designated for only single ESXi host.
        Returns:
        the value
      • getTimeCreated

        public Date getTimeCreated()
        The date and time the SDDC 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 SDDC was updated, in the format defined by RFC3339.
        Returns:
        the value
      • getLifecycleState

        public LifecycleStates getLifecycleState()
        The current state of the SDDC.
        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