oracle / oracle.oci / 5.0.0 / module / oci_database_vm_cluster_network_actions Perform actions on a VmClusterNetwork resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_vm_cluster_network_actions (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
Perform actions on a VmClusterNetwork resource in Oracle Cloud Infrastructure
For I(action=download_validation_report), downloads the network validation report file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
For I(action=download_vm_cluster_network_config_file), downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
For I(action=resize), adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata Cloud@Customer instances only.
For I(action=validate), validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.
- name: Perform action download_validation_report on vm_cluster_network oci_database_vm_cluster_network_actions: # required validation_report_dest: /tmp/exadata_validation_report exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx" action: download_validation_report
- name: Perform action download_vm_cluster_network_config_file on vm_cluster_network oci_database_vm_cluster_network_actions: # required config_file_dest: /tmp/exadata_config_file.zip exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx" action: download_vm_cluster_network_config_file
- name: Perform action add_dbserver_network on vm_cluster_network oci_database_vm_cluster_network_actions: # required action: ADD_DBSERVER_NETWORK vm_networks: - # required network_type: CLIENT nodes: - # required hostname: hostname_example ip: ip_example # optional vip_hostname: vip_hostname_example vip: vip_example lifecycle_state: CREATING db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx" # optional vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx" netmask: netmask_example gateway: gateway_example domain_name: domain_name_example exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx"
- name: Perform action remove_dbserver_network on vm_cluster_network oci_database_vm_cluster_network_actions: # required action: ADD_DBSERVER_NETWORK vm_networks: - # required network_type: CLIENT nodes: - # required hostname: hostname_example ip: ip_example # optional vip_hostname: vip_hostname_example vip: vip_example lifecycle_state: CREATING db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx" # optional vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx" netmask: netmask_example gateway: gateway_example domain_name: domain_name_example exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx"
- name: Perform action validate on vm_cluster_network oci_database_vm_cluster_network_actions: # required exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx" action: validate
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool action: choices: - download_validation_report - download_vm_cluster_network_config_file - add_dbserver_network - remove_dbserver_network - validate description: - The action to perform on the VmClusterNetwork. 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 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 vm_networks: description: - Details of the client and backup networks. - Required for I(action=resize). elements: dict suboptions: domain_name: description: - The network domain name. type: str gateway: description: - The network gateway. type: str netmask: description: - The network netmask. type: str network_type: choices: - CLIENT - BACKUP - DISASTER_RECOVERY description: - The network type. required: true type: str nodes: description: - The list of node details. elements: dict required: true suboptions: db_server_id: description: - The Db server associated with the node. type: str hostname: description: - The node host name. required: true type: str ip: description: - The node IP address. required: true type: str lifecycle_state: choices: - CREATING - REQUIRES_VALIDATION - VALIDATING - VALIDATED - VALIDATION_FAILED - UPDATING - ALLOCATED - TERMINATING - TERMINATED - FAILED description: - The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. type: str vip: description: - The node virtual IP (VIP) address. type: str vip_hostname: description: - The node virtual IP (VIP) host name. type: str type: list vlan_id: description: - The network VLAN ID. type: str type: list 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 config_file_dest: description: - The destination file path to write the config file to when I(action=download_vm_cluster_network_config_file). The file will be created if it does not exist. If the file already exists, the content will be overwritten. I(config_file_dest) is required if I(action=download_vm_cluster_network_config_file). - Required for I(action=download_vm_cluster_network_config_file). 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: aliases: - id description: - The VM cluster network L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true type: str validation_report_dest: description: - The destination file path to write the report to when I(action=download_validation_report). The file will be created if it does not exist. If the file already exists, the content will be overwritten. I(validation_report_dest) is required if I(action=download_validation_report). - Required for I(action=download_validation_report). 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: - The Exadata infrastructure L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true 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_cluster_network: contains: 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 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 VM cluster network. The name does not need to be unique. returned: on success sample: display_name_example type: str dns: description: - The list of DNS server IP addresses. Maximum of 3 allowed. returned: on success sample: [] type: list dr_scans: contains: hostname: description: - The Disaster recovery SCAN hostname. returned: on success sample: hostname_example type: str ips: description: - The list of Disaster recovery SCAN IP addresses. Three addresses should be provided. returned: on success sample: [] type: list scan_listener_port_tcp: description: - The Disaster recovery SCAN TCPIP port. Default is 1521. returned: on success sample: 56 type: int description: - The SCAN details for DR network returned: on success type: complex 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 VM cluster network. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx 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 network. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. NEEDS_ATTENTION - The resource is in needs attention state as some of it's child nodes are not validated and unusable by VM cluster. returned: on success sample: CREATING type: str ntp: description: - The list of NTP server IP addresses. Maximum of 3 allowed. returned: on success sample: [] type: list scans: contains: hostname: description: - The SCAN hostname. returned: on success sample: hostname_example type: str ips: description: - The list of SCAN IP addresses. Three addresses should be provided. returned: on success sample: [] type: list port: description: - '**Deprecated.** This field is deprecated. You may use ''scanListenerPortTcp'' to specify the port. The SCAN TCPIP port. Default is 1521.' returned: on success sample: 56 type: int scan_listener_port_tcp: description: - The SCAN TCPIP port. Default is 1521. returned: on success sample: 56 type: int scan_listener_port_tcp_ssl: description: - The SCAN TCPIP SSL port. Default is 2484. returned: on success sample: 56 type: int description: - The SCAN details. returned: on success type: complex time_created: description: - The date and time when the VM cluster network was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str vm_cluster_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the associated VM Cluster. returned: on success sample: ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx type: str vm_networks: contains: domain_name: description: - The network domain name. returned: on success sample: domain_name_example type: str gateway: description: - The network gateway. returned: on success sample: gateway_example type: str netmask: description: - The network netmask. returned: on success sample: netmask_example type: str network_type: description: - The network type. returned: on success sample: CLIENT type: str nodes: contains: db_server_id: description: - The Db server associated with the node. returned: on success sample: ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx type: str hostname: description: - The node host name. returned: on success sample: hostname_example type: str ip: description: - The node IP address. returned: on success sample: ip_example type: str lifecycle_state: description: - The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. returned: on success sample: CREATING type: str vip: description: - The node virtual IP (VIP) address. returned: on success sample: vip_example type: str vip_hostname: description: - The node virtual IP (VIP) host name. returned: on success sample: vip_hostname_example type: str description: - The list of node details. returned: on success type: complex vlan_id: description: - The network VLAN ID. returned: on success sample: ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx type: str description: - Details of the client and backup networks. returned: on success type: complex description: - Details of the VmClusterNetwork resource acted upon by the current operation returned: on success sample: compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US display_name: display_name_example dns: [] dr_scans: - hostname: hostname_example ips: [] scan_listener_port_tcp: 56 exadata_infrastructure_id: ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx lifecycle_details: lifecycle_details_example lifecycle_state: CREATING ntp: [] scans: - hostname: hostname_example ips: [] port: 56 scan_listener_port_tcp: 56 scan_listener_port_tcp_ssl: 56 time_created: '2013-10-20T19:20:30+01:00' vm_cluster_id: ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx vm_networks: - domain_name: domain_name_example gateway: gateway_example netmask: netmask_example network_type: CLIENT nodes: - db_server_id: ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx hostname: hostname_example ip: ip_example lifecycle_state: CREATING vip: vip_example vip_hostname: vip_hostname_example vlan_id: ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx type: complex