oracle.oci.oci_log_analytics_entity_type_facts – Fetches details about one or multiple LogAnalyticsEntityType 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_log_analytics_entity_type_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple LogAnalyticsEntityType resources in Oracle Cloud Infrastructure
Return a list of log analytics entity types.
If entity_type_name is specified, the details of a single LogAnalyticsEntityType 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.
|
|
cloud_type
string
|
|
A filter to return CLOUD or NON_CLOUD entity types.
|
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 . |
|
entity_type_name
string
|
Log analytics entity type name.
Required to get a specific log_analytics_entity_type.
|
|
lifecycle_state
string
|
|
A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.
|
name
string
|
A filter to return only log analytics entity types whose name matches the entire name given. The match is case-insensitive.
|
|
name_contains
string
|
A filter to return only log analytics entity types whose name or internalName contains name given. The match is case-insensitive.
|
|
namespace_name
string
/ required
|
The Logging Analytics namespace used for the request.
|
|
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
|
|
The field to sort by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for name is ascending. If no value is specified timeCreated is default.
|
sort_order
string
|
|
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 |
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 log_analytics_entity_type
oci_log_analytics_entity_type_facts:
# required
entity_type_name: entity_type_name_example
namespace_name: namespace_name_example
- name: List log_analytics_entity_types
oci_log_analytics_entity_type_facts:
# required
namespace_name: namespace_name_example
# optional
name: name_example
name_contains: name_contains_example
cloud_type: CLOUD
lifecycle_state: ACTIVE
sort_order: ASC
sort_by: timeCreated
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
log_analytics_entity_types
complex
|
on success |
List of LogAnalyticsEntityType resources
Sample:
[{'category': 'category_example', 'cloud_type': 'CLOUD', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'internal_name': 'internal_name_example', 'lifecycle_state': 'ACTIVE', 'management_agent_eligibility_status': 'ELIGIBLE', 'name': 'name_example', 'properties': [{'description': 'description_example', 'name': 'name_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
||
category
string
|
on success |
Log analytics entity type category. Category will be used for grouping and filtering.
Sample:
category_example
|
||
cloud_type
string
|
on success |
Log analytics entity type group. That can be CLOUD (OCI) or NON_CLOUD otherwise.
Sample:
CLOUD
|
||
compartment_id
string
|
on success |
Compartment Identifier OCID].
Returned for get operation
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
internal_name
string
|
on success |
Internal name for the log analytics entity type.
Sample:
internal_name_example
|
||
lifecycle_state
string
|
on success |
The current lifecycle state of the log analytics entity.
Sample:
ACTIVE
|
||
management_agent_eligibility_status
string
|
on success |
This field indicates whether logs for entities of this type can be collected using a management agent.
Sample:
ELIGIBLE
|
||
name
string
|
on success |
Log analytics entity type name.
Sample:
name_example
|
||
properties
complex
|
on success |
The parameters used in file patterns specified in log sources for this log analytics entity type.
Returned for get operation
|
||
description
string
|
on success |
Description for the log analytics entity type property.
Sample:
description_example
|
||
name
string
|
on success |
Log analytics entity type property name.
Sample:
name_example
|
||
time_created
string
|
on success |
Time the log analytics entity type was created. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
Time the log analytics entity type was updated. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)