oracle.oci.oci_opensearch_cluster_actions – Perform actions on an OpensearchCluster resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.5.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_opensearch_cluster_actions.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on an OpensearchCluster resource in Oracle Cloud Infrastructure
For action=backup, backup the opensearch cluster details.
For action=opensearch_cluster_restore, restore the opensearch cluster details.
For action=resize_opensearch_cluster_horizontal, resize the opensearch cluster horizontal details.
For action=resize_opensearch_cluster_vertical, resize the opensearch cluster vertical details.
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 OpensearchCluster.
|
|
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.
|
|
|
compartment_id
string
|
The OCID of the compartment where the cluster backup is located.
Required for action=backup, action=opensearch_cluster_restore.
|
|
|
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. |
|
|
data_node_count
integer
|
The number of data nodes to configure for the cluster.
Applicable only for action=resize_opensearch_cluster_horizontal.
|
|
|
data_node_host_memory_gb
integer
|
The amount of memory in GB, to configure for the cluster's data nodes.
Applicable only for action=resize_opensearch_cluster_vertical.
|
|
|
data_node_host_ocpu_count
integer
|
The number of OCPUs to configure for the cluster's data nodes.
Applicable only for action=resize_opensearch_cluster_vertical.
|
|
|
data_node_storage_gb
integer
|
The amount of storage in GB, to configure per node for the cluster's data nodes.
Applicable only for action=resize_opensearch_cluster_vertical.
|
|
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Applicable only for action=resize_opensearch_cluster_horizontalaction=resize_opensearch_cluster_vertical.
|
|
|
display_name
string
|
The name of the cluster backup. Avoid entering confidential information.
Required for action=backup.
aliases: name |
|
|
freeform_tags
dictionary
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Applicable only for action=resize_opensearch_cluster_horizontalaction=resize_opensearch_cluster_vertical.
|
|
|
master_node_count
integer
|
The number of master nodes to configure for the cluster.
Applicable only for action=resize_opensearch_cluster_horizontal.
|
|
|
master_node_host_memory_gb
integer
|
The amount of memory in GB, to configure for the cluster's master nodes.
Applicable only for action=resize_opensearch_cluster_vertical.
|
|
|
master_node_host_ocpu_count
integer
|
The number of OCPUs to configure for the cluster's master nodes.
Applicable only for action=resize_opensearch_cluster_vertical.
|
|
|
opendashboard_node_count
integer
|
The number of OpenSearch Dashboard nodes to configure for the cluster.
Applicable only for action=resize_opensearch_cluster_horizontal.
|
|
|
opendashboard_node_host_memory_gb
integer
|
The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes.
Applicable only for action=resize_opensearch_cluster_vertical.
|
|
|
opendashboard_node_host_ocpu_count
integer
|
The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.
Applicable only for action=resize_opensearch_cluster_vertical.
|
|
|
opensearch_cluster_backup_id
string
|
The OCID of the cluster backup to restore.
Required for action=opensearch_cluster_restore.
|
|
|
opensearch_cluster_id
string
/ required
|
unique OpensearchCluster identifier
aliases: id |
|
|
prefix
string
|
The prefix for the indices in the cluster backup.
Applicable only for action=opensearch_cluster_restore.
|
|
|
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 backup on opensearch_cluster
oci_opensearch_cluster_actions:
# required
display_name: display_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
opensearch_cluster_id: "ocid1.opensearchcluster.oc1..xxxxxxEXAMPLExxxxxx"
action: backup
- name: Perform action opensearch_cluster_restore on opensearch_cluster
oci_opensearch_cluster_actions:
# required
opensearch_cluster_backup_id: "ocid1.opensearchclusterbackup.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
opensearch_cluster_id: "ocid1.opensearchcluster.oc1..xxxxxxEXAMPLExxxxxx"
action: opensearch_cluster_restore
# optional
prefix: prefix_example
- name: Perform action resize_opensearch_cluster_horizontal on opensearch_cluster
oci_opensearch_cluster_actions:
# required
opensearch_cluster_id: "ocid1.opensearchcluster.oc1..xxxxxxEXAMPLExxxxxx"
action: resize_opensearch_cluster_horizontal
# optional
master_node_count: 56
data_node_count: 56
opendashboard_node_count: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Perform action resize_opensearch_cluster_vertical on opensearch_cluster
oci_opensearch_cluster_actions:
# required
opensearch_cluster_id: "ocid1.opensearchcluster.oc1..xxxxxxEXAMPLExxxxxx"
action: resize_opensearch_cluster_vertical
# optional
master_node_host_ocpu_count: 56
master_node_host_memory_gb: 56
data_node_host_ocpu_count: 56
data_node_host_memory_gb: 56
data_node_storage_gb: 56
opendashboard_node_host_ocpu_count: 56
opendashboard_node_host_memory_gb: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)