Try SpotterFetches details about one or multiple VmCluster resources 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.0Fetches details about one or multiple VmCluster resources in Oracle Cloud Infrastructure
Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the cloud VM clusters in an Exadata Cloud Service instance, use the L(ListCloudVmClusters ,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/CloudVmCluster/ListCloudVmClusters) operation.
If I(vm_cluster_id) is specified, the details of a single VmCluster will be returned.
- name: Get a specific vm_cluster
oci_database_vm_cluster_facts:
# required
vm_cluster_id: "ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx"
- name: List vm_clusters
oci_database_vm_cluster_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: PROVISIONING
display_name: display_name_example
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
sort_by:
choices:
- TIMECREATED
- DISPLAYNAME
description:
- The field to sort by. You can provide one sort order (`sortOrder`). Default order
for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The
DISPLAYNAME sort order is case sensitive.
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
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either ascending (`ASC`) or descending (`DESC`).
type: str
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
display_name:
aliases:
- name
description:
- A filter to return only resources that match the entire display name given. The
match is not case sensitive.
type: str
vm_cluster_id:
aliases:
- id
description:
- The VM cluster L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required to get a specific vm_cluster.
type: str
compartment_id:
description:
- The compartment L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
- Required to list multiple vm_clusters.
type: str
lifecycle_state:
choices:
- PROVISIONING
- AVAILABLE
- UPDATING
- TERMINATING
- TERMINATED
- FAILED
- MAINTENANCE_IN_PROGRESS
description:
- A filter to return only resources that match the given lifecycle state exactly.
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
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
exadata_infrastructure_id:
description:
- If provided, filters the results for the given Exadata Infrastructure.
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
vm_clusters:
contains:
availability_domain:
description:
- The name of the availability domain that the VM cluster is located in.
returned: on success
sample: Uocm:PHX-AD-1
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
cpus_enabled:
description:
- The number of enabled CPU cores.
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_size_in_gbs:
description:
- Size of the DATA disk group in GBs.
returned: on success
sample: 1.2
type: float
data_storage_size_in_tbs:
description:
- Size, in terabytes, of the DATA disk group.
returned: on success
sample: 1.2
type: float
db_node_storage_size_in_gbs:
description:
- The local node storage allocated in GBs.
returned: on success
sample: 56
type: int
db_servers:
description:
- The list of Db server.
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
display_name:
description:
- The user-friendly name for the Exadata Cloud@Customer VM cluster. The name
does not need to be unique.
returned: on success
sample: display_name_example
type: str
exadata_infrastructure_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Exadata infrastructure.
returned: on success
sample: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
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:
- The Oracle Grid Infrastructure software version for the VM cluster.
returned: on success
sample: gi_version_example
type: str
id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the VM cluster.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
is_local_backup_enabled:
description:
- If true, database backup on local Exadata storage is configured for the VM
cluster. If false, database backup on local Exadata storage is not available
in the VM cluster.
returned: on success
sample: true
type: bool
is_sparse_diskgroup_enabled:
description:
- If true, sparse disk group is configured for the VM cluster. If false, sparse
disk group is not created.
returned: on success
sample: true
type: bool
last_patch_history_entry_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the last patch history. This value is updated as soon as a patch operation
starts.
returned: on success
sample: ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx
type: str
license_model:
description:
- The Oracle license model that applies to the 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 VM cluster.
returned: on success
sample: PROVISIONING
type: str
memory_size_in_gbs:
description:
- The memory allocated in GBs.
returned: on success
sample: 56
type: int
ocpus_enabled:
description:
- The number of enabled OCPU cores.
returned: on success
sample: 3.4
type: float
shape:
description:
- The shape of the Exadata infrastructure. The shape determines the amount of
CPU, storage, and memory resources allocated to the instance.
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
VM cluster.
returned: on success
sample:
- ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
type: list
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 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 Exadata infrastructure. 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
vm_cluster_network_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the VM cluster network.
returned: on success
sample: ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- List of VmCluster resources
returned: on success
sample:
- availability_domain: Uocm:PHX-AD-1
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
cpus_enabled: 56
data_collection_options:
is_diagnostics_events_enabled: true
is_health_monitoring_enabled: true
is_incident_logs_enabled: true
data_storage_size_in_gbs: 1.2
data_storage_size_in_tbs: 1.2
db_node_storage_size_in_gbs: 56
db_servers: []
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
exadata_infrastructure_id: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
freeform_tags:
Department: Finance
gi_version: gi_version_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
is_local_backup_enabled: true
is_sparse_diskgroup_enabled: true
last_patch_history_entry_id: ocid1.lastpatchhistoryentry.oc1..xxxxxxEXAMPLExxxxxx
license_model: LICENSE_INCLUDED
lifecycle_details: lifecycle_details_example
lifecycle_state: PROVISIONING
memory_size_in_gbs: 56
ocpus_enabled: 3.4
shape: shape_example
ssh_public_keys:
- ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
system_version: system_version_example
time_created: '2013-10-20T19:20:30+01:00'
time_zone: time_zone_example
vm_cluster_network_id: ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx
type: complex