ClusterSummary¶

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

Bases: object

A summary of the Cluster.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ClusterSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ClusterSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ClusterSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ClusterSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ClusterSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ClusterSummary.
`VSPHERE_TYPE_MANAGEMENT`	A constant which can be used with the vsphere_type property of a ClusterSummary.
`VSPHERE_TYPE_WORKLOAD`	A constant which can be used with the vsphere_type property of a ClusterSummary.
`compartment_id`	[Required] Gets the compartment_id of this ClusterSummary.
`compute_availability_domain`	[Required] Gets the compute_availability_domain of this ClusterSummary.
`defined_tags`	[Required] Gets the defined_tags of this ClusterSummary.
`display_name`	[Required] Gets the display_name of this ClusterSummary.
`esxi_hosts_count`	[Required] Gets the esxi_hosts_count of this ClusterSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this ClusterSummary.
`id`	[Required] Gets the id of this ClusterSummary.
`initial_host_ocpu_count`	Gets the initial_host_ocpu_count of this ClusterSummary.
`initial_host_shape_name`	[Required] Gets the initial_host_shape_name of this ClusterSummary.
`is_shielded_instance_enabled`	Gets the is_shielded_instance_enabled of this ClusterSummary.
`lifecycle_state`	Gets the lifecycle_state of this ClusterSummary.
`sddc_id`	[Required] Gets the sddc_id of this ClusterSummary.
`system_tags`	Gets the system_tags of this ClusterSummary.
`time_created`	Gets the time_created of this ClusterSummary.
`time_updated`	Gets the time_updated of this ClusterSummary.
`vmware_software_version`	[Required] Gets the vmware_software_version of this ClusterSummary.
`vsphere_type`	[Required] Gets the vsphere_type of this ClusterSummary.

Methods

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

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

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new ClusterSummary 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 ClusterSummary.
compute_availability_domain (str) – The value to assign to the compute_availability_domain property of this ClusterSummary.
sddc_id (str) – The value to assign to the sddc_id property of this ClusterSummary.
display_name (str) – The value to assign to the display_name property of this ClusterSummary.
vmware_software_version (str) – The value to assign to the vmware_software_version property of this ClusterSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ClusterSummary.
esxi_hosts_count (int) – The value to assign to the esxi_hosts_count property of this ClusterSummary.
time_created (datetime) – The value to assign to the time_created property of this ClusterSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ClusterSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ClusterSummary. 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’.
is_shielded_instance_enabled (bool) – The value to assign to the is_shielded_instance_enabled property of this ClusterSummary.
initial_host_shape_name (str) – The value to assign to the initial_host_shape_name property of this ClusterSummary.
initial_host_ocpu_count (float) – The value to assign to the initial_host_ocpu_count property of this ClusterSummary.
vsphere_type (str) – The value to assign to the vsphere_type property of this ClusterSummary. 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 ClusterSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ClusterSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ClusterSummary.

compartment_id¶

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

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

compute_availability_domain¶

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

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

defined_tags¶

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

display_name¶

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

esxi_hosts_count¶

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

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

freeform_tags¶

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

id¶

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

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

initial_host_ocpu_count¶

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

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

initial_host_shape_name¶

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

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

is_shielded_instance_enabled¶

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

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

lifecycle_state¶

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

sddc_id¶

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

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

system_tags¶

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

time_created¶

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

time_updated¶

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

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

vmware_software_version¶

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

vsphere_type¶

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