oracle.oci.oci_opsi_exadata_insights – Manage an ExadataInsights resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete an ExadataInsights resource in Oracle Cloud Infrastructure

  • For state=present, create an Exadata insight resource for an Exadata system in Operations Insights. The Exadata system will be enabled in Operations Insights. Exadata-related metric collection and analysis will be started.

  • This resource has the following action operations in the oracle.oci.oci_opsi_exadata_insights_actions module: change.

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
  • security_token
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
Compartment Identifier of Exadata insight
Required for create using state=present.
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_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
enterprise_manager_bridge_id
string
OPSI Enterprise Manager Bridge OCID
Required when entity_source is 'EM_MANAGED_EXTERNAL_EXADATA'
enterprise_manager_entity_identifier
string
Enterprise Manager Entity Unique Identifier
Required when entity_source is 'EM_MANAGED_EXTERNAL_EXADATA'
enterprise_manager_identifier
string
Enterprise Manager Unique Identifier
Required when entity_source is 'EM_MANAGED_EXTERNAL_EXADATA'
entity_source
string
    Choices:
  • EM_MANAGED_EXTERNAL_EXADATA
  • PE_COMANAGED_EXADATA
Source of the Exadata system.
Required for create using state=present, update using state=present with exadata_insight_id present.
exadata_infra_id
string
The OCID of the Exadata Infrastructure.
Required when entity_source is 'PE_COMANAGED_EXADATA'
exadata_insight_id
string
Unique Exadata insight identifier
Required for update using state=present.
Required for delete using state=absent.

aliases: id
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
is_auto_sync_enabled
boolean
    Choices:
  • no
  • yes
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.
This parameter is updatable.
Applicable when entity_source is 'EM_MANAGED_EXTERNAL_EXADATA'
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
member_entity_details
list / elements=dictionary
Applicable when entity_source is 'EM_MANAGED_EXTERNAL_EXADATA'
compartment_id
string / required
The OCID of the compartment.
Required when entity_source is 'EM_MANAGED_EXTERNAL_EXADATA'
enterprise_manager_entity_identifier
string / required
Enterprise Manager Entity Unique Identifier
Required when entity_source is 'EM_MANAGED_EXTERNAL_EXADATA'
member_vm_cluster_details
list / elements=dictionary
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
compartment_id
string / required
The OCID of the compartment.
Required when entity_source is 'PE_COMANAGED_EXADATA'
dbm_private_endpoint_id
string
The OCID of the Database Management private endpoint
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
member_database_details
list / elements=dictionary
The databases that belong to the VM Cluster
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
compartment_id
string / required
Compartment Identifier of database
Required when entity_source is 'PE_COMANAGED_EXADATA'
connection_details
dictionary
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
hosts
list / elements=dictionary / required
List of hosts and port for private endpoint accessed database resource.
Required when entity_source is 'PE_COMANAGED_EXADATA'
host_ip
string
Host IP used for connection requests for Cloud DB resource.
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
port
integer
Listener port number used for connection requests for rivate endpoint accessed db resource.
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
protocol
string
    Choices:
  • TCP
  • TCPS
Protocol used for connection requests for private endpoint accssed database resource.
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
service_name
string
Database service name used for connection requests.
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
credential_details
dictionary / required
Required when entity_source is 'PE_COMANAGED_EXADATA'
credential_source_name
string / required
Credential source name that had been added in Management Agent wallet. This is supplied in the External Database Service.
credential_type
string / required
    Choices:
  • CREDENTIALS_BY_SOURCE
  • CREDENTIALS_BY_VAULT
Credential type.
password_secret_id
string
The secret OCID mapping to the database credentials.
Applicable when credential_type is 'CREDENTIALS_BY_VAULT'
role
string
    Choices:
  • NORMAL
database user role.
Applicable when credential_type is 'CREDENTIALS_BY_VAULT'
user_name
string
database user name.
Applicable when credential_type is 'CREDENTIALS_BY_VAULT'
wallet_secret_id
string
The OCID of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases.
Applicable when credential_type is 'CREDENTIALS_BY_VAULT'
database_id
string / required
The OCID of the database.
Required when entity_source is 'PE_COMANAGED_EXADATA'
database_resource_type
string / required
OCI database resource type
Required when entity_source is 'PE_COMANAGED_EXADATA'
dbm_private_endpoint_id
string
The OCID of the Database Management private endpoint
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
deployment_type
string / required
    Choices:
  • VIRTUAL_MACHINE
  • BARE_METAL
  • EXACS
Database Deployment Type
Required when entity_source is 'PE_COMANAGED_EXADATA'
entity_source
string / required
    Choices:
  • EM_MANAGED_EXTERNAL_DATABASE
  • PE_COMANAGED_DATABASE
Source of the database entity.
Required when entity_source is 'PE_COMANAGED_EXADATA'
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
opsi_private_endpoint_id
string
The OCID of the OPSI private endpoint
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
service_name
string / required
Database service name used for connection requests.
Required when entity_source is 'PE_COMANAGED_EXADATA'
system_tags
dictionary
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
opsi_private_endpoint_id
string
The OCID of the OPSI private endpoint
Applicable when entity_source is 'PE_COMANAGED_EXADATA'
vmcluster_id
string / required
The OCID of the VM Cluster.
Required when entity_source is 'PE_COMANAGED_EXADATA'
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
state
string
    Choices:
  • present ←
  • absent
The state of the ExadataInsights.
Use state=present to create or update an ExadataInsights.
Use state=absent to delete an ExadataInsights.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create exadata_insights with entity_source = EM_MANAGED_EXTERNAL_EXADATA
  oci_opsi_exadata_insights:
    # required
    enterprise_manager_identifier: enterprise_manager_identifier_example
    enterprise_manager_bridge_id: "ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx"
    enterprise_manager_entity_identifier: enterprise_manager_entity_identifier_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    entity_source: EM_MANAGED_EXTERNAL_EXADATA

    # optional
    member_entity_details:
    - # required
      enterprise_manager_entity_identifier: enterprise_manager_entity_identifier_example
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    is_auto_sync_enabled: true

- name: Create exadata_insights with entity_source = PE_COMANAGED_EXADATA
  oci_opsi_exadata_insights:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    exadata_infra_id: "ocid1.exadatainfra.oc1..xxxxxxEXAMPLExxxxxx"
    entity_source: PE_COMANAGED_EXADATA

    # optional
    member_vm_cluster_details:
    - # required
      vmcluster_id: "ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx"
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      opsi_private_endpoint_id: "ocid1.opsiprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
      dbm_private_endpoint_id: "ocid1.dbmprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
      member_database_details:
      - # required
        entity_source: EM_MANAGED_EXTERNAL_DATABASE
        compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
        database_id: "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx"
        database_resource_type: database_resource_type_example
        service_name: service_name_example
        credential_details:
          # required
          credential_source_name: credential_source_name_example
          credential_type: CREDENTIALS_BY_SOURCE
        deployment_type: VIRTUAL_MACHINE

        # optional
        freeform_tags: {'Department': 'Finance'}
        defined_tags: {'Operations': {'CostCenter': 'US'}}
        opsi_private_endpoint_id: "ocid1.opsiprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
        dbm_private_endpoint_id: "ocid1.dbmprivateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
        connection_details:
          # required
          hosts:
          - # optional
            host_ip: host_ip_example
            port: 56
            # optional
          protocol: TCP
          service_name: service_name_example
        system_tags: null
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update exadata_insights with entity_source = EM_MANAGED_EXTERNAL_EXADATA
  oci_opsi_exadata_insights:
    # required
    entity_source: EM_MANAGED_EXTERNAL_EXADATA

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    is_auto_sync_enabled: true

- name: Update exadata_insights with entity_source = PE_COMANAGED_EXADATA
  oci_opsi_exadata_insights:
    # required
    entity_source: PE_COMANAGED_EXADATA

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete exadata_insights
  oci_opsi_exadata_insights:
    # required
    exadata_insight_id: "ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

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
Details of the ExadataInsights resource acted upon by the current operation

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

Sample:
ocid1.enterprisemanagerbridge.oc1..xxxxxxEXAMPLExxxxxx
 
enterprise_manager_entity_display_name
string
on success
Enterprise Manager Entity Display Name

Sample:
enterprise_manager_entity_display_name_example
 
enterprise_manager_entity_identifier
string
on success
Enterprise Manager Entity Unique Identifier

Sample:
enterprise_manager_entity_identifier_example
 
enterprise_manager_entity_name
string
on success
Enterprise Manager Entity Name

Sample:
enterprise_manager_entity_name_example
 
enterprise_manager_entity_type
string
on success
Enterprise Manager Entity Type

Sample:
enterprise_manager_entity_type_example
 
enterprise_manager_identifier
string
on success
Enterprise Manager Unique Identifier

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.

Sample:
ocid1.exadatainfra.oc1..xxxxxxEXAMPLExxxxxx
 
exadata_infra_resource_type
string
on success
OCI exadata infrastructure resource type

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.

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.

Sample:
True
 
is_virtualized_exadata
boolean
on success
true if virtualization is used in the Exadata system

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)