oracle.oci.oci_compute_dedicated_vm_host_facts – Fetches details about one or multiple DedicatedVmHost resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.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_compute_dedicated_vm_host_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple DedicatedVmHost resources in Oracle Cloud Infrastructure

  • Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.

  • You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named dedicated virtual machine hosts in the compartment.

  • If dedicated_vm_host_id is specified, the details of a single DedicatedVmHost will be returned.

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
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.
availability_domain
string
The name of the availability domain.
Example: `Uocm:PHX-AD-1`
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.
Required to list multiple dedicated_vm_hosts.
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.
dedicated_vm_host_id
string
The OCID of the dedicated VM host.
Required to get a specific dedicated_vm_host.

aliases: id
display_name
string
A filter to return only resources that match the given display name exactly.

aliases: name
instance_shape_name
string
The name for the instance's shape.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • UPDATING
  • DELETING
  • DELETED
  • FAILED
A filter to only return resources that match the given lifecycle state.
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.
remaining_memory_in_gbs_greater_than_or_equal_to
float
The remaining memory of the dedicated VM host, in GBs.
remaining_ocpus_greater_than_or_equal_to
float
The available OCPUs of the dedicated VM host.
sort_by
string
    Choices:
  • TIMECREATED
  • DISPLAYNAME
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
    Choices:
  • ASC
  • DESC
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

Examples

- name: Get a specific dedicated_vm_host
  oci_compute_dedicated_vm_host_facts:
    # required
    dedicated_vm_host_id: "ocid1.dedicatedvmhost.oc1..xxxxxxEXAMPLExxxxxx"

- name: List dedicated_vm_hosts
  oci_compute_dedicated_vm_host_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    availability_domain: Uocm:PHX-AD-1
    lifecycle_state: CREATING
    display_name: display_name_example
    instance_shape_name: instance_shape_name_example
    sort_by: TIMECREATED
    sort_order: ASC
    remaining_memory_in_gbs_greater_than_or_equal_to: 0.0
    remaining_ocpus_greater_than_or_equal_to: 0.0

Return Values

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

Key Returned Description
dedicated_vm_hosts
complex
on success
List of DedicatedVmHost resources

Sample:
[{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'dedicated_vm_host_shape': 'dedicated_vm_host_shape_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'remaining_memory_in_gbs': 3.4, 'remaining_ocpus': 3.4, 'time_created': '2013-10-20T19:20:30+01:00', 'total_memory_in_gbs': 3.4, 'total_ocpus': 3.4}]
 
availability_domain
string
on success
The availability domain the dedicated virtual machine host is running in.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID of the compartment that contains the dedicated virtual machine host.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
dedicated_vm_host_shape
string
on success
The dedicated virtual machine host shape. The shape determines the number of CPUs and other resources available for VMs.

Sample:
dedicated_vm_host_shape_example
 
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"}}`
Returned for get operation

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
fault_domain
string
on success
The fault domain for the dedicated virtual machine host's assigned instances. For more information, see Fault Domains.
If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated virtual machine host, delete it, and then create a new dedicated virtual machine host in the preferred fault domain.
To get a list of fault domains, use the `ListFaultDomains` operation in the Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`

Sample:
FAULT-DOMAIN-1
 
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"}`
Returned for get operation

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the dedicated VM host.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the dedicated VM host.

Sample:
CREATING
 
remaining_memory_in_gbs
float
on success
The remaining memory of the dedicated VM host, in GBs.

Sample:
3.4
 
remaining_ocpus
float
on success
The available OCPUs of the dedicated VM host.

Sample:
3.4
 
time_created
string
on success
The date and time the dedicated VM host was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
total_memory_in_gbs
float
on success
The total memory of the dedicated VM host, in GBs.

Sample:
3.4
 
total_ocpus
float
on success
The total OCPUs of the dedicated VM host.

Sample:
3.4


Authors

  • Oracle (@oracle)