oracle.oci.oci_log_analytics_import_custom_content_actions – Perform actions on an ImportCustomContent resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on an ImportCustomContent resource in Oracle Cloud Infrastructure

  • For action=import_custom_content, imports the specified custom content from the input in zip format.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • import_custom_content
The action to perform on the ImportCustomContent.
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
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.
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.
expect
string
A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent. If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is "100-Continue" (case-insensitive).
import_custom_content_file_body_input_file
string / required
The file to upload which contains the custom content.
is_overwrite
boolean
    Choices:
  • no
  • yes
A flag indicating whether or not to overwrite existing content if a conflict is found during import content operation.
namespace_name
string / required
The Logging Analytics namespace used for the request.
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.
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

Examples

- name: Perform action import_custom_content on import_custom_content
  oci_log_analytics_import_custom_content_actions:
    # required
    namespace_name: namespace_name_example
    import_custom_content_file_body_input_file: import_custom_content_file_body_input_file_example
    action: import_custom_content

    # optional
    is_overwrite: true
    expect: expect_example

Return Values

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

Key Returned Description
import_custom_content
complex
on success
Details of the ImportCustomContent resource acted upon by the current operation

Sample:
{'change_list': {'conflict_field_display_names': [], 'conflict_parser_names': [], 'conflict_source_names': [], 'created_field_display_names': [], 'created_parser_names': [], 'created_source_names': [], 'updated_field_display_names': [], 'updated_parser_names': [], 'updated_source_names': []}, 'content_name': 'content_name_example', 'field_names': [], 'parser_names': [], 'source_names': []}
 
change_list
complex
on success

   
conflict_field_display_names
list / elements=string
on success
A list of field display names with conflicts.

   
conflict_parser_names
list / elements=string
on success
A list of parser names with conflicts.

   
conflict_source_names
list / elements=string
on success
A list of source names with conflicts.

   
created_field_display_names
list / elements=string
on success
An array of created field display names.

   
created_parser_names
list / elements=string
on success
An array of created parser names.

   
created_source_names
list / elements=string
on success
An array of created source names.

   
updated_field_display_names
list / elements=string
on success
An array of updated field display names.

   
updated_parser_names
list / elements=string
on success
An array of updated parser names.

   
updated_source_names
list / elements=string
on success
An array of updated source names.

 
content_name
string
on success
The content name.

Sample:
content_name_example
 
field_names
list / elements=string
on success
The field names.

 
parser_names
list / elements=string
on success
The parser names.

 
source_names
list / elements=string
on success
The source names.



Authors

  • Oracle (@oracle)