oracle.oci.oci_log_analytics_lookup – Manage a LogAnalyticsLookup 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_lookup
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to update and delete a LogAnalyticsLookup resource in Oracle Cloud Infrastructure
This resource has the following action operations in the oracle.oci.oci_log_analytics_lookup_actions module: append_lookup_data, update_lookup_data.
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. |
|
categories
list
/ elements=dictionary
|
An array of categories to assign to the lookup. Specifying the name attribute for each category would suffice. Oracle-defined category assignments cannot be removed.
This parameter is updatable.
|
||
description
string
|
The category description.
This parameter is updatable.
|
||
display_name
string
|
The category display name.
This parameter is updatable.
aliases: name |
||
is_system
boolean
|
|
The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category.
This parameter is updatable.
|
|
name
string
|
The unique name that identifies the category.
This parameter is updatable.
|
||
type
string
|
The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".
This parameter is updatable.
|
||
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.
|
||
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 . |
||
default_match_value
string
|
The default match value.
This parameter is updatable.
|
||
description
string
|
The lookup description.
This parameter is updatable.
|
||
fields
list
/ elements=dictionary
|
The lookup fields.
This parameter is updatable.
|
||
common_field_name
string
|
The common field name.
This parameter is updatable.
|
||
default_match_value
string
|
The default match value.
This parameter is updatable.
|
||
display_name
string
|
The display name.
This parameter is updatable.
aliases: name |
||
is_common_field
boolean
|
|
A flag indicating whether or not the field is a common field.
This parameter is updatable.
|
|
match_operator
string
|
The match operator.
This parameter is updatable.
|
||
name
string
|
The field name.
This parameter is updatable.
|
||
position
integer
|
The position.
This parameter is updatable.
|
||
is_force
boolean
|
|
is force
|
|
lookup_name
string
/ required
|
The name of the lookup to operate on.
|
||
max_matches
integer
|
The maximum number of matches.
This parameter is updatable.
|
||
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. |
||
state
string
|
|
The state of the LogAnalyticsLookup.
Use state=present to update an existing a LogAnalyticsLookup.
Use state=absent to delete a LogAnalyticsLookup.
|
|
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Update log_analytics_lookup
oci_log_analytics_lookup:
# required
namespace_name: namespace_name_example
lookup_name: lookup_name_example
# optional
default_match_value: default_match_value_example
description: description_example
fields:
- # optional
common_field_name: common_field_name_example
default_match_value: default_match_value_example
display_name: display_name_example
is_common_field: true
match_operator: match_operator_example
name: name_example
position: 56
max_matches: 56
categories:
- # optional
name: name_example
description: description_example
display_name: display_name_example
type: type_example
is_system: true
- name: Delete log_analytics_lookup
oci_log_analytics_lookup:
# required
namespace_name: namespace_name_example
lookup_name: lookup_name_example
state: absent
# optional
is_force: true
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)