Sddc¶

class oci.ocvp.models.Sddc(**kwargs)¶

Bases: object

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.

Attributes

`HCX_MODE_ADVANCED`	A constant which can be used with the hcx_mode property of a Sddc.
`HCX_MODE_DISABLED`	A constant which can be used with the hcx_mode property of a Sddc.
`HCX_MODE_ENTERPRISE`	A constant which can be used with the hcx_mode property of a Sddc.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Sddc.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Sddc.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Sddc.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Sddc.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Sddc.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Sddc.
`clusters_count`	[Required] Gets the clusters_count of this Sddc.
`compartment_id`	[Required] Gets the compartment_id of this Sddc.
`defined_tags`	[Required] Gets the defined_tags of this Sddc.
`display_name`	[Required] Gets the display_name of this Sddc.
`esxi_software_version`	Gets the esxi_software_version of this Sddc.
`freeform_tags`	[Required] Gets the freeform_tags of this Sddc.
`hcx_fqdn`	Gets the hcx_fqdn of this Sddc.
`hcx_mode`	[Required] Gets the hcx_mode of this Sddc.
`hcx_on_prem_licenses`	Gets the hcx_on_prem_licenses of this Sddc.
`hcx_private_ip_id`	Gets the hcx_private_ip_id of this Sddc.
`id`	[Required] Gets the id of this Sddc.
`initial_configuration`	[Required] Gets the initial_configuration of this Sddc.
`is_hcx_pending_downgrade`	Gets the is_hcx_pending_downgrade of this Sddc.
`is_single_host_sddc`	Gets the is_single_host_sddc of this Sddc.
`lifecycle_state`	Gets the lifecycle_state of this Sddc.
`nsx_edge_uplink_ip_id`	Gets the nsx_edge_uplink_ip_id of this Sddc.
`nsx_manager_fqdn`	[Required] Gets the nsx_manager_fqdn of this Sddc.
`nsx_manager_private_ip_id`	[Required] Gets the nsx_manager_private_ip_id of this Sddc.
`nsx_manager_username`	Gets the nsx_manager_username of this Sddc.
`ssh_authorized_keys`	[Required] Gets the ssh_authorized_keys of this Sddc.
`system_tags`	Gets the system_tags of this Sddc.
`time_created`	[Required] Gets the time_created of this Sddc.
`time_hcx_billing_cycle_end`	Gets the time_hcx_billing_cycle_end of this Sddc.
`time_hcx_license_status_updated`	Gets the time_hcx_license_status_updated of this Sddc.
`time_updated`	Gets the time_updated of this Sddc.
`vcenter_fqdn`	[Required] Gets the vcenter_fqdn of this Sddc.
`vcenter_private_ip_id`	[Required] Gets the vcenter_private_ip_id of this Sddc.
`vcenter_username`	Gets the vcenter_username of this Sddc.
`vmware_software_version`	[Required] Gets the vmware_software_version of this Sddc.

Methods

__init__(**kwargs) Initializes a new Sddc object with values from keyword arguments.

HCX_MODE_ADVANCED = 'ADVANCED'¶: A constant which can be used with the hcx_mode property of a Sddc. This constant has a value of “ADVANCED”

HCX_MODE_DISABLED = 'DISABLED'¶: A constant which can be used with the hcx_mode property of a Sddc. This constant has a value of “DISABLED”

HCX_MODE_ENTERPRISE = 'ENTERPRISE'¶: A constant which can be used with the hcx_mode property of a Sddc. This constant has a value of “ENTERPRISE”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Sddc. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Sddc. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Sddc. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Sddc. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Sddc. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Sddc. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new Sddc object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this Sddc.
display_name (str) – The value to assign to the display_name property of this Sddc.
vmware_software_version (str) – The value to assign to the vmware_software_version property of this Sddc.
esxi_software_version (str) – The value to assign to the esxi_software_version property of this Sddc.
compartment_id (str) – The value to assign to the compartment_id property of this Sddc.
clusters_count (int) – The value to assign to the clusters_count property of this Sddc.
vcenter_fqdn (str) – The value to assign to the vcenter_fqdn property of this Sddc.
nsx_manager_fqdn (str) – The value to assign to the nsx_manager_fqdn property of this Sddc.
vcenter_private_ip_id (str) – The value to assign to the vcenter_private_ip_id property of this Sddc.
nsx_manager_private_ip_id (str) – The value to assign to the nsx_manager_private_ip_id property of this Sddc.
vcenter_username (str) – The value to assign to the vcenter_username property of this Sddc.
nsx_manager_username (str) – The value to assign to the nsx_manager_username property of this Sddc.
ssh_authorized_keys (str) – The value to assign to the ssh_authorized_keys property of this Sddc.
nsx_edge_uplink_ip_id (str) – The value to assign to the nsx_edge_uplink_ip_id property of this Sddc.
hcx_private_ip_id (str) – The value to assign to the hcx_private_ip_id property of this Sddc.
hcx_fqdn (str) – The value to assign to the hcx_fqdn property of this Sddc.
hcx_mode (str) – The value to assign to the hcx_mode property of this Sddc. Allowed values for this property are: “DISABLED”, “ADVANCED”, “ENTERPRISE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
initial_configuration (oci.ocvp.models.InitialConfiguration) – The value to assign to the initial_configuration property of this Sddc.
is_hcx_pending_downgrade (bool) – The value to assign to the is_hcx_pending_downgrade property of this Sddc.
hcx_on_prem_licenses (list[oci.ocvp.models.HcxLicenseSummary]) – The value to assign to the hcx_on_prem_licenses property of this Sddc.
time_hcx_billing_cycle_end (datetime) – The value to assign to the time_hcx_billing_cycle_end property of this Sddc.
time_hcx_license_status_updated (datetime) – The value to assign to the time_hcx_license_status_updated property of this Sddc.
is_single_host_sddc (bool) – The value to assign to the is_single_host_sddc property of this Sddc.
time_created (datetime) – The value to assign to the time_created property of this Sddc.
time_updated (datetime) – The value to assign to the time_updated property of this Sddc.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Sddc. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Sddc.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Sddc.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Sddc.

clusters_count¶

[Required] Gets the clusters_count of this Sddc. The number of Clusters in the SDDC.

Returns:	The clusters_count of this Sddc.
Return type:	int

compartment_id¶

[Required] Gets the compartment_id of this Sddc. The OCID of the compartment that contains the SDDC.

Returns:	The compartment_id of this Sddc.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this Sddc. 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 defined_tags of this Sddc.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this Sddc. 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 display_name of this Sddc.
Return type:	str

esxi_software_version¶

Gets the esxi_software_version of this Sddc. In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see list_supported_vmware_software_versions()).

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 create_esxi_host() 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 update_sddc() to update the SDDC’s vmwareSoftwareVersion with that new version.

Returns:	The esxi_software_version of this Sddc.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this Sddc. 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 freeform_tags of this Sddc.
Return type:	dict(str, str)

hcx_fqdn¶

Gets the hcx_fqdn of this Sddc. The FQDN for HCX Manager.

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

Returns:	The hcx_fqdn of this Sddc.
Return type:	str

hcx_mode¶

[Required] Gets the hcx_mode of this Sddc. HCX configuration of the SDDC.

Allowed values for this property are: “DISABLED”, “ADVANCED”, “ENTERPRISE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The hcx_mode of this Sddc.
Return type:	str

hcx_on_prem_licenses¶

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

Returns:	The hcx_on_prem_licenses of this Sddc.
Return type:	list[oci.ocvp.models.HcxLicenseSummary]

hcx_private_ip_id¶

Gets the hcx_private_ip_id of this Sddc. 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 hcx_private_ip_id of this Sddc.
Return type:	str

id¶

[Required] Gets the id of this Sddc. The OCID of the SDDC.

Returns:	The id of this Sddc.
Return type:	str

initial_configuration¶

[Required] Gets the initial_configuration of this Sddc.

Returns:	The initial_configuration of this Sddc.
Return type:	oci.ocvp.models.InitialConfiguration

is_hcx_pending_downgrade¶

Gets the is_hcx_pending_downgrade of this Sddc. Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.

Returns:	The is_hcx_pending_downgrade of this Sddc.
Return type:	bool

is_single_host_sddc¶

Gets the is_single_host_sddc of this Sddc. Indicates whether this SDDC is designated for only single ESXi host.

Returns:	The is_single_host_sddc of this Sddc.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this Sddc. The current state of the SDDC.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Sddc.
Return type:	str

nsx_edge_uplink_ip_id¶

Gets the nsx_edge_uplink_ip_id of this Sddc. 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 nsx_edge_uplink_ip_id of this Sddc.
Return type:	str

nsx_manager_fqdn¶

[Required] Gets the nsx_manager_fqdn of this Sddc. The FQDN for NSX Manager.

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

Returns:	The nsx_manager_fqdn of this Sddc.
Return type:	str

nsx_manager_private_ip_id¶

[Required] Gets the nsx_manager_private_ip_id of this Sddc. 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 nsx_manager_private_ip_id of this Sddc.
Return type:	str

nsx_manager_username¶

Gets the nsx_manager_username of this Sddc. 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 nsx_manager_username of this Sddc.
Return type:	str

ssh_authorized_keys¶

[Required] Gets the ssh_authorized_keys of this Sddc. 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 create_esxi_host().

Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different SSH keys, you should use update_sddc() to update the SDDC’s sshAuthorizedKeys with the new public keys.

Returns:	The ssh_authorized_keys of this Sddc.
Return type:	str

system_tags¶

Gets the system_tags of this Sddc. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:	The system_tags of this Sddc.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this Sddc. The date and time the SDDC was created, in the format defined by RFC3339.

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

Returns:	The time_created of this Sddc.
Return type:	datetime

time_hcx_billing_cycle_end¶

Gets the time_hcx_billing_cycle_end of this Sddc. 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 time_hcx_billing_cycle_end of this Sddc.
Return type:	datetime

time_hcx_license_status_updated¶

Gets the time_hcx_license_status_updated of this Sddc. 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 time_hcx_license_status_updated of this Sddc.
Return type:	datetime

time_updated¶

Gets the time_updated of this Sddc. The date and time the SDDC was updated, in the format defined by RFC3339.

Returns:	The time_updated of this Sddc.
Return type:	datetime

vcenter_fqdn¶

[Required] Gets the vcenter_fqdn of this Sddc. The FQDN for vCenter.

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

Returns:	The vcenter_fqdn of this Sddc.
Return type:	str

vcenter_private_ip_id¶

[Required] Gets the vcenter_private_ip_id of this Sddc. 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 vcenter_private_ip_id of this Sddc.
Return type:	str

vcenter_username¶

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

Returns:	The vcenter_username of this Sddc.
Return type:	str

vmware_software_version¶

[Required] Gets the vmware_software_version of this Sddc. In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see list_supported_vmware_software_versions()).

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 create_esxi_host().

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 update_sddc() to update the SDDC’s vmwareSoftwareVersion with that new version.

Returns:	The vmware_software_version of this Sddc.
Return type:	str