oracle.oci.oci_opsi_host_configuration_facts – Fetches details about one or multiple HostConfiguration resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets a list of host insight configurations based on the query parameters specified. Either compartmentId or hostInsightId query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of host insight configurations in that compartment and in all sub-compartments 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.
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.
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
A flag to search all resources within a given compartment and all sub-compartments.
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.
defined_tag_equals
list / elements=string
A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
defined_tag_exists
list / elements=string
A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
enterprise_manager_bridge_id
string
Unique Enterprise Manager bridge identifier
exadata_insight_id
list / elements=string
Optional list of exadata insight resource OCIDs.
freeform_tag_equals
list / elements=string
A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
freeform_tag_exists
list / elements=string
A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
host_id
string
Optional OCID of the host (Compute Id)
host_type
list / elements=string
Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST
id
list / elements=string
Optional list of host insight resource OCIDs.
platform_type
list / elements=string
    Choices:
  • LINUX
  • SOLARIS
  • SUNOS
  • ZLINUX
Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX].
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.
sort_by
string
    Choices:
  • hostName
  • platformType
Host configuration list sort options.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
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: List host_configurations
  oci_opsi_host_configuration_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    enterprise_manager_bridge_id: "ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx"
    id: [ "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" ]
    exadata_insight_id: [ "ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx" ]
    platform_type: [ "LINUX" ]
    sort_order: ASC
    sort_by: hostName
    defined_tag_equals: [ "defined_tag_equals_example" ]
    freeform_tag_equals: [ "freeform_tag_equals_example" ]
    defined_tag_exists: [ "defined_tag_exists_example" ]
    freeform_tag_exists: [ "freeform_tag_exists_example" ]
    compartment_id_in_subtree: true
    host_type: [ "host_type_example" ]
    host_id: "ocid1.host.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
host_configurations
complex
on success
List of HostConfiguration resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'cores_per_socket': 56, 'cpu_architecture': 'cpu_architecture_example', 'cpu_cache_in_mbs': 1.2, 'cpu_frequency_in_mhz': 1.2, 'cpu_implementation': 'cpu_implementation_example', 'cpu_vendor': 'cpu_vendor_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'entity_source': 'MACS_MANAGED_EXTERNAL_HOST', 'freeform_tags': {'Department': 'Finance'}, 'host_insight_id': 'ocid1.hostinsight.oc1..xxxxxxEXAMPLExxxxxx', 'host_name': 'host_name_example', 'is_hyper_threading_enabled': True, 'platform_type': 'LINUX', 'platform_vendor': 'platform_vendor_example', 'platform_version': 'platform_version_example', 'threads_per_socket': 56, 'total_cpus': 56, 'total_memory_in_gbs': 1.2, 'total_sockets': 56}]
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
cores_per_socket
integer
on success
Number of cores per socket.

Sample:
56
 
cpu_architecture
string
on success
CPU architechure

Sample:
cpu_architecture_example
 
cpu_cache_in_mbs
float
on success
Size of cache memory in megabytes.

Sample:
1.2
 
cpu_frequency_in_mhz
float
on success
Clock frequency of the processor in megahertz.

Sample:
1.2
 
cpu_implementation
string
on success
Model name of processor.

Sample:
cpu_implementation_example
 
cpu_vendor
string
on success
Name of the CPU vendor.

Sample:
cpu_vendor_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
entity_source
string
on success
Source of the host entity.

Sample:
MACS_MANAGED_EXTERNAL_HOST
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
host_insight_id
string
on success
The OCID of the host insight resource.

Sample:
ocid1.hostinsight.oc1..xxxxxxEXAMPLExxxxxx
 
host_name
string
on success
The host name. The host name is unique amongst the hosts managed by the same management agent.

Sample:
host_name_example
 
is_hyper_threading_enabled
boolean
on success
Indicates if hyper-threading is enabled or not

Sample:
True
 
platform_type
string
on success
Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX].

Sample:
LINUX
 
platform_vendor
string
on success
Platform vendor.

Sample:
platform_vendor_example
 
platform_version
string
on success
Platform version.

Sample:
platform_version_example
 
threads_per_socket
integer
on success
Number of threads per socket.

Sample:
56
 
total_cpus
integer
on success
Total CPU on this host.

Sample:
56
 
total_memory_in_gbs
float
on success
Total amount of usable physical memory in gibabytes

Sample:
1.2
 
total_sockets
integer
on success
Number of total sockets.

Sample:
56


Authors

  • Oracle (@oracle)