Sddc

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

Bases: object

A 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

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.
compartment_id [Required] Gets the compartment_id of this Sddc.
compute_availability_domain [Required] Gets the compute_availability_domain of this Sddc.
defined_tags [Required] Gets the defined_tags of this Sddc.
display_name [Required] Gets the display_name of this Sddc.
esxi_hosts_count [Required] Gets the esxi_hosts_count of this Sddc.
freeform_tags [Required] Gets the freeform_tags of this Sddc.
hcx_fqdn Gets the hcx_fqdn of this Sddc.
hcx_initial_password Gets the hcx_initial_password of this Sddc.
hcx_on_prem_key Gets the hcx_on_prem_key of this Sddc.
hcx_private_ip_id Gets the hcx_private_ip_id of this Sddc.
hcx_vlan_id Gets the hcx_vlan_id of this Sddc.
id [Required] Gets the id of this Sddc.
instance_display_name_prefix Gets the instance_display_name_prefix of this Sddc.
is_hcx_enabled Gets the is_hcx_enabled of this Sddc.
lifecycle_state Gets the lifecycle_state of this Sddc.
nsx_edge_uplink1_vlan_id [Required] Gets the nsx_edge_uplink1_vlan_id of this Sddc.
nsx_edge_uplink2_vlan_id [Required] Gets the nsx_edge_uplink2_vlan_id of this Sddc.
nsx_edge_uplink_ip_id Gets the nsx_edge_uplink_ip_id of this Sddc.
nsx_edge_v_tep_vlan_id [Required] Gets the nsx_edge_v_tep_vlan_id of this Sddc.
nsx_manager_fqdn [Required] Gets the nsx_manager_fqdn of this Sddc.
nsx_manager_initial_password Gets the nsx_manager_initial_password 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.
nsx_overlay_segment_name Gets the nsx_overlay_segment_name of this Sddc.
nsx_v_tep_vlan_id [Required] Gets the nsx_v_tep_vlan_id of this Sddc.
provisioning_subnet_id [Required] Gets the provisioning_subnet_id of this Sddc.
ssh_authorized_keys [Required] Gets the ssh_authorized_keys of this Sddc.
time_created [Required] Gets the time_created of this Sddc.
time_updated Gets the time_updated of this Sddc.
vcenter_fqdn [Required] Gets the vcenter_fqdn of this Sddc.
vcenter_initial_password Gets the vcenter_initial_password 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.
vmotion_vlan_id [Required] Gets the vmotion_vlan_id of this Sddc.
vmware_software_version [Required] Gets the vmware_software_version of this Sddc.
vsan_vlan_id [Required] Gets the vsan_vlan_id of this Sddc.
vsphere_vlan_id [Required] Gets the vsphere_vlan_id of this Sddc.
workload_network_cidr Gets the workload_network_cidr of this Sddc.

Methods

__init__(**kwargs) Initializes a new Sddc object with values from keyword arguments.
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.
  • compute_availability_domain (str) – The value to assign to the compute_availability_domain property of this Sddc.
  • display_name (str) – The value to assign to the display_name property of this Sddc.
  • instance_display_name_prefix (str) – The value to assign to the instance_display_name_prefix property of this Sddc.
  • vmware_software_version (str) – The value to assign to the vmware_software_version property of this Sddc.
  • compartment_id (str) – The value to assign to the compartment_id property of this Sddc.
  • esxi_hosts_count (int) – The value to assign to the esxi_hosts_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_initial_password (str) – The value to assign to the vcenter_initial_password property of this Sddc.
  • nsx_manager_initial_password (str) – The value to assign to the nsx_manager_initial_password 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.
  • workload_network_cidr (str) – The value to assign to the workload_network_cidr property of this Sddc.
  • nsx_overlay_segment_name (str) – The value to assign to the nsx_overlay_segment_name 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.
  • provisioning_subnet_id (str) – The value to assign to the provisioning_subnet_id property of this Sddc.
  • vsphere_vlan_id (str) – The value to assign to the vsphere_vlan_id property of this Sddc.
  • vmotion_vlan_id (str) – The value to assign to the vmotion_vlan_id property of this Sddc.
  • vsan_vlan_id (str) – The value to assign to the vsan_vlan_id property of this Sddc.
  • nsx_v_tep_vlan_id (str) – The value to assign to the nsx_v_tep_vlan_id property of this Sddc.
  • nsx_edge_v_tep_vlan_id (str) – The value to assign to the nsx_edge_v_tep_vlan_id property of this Sddc.
  • nsx_edge_uplink1_vlan_id (str) – The value to assign to the nsx_edge_uplink1_vlan_id property of this Sddc.
  • nsx_edge_uplink2_vlan_id (str) – The value to assign to the nsx_edge_uplink2_vlan_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_initial_password (str) – The value to assign to the hcx_initial_password property of this Sddc.
  • hcx_vlan_id (str) – The value to assign to the hcx_vlan_id property of this Sddc.
  • is_hcx_enabled (bool) – The value to assign to the is_hcx_enabled property of this Sddc.
  • hcx_on_prem_key (str) – The value to assign to the hcx_on_prem_key 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.
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
compute_availability_domain

[Required] Gets the compute_availability_domain of this Sddc. The availability domain the ESXi hosts are running in.

Example: Uocm:PHX-AD-1

Returns:The compute_availability_domain 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_hosts_count

[Required] Gets the esxi_hosts_count of this Sddc. The number of ESXi hosts in the SDDC.

Returns:The esxi_hosts_count of this Sddc.
Return type:int
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. HCX Fully Qualified Domain Name

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

Gets the hcx_initial_password of this Sddc. HCX initial password

Returns:The hcx_initial_password of this Sddc.
Return type:str
hcx_on_prem_key

Gets the hcx_on_prem_key of this Sddc. HCX on-premise license key

Returns:The hcx_on_prem_key of this Sddc.
Return type:str
hcx_private_ip_id

Gets the hcx_private_ip_id of this Sddc. HCX Private IP

Returns:The hcx_private_ip_id of this Sddc.
Return type:str
hcx_vlan_id

Gets the hcx_vlan_id of this Sddc. HCX vlan id

Returns:The hcx_vlan_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
instance_display_name_prefix

Gets the instance_display_name_prefix of this Sddc. A prefix used in the name of each ESXi host and Compute instance in the SDDC. If this isn’t set, the SDDC’s displayName is used as the prefix.

For example, if the value is MySDDC, the ESXi hosts are named MySDDC-1, MySDDC-2, and so on.

Returns:The instance_display_name_prefix of this Sddc.
Return type:str
is_hcx_enabled

Gets the is_hcx_enabled of this Sddc. HCX enabled or not

Returns:The is_hcx_enabled 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_uplink1_vlan_id

[Required] Gets the nsx_edge_uplink1_vlan_id of this Sddc. The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment.

This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with create_esxi_host().

Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the NSX Edge Uplink 1 component of the VMware environment, you should use update_sddc() to update the SDDC’s nsxEdgeUplink1VlanId with that new VLAN’s OCID.

Returns:The nsx_edge_uplink1_vlan_id of this Sddc.
Return type:str
nsx_edge_uplink2_vlan_id

[Required] Gets the nsx_edge_uplink2_vlan_id of this Sddc. The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment.

This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with create_esxi_host().

Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the NSX Edge Uplink 2 component of the VMware environment, you should use update_sddc() to update the SDDC’s nsxEdgeUplink2VlanId with that new VLAN’s OCID.

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

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_edge_v_tep_vlan_id

[Required] Gets the nsx_edge_v_tep_vlan_id of this Sddc. The OCID of the VLAN used by the SDDC for the NSX Edge VTEP component of the VMware environment.

This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the NSX Edge VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with create_esxi_host().

Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the NSX Edge VTEP component of the VMware environment, you should use update_sddc() to update the SDDC’s nsxEdgeVTepVlanId with that new VLAN’s OCID.

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

[Required] Gets the nsx_manager_fqdn of this Sddc. 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_initial_password

Gets the nsx_manager_initial_password of this Sddc. The SDDC includes an administrator username and initial password for NSX Manager. Make sure to change this initial NSX Manager password to a different value.

Returns:The nsx_manager_initial_password 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
nsx_overlay_segment_name

Gets the nsx_overlay_segment_name of this Sddc. The VMware NSX overlay workload segment to host your application. Connect to workload portgroup in vCenter to access this overlay segment.

Returns:The nsx_overlay_segment_name of this Sddc.
Return type:str
nsx_v_tep_vlan_id

[Required] Gets the nsx_v_tep_vlan_id of this Sddc. The OCID of the VLAN used by the SDDC for the NSX VTEP component of the VMware environment.

This attribute is not guaranteed to reflect the NSX VTEP VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the NSX VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with create_esxi_host().

Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the NSX VTEP component of the VMware environment, you should use update_sddc() to update the SDDC’s nsxVTepVlanId with that new VLAN’s OCID.

Returns:The nsx_v_tep_vlan_id of this Sddc.
Return type:str
provisioning_subnet_id

[Required] Gets the provisioning_subnet_id of this Sddc. The OCID of the management subnet used to provision the SDDC.

Returns:The provisioning_subnet_id 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
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_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. FQDN for vCenter

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

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

Gets the vcenter_initial_password of this Sddc. The SDDC includes an administrator username and initial password for vCenter. Make sure to change this initial vCenter password to a different value.

Returns:The vcenter_initial_password 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 initial 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
vmotion_vlan_id

[Required] Gets the vmotion_vlan_id of this Sddc. The OCID of the VLAN used by the SDDC for the vMotion component of the VMware environment.

This attribute is not guaranteed to reflect the vMotion VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the vMotion VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with create_esxi_host().

Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the vMotion component of the VMware environment, you should use update_sddc() to update the SDDC’s vmotionVlanId with that new VLAN’s OCID.

Returns:The vmotion_vlan_id 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 :func:` _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
vsan_vlan_id

[Required] Gets the vsan_vlan_id of this Sddc. The OCID of the VLAN used by the SDDC for the vSAN component of the VMware environment.

This attribute is not guaranteed to reflect the vSAN VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the vSAN VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with create_esxi_host().

Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the vSAN component of the VMware environment, you should use update_sddc() to update the SDDC’s vsanVlanId with that new VLAN’s OCID.

Returns:The vsan_vlan_id of this Sddc.
Return type:str
vsphere_vlan_id

[Required] Gets the vsphere_vlan_id of this Sddc. The OCID of the VLAN used by the SDDC for the vSphere component of the VMware environment.

This attribute is not guaranteed to reflect the vSphere VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the vSphere VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you add to this SDDC in the future with create_esxi_host().

Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the vSphere component of the VMware environment, you should use update_sddc() to update the SDDC’s vsphereVlanId with that new VLAN’s OCID.

Returns:The vsphere_vlan_id of this Sddc.
Return type:str
workload_network_cidr

Gets the workload_network_cidr of this Sddc. The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.

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