oracle.oci.oci_opsi_exadata_insights_facts – Fetches details about one or multiple ExadataInsights resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_exadata_insights_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ExadataInsights resources in Oracle Cloud Infrastructure
Gets a list of Exadata insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of Exadata insights in that compartment and in all sub-compartments will be returned.
If exadata_insight_id is specified, the details of a single ExadataInsights 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.
|
|
compartment_id_in_subtree
boolean
|
|
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 . |
|
enterprise_manager_bridge_id
string
|
Unique Enterprise Manager bridge identifier
|
|
exadata_insight_id
string
|
Unique Exadata insight identifier
Required to get a specific exadata_insights.
aliases: id |
|
exadata_type
list
/ elements=string
|
Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.
|
|
lifecycle_state
list
/ elements=string
|
|
Lifecycle states
|
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. |
|
sort_by
string
|
|
Exadata insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. Default order for timeCreated is descending. Default order for exadataName is ascending. If no value is specified timeCreated is default.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
|
status
list
/ elements=string
|
|
Resource Status
|
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 exadata_insights
oci_opsi_exadata_insights_facts:
# required
exadata_insight_id: "ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx"
- name: List exadata_insights
oci_opsi_exadata_insights_facts:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
enterprise_manager_bridge_id: "ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx"
status: [ "DISABLED" ]
lifecycle_state: [ "CREATING" ]
exadata_type: [ "exadata_type_example" ]
sort_order: ASC
sort_by: timeCreated
compartment_id_in_subtree: true
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
exadata_insights
complex
|
on success |
List of ExadataInsights resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'enterprise_manager_bridge_id': 'ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx', 'enterprise_manager_entity_display_name': 'enterprise_manager_entity_display_name_example', 'enterprise_manager_entity_identifier': 'enterprise_manager_entity_identifier_example', 'enterprise_manager_entity_name': 'enterprise_manager_entity_name_example', 'enterprise_manager_entity_type': 'enterprise_manager_entity_type_example', 'enterprise_manager_identifier': 'enterprise_manager_identifier_example', 'entity_source': 'EM_MANAGED_EXTERNAL_EXADATA', 'exadata_display_name': 'exadata_display_name_example', 'exadata_infra_id': 'ocid1.exadatainfra.oc1..xxxxxxEXAMPLExxxxxx', 'exadata_infra_resource_type': 'cloudExadataInfrastructure', 'exadata_name': 'exadata_name_example', 'exadata_rack_type': 'FULL', 'exadata_shape': 'exadata_shape_example', 'exadata_type': 'DBMACHINE', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_auto_sync_enabled': True, 'is_virtualized_exadata': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'status': 'DISABLED', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
|
compartment_id
string
|
on success |
Compartment identifier of the Exadata insight resource
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
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'}}
|
|
enterprise_manager_bridge_id
string
|
on success |
OPSI Enterprise Manager Bridge OCID
Returned for get operation
Sample:
ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx
|
|
enterprise_manager_entity_display_name
string
|
on success |
Enterprise Manager Entity Display Name
Returned for get operation
Sample:
enterprise_manager_entity_display_name_example
|
|
enterprise_manager_entity_identifier
string
|
on success |
Enterprise Manager Entity Unique Identifier
Returned for get operation
Sample:
enterprise_manager_entity_identifier_example
|
|
enterprise_manager_entity_name
string
|
on success |
Enterprise Manager Entity Name
Returned for get operation
Sample:
enterprise_manager_entity_name_example
|
|
enterprise_manager_entity_type
string
|
on success |
Enterprise Manager Entity Type
Returned for get operation
Sample:
enterprise_manager_entity_type_example
|
|
enterprise_manager_identifier
string
|
on success |
Enterprise Manager Unique Identifier
Returned for get operation
Sample:
enterprise_manager_identifier_example
|
|
entity_source
string
|
on success |
Source of the Exadata system.
Sample:
EM_MANAGED_EXTERNAL_EXADATA
|
|
exadata_display_name
string
|
on success |
The user-friendly name for the Exadata system. The name does not have to be unique.
Sample:
exadata_display_name_example
|
|
exadata_infra_id
string
|
on success |
The OCID of the Exadata Infrastructure.
Returned for get operation
Sample:
ocid1.exadatainfra.oc1..xxxxxxEXAMPLExxxxxx
|
|
exadata_infra_resource_type
string
|
on success |
OCI exadata infrastructure resource type
Returned for get operation
Sample:
cloudExadataInfrastructure
|
|
exadata_name
string
|
on success |
The Exadata system name. If the Exadata systems managed by Enterprise Manager, the name is unique amongst the Exadata systems managed by the same Enterprise Manager.
Sample:
exadata_name_example
|
|
exadata_rack_type
string
|
on success |
Exadata rack type.
Sample:
FULL
|
|
exadata_shape
string
|
on success |
The shape of the Exadata Infrastructure.
Returned for get operation
Sample:
exadata_shape_example
|
|
exadata_type
string
|
on success |
Operations Insights internal representation of the the Exadata system type.
Sample:
DBMACHINE
|
|
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'}
|
|
id
string
|
on success |
Exadata insight identifier
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
is_auto_sync_enabled
boolean
|
on success |
Set to true to enable automatic enablement and disablement of related targets from Enterprise Manager. New resources (e.g. Database Insights) will be placed in the same compartment as the related Exadata Insight.
Returned for get operation
Sample:
True
|
|
is_virtualized_exadata
boolean
|
on success |
true if virtualization is used in the Exadata system
Returned for get operation
Sample:
True
|
|
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
|
lifecycle_state
string
|
on success |
The current state of the Exadata insight.
Sample:
CREATING
|
|
status
string
|
on success |
Indicates the status of an Exadata insight in Operations Insights
Sample:
DISABLED
|
|
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|
time_created
string
|
on success |
The time the the Exadata insight was first enabled. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
The time the Exadata insight was updated. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)