Try SpotterPerform actions on a CloudVmCluster resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Perform actions on a CloudVmCluster resource in Oracle Cloud Infrastructure
For I(action=add_virtual_machine), add Virtual Machines to the Cloud VM cluster. Applies to Exadata Cloud instances only.
For I(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 I(action=remove_virtual_machine), remove Virtual Machines from the Cloud VM cluster. Applies to Exadata Cloud instances only.
- 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
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
action:
choices:
- add_virtual_machine
- change_compartment
- remove_virtual_machine
description:
- The action to perform on the CloudVmCluster.
required: true
type: str
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
db_servers:
description:
- The list of ExaCS DB servers for the cluster to be added.
- Required for I(action=add_virtual_machine), I(action=remove_virtual_machine).
elements: dict
suboptions:
db_server_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of ExaDB-D DB server.
required: true
type: str
type: list
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
- Required for I(action=change_compartment).
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
cloud_vm_cluster_id:
aliases:
- id
description:
- The cloud VM cluster L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
required: true
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
cloud_vm_cluster:
contains:
availability_domain:
description:
- The name of the availability domain that the cloud Exadata infrastructure
resource is located in.
returned: on success
sample: Uocm:PHX-AD-1
type: str
backup_network_nsg_ids:
description:
- A list of the L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
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 L(Security
Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
Applicable only to Exadata systems.
returned: on success
sample: []
type: list
backup_subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the backup network subnet associated with the cloud VM cluster.
- '**Subnet Restriction:** See the subnet restrictions information for **subnetId**.'
returned: on success
sample: ocid1.backupsubnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
cloud_exadata_infrastructure_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the cloud Exadata infrastructure.
returned: on success
sample: ocid1.cloudexadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
type: str
cluster_name:
description:
- 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.
returned: on success
sample: cluster_name_example
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
cpu_core_count:
description:
- The number of CPU cores enabled on the cloud VM cluster.
returned: on success
sample: 56
type: int
data_collection_options:
contains:
is_diagnostics_events_enabled:
description:
- 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.
returned: on success
sample: true
type: bool
is_health_monitoring_enabled:
description:
- 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.
returned: on success
sample: true
type: bool
is_incident_logs_enabled:
description:
- 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.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
data_storage_percentage:
description:
- 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 L(Storage Configuration,https://docs.cloud.oracle.com/Content/Database/Concepts/exaoverview.htm#Exadata)
in the Exadata documentation for details on the impact of the configuration
settings on storage.
returned: on success
sample: 56
type: int
data_storage_size_in_tbs:
description:
- The data disk group size to be allocated in TBs.
returned: on success
sample: 1.2
type: float
db_node_storage_size_in_gbs:
description:
- The local node storage to be allocated in GBs.
returned: on success
sample: 56
type: int
db_servers:
description:
- The list of DB servers.
returned: on success
sample: []
type: list
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
returned: on success
sample:
Operations:
CostCenter: US
type: dict
disk_redundancy:
description:
- The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way
redundancy. HIGH is 3-way redundancy.
returned: on success
sample: HIGH
type: str
display_name:
description:
- The user-friendly name for the cloud VM cluster. The name does not need to
be unique.
returned: on success
sample: display_name_example
type: str
domain:
description:
- The domain name for the cloud VM cluster.
returned: on success
sample: domain_example
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
gi_version:
description:
- A valid Oracle Grid Infrastructure (GI) software version.
returned: on success
sample: gi_version_example
type: str
hostname:
description:
- The hostname for the cloud VM cluster.
returned: on success
sample: hostname_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the cloud VM cluster.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
iorm_config_cache:
contains:
db_plans:
contains:
db_name:
description:
- The database name. For the default `DbPlan`, the `dbName` is `default`.
returned: on success
sample: db_name_example
type: str
flash_cache_limit:
description:
- The flash cache limit for this database. This value is internally
configured based on the share value assigned to the database.
returned: on success
sample: flash_cache_limit_example
type: str
share:
description:
- The relative priority of this database.
returned: on success
sample: 56
type: int
description:
- An array of IORM settings for all the database in the Exadata DB system.
returned: on success
type: complex
lifecycle_details:
description:
- Additional information about the current `lifecycleState`.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of IORM configuration for the Exadata DB system.
returned: on success
sample: BOOTSTRAPPING
type: str
objective:
description:
- The current value for the IORM objective. The default is `AUTO`.
returned: on success
sample: LOW_LATENCY
type: str
description:
- ''
returned: on success
type: complex
is_local_backup_enabled:
description:
- 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.
returned: on success
sample: true
type: bool
is_sparse_diskgroup_enabled:
description:
- If true, sparse disk group is configured for the cloud VM cluster. If false,
sparse disk group is not created.
returned: on success
sample: true
type: bool
last_update_history_entry_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last maintenance update history entry. This value is updated when a
maintenance update starts.
returned: on success
sample: ocid1.lastupdatehistoryentry.oc1..xxxxxxEXAMPLExxxxxx
type: str
license_model:
description:
- The Oracle license model that applies to the cloud VM cluster. The default
is LICENSE_INCLUDED.
returned: on success
sample: LICENSE_INCLUDED
type: str
lifecycle_details:
description:
- Additional information about the current lifecycle state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of the cloud VM cluster.
returned: on success
sample: PROVISIONING
type: str
listener_port:
description:
- The port number configured for the listener on the cloud VM cluster.
returned: on success
sample: 56
type: int
memory_size_in_gbs:
description:
- The memory to be allocated in GBs.
returned: on success
sample: 56
type: int
node_count:
description:
- The number of nodes in the cloud VM cluster.
returned: on success
sample: 56
type: int
nsg_ids:
description:
- The list of L(OCIDs,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
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 L(Security Rules,https://docs.cloud.oracle.com/Content/Network/Concepts/securityrules.htm).
**NsgIds restrictions:** - A network security group (NSG) is optional for
Autonomous Databases with private access. The nsgIds list can be empty.
returned: on success
sample: []
type: list
ocpu_count:
description:
- The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal
place is allowed for the fractional part.
returned: on success
sample: 3.4
type: float
scan_dns_name:
description:
- The FQDN of the DNS record for the SCAN IP addresses that are associated with
the cloud VM cluster.
returned: on success
sample: scan_dns_name_example
type: str
scan_dns_record_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the DNS record for the SCAN IP addresses that are associated with the cloud
VM cluster.
returned: on success
sample: ocid1.scandnsrecord.oc1..xxxxxxEXAMPLExxxxxx
type: str
scan_ip_ids:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
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.'
returned: on success
sample: []
type: list
scan_listener_port_tcp:
description:
- The TCP Single Client Access Name (SCAN) port. The default port is 1521.
returned: on success
sample: 56
type: int
scan_listener_port_tcp_ssl:
description:
- The TCPS Single Client Access Name (SCAN) port. The default port is 2484.
returned: on success
sample: 56
type: int
shape:
description:
- The model name of the Exadata hardware running the cloud VM cluster.
returned: on success
sample: shape_example
type: str
ssh_public_keys:
description:
- The public key portion of one or more key pairs used for SSH access to the
cloud VM cluster.
returned: on success
sample:
- ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
type: list
storage_size_in_gbs:
description:
- The storage allocation for the disk group, in gigabytes (GB).
returned: on success
sample: 56
type: int
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
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.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
system_version:
description:
- Operating system version of the image.
returned: on success
sample: system_version_example
type: str
time_created:
description:
- The date and time that the cloud VM cluster was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_zone:
description:
- The time zone of the cloud VM cluster. For details, see L(Exadata Infrastructure
Time Zones,https://docs.cloud.oracle.com/Content/Database/References/timezones.htm).
returned: on success
sample: time_zone_example
type: str
vip_ids:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
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.'
returned: on success
sample: []
type: list
zone_id:
description:
- The OCID of the zone the cloud VM cluster is associated with.
returned: on success
sample: ocid1.zone.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Details of the CloudVmCluster resource acted upon by the current operation
returned: on success
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
type: complex