oracle.oci.oci_analytics_instance_actions – Perform actions on an AnalyticsInstance 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_analytics_instance_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on an AnalyticsInstance resource in Oracle Cloud Infrastructure
For action=change_compartment, change the compartment of an Analytics instance. The operation is long-running and creates a new WorkRequest.
For action=change_analytics_instance_network_endpoint, change an Analytics instance network endpoint. The operation is long-running and creates a new WorkRequest.
For action=scale, scale an Analytics instance up or down. The operation is long-running and creates a new WorkRequest.
For action=set_kms_key, encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.
For action=start, starts the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
For action=stop, stop the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
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 AnalyticsInstance.
|
||
analytics_instance_id
string
/ required
|
The OCID of the AnalyticsInstance.
aliases: id |
|||
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. |
||
capacity
dictionary
|
Required for action=scale.
|
|||
capacity_type
string
/ required
|
|
The capacity model to use.
|
||
capacity_value
integer
/ required
|
The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the 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.
|
|||
compartment_id
string
|
The OCID of the new compartment.
Required for action=change_compartment.
|
|||
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 . |
|||
kms_key_id
string
|
OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. An empty value indicates Oracle managed default encryption (null is not supported in this API).
Required for action=set_kms_key.
|
|||
network_endpoint_details
dictionary
|
Required for action=change_analytics_instance_network_endpoint.
|
|||
network_endpoint_type
string
/ required
|
|
The type of network endpoint.
|
||
network_security_group_ids
list
/ elements=string
|
Network Security Group OCIDs for an Analytics instance.
Applicable when network_endpoint_type is 'PRIVATE'
|
|||
subnet_id
string
|
The subnet OCID for the private endpoint.
Required when network_endpoint_type is 'PRIVATE'
|
|||
vcn_id
string
|
The VCN OCID for the private endpoint.
Required when network_endpoint_type is 'PRIVATE'
|
|||
whitelisted_ips
list
/ elements=string
|
Source IP addresses or IP address ranges in ingress rules.
Applicable when network_endpoint_type is 'PUBLIC'
|
|||
whitelisted_services
list
/ elements=string
|
|
Oracle Cloud Services that are allowed to access this Analytics instance.
Applicable when network_endpoint_type is 'PUBLIC'
|
||
whitelisted_vcns
list
/ elements=dictionary
|
Virtual Cloud Networks allowed to access this network endpoint.
Applicable when network_endpoint_type is 'PUBLIC'
|
|||
id
string
/ required
|
The Virtual Cloud Network OCID.
Required when network_endpoint_type is 'PUBLIC'
|
|||
whitelisted_ips
list
/ elements=string
|
Source IP addresses or IP address ranges in ingress rules.
Applicable when network_endpoint_type is 'PUBLIC'
|
|||
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 change_compartment on analytics_instance
oci_analytics_instance_actions:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
- name: Perform action change_analytics_instance_network_endpoint on analytics_instance
oci_analytics_instance_actions:
# required
network_endpoint_details:
# required
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
network_endpoint_type: PRIVATE
# optional
network_security_group_ids: [ "network_security_group_ids_example" ]
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
action: change_analytics_instance_network_endpoint
- name: Perform action scale on analytics_instance
oci_analytics_instance_actions:
# required
capacity:
# required
capacity_type: OLPU_COUNT
capacity_value: 56
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
action: scale
- name: Perform action set_kms_key on analytics_instance
oci_analytics_instance_actions:
# required
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
action: set_kms_key
- name: Perform action start on analytics_instance
oci_analytics_instance_actions:
# required
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
action: start
- name: Perform action stop on analytics_instance
oci_analytics_instance_actions:
# required
analytics_instance_id: "ocid1.analyticsinstance.oc1..xxxxxxEXAMPLExxxxxx"
action: stop
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
analytics_instance
complex
|
on success |
Details of the AnalyticsInstance resource acted upon by the current operation
Sample:
{'capacity': {'capacity_type': 'OLPU_COUNT', 'capacity_value': 56}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'email_notification': 'email_notification_example', 'feature_set': 'SELF_SERVICE_ANALYTICS', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'license_type': 'LICENSE_INCLUDED', 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'network_endpoint_details': {'network_endpoint_type': 'PUBLIC', 'network_security_group_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx', 'whitelisted_ips': [], 'whitelisted_services': [], 'whitelisted_vcns': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'whitelisted_ips': []}]}, 'private_access_channels': {'display_name': 'display_name_example', 'egress_source_ip_addresses': [], 'ip_address': 'ip_address_example', 'key': 'key_example', 'network_security_group_ids': [], 'private_source_dns_zones': [{'description': 'description_example', 'dns_zone': 'dns_zone_example'}], 'private_source_scan_hosts': [{'description': 'description_example', 'scan_hostname': 'scan_hostname_example', 'scan_port': 56}], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}, 'service_url': 'service_url_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'vanity_url_details': {'description': 'description_example', 'hosts': [], 'key': 'key_example', 'public_certificate': '-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----', 'urls': []}}
|
|||
capacity
complex
|
on success |
|
|||
capacity_type
string
|
on success |
The capacity model to use.
Sample:
OLPU_COUNT
|
|||
capacity_value
integer
|
on success |
The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the number of CPUs, amount of memory or other resources allocated to the instance.
Sample:
56
|
|||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
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'}}
|
|||
description
string
|
on success |
Optional description.
Sample:
description_example
|
|||
email_notification
string
|
on success |
Email address receiving notifications.
Sample:
email_notification_example
|
|||
feature_set
string
|
on success |
Analytics feature set.
Sample:
SELF_SERVICE_ANALYTICS
|
|||
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 resource OCID.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
kms_key_id
string
|
on success |
The OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
|
|||
license_type
string
|
on success |
The license used for the service.
Sample:
LICENSE_INCLUDED
|
|||
lifecycle_state
string
|
on success |
The current state of an instance.
Sample:
ACTIVE
|
|||
name
string
|
on success |
The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
Sample:
name_example
|
|||
network_endpoint_details
complex
|
on success |
|
|||
network_endpoint_type
string
|
on success |
The type of network endpoint.
Sample:
PUBLIC
|
|||
network_security_group_ids
list
/ elements=string
|
on success |
Network Security Group OCIDs for an Analytics instance.
|
|||
subnet_id
string
|
on success |
The subnet OCID for the private endpoint.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|||
vcn_id
string
|
on success |
The VCN OCID for the private endpoint.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
|||
whitelisted_ips
list
/ elements=string
|
on success |
Source IP addresses or IP address ranges in ingress rules.
|
|||
whitelisted_services
list
/ elements=string
|
on success |
Oracle Cloud Services that are allowed to access this Analytics instance.
|
|||
whitelisted_vcns
complex
|
on success |
Virtual Cloud Networks allowed to access this network endpoint.
|
|||
id
string
|
on success |
The Virtual Cloud Network OCID.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
whitelisted_ips
list
/ elements=string
|
on success |
Source IP addresses or IP address ranges in ingress rules.
|
|||
private_access_channels
complex
|
on success |
Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
|
|||
display_name
string
|
on success |
Display Name of the Private Access Channel.
Sample:
display_name_example
|
|||
egress_source_ip_addresses
list
/ elements=string
|
on success |
The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources.
|
|||
ip_address
string
|
on success |
IP Address of the Private Access channel.
Sample:
ip_address_example
|
|||
key
string
|
on success |
Private Access Channel unique identifier key.
Sample:
key_example
|
|||
network_security_group_ids
list
/ elements=string
|
on success |
Network Security Group OCIDs for an Analytics instance.
|
|||
private_source_dns_zones
complex
|
on success |
List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
|
|||
description
string
|
on success |
Description of private source dns zone.
Sample:
description_example
|
|||
dns_zone
string
|
on success |
Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
Sample:
dns_zone_example
|
|||
private_source_scan_hosts
complex
|
on success |
List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
|
|||
description
string
|
on success |
Description of private source scan host zone.
Sample:
description_example
|
|||
scan_hostname
string
|
on success |
Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
Sample:
scan_hostname_example
|
|||
scan_port
integer
|
on success |
Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
Sample:
56
|
|||
subnet_id
string
|
on success |
OCID of the customer subnet connected to private access channel.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|||
vcn_id
string
|
on success |
OCID of the customer VCN peered with private access channel.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
|||
service_url
string
|
on success |
URL of the Analytics service.
Sample:
service_url_example
|
|||
time_created
string
|
on success |
The date and time the instance was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_updated
string
|
on success |
The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.
Sample:
2013-10-20T19:20:30+01:00
|
|||
vanity_url_details
complex
|
on success |
Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.
|
|||
description
string
|
on success |
Description of the vanity url.
Sample:
description_example
|
|||
hosts
list
/ elements=string
|
on success |
List of fully qualified hostnames supported by this vanity URL definition (max of 3).
|
|||
key
string
|
on success |
The vanity url unique identifier key.
Sample:
key_example
|
|||
public_certificate
string
|
on success |
PEM certificate for HTTPS connections.
Sample:
-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----
|
|||
urls
list
/ elements=string
|
on success |
List of urls supported by this vanity URL definition (max of 3).
|
Authors¶
Oracle (@oracle)