oracle.oci.oci_log_analytics_entity – Manage a LogAnalyticsEntity 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_log_analytics_entity.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, create a new log analytics entity.

  • This resource has the following action operations in the oracle.oci.oci_log_analytics_entity_actions module: add_entity_association, change_compartment, remove_entity_associations.

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.
cloud_resource_id
string
The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises.
compartment_id
string
Compartment Identifier OCID].
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
entity_type_name
string
Log analytics entity type name.
Required for create using state=present.
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.
hostname
string
The hostname where the entity represented here is actually present. This would be the output one would get if they run `echo $HOSTNAME` on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.
This parameter is updatable.
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.
log_analytics_entity_id
string
The log analytics entity OCID.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
management_agent_id
string
The OCID of the Management Agent.
This parameter is updatable.
name
string
Log analytics entity name.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.
namespace_name
string / required
The Logging Analytics namespace used for the request.
properties
dictionary
The name/value pairs for parameter values to be used in file patterns specified in log sources.
This parameter is updatable.
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.
source_id
string
This indicates the type of source. It is primarily for Enterprise Manager Repository ID.
state
string
    Choices:
  • present ←
  • absent
The state of the LogAnalyticsEntity.
Use state=present to create or update a LogAnalyticsEntity.
Use state=absent to delete a LogAnalyticsEntity.
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
timezone_region
string
The timezone region of the log analytics entity.
This parameter is updatable.
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 log_analytics_entity
  oci_log_analytics_entity:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    entity_type_name: entity_type_name_example
    name: name_example
    namespace_name: namespace_name_example

    # optional
    cloud_resource_id: "ocid1.cloudresource.oc1..xxxxxxEXAMPLExxxxxx"
    source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"
    management_agent_id: "ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx"
    timezone_region: Asia/Kolkata
    hostname: hostname_example
    properties: null
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update log_analytics_entity
  oci_log_analytics_entity:
    # required
    namespace_name: namespace_name_example
    log_analytics_entity_id: "ocid1.loganalyticsentity.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    management_agent_id: "ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx"
    timezone_region: Asia/Kolkata
    hostname: hostname_example
    properties: null
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update log_analytics_entity using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_log_analytics_entity:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    namespace_name: namespace_name_example

    # optional
    management_agent_id: "ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx"
    timezone_region: Asia/Kolkata
    hostname: hostname_example
    properties: null
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete log_analytics_entity
  oci_log_analytics_entity:
    # required
    namespace_name: namespace_name_example
    log_analytics_entity_id: "ocid1.loganalyticsentity.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete log_analytics_entity using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_log_analytics_entity:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    namespace_name: namespace_name_example
    state: absent

Return Values

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

Key Returned Description
log_analytics_entity
complex
on success
Details of the LogAnalyticsEntity resource acted upon by the current operation

Sample:
{'are_logs_collected': True, 'cloud_resource_id': 'ocid1.cloudresource.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'creation_source': {'details': 'details_example', 'type': 'EM_BRIDGE'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'entity_type_internal_name': 'entity_type_internal_name_example', 'entity_type_name': 'entity_type_name_example', 'freeform_tags': {'Department': 'Finance'}, 'hostname': 'hostname_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'management_agent_compartment_id': 'ocid1.managementagentcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'management_agent_display_name': 'management_agent_display_name_example', 'management_agent_id': 'ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'properties': {}, 'source_id': 'ocid1.source.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'timezone_region': 'Asia/Kolkata'}
 
are_logs_collected
boolean
on success
The Boolean flag to indicate if logs are collected for an entity for log analytics usage.

Sample:
True
 
cloud_resource_id
string
on success
The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises.

Sample:
ocid1.cloudresource.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
Compartment Identifier OCID].

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
creation_source
complex
on success

   
details
string
on success
This will provide additional details for source of auto-creation. For example, if entity is auto-created by enterprise manager bridge, this field provides additional detail on enterprise manager that contributed to the entity auto-creation.

Sample:
details_example
   
type
string
on success
Source that auto-created the entity.

Sample:
EM_BRIDGE
 
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_type_internal_name
string
on success
Internal name for the log analytics entity type.

Sample:
entity_type_internal_name_example
 
entity_type_name
string
on success
Log analytics entity type name.

Sample:
entity_type_name_example
 
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'}
 
hostname
string
on success
The hostname where the entity represented here is actually present. This would be the output one would get if they run `echo $HOSTNAME` on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.

Sample:
hostname_example
 
id
string
on success
The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the log analytics entity.

Sample:
ACTIVE
 
management_agent_compartment_id
string
on success
Management agent (management-agents resource kind) compartment OCID

Sample:
ocid1.managementagentcompartment.oc1..xxxxxxEXAMPLExxxxxx
 
management_agent_display_name
string
on success
Management agent (management-agents resource kind) display name

Sample:
management_agent_display_name_example
 
management_agent_id
string
on success
The OCID of the Management Agent.

Sample:
ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx
 
name
string
on success
Log analytics entity name.

Sample:
name_example
 
properties
dictionary
on success
The name/value pairs for parameter values to be used in file patterns specified in log sources.
 
source_id
string
on success
This indicates the type of source. It is primarily for Enterprise Manager Repository ID.

Sample:
ocid1.source.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the resource was created, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the resource was last updated, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
timezone_region
string
on success
The timezone region of the log analytics entity.

Sample:
Asia/Kolkata


Authors

  • Oracle (@oracle)