oracle.oci.oci_ocvp_esxi_host – Manage an EsxiHost resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_ocvp_esxi_host.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete an EsxiHost resource in Oracle Cloud Infrastructure

  • For state=present, adds another ESXi host to an existing SDDC. The attributes of the specified Sddc determine the VMware software and other configuration settings used by the ESXi host.

  • Use the WorkRequest operations to track the creation of the ESXi host.

  • This resource has the following action operations in the oracle.oci.oci_ocvp_esxi_host_actions module: swap_billing.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
billing_donor_host_id
string
The OCID of the deleted ESXi Host with LeftOver billing cycle.
This parameter is updatable.
capacity_reservation_id
string
The OCID of the Capacity Reservation.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compute_availability_domain
string
The availability domain to create the ESXi host in. If keep empty, for AD-specific SDDC, new ESXi host will be created in the same availability domain; for multi-AD SDDC, new ESXi host will be auto assigned to the next availability domain following evenly distribution strategy.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
current_sku
string
    Choices:
  • HOUR
  • MONTH
  • ONE_YEAR
  • THREE_YEARS
The billing option currently used by the ESXi host. ListSupportedSkus.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
display_name
string
A descriptive name for the ESXi host. It's changeable. Esxi Host name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the SDDC.
If this attribute is not specified, the SDDC's `instanceDisplayNamePrefix` attribute is used to name and incrementally number the ESXi host. For example, if you're creating the fourth ESXi host in the SDDC, and `instanceDisplayNamePrefix` is `MySDDC`, the host's display name is `MySDDC-4`.
Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
esxi_host_id
string
The OCID of the ESXi host.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
failed_esxi_host_id
string
The OCID of the ESXi host that is failed. This is an optional parameter. If this parameter is specified, a new ESXi host will be created to replace the failed one, and the `failedEsxiHostId` field will be updated in the newly created Esxi host.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
host_ocpu_count
float
The OCPU count of the ESXi host.
host_shape_name
string
The compute shape name of the ESXi host. ListSupportedHostShapes.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
next_sku
string
    Choices:
  • HOUR
  • MONTH
  • ONE_YEAR
  • THREE_YEARS
The billing option to switch to after the existing billing cycle ends. If `nextSku` is null or empty, `currentSku` continues to the next billing cycle. ListSupportedSkus.
This parameter is updatable.
non_upgraded_esxi_host_id
string
The OCID of the ESXi host that will be upgraded. This is an optional parameter. If this parameter is specified, an ESXi host with the new software version is created to replace the original one, and the `nonUpgradedEsxiHostId` field is updated in the newly created Esxi host. See Upgrading VMware Software for more information.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sddc_id
string
The OCID of the SDDC to add the ESXi host to.
Required for create using state=present.
state
string
    Choices:
  • present ←
  • absent
The state of the EsxiHost.
Use state=present to create or update an EsxiHost.
Use state=absent to delete an EsxiHost.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create esxi_host
  oci_ocvp_esxi_host:
    # required
    sddc_id: "ocid1.sddc.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    current_sku: HOUR
    compute_availability_domain: Uocm:PHX-AD-1
    failed_esxi_host_id: "ocid1.failedesxihost.oc1..xxxxxxEXAMPLExxxxxx"
    host_shape_name: host_shape_name_example
    host_ocpu_count: 3.4
    capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx"
    non_upgraded_esxi_host_id: "ocid1.nonupgradedesxihost.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    next_sku: HOUR
    billing_donor_host_id: "ocid1.billingdonorhost.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update esxi_host
  oci_ocvp_esxi_host:
    # required
    esxi_host_id: "ocid1.esxihost.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    next_sku: HOUR
    billing_donor_host_id: "ocid1.billingdonorhost.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update esxi_host using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_ocvp_esxi_host:
    # required
    display_name: display_name_example

    # optional
    next_sku: HOUR
    billing_donor_host_id: "ocid1.billingdonorhost.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete esxi_host
  oci_ocvp_esxi_host:
    # required
    esxi_host_id: "ocid1.esxihost.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete esxi_host using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_ocvp_esxi_host:
    # required
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
esxi_host
complex
on success
Details of the EsxiHost resource acted upon by the current operation

Sample:
{'billing_contract_end_date': '2013-10-20T19:20:30+01:00', 'billing_donor_host_id': 'ocid1.billingdonorhost.oc1..xxxxxxEXAMPLExxxxxx', 'capacity_reservation_id': 'ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compute_availability_domain': 'Uocm:PHX-AD-1', 'compute_instance_id': 'ocid1.computeinstance.oc1..xxxxxxEXAMPLExxxxxx', 'current_sku': 'HOUR', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'failed_esxi_host_id': 'ocid1.failedesxihost.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'grace_period_end_date': '2013-10-20T19:20:30+01:00', 'host_ocpu_count': 3.4, 'host_shape_name': 'host_shape_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_billing_continuation_in_progress': True, 'is_billing_swapping_in_progress': True, 'lifecycle_state': 'CREATING', 'next_sku': 'HOUR', 'non_upgraded_esxi_host_id': 'ocid1.nonupgradedesxihost.oc1..xxxxxxEXAMPLExxxxxx', 'replacement_esxi_host_id': 'ocid1.replacementesxihost.oc1..xxxxxxEXAMPLExxxxxx', 'sddc_id': 'ocid1.sddc.oc1..xxxxxxEXAMPLExxxxxx', 'swap_billing_host_id': 'ocid1.swapbillinghost.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'upgraded_replacement_esxi_host_id': 'ocid1.upgradedreplacementesxihost.oc1..xxxxxxEXAMPLExxxxxx', 'vmware_software_version': 'vmware_software_version_example'}
 
billing_contract_end_date
string
on success
Current billing cycle end date. If the value in `currentSku` and `nextSku` are different, the value specified in `nextSku` becomes the new `currentSKU` when the `contractEndDate` is reached. Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
billing_donor_host_id
string
on success
The OCID of the deleted ESXi Host with LeftOver billing cycle.

Sample:
ocid1.billingdonorhost.oc1..xxxxxxEXAMPLExxxxxx
 
capacity_reservation_id
string
on success
The OCID of the Capacity Reservation.

Sample:
ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment that contains the SDDC.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
compute_availability_domain
string
on success
The availability domain of the ESXi host.

Sample:
Uocm:PHX-AD-1
 
compute_instance_id
string
on success
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.

Sample:
ocid1.computeinstance.oc1..xxxxxxEXAMPLExxxxxx
 
current_sku
string
on success
The billing option currently used by the ESXi host. ListSupportedSkus.

Sample:
HOUR
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A descriptive name for the ESXi host. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
failed_esxi_host_id
string
on success
The OCID of the ESXi host that failed.

Sample:
ocid1.failedesxihost.oc1..xxxxxxEXAMPLExxxxxx
 
freeform_tags
dictionary
on success
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"}`

Sample:
{'Department': 'Finance'}
 
grace_period_end_date
string
on success
The date and time when the new esxi host should start billing cycle. RFC3339. Example: `2021-07-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
host_ocpu_count
float
on success
The OCPU count of the ESXi host.

Sample:
3.4
 
host_shape_name
string
on success
The compute shape name of the ESXi host. ListSupportedHostShapes.

Sample:
host_shape_name_example
 
id
string
on success
The OCID of the ESXi host.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_billing_continuation_in_progress
boolean
on success
Indicates whether this host is in the progress of billing continuation.

Sample:
True
 
is_billing_swapping_in_progress
boolean
on success
Indicates whether this host is in the progress of swapping billing.

Sample:
True
 
lifecycle_state
string
on success
The current state of the ESXi host.

Sample:
CREATING
 
next_sku
string
on success
The billing option to switch to after the current billing cycle ends. If `nextSku` is null or empty, `currentSku` continues to the next billing cycle. ListSupportedSkus.

Sample:
HOUR
 
non_upgraded_esxi_host_id
string
on success
The OCID of the ESXi host that will be upgraded.

Sample:
ocid1.nonupgradedesxihost.oc1..xxxxxxEXAMPLExxxxxx
 
replacement_esxi_host_id
string
on success
The OCID of the ESXi host that is created to replace the failed host.

Sample:
ocid1.replacementesxihost.oc1..xxxxxxEXAMPLExxxxxx
 
sddc_id
string
on success
The OCID of the SDDC that the ESXi host belongs to.

Sample:
ocid1.sddc.oc1..xxxxxxEXAMPLExxxxxx
 
swap_billing_host_id
string
on success
The OCID of the active ESXi Host to swap billing with current host.

Sample:
ocid1.swapbillinghost.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the ESXi host was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the ESXi host was updated, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
upgraded_replacement_esxi_host_id
string
on success
The OCID of the ESXi host that is newly created to upgrade the original host.

Sample:
ocid1.upgradedreplacementesxihost.oc1..xxxxxxEXAMPLExxxxxx
 
vmware_software_version
string
on success
The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.

Sample:
vmware_software_version_example


Authors

  • Oracle (@oracle)