oracle.oci.oci_ocvp_esxi_host_facts – Fetches details about one or multiple EsxiHost resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple EsxiHost resources in Oracle Cloud Infrastructure
Lists the ESXi hosts in the specified SDDC. The list can be filtered by Compute instance OCID or ESXi display name.
Remember that in terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. Each EsxiHost object has its own OCID (id), and a separate attribute for the OCID of the Compute instance (computeInstanceId). When filtering the list of ESXi hosts, you can specify the OCID of the Compute instance, not the ESXi host OCID.
If esxi_host_id is specified, the details of a single EsxiHost will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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. |
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.
|
|
compartment_id
string
|
The OCID of the compartment as optional parameter.
|
|
compute_instance_id
string
|
The OCID of the Compute instance.
|
|
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 . |
|
display_name
string
|
A filter to return only resources that match the given display name exactly.
aliases: name |
|
esxi_host_id
string
|
The OCID of the ESXi host.
Required to get a specific esxi_host.
aliases: id |
|
is_billing_donors_only
boolean
|
|
If this flag/param is set to True, we return only deleted hosts with LeftOver billingCycle.
|
is_swap_billing_only
boolean
|
|
If this flag/param is set to True, we return only active hosts.
|
lifecycle_state
string
|
|
The lifecycle state of the resource.
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
|
sort_by
string
|
|
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific esxi_host
oci_ocvp_esxi_host_facts:
# required
esxi_host_id: "ocid1.esxihost.oc1..xxxxxxEXAMPLExxxxxx"
- name: List esxi_hosts
oci_ocvp_esxi_host_facts:
# optional
sddc_id: "ocid1.sddc.oc1..xxxxxxEXAMPLExxxxxx"
compute_instance_id: "ocid1.computeinstance.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
sort_order: ASC
sort_by: timeCreated
lifecycle_state: CREATING
is_billing_donors_only: true
is_swap_billing_only: true
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
esxi_hosts
complex
|
on success |
List of EsxiHost resources
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.
Returned for get operation
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)