vm_cluster_networks

Creates, updates, deletes, gets or lists a vm_cluster_networks resource.

Overview

Name	`vm_cluster_networks`
Type	Resource
Id	`oci.database.vm_cluster_networks`

Fields

The following fields are returned by SELECT queries:

get
list

The specified Exadata Cloud@Customer VM cluster network.

Name	Datatype	Description
`id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network.
`compartmentId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`displayName`	`string`	The user-friendly name for the VM cluster network. The name does not need to be unique.
`dns`	`array`	The list of DNS server IP addresses. Maximum of 3 allowed.
`drScans`	`array`	The SCAN details for DR network
`exadataInfrastructureId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
`freeformTags`	`object`	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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleDetails`	`string`	Additional information about the current lifecycle state.
`lifecycleState`	`string`	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. (CREATING, REQUIRES_VALIDATION, VALIDATING, VALIDATED, VALIDATION_FAILED, UPDATING, ALLOCATED, TERMINATING, TERMINATED, FAILED, NEEDS_ATTENTION)
`ntp`	`array`	The list of NTP server IP addresses. Maximum of 3 allowed.
`scans`	`array`	The SCAN details.
`systemTags`	`object`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`timeCreated`	`string (date-time)`	The date and time when the VM cluster network was created.
`vmClusterId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the associated VM Cluster.
`vmNetworks`	`array`	Details of the client and backup networks.

Details of the VM cluster network. Applies to Exadata Cloud@Customer instances only.

Name	Datatype	Description
`id`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network.
`compartmentId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`displayName`	`string`	The user-friendly name for the VM cluster network. The name does not need to be unique.
`dns`	`array`	The list of DNS server IP addresses. Maximum of 3 allowed.
`drScans`	`array`	The SCAN details for DR network
`exadataInfrastructureId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
`freeformTags`	`object`	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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleDetails`	`string`	Additional information about the current lifecycle state.
`lifecycleState`	`string`	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. (CREATING, REQUIRES_VALIDATION, VALIDATING, VALIDATED, VALIDATION_FAILED, UPDATING, ALLOCATED, TERMINATING, TERMINATED, FAILED, NEEDS_ATTENTION)
`ntp`	`array`	The list of NTP server IP addresses. Maximum of 3 allowed.
`scans`	`array`	The SCAN details.
`systemTags`	`object`	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
`timeCreated`	`string (date-time)`	The date and time when the VM cluster network was created.
`vmClusterId`	`string`	The [OCID](/Content/General/Concepts/identifiers.htm) of the associated VM Cluster.
`vmNetworks`	`array`	Details of the client and backup networks.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`exadataInfrastructureId`, `vmClusterNetworkId`, `region`	`opc-request-id`	Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.<br />To get information about a cloud VM cluster in an Exadata Cloud Service instance, use the [GetCloudVmCluster ](#/en/database/latest/CloudVmCluster/GetCloudVmCluster) operation.<br />
`list`	`select`	`exadataInfrastructureId`, `compartmentId`, `region`	`limit`, `page`, `sortBy`, `sortOrder`, `lifecycleState`, `displayName`, `opc-request-id`	Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.<br />
`create`	`insert`	`exadataInfrastructureId`, `region`, `compartmentId`, `displayName`, `scans`, `vmNetworks`	`opc-retry-token`, `opc-request-id`	Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only.<br />To create a cloud VM cluster in an Exadata Cloud Service instance, use the [CreateCloudVmCluster ](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster) operation.<br />
`update`	`update`	`exadataInfrastructureId`, `vmClusterNetworkId`, `region`	`if-match`, `opc-request-id`	Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.<br />To update a cloud VM cluster in an Exadata Cloud Service instance, use the [UpdateCloudVmCluster ](#/en/database/latest/CloudVmCluster/UpdateCloudVmCluster) operation.<br />
`delete`	`delete`	`exadataInfrastructureId`, `vmClusterNetworkId`, `region`	`if-match`, `opc-request-id`	Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.<br />To delete a cloud VM cluster in an Exadata Cloud Service instance, use the [DeleteCloudVmCluster ](#/en/database/latest/CloudVmCluster/DeleteCloudVmCluster) operation.<br />
`generate_recommended_vm_cluster_network`	`exec`	`exadataInfrastructureId`, `region`, `compartmentId`, `displayName`, `networks`	`opc-request-id`, `opc-retry-token`	Generates a recommended Cloud@Customer VM cluster network configuration.<br />
`download_vm_cluster_network_config_file`	`exec`	`exadataInfrastructureId`, `vmClusterNetworkId`, `region`	`opc-request-id`, `opc-retry-token`	Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.<br />
`resize_vm_cluster_network`	`exec`	`exadataInfrastructureId`, `vmClusterNetworkId`, `region`, `vmNetworks`, `action`	`opc-request-id`, `opc-retry-token`, `if-match`	Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata<br />Cloud@Customer instances only.<br />
`validate_vm_cluster_network`	`exec`	`exadataInfrastructureId`, `vmClusterNetworkId`, `region`	`opc-request-id`, `opc-retry-token`	Validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`compartmentId`	`string`	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
`exadataInfrastructureId`	`string`	The Exadata infrastructure [OCID](/Content/General/Concepts/identifiers.htm).
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`vmClusterNetworkId`	`string`	The VM cluster network [OCID](/Content/General/Concepts/identifiers.htm).
`displayName`	`string`	A filter to return only resources that match the entire display name given. The match is not case sensitive.
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`lifecycleState`	`string`	A filter to return only resources that match the given lifecycle state exactly.
`limit`	`integer`	The maximum number of items to return per page.
`opc-request-id`	`string`	Unique identifier for the request.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	The pagination token to continue listing from.
`sortBy`	`string`	The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
`sortOrder`	`string`	The sort order to use, either ascending (`ASC`) or descending (`DESC`).

`SELECT` examples

get
list

Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To get information about a cloud VM cluster in an Exadata Cloud Service instance, use the [GetCloudVmCluster ](#/en/database/latest/CloudVmCluster/GetCloudVmCluster) operation.

SELECT
id,
compartmentId,
definedTags,
displayName,
dns,
drScans,
exadataInfrastructureId,
freeformTags,
lifecycleDetails,
lifecycleState,
ntp,
scans,
systemTags,
timeCreated,
vmClusterId,
vmNetworks
FROM oci.database.vm_cluster_networks
WHERE exadataInfrastructureId = '{{ exadataInfrastructureId }}' -- required
AND vmClusterNetworkId = '{{ vmClusterNetworkId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.

SELECT
id,
compartmentId,
definedTags,
displayName,
dns,
drScans,
exadataInfrastructureId,
freeformTags,
lifecycleDetails,
lifecycleState,
ntp,
scans,
systemTags,
timeCreated,
vmClusterId,
vmNetworks
FROM oci.database.vm_cluster_networks
WHERE exadataInfrastructureId = '{{ exadataInfrastructureId }}' -- required
AND compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND displayName = '{{ displayName }}'
AND opc-request-id = '{{ opc-request-id }}'
;

`INSERT` examples

create
Manifest

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 ](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster) operation.

INSERT INTO oci.database.vm_cluster_networks (
compartmentId,
definedTags,
displayName,
dns,
drScans,
freeformTags,
ntp,
scans,
vmNetworks,
exadataInfrastructureId,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ dns }}',
'{{ drScans }}',
'{{ freeformTags }}',
'{{ ntp }}',
'{{ scans }}' /* required */,
'{{ vmNetworks }}' /* required */,
'{{ exadataInfrastructureId }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
dns,
drScans,
exadataInfrastructureId,
freeformTags,
lifecycleDetails,
lifecycleState,
ntp,
scans,
systemTags,
timeCreated,
vmClusterId,
vmNetworks
;

# Description fields are for documentation purposes
- name: vm_cluster_networks
props:
  - name: exadataInfrastructureId
    value: "{{ exadataInfrastructureId }}"
    description: Required parameter for the vm_cluster_networks resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vm_cluster_networks resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The user-friendly name for the Exadata Cloud@Customer VM cluster network. The name does not need to be unique.
  - name: dns
    value:
      - "{{ dns }}"
    description: |
      The list of DNS server IP addresses. Maximum of 3 allowed.
  - name: drScans
    description: |
      The SCAN details for DR network
    value:
      - hostname: "{{ hostname }}"
        ips: "{{ ips }}"
        scanListenerPortTcp: {{ scanListenerPortTcp }}
  - name: freeformTags
    value: "{{ freeformTags }}"
    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 [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: ntp
    value:
      - "{{ ntp }}"
    description: |
      The list of NTP server IP addresses. Maximum of 3 allowed.
  - name: scans
    description: |
      The SCAN details.
    value:
      - hostname: "{{ hostname }}"
        ips: "{{ ips }}"
        port: {{ port }}
  - name: vmNetworks
    description: |
      Details of the client and backup networks.
    value:
      - domainName: "{{ domainName }}"
        gateway: "{{ gateway }}"
        netmask: "{{ netmask }}"
        networkType: "{{ networkType }}"
        nodes: "{{ nodes }}"
        vlanId: "{{ vlanId }}"
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

`UPDATE` examples

update

Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To update a cloud VM cluster in an Exadata Cloud Service instance, use the [UpdateCloudVmCluster ](#/en/database/latest/CloudVmCluster/UpdateCloudVmCluster) operation.

UPDATE oci.database.vm_cluster_networks
SET 
definedTags = '{{ definedTags }}',
dns = '{{ dns }}',
drScans = '{{ drScans }}',
freeformTags = '{{ freeformTags }}',
ntp = '{{ ntp }}',
scans = '{{ scans }}',
vmNetworks = '{{ vmNetworks }}'
WHERE 
exadataInfrastructureId = '{{ exadataInfrastructureId }}' --required
AND vmClusterNetworkId = '{{ vmClusterNetworkId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
dns,
drScans,
exadataInfrastructureId,
freeformTags,
lifecycleDetails,
lifecycleState,
ntp,
scans,
systemTags,
timeCreated,
vmClusterId,
vmNetworks;

`DELETE` examples

delete

Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To delete a cloud VM cluster in an Exadata Cloud Service instance, use the [DeleteCloudVmCluster ](#/en/database/latest/CloudVmCluster/DeleteCloudVmCluster) operation.

DELETE FROM oci.database.vm_cluster_networks
WHERE exadataInfrastructureId = '{{ exadataInfrastructureId }}' --required
AND vmClusterNetworkId = '{{ vmClusterNetworkId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods

generate_recommended_vm_cluster_network
download_vm_cluster_network_config_file
resize_vm_cluster_network
validate_vm_cluster_network

Generates a recommended Cloud@Customer VM cluster network configuration.

EXEC oci.database.vm_cluster_networks.generate_recommended_vm_cluster_network 
@exadataInfrastructureId='{{ exadataInfrastructureId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}", 
"dbServers": "{{ dbServers }}", 
"definedTags": "{{ definedTags }}", 
"displayName": "{{ displayName }}", 
"dns": "{{ dns }}", 
"drScanListenerPortTcp": {{ drScanListenerPortTcp }}, 
"freeformTags": "{{ freeformTags }}", 
"networks": "{{ networks }}", 
"ntp": "{{ ntp }}"
}'
;

Downloads the configuration file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

EXEC oci.database.vm_cluster_networks.download_vm_cluster_network_config_file 
@exadataInfrastructureId='{{ exadataInfrastructureId }}' --required, 
@vmClusterNetworkId='{{ vmClusterNetworkId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}'
;

Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata Cloud@Customer instances only.

EXEC oci.database.vm_cluster_networks.resize_vm_cluster_network 
@exadataInfrastructureId='{{ exadataInfrastructureId }}' --required, 
@vmClusterNetworkId='{{ vmClusterNetworkId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"action": "{{ action }}", 
"vmNetworks": "{{ vmNetworks }}"
}'
;

Validates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

EXEC oci.database.vm_cluster_networks.validate_vm_cluster_network 
@exadataInfrastructureId='{{ exadataInfrastructureId }}' --required, 
@vmClusterNetworkId='{{ vmClusterNetworkId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​