oci_database_vm_cluster_network
This resource provides the Vm Cluster Network resource in Oracle Cloud Infrastructure Database service.
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 CreateCloudVmCluster operation.
Example Usage
resource "oci_database_vm_cluster_network" "test_vm_cluster_network" {
#Required
compartment_id = var.compartment_id
display_name = var.vm_cluster_network_display_name
exadata_infrastructure_id = oci_database_exadata_infrastructure.test_exadata_infrastructure.id
scans {
#Required
hostname = var.vm_cluster_network_scans_hostname
ips = var.vm_cluster_network_scans_ips
#Optional
port = var.vm_cluster_network_scans_port
scan_listener_port_tcp = var.vm_cluster_network_scans_scan_listener_port_tcp
scan_listener_port_tcp_ssl = var.vm_cluster_network_scans_scan_listener_port_tcp_ssl
}
vm_networks {
#Required
network_type = var.vm_cluster_network_vm_networks_network_type
nodes {
#Required
hostname = var.vm_cluster_network_vm_networks_nodes_hostname
ip = var.vm_cluster_network_vm_networks_nodes_ip
#Optional
db_server_id = oci_database_db_server.test_db_server.id
state = var.vm_cluster_network_vm_networks_nodes_state
vip = var.vm_cluster_network_vm_networks_nodes_vip
vip_hostname = var.vm_cluster_network_vm_networks_nodes_vip_hostname
}
#Optional
domain_name = oci_identity_domain.test_domain.name
gateway = var.vm_cluster_network_vm_networks_gateway
netmask = var.vm_cluster_network_vm_networks_netmask
vlan_id = var.vm_cluster_network_vm_networks_vlan_id
}
#Optional
defined_tags = var.vm_cluster_network_defined_tags
dns = var.vm_cluster_network_dns
dr_scans {
#Required
hostname = var.vm_cluster_network_dr_scans_hostname
ips = var.vm_cluster_network_dr_scans_ips
scan_listener_port_tcp = var.vm_cluster_network_dr_scans_scan_listener_port_tcp
}
freeform_tags = {"Department"= "Finance"}
ntp = var.vm_cluster_network_ntp
validate_vm_cluster_network = var.vm_cluster_network_validate_vm_cluster_network
}
Argument Reference
The following arguments are supported:
compartment_id
- (Required) The OCID of the compartment.defined_tags
- (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.display_name
- (Required) The user-friendly name for the Exadata Cloud@Customer VM cluster network. The name does not need to be unique.dns
- (Optional) (Updatable) The list of DNS server IP addresses. Maximum of 3 allowed.dr_scans
- (Optional) (Updatable) The SCAN details for DR networkhostname
- (Required) (Updatable) The Disaster recovery SCAN hostname.ips
- (Required) (Updatable) The list of Disaster recovery SCAN IP addresses. Three addresses should be provided.scan_listener_port_tcp
- (Required) (Updatable) The Disaster recovery SCAN TCPIP port. Default is 1521.
exadata_infrastructure_id
- (Required) The Exadata infrastructure OCID.freeform_tags
- (Optional) (Updatable) 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 Resource Tags. Example:{"Department": "Finance"}
ntp
- (Optional) (Updatable) The list of NTP server IP addresses. Maximum of 3 allowed.scans
- (Required) (Updatable) The SCAN details.hostname
- (Required) (Updatable) The SCAN hostname.ips
- (Required) (Updatable) The list of SCAN IP addresses. Three addresses should be provided.port
- (Optional) (Updatable) Deprecated. This field is deprecated. You may use ‘scanListenerPortTcp’ to specify the port. The SCAN TCPIP port. Default is 1521.scan_listener_port_tcp
- (Optional) (Updatable) The SCAN TCPIP port. Default is 1521.scan_listener_port_tcp_ssl
- (Optional) (Updatable) The SCAN TCPIP SSL port. Default is 2484.
validate_vm_cluster_network
- (Optional) (Updatable) A boolean flag indicating whether or not to validate VM cluster network after creation. Updates are not allowed on validated exadata VM cluster network. Note: Deleting a VM Cluster resource puts a VM Cluster Network inREQUIRES_VALIDATION
state. This results inAfter applying this step and refreshing, the plan was not empty
error and users should apply the terraform configuration again to validate the VM Cluster Network.vm_networks
- (Required) (Updatable) Details of the client and backup networks.domain_name
- (Optional) (Updatable) The network domain name.gateway
- (Optional) (Updatable) The network gateway.netmask
- (Optional) (Updatable) The network netmask.network_type
- (Required) (Updatable) The network type.nodes
- (Required) (Updatable) The list of node details.db_server_id
- (Optional) (Updatable) The Db server associated with the node.hostname
- (Required) (Updatable) The node host name.ip
- (Required) (Updatable) The node IP address.state
- (Optional) (Updatable) 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.vip
- (Optional) (Updatable) The node virtual IP (VIP) address.vip_hostname
- (Optional) (Updatable) The node virtual IP (VIP) host name.
vlan_id
- (Optional) (Updatable) The network VLAN ID.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Attributes Reference
The following attributes are exported:
compartment_id
- The OCID of the compartment.defined_tags
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.display_name
- The user-friendly name for the VM cluster network. The name does not need to be unique.dns
- The list of DNS server IP addresses. Maximum of 3 allowed.dr_scans
- The SCAN details for DR networkhostname
- The Disaster recovery SCAN hostname.ips
- The list of Disaster recovery SCAN IP addresses. Three addresses should be provided.scan_listener_port_tcp
- The Disaster recovery SCAN TCPIP port. Default is 1521.
exadata_infrastructure_id
- The OCID of the Exadata infrastructure.freeform_tags
- 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 Resource Tags. Example:{"Department": "Finance"}
id
- The OCID of the VM cluster network.lifecycle_details
- Additional information about the current lifecycle state.ntp
- The list of NTP server IP addresses. Maximum of 3 allowed.scans
- The SCAN details.hostname
- The SCAN hostname.ips
- The list of SCAN IP addresses. Three addresses should be provided.port
- Deprecated. This field is deprecated. You may use ‘scanListenerPortTcp’ to specify the port. The SCAN TCPIP port. Default is 1521.scan_listener_port_tcp
- The SCAN TCPIP port. Default is 1521.scan_listener_port_tcp_ssl
- The SCAN TCPIP SSL port. Default is 2484.
state
- 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.time_created
- The date and time when the VM cluster network was created.vm_cluster_id
- The OCID of the associated VM Cluster.vm_networks
- Details of the client and backup networks.domain_name
- The network domain name.gateway
- The network gateway.netmask
- The network netmask.network_type
- The network type.nodes
- The list of node details.db_server_id
- The Db server associated with the node.hostname
- The node host name.ip
- The node IP address.state
- 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.vip
- The node virtual IP (VIP) address.vip_hostname
- The node virtual IP (VIP) host name.
vlan_id
- The network VLAN ID.
Timeouts
The timeouts
block allows you to specify timeouts for certain operations:
* create
- (Defaults to 20 minutes), when creating the Vm Cluster Network
* update
- (Defaults to 20 minutes), when updating the Vm Cluster Network
* delete
- (Defaults to 20 minutes), when destroying the Vm Cluster Network
Import
VmClusterNetworks can be imported using the id
, e.g.
$ terraform import oci_database_vm_cluster_network.test_vm_cluster_network "exadataInfrastructures/{exadataInfrastructureId}/vmClusterNetworks/{vmClusterNetworkId}"