oracle.oci.oci_database_cloud_vm_cluster_actions – Perform actions on a CloudVmCluster 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_database_cloud_vm_cluster_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a CloudVmCluster resource in Oracle Cloud Infrastructure

  • For action=add_virtual_machine, add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.

  • For action=change_compartment, moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

  • For action=remove_virtual_machine, remove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • add_virtual_machine
  • change_compartment
  • remove_virtual_machine
The action to perform on the CloudVmCluster.
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.
cloud_vm_cluster_id
string / required
The cloud VM cluster OCID.

aliases: id
compartment_id
string
The OCID of the 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.
db_servers
list / elements=dictionary
The list of ExaCS DB servers for the cluster to be added.
Required for action=add_virtual_machine, action=remove_virtual_machine.
db_server_id
string / required
The OCID of ExaCS Db server.
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
    Choices:
  • no
  • yes ←
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.

Examples

- name: Perform action add_virtual_machine on cloud_vm_cluster
  oci_database_cloud_vm_cluster_actions:
    # required
    db_servers:
    - # required
      db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx"
    cloud_vm_cluster_id: "ocid1.cloudvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
    action: add_virtual_machine

- name: Perform action change_compartment on cloud_vm_cluster
  oci_database_cloud_vm_cluster_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    cloud_vm_cluster_id: "ocid1.cloudvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action remove_virtual_machine on cloud_vm_cluster
  oci_database_cloud_vm_cluster_actions:
    # required
    db_servers:
    - # required
      db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx"
    cloud_vm_cluster_id: "ocid1.cloudvmcluster.oc1..xxxxxxEXAMPLExxxxxx"
    action: remove_virtual_machine

Return Values

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

Key Returned Description
cloud_vm_cluster
complex
on success
Details of the CloudVmCluster resource acted upon by the current operation

Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'backup_network_nsg_ids': [], 'backup_subnet_id': 'ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx', 'cloud_exadata_infrastructure_id': 'ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx', 'cluster_name': 'cluster_name_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'cpu_core_count': 56, 'data_collection_options': {'is_diagnostics_events_enabled': True, 'is_health_monitoring_enabled': True, 'is_incident_logs_enabled': True}, 'data_storage_percentage': 56, 'data_storage_size_in_tbs': 1.2, 'db_node_storage_size_in_gbs': 56, 'db_servers': [], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'disk_redundancy': 'HIGH', 'display_name': 'display_name_example', 'domain': 'domain_example', 'freeform_tags': {'Department': 'Finance'}, 'gi_version': 'gi_version_example', 'hostname': 'hostname_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'iorm_config_cache': {'db_plans': [{'db_name': 'db_name_example', 'flash_cache_limit': 'flash_cache_limit_example', 'share': 56}], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'BOOTSTRAPPING', 'objective': 'LOW_LATENCY'}, 'is_local_backup_enabled': True, 'is_sparse_diskgroup_enabled': True, 'last_update_history_entry_id': 'ocid1.lastupdatehistoryentry.oc1..xxxxxxEXAMPLExxxxxx', 'license_model': 'LICENSE_INCLUDED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'PROVISIONING', 'listener_port': 56, 'memory_size_in_gbs': 56, 'node_count': 56, 'nsg_ids': [], 'ocpu_count': 3.4, 'scan_dns_name': 'scan_dns_name_example', 'scan_dns_record_id': 'ocid1.scandnsrecord.oc1..xxxxxxEXAMPLExxxxxx', 'scan_ip_ids': [], 'scan_listener_port_tcp': 56, 'scan_listener_port_tcp_ssl': 56, 'shape': 'shape_example', 'ssh_public_keys': ['ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...'], 'storage_size_in_gbs': 56, 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_version': 'system_version_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_zone': 'time_zone_example', 'vip_ids': [], 'zone_id': 'ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx'}
 
availability_domain
string
on success
The name of the availability domain that the cloud Exadata infrastructure resource is located in.

Sample:
Uocm:PHX-AD-1
 
backup_network_nsg_ids
list / elements=string
on success
A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

 
backup_subnet_id
string
on success
The OCID of the backup network subnet associated with the cloud VM cluster.
**Subnet Restriction:** See the subnet restrictions information for **subnetId**.

Sample:
ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx
 
cloud_exadata_infrastructure_id
string
on success
The OCID of the cloud Exadata infrastructure.

Sample:
ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
 
cluster_name
string
on success
The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

Sample:
cluster_name_example
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
cpu_core_count
integer
on success
The number of CPU cores enabled on the cloud VM cluster.

Sample:
56
 
data_collection_options
complex
on success

   
is_diagnostics_events_enabled
boolean
on success
Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API.

Sample:
True
   
is_health_monitoring_enabled
boolean
on success
Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API.

Sample:
True
   
is_incident_logs_enabled
boolean
on success
Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API.

Sample:
True
 
data_storage_percentage
integer
on success
The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

Sample:
56
 
data_storage_size_in_tbs
float
on success
The data disk group size to be allocated in TBs.

Sample:
1.2
 
db_node_storage_size_in_gbs
integer
on success
The local node storage to be allocated in GBs.

Sample:
56
 
db_servers
list / elements=string
on success
The list of Db servers.

 
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.

Sample:
{'Operations': {'CostCenter': 'US'}}
 
disk_redundancy
string
on success
The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

Sample:
HIGH
 
display_name
string
on success
The user-friendly name for the cloud VM cluster. The name does not need to be unique.

Sample:
display_name_example
 
domain
string
on success
The domain name for the cloud VM cluster.

Sample:
domain_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'}
 
gi_version
string
on success
A valid Oracle Grid Infrastructure (GI) software version.

Sample:
gi_version_example
 
hostname
string
on success
The hostname for the cloud VM cluster.

Sample:
hostname_example
 
id
string
on success
The OCID of the cloud VM cluster.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
iorm_config_cache
complex
on success

   
db_plans
complex
on success
An array of IORM settings for all the database in the Exadata DB system.

     
db_name
string
on success
The database name. For the default `DbPlan`, the `dbName` is `default`.

Sample:
db_name_example
     
flash_cache_limit
string
on success
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.

Sample:
flash_cache_limit_example
     
share
integer
on success
The relative priority of this database.

Sample:
56
   
lifecycle_details
string
on success
Additional information about the current `lifecycleState`.

Sample:
lifecycle_details_example
   
lifecycle_state
string
on success
The current state of IORM configuration for the Exadata DB system.

Sample:
BOOTSTRAPPING
   
objective
string
on success
The current value for the IORM objective. The default is `AUTO`.

Sample:
LOW_LATENCY
 
is_local_backup_enabled
boolean
on success
If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

Sample:
True
 
is_sparse_diskgroup_enabled
boolean
on success
If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

Sample:
True
 
last_update_history_entry_id
string
on success
The OCID of the last maintenance update history entry. This value is updated when a maintenance update starts.

Sample:
ocid1.lastupdatehistoryentry.oc1..xxxxxxEXAMPLExxxxxx
 
license_model
string
on success
The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

Sample:
LICENSE_INCLUDED
 
lifecycle_details
string
on success
Additional information about the current lifecycle state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the cloud VM cluster.

Sample:
PROVISIONING
 
listener_port
integer
on success
The port number configured for the listener on the cloud VM cluster.

Sample:
56
 
memory_size_in_gbs
integer
on success
The memory to be allocated in GBs.

Sample:
56
 
node_count
integer
on success
The number of nodes in the cloud VM cluster.

Sample:
56
 
nsg_ids
list / elements=string
on success
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. **NsgIds restrictions:** - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

 
ocpu_count
float
on success
The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

Sample:
3.4
 
scan_dns_name
string
on success
The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

Sample:
scan_dns_name_example
 
scan_dns_record_id
string
on success
The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.

Sample:
ocid1.scandnsrecord.oc1..xxxxxxEXAMPLExxxxxx
 
scan_ip_ids
list / elements=string
on success
The OCID of the Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
**Note:** For a single-node DB system, this list is empty.

 
scan_listener_port_tcp
integer
on success
The TCP Single Client Access Name (SCAN) port. The default port is 1521.

Sample:
56
 
scan_listener_port_tcp_ssl
integer
on success
The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

Sample:
56
 
shape
string
on success
The model name of the Exadata hardware running the cloud VM cluster.

Sample:
shape_example
 
ssh_public_keys
list / elements=string
on success
The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

Sample:
['ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...']
 
storage_size_in_gbs
integer
on success
The storage allocation for the disk group, in gigabytes (GB).

Sample:
56
 
subnet_id
string
on success
The OCID of the subnet associated with the cloud VM cluster.
**Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
system_version
string
on success
Operating system version of the image.

Sample:
system_version_example
 
time_created
string
on success
The date and time that the cloud VM cluster was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_zone
string
on success
The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

Sample:
time_zone_example
 
vip_ids
list / elements=string
on success
The OCID of the virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
**Note:** For a single-node DB system, this list is empty.

 
zone_id
string
on success
The OCID of the zone the cloud VM cluster is associated with.

Sample:
ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)