oracle.oci.oci_logging_log_actions – Perform actions on a Log 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_logging_log_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a Log resource in Oracle Cloud Infrastructure
For action=change_log_log_group, moves a log into a different log group within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource.
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 |
---|---|---|
action
string
/ required
|
|
The action to perform on the Log.
|
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.
|
|
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 . |
|
log_group_id
string
/ required
|
OCID of a log group to work with.
|
|
log_id
string
/ required
|
OCID of a log to work with.
aliases: id |
|
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. |
|
target_log_group_id
string
|
Log group OCID.
|
|
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: Perform action change_log_log_group on log
oci_logging_log_actions:
# required
log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
action: change_log_log_group
# optional
target_log_group_id: "ocid1.targetloggroup.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
log
complex
|
on success |
Details of the Log resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'configuration': {'archiving': {'is_enabled': True}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'source': {'category': 'category_example', 'parameters': {}, 'resource': 'resource_example', 'service': 'service_example', 'source_type': 'OCISERVICE'}}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'lifecycle_state': 'CREATING', 'log_group_id': 'ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx', 'log_type': 'CUSTOM', 'retention_duration': 56, 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_modified': '2013-10-20T19:20:30+01:00'}
|
|||
compartment_id
string
|
on success |
The OCID of the compartment that the resource belongs to.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
configuration
complex
|
on success |
|
|||
archiving
complex
|
on success |
|
|||
is_enabled
boolean
|
on success |
True if archiving enabled. This field is now deprecated, you should use Service Connector Hub to enable archiving.
Sample:
True
|
|||
compartment_id
string
|
on success |
The OCID of the compartment that the resource belongs to.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
source
complex
|
on success |
|
|||
category
string
|
on success |
Log object category.
Sample:
category_example
|
|||
parameters
dictionary
|
on success |
Log category parameters are stored here.
|
|||
resource
string
|
on success |
The unique identifier of the resource emitting the log.
Sample:
resource_example
|
|||
service
string
|
on success |
Service generating log.
Sample:
service_example
|
|||
source_type
string
|
on success |
The log source. * **OCISERVICE:** Oracle Service.
Sample:
OCISERVICE
|
|||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||
display_name
string
|
on success |
The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
|||
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
|||
id
string
|
on success |
The OCID of the resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
is_enabled
boolean
|
on success |
Whether or not this resource is currently enabled.
Sample:
True
|
|||
lifecycle_state
string
|
on success |
The pipeline state.
Sample:
CREATING
|
|||
log_group_id
string
|
on success |
Log group OCID.
Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
|
|||
log_type
string
|
on success |
The logType that the log object is for, whether custom or service.
Sample:
CUSTOM
|
|||
retention_duration
integer
|
on success |
Log retention duration in 30-day increments (30, 60, 90 and so on until 180).
Sample:
56
|
|||
tenancy_id
string
|
on success |
The OCID of the tenancy.
Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
|
|||
time_created
string
|
on success |
Time the resource was created.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_last_modified
string
|
on success |
Time the resource was last modified.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)