Cluster¶

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

Bases: object

An Oracle Cloud VMware Solution Cluster contains the resources required for a functional VMware environment. Instances in a Cluster (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 Cluster.

The Cluster uses a single management subnet for provisioning the Cluster. 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

`INITIAL_COMMITMENT_HOUR`	A constant which can be used with the initial_commitment property of a Cluster.
`INITIAL_COMMITMENT_MONTH`	A constant which can be used with the initial_commitment property of a Cluster.
`INITIAL_COMMITMENT_ONE_YEAR`	A constant which can be used with the initial_commitment property of a Cluster.
`INITIAL_COMMITMENT_THREE_YEARS`	A constant which can be used with the initial_commitment property of a Cluster.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Cluster.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Cluster.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Cluster.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Cluster.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Cluster.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Cluster.
`VSPHERE_TYPE_MANAGEMENT`	A constant which can be used with the vsphere_type property of a Cluster.
`VSPHERE_TYPE_WORKLOAD`	A constant which can be used with the vsphere_type property of a Cluster.
`capacity_reservation_id`	Gets the capacity_reservation_id of this Cluster.
`compartment_id`	[Required] Gets the compartment_id of this Cluster.
`compute_availability_domain`	[Required] Gets the compute_availability_domain of this Cluster.
`datastores`	Gets the datastores of this Cluster.
`defined_tags`	[Required] Gets the defined_tags of this Cluster.
`display_name`	[Required] Gets the display_name of this Cluster.
`esxi_hosts_count`	[Required] Gets the esxi_hosts_count of this Cluster.
`esxi_software_version`	Gets the esxi_software_version of this Cluster.
`freeform_tags`	[Required] Gets the freeform_tags of this Cluster.
`id`	[Required] Gets the id of this Cluster.
`initial_commitment`	Gets the initial_commitment of this Cluster.
`initial_host_ocpu_count`	Gets the initial_host_ocpu_count of this Cluster.
`initial_host_shape_name`	[Required] Gets the initial_host_shape_name of this Cluster.
`instance_display_name_prefix`	Gets the instance_display_name_prefix of this Cluster.
`is_shielded_instance_enabled`	Gets the is_shielded_instance_enabled of this Cluster.
`lifecycle_state`	Gets the lifecycle_state of this Cluster.
`network_configuration`	[Required] Gets the network_configuration of this Cluster.
`sddc_id`	[Required] Gets the sddc_id of this Cluster.
`system_tags`	Gets the system_tags of this Cluster.
`time_created`	[Required] Gets the time_created of this Cluster.
`time_updated`	Gets the time_updated of this Cluster.
`upgrade_licenses`	Gets the upgrade_licenses of this Cluster.
`vmware_software_version`	[Required] Gets the vmware_software_version of this Cluster.
`vsphere_type`	[Required] Gets the vsphere_type of this Cluster.
`vsphere_upgrade_objects`	Gets the vsphere_upgrade_objects of this Cluster.
`workload_network_cidr`	Gets the workload_network_cidr of this Cluster.

Methods

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

INITIAL_COMMITMENT_HOUR = 'HOUR'¶: A constant which can be used with the initial_commitment property of a Cluster. This constant has a value of “HOUR”

INITIAL_COMMITMENT_MONTH = 'MONTH'¶: A constant which can be used with the initial_commitment property of a Cluster. This constant has a value of “MONTH”

INITIAL_COMMITMENT_ONE_YEAR = 'ONE_YEAR'¶: A constant which can be used with the initial_commitment property of a Cluster. This constant has a value of “ONE_YEAR”

INITIAL_COMMITMENT_THREE_YEARS = 'THREE_YEARS'¶: A constant which can be used with the initial_commitment property of a Cluster. This constant has a value of “THREE_YEARS”

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

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

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

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

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

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

VSPHERE_TYPE_MANAGEMENT = 'MANAGEMENT'¶: A constant which can be used with the vsphere_type property of a Cluster. This constant has a value of “MANAGEMENT”

VSPHERE_TYPE_WORKLOAD = 'WORKLOAD'¶: A constant which can be used with the vsphere_type property of a Cluster. This constant has a value of “WORKLOAD”

__init__(**kwargs)¶

Initializes a new Cluster 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 Cluster.
compute_availability_domain (str) – The value to assign to the compute_availability_domain property of this Cluster.
display_name (str) – The value to assign to the display_name property of this Cluster.
instance_display_name_prefix (str) – The value to assign to the instance_display_name_prefix property of this Cluster.
vmware_software_version (str) – The value to assign to the vmware_software_version property of this Cluster.
esxi_software_version (str) – The value to assign to the esxi_software_version property of this Cluster.
compartment_id (str) – The value to assign to the compartment_id property of this Cluster.
sddc_id (str) – The value to assign to the sddc_id property of this Cluster.
esxi_hosts_count (int) – The value to assign to the esxi_hosts_count property of this Cluster.
initial_commitment (str) – The value to assign to the initial_commitment property of this Cluster. Allowed values for this property are: “HOUR”, “MONTH”, “ONE_YEAR”, “THREE_YEARS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
workload_network_cidr (str) – The value to assign to the workload_network_cidr property of this Cluster.
network_configuration (oci.ocvp.models.NetworkConfiguration) – The value to assign to the network_configuration property of this Cluster.
time_created (datetime) – The value to assign to the time_created property of this Cluster.
time_updated (datetime) – The value to assign to the time_updated property of this Cluster.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Cluster. 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’.
upgrade_licenses (list[oci.ocvp.models.VsphereLicense]) – The value to assign to the upgrade_licenses property of this Cluster.
vsphere_upgrade_objects (list[oci.ocvp.models.VsphereUpgradeObject]) – The value to assign to the vsphere_upgrade_objects property of this Cluster.
initial_host_shape_name (str) – The value to assign to the initial_host_shape_name property of this Cluster.
initial_host_ocpu_count (float) – The value to assign to the initial_host_ocpu_count property of this Cluster.
is_shielded_instance_enabled (bool) – The value to assign to the is_shielded_instance_enabled property of this Cluster.
capacity_reservation_id (str) – The value to assign to the capacity_reservation_id property of this Cluster.
datastores (list[oci.ocvp.models.DatastoreDetails]) – The value to assign to the datastores property of this Cluster.
vsphere_type (str) – The value to assign to the vsphere_type property of this Cluster. Allowed values for this property are: “MANAGEMENT”, “WORKLOAD”, ‘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 Cluster.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Cluster.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Cluster.

capacity_reservation_id¶

Gets the capacity_reservation_id of this Cluster. The OCID of the Capacity Reservation.

Returns:	The capacity_reservation_id of this Cluster.
Return type:	str

compartment_id¶

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

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

compute_availability_domain¶

[Required] Gets the compute_availability_domain of this Cluster. The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD.

Example: Uocm:PHX-AD-1, multi-AD

Returns:	The compute_availability_domain of this Cluster.
Return type:	str

datastores¶

Gets the datastores of this Cluster. Datastores used for the Cluster.

Returns:	The datastores of this Cluster.
Return type:	list[oci.ocvp.models.DatastoreDetails]

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this Cluster. A descriptive name for the Cluster. 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 Cluster.
Return type:	str

esxi_hosts_count¶

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

Returns:	The esxi_hosts_count of this Cluster.
Return type:	int

esxi_software_version¶

Gets the esxi_software_version of this Cluster. 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 ESXi host level.

Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you should use update_cluster() to update the Cluster’s esxiSoftwareVersion with that new version.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this Cluster. The OCID of the Cluster.

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

initial_commitment¶

Gets the initial_commitment of this Cluster. The billing option selected during Cluster creation. list_supported_commitments().

Allowed values for this property are: “HOUR”, “MONTH”, “ONE_YEAR”, “THREE_YEARS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The initial_commitment of this Cluster.
Return type:	str

initial_host_ocpu_count¶

Gets the initial_host_ocpu_count of this Cluster. The initial OCPU count of the Cluster’s ESXi hosts.

Returns:	The initial_host_ocpu_count of this Cluster.
Return type:	float

initial_host_shape_name¶

[Required] Gets the initial_host_shape_name of this Cluster. The initial compute shape of the Cluster’s ESXi hosts. list_supported_host_shapes().

Returns:	The initial_host_shape_name of this Cluster.
Return type:	str

instance_display_name_prefix¶

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

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

Returns:	The instance_display_name_prefix of this Cluster.
Return type:	str

is_shielded_instance_enabled¶

Gets the is_shielded_instance_enabled of this Cluster. Indicates whether shielded instance is enabled at the Cluster level.

Returns:	The is_shielded_instance_enabled of this Cluster.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this Cluster. The current state of the Cluster.

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 Cluster.
Return type:	str

network_configuration¶

[Required] Gets the network_configuration of this Cluster.

Returns:	The network_configuration of this Cluster.
Return type:	oci.ocvp.models.NetworkConfiguration

sddc_id¶

[Required] Gets the sddc_id of this Cluster. The OCID of the SDDC that the Cluster belongs to.

Returns:	The sddc_id of this Cluster.
Return type:	str

system_tags¶

Gets the system_tags of this Cluster. 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 Cluster.
Return type:	dict(str, dict(str, object))

time_created¶

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

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

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

time_updated¶

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

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

upgrade_licenses¶

Gets the upgrade_licenses of this Cluster. The vSphere licenses to use when upgrading the Cluster.

Returns:	The upgrade_licenses of this Cluster.
Return type:	list[oci.ocvp.models.VsphereLicense]

vmware_software_version¶

[Required] Gets the vmware_software_version of this Cluster. 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 Cluster. 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 Cluster in the future with create_esxi_host().

Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use update_cluster() to update the Cluster’s vmwareSoftwareVersion with that new version.

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

vsphere_type¶

[Required] Gets the vsphere_type of this Cluster. vSphere Cluster types.

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

Returns:	The vsphere_type of this Cluster.
Return type:	str

vsphere_upgrade_objects¶

Gets the vsphere_upgrade_objects of this Cluster. The links to binary objects needed to upgrade vSphere.

Returns:	The vsphere_upgrade_objects of this Cluster.
Return type:	list[oci.ocvp.models.VsphereUpgradeObject]

workload_network_cidr¶

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