oracle / oracle.oci / 4.32.0 / module / oci_compute_dedicated_vm_host_facts Fetches details about one or multiple DedicatedVmHost resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_compute_dedicated_vm_host_facts (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
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 I(dedicated_vm_host_id) is specified, the details of a single DedicatedVmHost will be returned.
- 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
region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str sort_by: choices: - TIMECREATED - DISPLAYNAME description: - 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.' type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. type: str cert_bundle: description: - 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. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str display_name: aliases: - name description: - A filter to return only resources that match the given display name exactly. type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. - Required to list multiple dedicated_vm_hosts. type: str lifecycle_state: choices: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED description: - A filter to only return resources that match the given lifecycle state. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str availability_domain: description: - The name of the availability domain. - 'Example: `Uocm:PHX-AD-1`' type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str instance_shape_name: description: - The name for the instance's shape. type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str dedicated_vm_host_id: aliases: - id description: - The OCID of the dedicated VM host. - Required to get a specific dedicated_vm_host. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool remaining_ocpus_greater_than_or_equal_to: description: - The available OCPUs of the dedicated VM host. type: float remaining_memory_in_gbs_greater_than_or_equal_to: description: - The remaining memory of the dedicated VM host, in GBs. type: float
dedicated_vm_hosts: contains: availability_domain: description: - The availability domain the dedicated virtual machine host is running in. - 'Example: `Uocm:PHX-AD-1`' returned: on success sample: Uocm:PHX-AD-1 type: str compartment_id: description: - The OCID of the compartment that contains the dedicated virtual machine host. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str dedicated_vm_host_shape: description: - The dedicated virtual machine host shape. The shape determines the number of CPUs and other resources available for VMs. returned: on success sample: dedicated_vm_host_shape_example type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' - Returned for get operation returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str fault_domain: description: - The fault domain for the dedicated virtual machine host's assigned instances. For more information, see L(Fault Domains,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm#fault). - 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 L(Identity and Access Management Service API,https://docs.cloud.oracle.com/iaas/api/#/en/identity/20160918/). - 'Example: `FAULT-DOMAIN-1`' returned: on success sample: FAULT-DOMAIN-1 type: str freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' - Returned for get operation returned: on success sample: Department: Finance type: dict id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated VM host. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_state: description: - The current state of the dedicated VM host. returned: on success sample: CREATING type: str remaining_memory_in_gbs: description: - The remaining memory of the dedicated VM host, in GBs. returned: on success sample: 3.4 type: float remaining_ocpus: description: - The available OCPUs of the dedicated VM host. returned: on success sample: 3.4 type: float time_created: description: - The date and time the dedicated VM host was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339). - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str total_memory_in_gbs: description: - The total memory of the dedicated VM host, in GBs. returned: on success sample: 3.4 type: float total_ocpus: description: - The total OCPUs of the dedicated VM host. returned: on success sample: 3.4 type: float description: - List of DedicatedVmHost resources returned: on success 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 type: complex