CreateClusterDetails

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

Bases: object

Details of the Cluster.

Attributes:

INITIAL_COMMITMENT_HOUR

A constant which can be used with the initial_commitment property of a CreateClusterDetails.

INITIAL_COMMITMENT_MONTH

A constant which can be used with the initial_commitment property of a CreateClusterDetails.

INITIAL_COMMITMENT_ONE_YEAR

A constant which can be used with the initial_commitment property of a CreateClusterDetails.

INITIAL_COMMITMENT_THREE_YEARS

A constant which can be used with the initial_commitment property of a CreateClusterDetails.

INITIAL_FAULT_DOMAIN_HOST_DISTRIBUTION_EVENLY_DISTRIBUTED

A constant which can be used with the initial_fault_domain_host_distribution property of a CreateClusterDetails.

INITIAL_FAULT_DOMAIN_HOST_DISTRIBUTION_UNEVENLY_DISTRIBUTED

A constant which can be used with the initial_fault_domain_host_distribution property of a CreateClusterDetails.

capacity_reservation_id

Gets the capacity_reservation_id of this CreateClusterDetails.

cluster_byol_allocation_details

Gets the cluster_byol_allocation_details of this CreateClusterDetails.

compute_availability_domain

[Required] Gets the compute_availability_domain of this CreateClusterDetails.

datastore_cluster_ids

Gets the datastore_cluster_ids of this CreateClusterDetails.

datastores

Gets the datastores of this CreateClusterDetails.

defined_tags

Gets the defined_tags of this CreateClusterDetails.

display_name

Gets the display_name of this CreateClusterDetails.

esxi_hosts_count

[Required] Gets the esxi_hosts_count of this CreateClusterDetails.

esxi_software_version

Gets the esxi_software_version of this CreateClusterDetails.

freeform_tags

Gets the freeform_tags of this CreateClusterDetails.

initial_commitment

Gets the initial_commitment of this CreateClusterDetails.

initial_fault_domain_host_distribution

Gets the initial_fault_domain_host_distribution of this CreateClusterDetails.

initial_host_ocpu_count

Gets the initial_host_ocpu_count of this CreateClusterDetails.

initial_host_shape_name

Gets the initial_host_shape_name of this CreateClusterDetails.

initial_vcf_byol_allocation_id

Gets the initial_vcf_byol_allocation_id of this CreateClusterDetails.

instance_display_name_prefix

Gets the instance_display_name_prefix of this CreateClusterDetails.

is_shielded_instance_enabled

Gets the is_shielded_instance_enabled of this CreateClusterDetails.

network_configuration

[Required] Gets the network_configuration of this CreateClusterDetails.

sddc_id

[Required] Gets the sddc_id of this CreateClusterDetails.

vmware_software_version

Gets the vmware_software_version of this CreateClusterDetails.

workload_network_cidr

Gets the workload_network_cidr of this CreateClusterDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateClusterDetails object with values from keyword arguments.

INITIAL_COMMITMENT_HOUR = 'HOUR'

A constant which can be used with the initial_commitment property of a CreateClusterDetails. This constant has a value of “HOUR”

INITIAL_COMMITMENT_MONTH = 'MONTH'

A constant which can be used with the initial_commitment property of a CreateClusterDetails. 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 CreateClusterDetails. 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 CreateClusterDetails. This constant has a value of “THREE_YEARS”

INITIAL_FAULT_DOMAIN_HOST_DISTRIBUTION_EVENLY_DISTRIBUTED = 'EVENLY_DISTRIBUTED'

A constant which can be used with the initial_fault_domain_host_distribution property of a CreateClusterDetails. This constant has a value of “EVENLY_DISTRIBUTED”

INITIAL_FAULT_DOMAIN_HOST_DISTRIBUTION_UNEVENLY_DISTRIBUTED = 'UNEVENLY_DISTRIBUTED'

A constant which can be used with the initial_fault_domain_host_distribution property of a CreateClusterDetails. This constant has a value of “UNEVENLY_DISTRIBUTED”

__init__(**kwargs)

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

Parameters
  • sddc_id (str) – The value to assign to the sddc_id property of this CreateClusterDetails.

  • compute_availability_domain (str) – The value to assign to the compute_availability_domain property of this CreateClusterDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateClusterDetails.

  • instance_display_name_prefix (str) – The value to assign to the instance_display_name_prefix property of this CreateClusterDetails.

  • esxi_hosts_count (int) – The value to assign to the esxi_hosts_count property of this CreateClusterDetails.

  • network_configuration (oci.ocvp.models.NetworkConfiguration) – The value to assign to the network_configuration property of this CreateClusterDetails.

  • initial_commitment (str) – The value to assign to the initial_commitment property of this CreateClusterDetails. Allowed values for this property are: “HOUR”, “MONTH”, “ONE_YEAR”, “THREE_YEARS”

  • workload_network_cidr (str) – The value to assign to the workload_network_cidr property of this CreateClusterDetails.

  • initial_host_shape_name (str) – The value to assign to the initial_host_shape_name property of this CreateClusterDetails.

  • initial_host_ocpu_count (float) – The value to assign to the initial_host_ocpu_count property of this CreateClusterDetails.

  • is_shielded_instance_enabled (bool) – The value to assign to the is_shielded_instance_enabled property of this CreateClusterDetails.

  • capacity_reservation_id (str) – The value to assign to the capacity_reservation_id property of this CreateClusterDetails.

  • datastores (list[oci.ocvp.models.DatastoreInfo]) – The value to assign to the datastores property of this CreateClusterDetails.

  • datastore_cluster_ids (list[str]) – The value to assign to the datastore_cluster_ids property of this CreateClusterDetails.

  • vmware_software_version (str) – The value to assign to the vmware_software_version property of this CreateClusterDetails.

  • esxi_software_version (str) – The value to assign to the esxi_software_version property of this CreateClusterDetails.

  • initial_fault_domain_host_distribution (str) – The value to assign to the initial_fault_domain_host_distribution property of this CreateClusterDetails. Allowed values for this property are: “EVENLY_DISTRIBUTED”, “UNEVENLY_DISTRIBUTED”

  • cluster_byol_allocation_details (oci.ocvp.models.ClusterByolAllocationDetails) – The value to assign to the cluster_byol_allocation_details property of this CreateClusterDetails.

  • initial_vcf_byol_allocation_id (str) – The value to assign to the initial_vcf_byol_allocation_id property of this CreateClusterDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateClusterDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateClusterDetails.

property capacity_reservation_id

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

Returns

The capacity_reservation_id of this CreateClusterDetails.

Return type

str

property cluster_byol_allocation_details

Gets the cluster_byol_allocation_details of this CreateClusterDetails.

Returns

The cluster_byol_allocation_details of this CreateClusterDetails.

Return type

oci.ocvp.models.ClusterByolAllocationDetails

property compute_availability_domain

[Required] Gets the compute_availability_domain of this CreateClusterDetails. The availability domain to create the Cluster’s ESXi hosts in. For multi-AD Cluster deployment, set to multi-AD.

Returns

The compute_availability_domain of this CreateClusterDetails.

Return type

str

property datastore_cluster_ids

Gets the datastore_cluster_ids of this CreateClusterDetails. A list of datastore clusters.

Returns

The datastore_cluster_ids of this CreateClusterDetails.

Return type

list[str]

property datastores

Gets the datastores of this CreateClusterDetails. A list of datastore info for the Cluster. This value is required only when initialHostShapeName is a standard shape.

Returns

The datastores of this CreateClusterDetails.

Return type

list[oci.ocvp.models.DatastoreInfo]

property defined_tags

Gets the defined_tags of this CreateClusterDetails. 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 CreateClusterDetails.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this CreateClusterDetails. A descriptive name for the Cluster. Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. Avoid entering confidential information.

Returns

The display_name of this CreateClusterDetails.

Return type

str

property esxi_hosts_count

[Required] Gets the esxi_hosts_count of this CreateClusterDetails. The number of ESXi hosts to create in the Cluster. You can add more hosts later (see create_esxi_host()).

Note: If you later delete EXSi hosts from a production Cluster to make SDDC total host count less than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also, you cannot add more VMware workloads to the Cluster until the SDDC again has at least 3 ESXi hosts.

Returns

The esxi_hosts_count of this CreateClusterDetails.

Return type

int

property esxi_software_version

Gets the esxi_software_version of this CreateClusterDetails. The ESXi software bundle to install on the ESXi hosts in the Cluster. Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted. To get a list of the available versions, use list_supported_vmware_software_versions().

Returns

The esxi_software_version of this CreateClusterDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateClusterDetails. 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 CreateClusterDetails.

Return type

dict(str, str)

property initial_commitment

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

Allowed values for this property are: “HOUR”, “MONTH”, “ONE_YEAR”, “THREE_YEARS”

Returns

The initial_commitment of this CreateClusterDetails.

Return type

str

property initial_fault_domain_host_distribution

Gets the initial_fault_domain_host_distribution of this CreateClusterDetails. The initial fault domain host distribution mode for the Cluster.

Allowed values for this property are: “EVENLY_DISTRIBUTED”, “UNEVENLY_DISTRIBUTED”

Returns

The initial_fault_domain_host_distribution of this CreateClusterDetails.

Return type

str

property initial_host_ocpu_count

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

Returns

The initial_host_ocpu_count of this CreateClusterDetails.

Return type

float

property initial_host_shape_name

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

Returns

The initial_host_shape_name of this CreateClusterDetails.

Return type

str

property initial_vcf_byol_allocation_id

Gets the initial_vcf_byol_allocation_id of this CreateClusterDetails. The OCID of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation.

Returns

The initial_vcf_byol_allocation_id of this CreateClusterDetails.

Return type

str

property instance_display_name_prefix

Gets the instance_display_name_prefix of this CreateClusterDetails. 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 CreateClusterDetails.

Return type

str

property is_shielded_instance_enabled

Gets the is_shielded_instance_enabled of this CreateClusterDetails. Indicates whether shielded instance is enabled for this Cluster.

Returns

The is_shielded_instance_enabled of this CreateClusterDetails.

Return type

bool

property network_configuration

[Required] Gets the network_configuration of this CreateClusterDetails.

Returns

The network_configuration of this CreateClusterDetails.

Return type

oci.ocvp.models.NetworkConfiguration

property sddc_id

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

Returns

The sddc_id of this CreateClusterDetails.

Return type

str

property vmware_software_version

Gets the vmware_software_version of this CreateClusterDetails. The VMware software bundle to install on the ESXi hosts in the Cluster. To get a list of the available versions, use list_supported_vmware_software_versions().

Returns

The vmware_software_version of this CreateClusterDetails.

Return type

str

property workload_network_cidr

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

Returns

The workload_network_cidr of this CreateClusterDetails.

Return type

str