oracle.oci.oci_opsi_operations_insights_warehouse_actions – Perform actions on an OperationsInsightsWarehouse resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_opsi_operations_insights_warehouse_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on an OperationsInsightsWarehouse resource in Oracle Cloud Infrastructure
For action=download_operations_insights_warehouse_wallet, download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.
For action=rotate_operations_insights_warehouse_wallet, rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed.
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 OperationsInsightsWarehouse.
|
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 . |
|
dest
string
|
The destination file path to write the output. The file will be created if it does not exist. If the file already exists, the content will be overwritten.
Required for action=download_operations_insights_warehouse_wallet.
|
|
operations_insights_warehouse_id
string
/ required
|
Unique Operations Insights Warehouse identifier
aliases: id |
|
operations_insights_warehouse_wallet_password
string
|
User provided ADW wallet password for the Operations Insights Warehouse.
Required for action=download_operations_insights_warehouse_wallet.
|
|
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. |
|
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 download_operations_insights_warehouse_wallet on operations_insights_warehouse
oci_opsi_operations_insights_warehouse_actions:
# required
dest: /tmp/myfile
operations_insights_warehouse_wallet_password: example-password
operations_insights_warehouse_id: "ocid1.operationsinsightswarehouse.oc1..xxxxxxEXAMPLExxxxxx"
action: download_operations_insights_warehouse_wallet
- name: Perform action rotate_operations_insights_warehouse_wallet on operations_insights_warehouse
oci_opsi_operations_insights_warehouse_actions:
# required
operations_insights_warehouse_id: "ocid1.operationsinsightswarehouse.oc1..xxxxxxEXAMPLExxxxxx"
action: rotate_operations_insights_warehouse_wallet
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
operations_insights_warehouse
complex
|
on success |
Details of the OperationsInsightsWarehouse resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'cpu_allocated': 1.2, 'cpu_used': 1.2, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'dynamic_group_id': 'ocid1.dynamicgroup.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'operations_insights_tenancy_id': 'ocid1.operationsinsightstenancy.oc1..xxxxxxEXAMPLExxxxxx', 'storage_allocated_in_gbs': 1.2, 'storage_used_in_gbs': 1.2, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_wallet_rotated': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
|
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
cpu_allocated
float
|
on success |
Number of OCPUs allocated to OPSI Warehouse ADW.
Sample:
1.2
|
|
cpu_used
float
|
on success |
Number of OCPUs used by OPSI Warehouse ADW. Can be fractional.
Sample:
1.2
|
|
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'}}
|
|
display_name
string
|
on success |
User-friedly name of Operations Insights Warehouse that does not have to be unique.
Sample:
display_name_example
|
|
dynamic_group_id
string
|
on success |
OCID of the dynamic group created for the warehouse
Sample:
ocid1.dynamicgroup.oc1..xxxxxxEXAMPLExxxxxx
|
|
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'}
|
|
id
string
|
on success |
OPSI Warehouse OCID
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
|
lifecycle_state
string
|
on success |
Possible lifecycle states
Sample:
CREATING
|
|
operations_insights_tenancy_id
string
|
on success |
Tenancy Identifier of Operations Insights service
Sample:
ocid1.operationsinsightstenancy.oc1..xxxxxxEXAMPLExxxxxx
|
|
storage_allocated_in_gbs
float
|
on success |
Storage allocated to OPSI Warehouse ADW.
Sample:
1.2
|
|
storage_used_in_gbs
float
|
on success |
Storage by OPSI Warehouse ADW in GB.
Sample:
1.2
|
|
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|
time_created
string
|
on success |
The time at which the resource was first created. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
|
time_last_wallet_rotated
string
|
on success |
The time at which the ADW wallet was last rotated for the Operations Insights Warehouse. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
The time at which the resource was last updated. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)