oracle / oracle.oci / 2.38.0 / module / oci_database_autonomous_vm_cluster Manage an AutonomousVmCluster resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_autonomous_vm_cluster (2.38.0) — module
Install with ansible-galaxy collection install oracle.oci:==2.38.0
collections: - name: oracle.oci version: 2.38.0
This module allows the user to create, update and delete an AutonomousVmCluster resource in Oracle Cloud Infrastructure
For I(state=present), creates an Autonomous VM cluster for Exadata Cloud@Customer.
This resource has the following action operations in the M(oracle.oci.oci_database_autonomous_vm_cluster_actions) module: change_compartment.
- name: Create autonomous_vm_cluster oci_database_autonomous_vm_cluster: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx" # optional time_zone: time_zone_example is_local_backup_enabled: true license_model: LICENSE_INCLUDED freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update autonomous_vm_cluster oci_database_autonomous_vm_cluster: # required autonomous_vm_cluster_id: "ocid1.autonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx" # optional license_model: LICENSE_INCLUDED freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update autonomous_vm_cluster using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_database_autonomous_vm_cluster: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example # optional license_model: LICENSE_INCLUDED freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete autonomous_vm_cluster oci_database_autonomous_vm_cluster: # required autonomous_vm_cluster_id: "ocid1.autonomousvmcluster.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete autonomous_vm_cluster using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_database_autonomous_vm_cluster: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example state: absent
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the AutonomousVmCluster. - Use I(state=present) to create or update an AutonomousVmCluster. - Use I(state=absent) to delete an AutonomousVmCluster. required: false type: str key_by: description: The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource. elements: str type: list 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 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 time_zone: description: - The time zone to use for the Autonomous VM cluster. For details, see L(DB System Time Zones,https://docs.cloud.oracle.com/Content/Database/References/timezones.htm). type: str 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). - This parameter is updatable. type: dict display_name: aliases: - name description: - The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. - Required for create using I(state=present). - Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str force_create: default: false description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with I(key_by). type: bool 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 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"}`' - This parameter is updatable. type: dict license_model: choices: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE description: - The Oracle license model that applies to the Autonomous VM cluster. The default is BRING_YOUR_OWN_LICENSE. - This parameter is updatable. type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. 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 vm_cluster_network_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VM cluster network. - Required for create using I(state=present). type: str is_local_backup_enabled: description: - If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. type: bool 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 autonomous_vm_cluster_id: aliases: - id description: - The autonomous VM cluster L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str exadata_infrastructure_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. - Required for create using I(state=present). type: str
autonomous_vm_cluster: contains: available_cpus: description: - The numnber of CPU cores available. returned: on success sample: 56 type: int available_data_storage_size_in_tbs: description: - The data storage available in TBs returned: on success sample: 1.2 type: float 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_storage_size_in_tbs: description: - The total data storage allocated in TBs 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 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 Autonomous 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 id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Autonomous 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 Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. returned: on success sample: true type: bool license_model: description: - The Oracle license model that applies to the Autonomous 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 Autonomous 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 time_created: description: - The date and time that the Autonomous VM cluster was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_zone: description: - The time zone to use for the Autonomous VM cluster. For details, see L(DB System 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: - Details of the AutonomousVmCluster resource acted upon by the current operation returned: on success sample: available_cpus: 56 available_data_storage_size_in_tbs: 1.2 compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx cpus_enabled: 56 data_storage_size_in_tbs: 1.2 db_node_storage_size_in_gbs: 56 defined_tags: Operations: CostCenter: US display_name: display_name_example exadata_infrastructure_id: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_local_backup_enabled: true license_model: LICENSE_INCLUDED lifecycle_details: lifecycle_details_example lifecycle_state: PROVISIONING memory_size_in_gbs: 56 time_created: '2013-10-20T19:20:30+01:00' time_zone: time_zone_example vm_cluster_network_id: ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx type: complex