oracle / oracle.oci / 3.5.0 / module / oci_database_vm_cluster_network Manage 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 (3.5.0) — module
Install with ansible-galaxy collection install oracle.oci:==3.5.0
collections: - name: oracle.oci version: 3.5.0
This module allows the user to create, update and delete a VmClusterNetwork resource in Oracle Cloud Infrastructure
For I(state=present), creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. To create a cloud VM cluster in an Exadata Cloud Service instance, use the L(CreateCloudVmCluster ,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/database/latest/CloudVmCluster/CreateCloudVmCluster) operation.
This resource has the following action operations in the M(oracle.oci.oci_database_vm_cluster_network_actions) module: download_validation_report, download_vm_cluster_network_config_file, validate.
- name: Create vm_cluster_network oci_database_vm_cluster_network: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example scans: - # required hostname: hostname_example port: 56 ips: [ "ips_example" ] # optional scan_listener_port_tcp: 56 scan_listener_port_tcp_ssl: 56 vm_networks: - # required vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx" network_type: CLIENT netmask: netmask_example gateway: gateway_example domain_name: domain_name_example nodes: - # required hostname: hostname_example ip: ip_example # optional vip_hostname: vip_hostname_example vip: vip_example exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" # optional dns: [ "dns_example" ] ntp: [ "ntp_example" ] freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update vm_cluster_network oci_database_vm_cluster_network: # required exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx" # optional scans: - # required hostname: hostname_example port: 56 ips: [ "ips_example" ] # optional scan_listener_port_tcp: 56 scan_listener_port_tcp_ssl: 56 dns: [ "dns_example" ] ntp: [ "ntp_example" ] vm_networks: - # required vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx" network_type: CLIENT netmask: netmask_example gateway: gateway_example domain_name: domain_name_example nodes: - # required hostname: hostname_example ip: ip_example # optional vip_hostname: vip_hostname_example vip: vip_example freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update vm_cluster_network using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_database_vm_cluster_network: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" # optional scans: - # required hostname: hostname_example port: 56 ips: [ "ips_example" ] # optional scan_listener_port_tcp: 56 scan_listener_port_tcp_ssl: 56 dns: [ "dns_example" ] ntp: [ "ntp_example" ] vm_networks: - # required vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx" network_type: CLIENT netmask: netmask_example gateway: gateway_example domain_name: domain_name_example nodes: - # required hostname: hostname_example ip: ip_example # optional vip_hostname: vip_hostname_example vip: vip_example freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete vm_cluster_network oci_database_vm_cluster_network: # required exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete vm_cluster_network using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_database_vm_cluster_network: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx" state: absent
dns: description: - The list of DNS server IP addresses. Maximum of 3 allowed. - This parameter is updatable. elements: str type: list ntp: description: - The list of NTP server IP addresses. Maximum of 3 allowed. - This parameter is updatable. elements: str type: list wait: default: true description: Whether to wait for create or delete operation to complete. type: bool scans: description: - The SCAN details. - Required for create using I(state=present). - This parameter is updatable. elements: dict suboptions: hostname: description: - The SCAN hostname. required: true type: str ips: description: - The list of SCAN IP addresses. Three addresses should be provided. elements: str required: true type: list port: description: - The SCAN TCPIP port. Default is 1521. required: true type: int scan_listener_port_tcp: description: - The SCAN TCPIP port. Default is 1521. type: int scan_listener_port_tcp_ssl: description: - The SCAN TCPIP SSL port. Default is 2484. type: int type: list state: choices: - present - absent default: present description: - The state of the VmClusterNetwork. - Use I(state=present) to create or update a VmClusterNetwork. - Use I(state=absent) to delete a VmClusterNetwork. 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 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 create using I(state=present). - This parameter is updatable. elements: dict suboptions: domain_name: description: - The network domain name. required: true type: str gateway: description: - The network gateway. required: true type: str netmask: description: - The network netmask. required: true type: str network_type: choices: - CLIENT - BACKUP description: - The network type. required: true type: str nodes: description: - The list of node details. elements: dict required: true suboptions: hostname: description: - The node host name. required: true type: str ip: description: - The node IP address. required: true 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. required: true 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 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 Exadata Cloud@Customer VM cluster network. 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 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: aliases: - id description: - The VM cluster network 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 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
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 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. 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: - 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: 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 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: [] 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: - hostname: hostname_example ip: ip_example vip: vip_example vip_hostname: vip_hostname_example vlan_id: ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx type: complex