EsxiHost¶
- class oci.ocvp.models.EsxiHost(**kwargs)¶
Bases:
objectAn ESXi host is a node in a Cluster. At a minimum, each Cluster has 3 ESXi hosts that are used to implement a functioning VMware environment.
In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software.
Notice that an EsxiHost object has its own OCID (id), and a separate attribute for the OCID of the Compute instance (computeInstanceId).
Attributes:
A constant which can be used with the current_commitment property of a EsxiHost.
A constant which can be used with the current_commitment property of a EsxiHost.
A constant which can be used with the current_commitment property of a EsxiHost.
A constant which can be used with the current_commitment property of a EsxiHost.
A constant which can be used with the initial_fault_domain_host_distribution property of a EsxiHost.
A constant which can be used with the initial_fault_domain_host_distribution property of a EsxiHost.
A constant which can be used with the lifecycle_state property of a EsxiHost.
A constant which can be used with the lifecycle_state property of a EsxiHost.
A constant which can be used with the lifecycle_state property of a EsxiHost.
A constant which can be used with the lifecycle_state property of a EsxiHost.
A constant which can be used with the lifecycle_state property of a EsxiHost.
A constant which can be used with the lifecycle_state property of a EsxiHost.
A constant which can be used with the next_commitment property of a EsxiHost.
A constant which can be used with the next_commitment property of a EsxiHost.
A constant which can be used with the next_commitment property of a EsxiHost.
A constant which can be used with the next_commitment property of a EsxiHost.
[Required] Gets the billing_contract_end_date of this EsxiHost.
Gets the billing_donor_host_id of this EsxiHost.
Gets the capacity_reservation_id of this EsxiHost.
[Required] Gets the cluster_id of this EsxiHost.
Gets the compartment_id of this EsxiHost.
[Required] Gets the compute_availability_domain of this EsxiHost.
Gets the compute_fault_domain of this EsxiHost.
Gets the compute_instance_id of this EsxiHost.
[Required] Gets the current_commitment of this EsxiHost.
Gets the datastore_attachments of this EsxiHost.
Gets the datastore_cluster_ids of this EsxiHost.
[Required] Gets the defined_tags of this EsxiHost.
[Required] Gets the display_name of this EsxiHost.
Gets the esxi_software_version of this EsxiHost.
Gets the failed_esxi_host_id of this EsxiHost.
[Required] Gets the freeform_tags of this EsxiHost.
Gets the grace_period_end_date of this EsxiHost.
Gets the host_ocpu_count of this EsxiHost.
[Required] Gets the host_shape_name of this EsxiHost.
[Required] Gets the id of this EsxiHost.
Gets the initial_fault_domain_host_distribution of this EsxiHost.
Gets the is_billing_continuation_in_progress of this EsxiHost.
Gets the is_billing_swapping_in_progress of this EsxiHost.
Gets the is_vsan_byol_enabled of this EsxiHost.
Gets the lifecycle_state of this EsxiHost.
[Required] Gets the next_commitment of this EsxiHost.
Gets the non_upgraded_esxi_host_id of this EsxiHost.
Gets the primary_vnic_mac_address of this EsxiHost.
Gets the replacement_esxi_host_id of this EsxiHost.
[Required] Gets the sddc_id of this EsxiHost.
Gets the swap_billing_host_id of this EsxiHost.
Gets the system_tags of this EsxiHost.
Gets the time_created of this EsxiHost.
Gets the time_updated of this EsxiHost.
Gets the upgraded_replacement_esxi_host_id of this EsxiHost.
Gets the vcf_byol_allocation_id of this EsxiHost.
[Required] Gets the vmware_software_version of this EsxiHost.
Methods:
__init__(**kwargs)Initializes a new EsxiHost object with values from keyword arguments.
- CURRENT_COMMITMENT_HOUR = 'HOUR'¶
A constant which can be used with the current_commitment property of a EsxiHost. This constant has a value of “HOUR”
- CURRENT_COMMITMENT_MONTH = 'MONTH'¶
A constant which can be used with the current_commitment property of a EsxiHost. This constant has a value of “MONTH”
- CURRENT_COMMITMENT_ONE_YEAR = 'ONE_YEAR'¶
A constant which can be used with the current_commitment property of a EsxiHost. This constant has a value of “ONE_YEAR”
- CURRENT_COMMITMENT_THREE_YEARS = 'THREE_YEARS'¶
A constant which can be used with the current_commitment property of a EsxiHost. 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 EsxiHost. 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 EsxiHost. This constant has a value of “UNEVENLY_DISTRIBUTED”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a EsxiHost. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a EsxiHost. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a EsxiHost. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a EsxiHost. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a EsxiHost. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a EsxiHost. This constant has a value of “UPDATING”
- NEXT_COMMITMENT_HOUR = 'HOUR'¶
A constant which can be used with the next_commitment property of a EsxiHost. This constant has a value of “HOUR”
- NEXT_COMMITMENT_MONTH = 'MONTH'¶
A constant which can be used with the next_commitment property of a EsxiHost. This constant has a value of “MONTH”
- NEXT_COMMITMENT_ONE_YEAR = 'ONE_YEAR'¶
A constant which can be used with the next_commitment property of a EsxiHost. This constant has a value of “ONE_YEAR”
- NEXT_COMMITMENT_THREE_YEARS = 'THREE_YEARS'¶
A constant which can be used with the next_commitment property of a EsxiHost. This constant has a value of “THREE_YEARS”
- __init__(**kwargs)¶
Initializes a new EsxiHost 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 EsxiHost.
display_name (str) – The value to assign to the display_name property of this EsxiHost.
sddc_id (str) – The value to assign to the sddc_id property of this EsxiHost.
cluster_id (str) – The value to assign to the cluster_id property of this EsxiHost.
compartment_id (str) – The value to assign to the compartment_id property of this EsxiHost.
compute_instance_id (str) – The value to assign to the compute_instance_id property of this EsxiHost.
time_created (datetime) – The value to assign to the time_created property of this EsxiHost.
time_updated (datetime) – The value to assign to the time_updated property of this EsxiHost.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EsxiHost. 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’.
billing_donor_host_id (str) – The value to assign to the billing_donor_host_id property of this EsxiHost.
swap_billing_host_id (str) – The value to assign to the swap_billing_host_id property of this EsxiHost.
is_billing_continuation_in_progress (bool) – The value to assign to the is_billing_continuation_in_progress property of this EsxiHost.
is_billing_swapping_in_progress (bool) – The value to assign to the is_billing_swapping_in_progress property of this EsxiHost.
current_commitment (str) – The value to assign to the current_commitment property of this EsxiHost. 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’.
next_commitment (str) – The value to assign to the next_commitment property of this EsxiHost. 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’.
billing_contract_end_date (datetime) – The value to assign to the billing_contract_end_date property of this EsxiHost.
failed_esxi_host_id (str) – The value to assign to the failed_esxi_host_id property of this EsxiHost.
replacement_esxi_host_id (str) – The value to assign to the replacement_esxi_host_id property of this EsxiHost.
grace_period_end_date (datetime) – The value to assign to the grace_period_end_date property of this EsxiHost.
vmware_software_version (str) – The value to assign to the vmware_software_version property of this EsxiHost.
esxi_software_version (str) – The value to assign to the esxi_software_version property of this EsxiHost.
non_upgraded_esxi_host_id (str) – The value to assign to the non_upgraded_esxi_host_id property of this EsxiHost.
upgraded_replacement_esxi_host_id (str) – The value to assign to the upgraded_replacement_esxi_host_id property of this EsxiHost.
compute_availability_domain (str) – The value to assign to the compute_availability_domain property of this EsxiHost.
compute_fault_domain (str) – The value to assign to the compute_fault_domain property of this EsxiHost.
initial_fault_domain_host_distribution (str) – The value to assign to the initial_fault_domain_host_distribution property of this EsxiHost. Allowed values for this property are: “EVENLY_DISTRIBUTED”, “UNEVENLY_DISTRIBUTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
host_shape_name (str) – The value to assign to the host_shape_name property of this EsxiHost.
host_ocpu_count (float) – The value to assign to the host_ocpu_count property of this EsxiHost.
capacity_reservation_id (str) – The value to assign to the capacity_reservation_id property of this EsxiHost.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EsxiHost.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EsxiHost.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EsxiHost.
datastore_cluster_ids (list[str]) – The value to assign to the datastore_cluster_ids property of this EsxiHost.
datastore_attachments (list[oci.ocvp.models.DatastoreAttachment]) – The value to assign to the datastore_attachments property of this EsxiHost.
primary_vnic_mac_address (str) – The value to assign to the primary_vnic_mac_address property of this EsxiHost.
vcf_byol_allocation_id (str) – The value to assign to the vcf_byol_allocation_id property of this EsxiHost.
is_vsan_byol_enabled (bool) – The value to assign to the is_vsan_byol_enabled property of this EsxiHost.
- property billing_contract_end_date¶
[Required] Gets the billing_contract_end_date of this EsxiHost. Current billing cycle end date. If the value in currentCommitment and nextCommitment are different, the value specified in nextCommitment becomes the new currentCommitment when the contractEndDate is reached. Example: 2016-08-25T21:10:29.600Z
- Returns
The billing_contract_end_date of this EsxiHost.
- Return type
datetime
- property billing_donor_host_id¶
Gets the billing_donor_host_id of this EsxiHost. The OCID of the deleted ESXi Host with LeftOver billing cycle.
- Returns
The billing_donor_host_id of this EsxiHost.
- Return type
str
- property capacity_reservation_id¶
Gets the capacity_reservation_id of this EsxiHost. The OCID of the Capacity Reservation.
- Returns
The capacity_reservation_id of this EsxiHost.
- Return type
str
- property cluster_id¶
[Required] Gets the cluster_id of this EsxiHost. The OCID of the Cluster that the ESXi host belongs to.
- Returns
The cluster_id of this EsxiHost.
- Return type
str
- property compartment_id¶
Gets the compartment_id of this EsxiHost. The OCID of the compartment that contains the Cluster.
- Returns
The compartment_id of this EsxiHost.
- Return type
str
- property compute_availability_domain¶
[Required] Gets the compute_availability_domain of this EsxiHost. The availability domain of the ESXi host.
- Returns
The compute_availability_domain of this EsxiHost.
- Return type
str
- property compute_fault_domain¶
Gets the compute_fault_domain of this EsxiHost. The fault domain of the ESXi host.
- Returns
The compute_fault_domain of this EsxiHost.
- Return type
str
- property compute_instance_id¶
Gets the compute_instance_id of this EsxiHost. In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. The computeInstanceId is the OCID of that Compute instance.
- Returns
The compute_instance_id of this EsxiHost.
- Return type
str
- property current_commitment¶
[Required] Gets the current_commitment of this EsxiHost. The billing option currently used by the ESXi host.
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 current_commitment of this EsxiHost.
- Return type
str
- property datastore_attachments¶
Gets the datastore_attachments of this EsxiHost. List of DatastoreAttachment objects containing information about attachment details
- Returns
The datastore_attachments of this EsxiHost.
- Return type
- property datastore_cluster_ids¶
Gets the datastore_cluster_ids of this EsxiHost. A list of datastore clusters.
- Returns
The datastore_cluster_ids of this EsxiHost.
- Return type
list[str]
- property defined_tags¶
[Required] Gets the defined_tags of this EsxiHost. 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 EsxiHost.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this EsxiHost. A descriptive name for the ESXi host. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this EsxiHost.
- Return type
str
- property esxi_software_version¶
Gets the esxi_software_version of this EsxiHost. The version of ESXi software that Oracle Cloud VMware Solution installed on the ESXi hosts.
- Returns
The esxi_software_version of this EsxiHost.
- Return type
str
- property failed_esxi_host_id¶
Gets the failed_esxi_host_id of this EsxiHost. The OCID of the ESXi host that failed.
- Returns
The failed_esxi_host_id of this EsxiHost.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this EsxiHost. 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 EsxiHost.
- Return type
dict(str, str)
- property grace_period_end_date¶
Gets the grace_period_end_date of this EsxiHost. The date and time when the new esxi host should start billing cycle. RFC3339. Example: 2021-07-25T21:10:29.600Z
- Returns
The grace_period_end_date of this EsxiHost.
- Return type
datetime
- property host_ocpu_count¶
Gets the host_ocpu_count of this EsxiHost. The OCPU count of the ESXi host.
- Returns
The host_ocpu_count of this EsxiHost.
- Return type
float
- property host_shape_name¶
[Required] Gets the host_shape_name of this EsxiHost. The compute shape name of the ESXi host.
list_supported_host_shapes().- Returns
The host_shape_name of this EsxiHost.
- Return type
str
- property id¶
[Required] Gets the id of this EsxiHost. The OCID of the ESXi host.
- Returns
The id of this EsxiHost.
- Return type
str
- property initial_fault_domain_host_distribution¶
Gets the initial_fault_domain_host_distribution of this EsxiHost. The initial fault domain host distribution mode for the ESXi host.
Allowed values for this property are: “EVENLY_DISTRIBUTED”, “UNEVENLY_DISTRIBUTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The initial_fault_domain_host_distribution of this EsxiHost.
- Return type
str
- property is_billing_continuation_in_progress¶
Gets the is_billing_continuation_in_progress of this EsxiHost. Indicates whether this host is in the progress of billing continuation.
- Returns
The is_billing_continuation_in_progress of this EsxiHost.
- Return type
bool
- property is_billing_swapping_in_progress¶
Gets the is_billing_swapping_in_progress of this EsxiHost. Indicates whether this host is in the progress of swapping billing.
- Returns
The is_billing_swapping_in_progress of this EsxiHost.
- Return type
bool
- property is_vsan_byol_enabled¶
Gets the is_vsan_byol_enabled of this EsxiHost. Indicates whether this host embedded VMware vSAN with BYOL Allocation.
- Returns
The is_vsan_byol_enabled of this EsxiHost.
- Return type
bool
- property lifecycle_state¶
Gets the lifecycle_state of this EsxiHost. The current state of the ESXi host.
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 EsxiHost.
- Return type
str
- property next_commitment¶
[Required] Gets the next_commitment of this EsxiHost. The billing option to switch to after the current billing cycle ends. If nextCommitment is null or empty, currentCommitment continues to the next billing cycle.
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 next_commitment of this EsxiHost.
- Return type
str
- property non_upgraded_esxi_host_id¶
Gets the non_upgraded_esxi_host_id of this EsxiHost. The OCID of the ESXi host that will be upgraded.
- Returns
The non_upgraded_esxi_host_id of this EsxiHost.
- Return type
str
- property primary_vnic_mac_address¶
Gets the primary_vnic_mac_address of this EsxiHost. MAC address of ESXi host’s compute instance primary VNIC.
- Returns
The primary_vnic_mac_address of this EsxiHost.
- Return type
str
- property replacement_esxi_host_id¶
Gets the replacement_esxi_host_id of this EsxiHost. The OCID of the ESXi host that is created to replace the failed host.
- Returns
The replacement_esxi_host_id of this EsxiHost.
- Return type
str
- property sddc_id¶
[Required] Gets the sddc_id of this EsxiHost. The OCID of the SDDC that the ESXi host belongs to.
- Returns
The sddc_id of this EsxiHost.
- Return type
str
- property swap_billing_host_id¶
Gets the swap_billing_host_id of this EsxiHost. The OCID of the active ESXi Host to swap billing with current host.
- Returns
The swap_billing_host_id of this EsxiHost.
- Return type
str
- property system_tags¶
Gets the system_tags of this EsxiHost. 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 EsxiHost.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this EsxiHost. The date and time the ESXi host was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this EsxiHost.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this EsxiHost. The date and time the ESXi host was updated, in the format defined by RFC3339.
- Returns
The time_updated of this EsxiHost.
- Return type
datetime
- property upgraded_replacement_esxi_host_id¶
Gets the upgraded_replacement_esxi_host_id of this EsxiHost. The OCID of the ESXi host that is newly created to upgrade the original host.
- Returns
The upgraded_replacement_esxi_host_id of this EsxiHost.
- Return type
str
- property vcf_byol_allocation_id¶
Gets the vcf_byol_allocation_id of this EsxiHost. The OCID of the Byol Allocation for VCF (VMware Cloud Foundation) deployment.
- Returns
The vcf_byol_allocation_id of this EsxiHost.
- Return type
str
- property vmware_software_version¶
[Required] Gets the vmware_software_version of this EsxiHost. The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.
- Returns
The vmware_software_version of this EsxiHost.
- Return type
str