oracle / oracle.oci / 5.0.0 / module / oci_database_management_external_cluster Manage an ExternalCluster resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_external_cluster (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
This module allows the user to update an ExternalCluster resource in Oracle Cloud Infrastructure
- name: Update external_cluster oci_database_management_external_cluster: # required external_cluster_id: "ocid1.externalcluster.oc1..xxxxxxEXAMPLExxxxxx" # optional external_connector_id: "ocid1.externalconnector.oc1..xxxxxxEXAMPLExxxxxx"
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present default: present description: - The state of the ExternalCluster. - Use I(state=present) to update an existing an ExternalCluster. required: false 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 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 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 external_cluster_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external cluster. required: true 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 external_connector_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external connector. - This parameter is updatable. 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
external_cluster: contains: additional_details: description: - 'The additional details of the external cluster defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`' returned: on success sample: {} type: dict 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 component_name: description: - The name of the external cluster. returned: on success sample: component_name_example type: str display_name: description: - The user-friendly name for the external cluster. The name does not have to be unique. returned: on success sample: display_name_example type: str external_connector_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external connector. returned: on success sample: ocid1.externalconnector.oc1..xxxxxxEXAMPLExxxxxx type: str external_db_system_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external DB system that the cluster is a part of. returned: on success sample: ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx type: str grid_home: description: - The directory in which Oracle Grid Infrastructure is installed. returned: on success sample: grid_home_example type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the external cluster. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_flex_cluster: description: - Indicates whether the cluster is Oracle Flex Cluster or not. returned: on success sample: true type: bool lifecycle_details: description: - Additional information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current lifecycle state of the external cluster. returned: on success sample: CREATING type: str network_configurations: contains: network_number: description: - The network number. returned: on success sample: 56 type: int network_type: description: - The network type. returned: on success sample: AUTOCONFIG type: str subnet: description: - The subnet for the network. returned: on success sample: subnet_example type: str description: - The list of network address configurations of the external cluster. returned: on success type: complex ocr_file_location: description: - The location of the Oracle Cluster Registry (OCR). returned: on success sample: ocr_file_location_example type: str scan_configurations: contains: network_number: description: - The network number from which SCAN VIPs are obtained. returned: on success sample: 56 type: int scan_name: description: - The name of the SCAN listener. returned: on success sample: scan_name_example type: str scan_port: description: - The port number of the SCAN listener. returned: on success sample: 56 type: int scan_protocol: description: - The protocol of the SCAN listener. returned: on success sample: TCP type: str description: - The list of Single Client Access Name (SCAN) configurations of the external cluster. returned: on success type: complex time_created: description: - The date and time the external cluster was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_updated: description: - The date and time the external cluster was last updated. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str version: description: - The cluster version. returned: on success sample: version_example type: str vip_configurations: contains: address: description: - The VIP name or IP address. returned: on success sample: address_example type: str network_number: description: - The network number from which VIPs are obtained. returned: on success sample: 56 type: int node_name: description: - The name of the node with the VIP. returned: on success sample: node_name_example type: str description: - The list of Virtual IP (VIP) configurations of the external cluster. returned: on success type: complex description: - Details of the ExternalCluster resource acted upon by the current operation returned: on success sample: additional_details: {} compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx component_name: component_name_example display_name: display_name_example external_connector_id: ocid1.externalconnector.oc1..xxxxxxEXAMPLExxxxxx external_db_system_id: ocid1.externaldbsystem.oc1..xxxxxxEXAMPLExxxxxx grid_home: grid_home_example id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_flex_cluster: true lifecycle_details: lifecycle_details_example lifecycle_state: CREATING network_configurations: - network_number: 56 network_type: AUTOCONFIG subnet: subnet_example ocr_file_location: ocr_file_location_example scan_configurations: - network_number: 56 scan_name: scan_name_example scan_port: 56 scan_protocol: TCP time_created: '2013-10-20T19:20:30+01:00' time_updated: '2013-10-20T19:20:30+01:00' version: version_example vip_configurations: - address: address_example network_number: 56 node_name: node_name_example type: complex