cluster_networks

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

Overview

Name	`cluster_networks`
Type	Resource
Id	`oci.compute.cluster_networks`

Fields

The following fields are returned by SELECT queries:

get
list

The cluster network was retrieved.

Name	Datatype	Description
`id`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network.
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cluster network.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`hpcIslandId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HPC island used by the cluster network.
`instancePools`	`array`	The instance pools in the cluster network. Each cluster network can have one instance pool.
`lifecycleState`	`string`	The current state of the cluster network. (PROVISIONING, SCALING, STARTING, STOPPING, TERMINATING, STOPPED, TERMINATED, RUNNING)
`networkBlockIds`	`array`	The list of network block OCIDs of the HPC island.
`placementConfiguration`	`object`	The location for where the instance pools in a cluster network will place instances.
`timeCreated`	`string (date-time)`	The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
`timeUpdated`	`string (date-time)`	The date and time the resource was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`

Summary information for a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).

Name	Datatype	Description
`id`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network.
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cluster netowrk.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`instancePools`	`array`	The instance pools in the cluster network.
`lifecycleState`	`string`	The current state of the cluster network. (PROVISIONING, SCALING, STARTING, STOPPING, TERMINATING, STOPPED, TERMINATED, RUNNING)
`timeCreated`	`string (date-time)`	The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
`timeUpdated`	`string (date-time)`	The date and time the resource was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`clusterNetworkId`, `region`		Gets information about a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).<br />
`list`	`select`	`compartmentId`, `region`	`displayName`, `limit`, `page`, `sortBy`, `sortOrder`, `lifecycleState`	Lists the [cluster networks with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm)<br />in the specified compartment.<br />
`create`	`insert`	`region`, `compartmentId`, `instancePools`, `placementConfiguration`	`opc-retry-token`	Creates a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).<br />A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal<br />instances that are connected with an ultra low-latency remote direct memory access (RDMA) network.<br />Cluster networks with instance pools use instance pools to manage groups of identical instances.<br /><br />Use cluster networks with instance pools when you want predictable capacity for a specific number of identical<br />instances that are managed as a group.<br /><br />If you want to manage instances in the RDMA network independently of each other or use different types of instances<br />in the network group, create a compute cluster by using the [CreateComputeCluster](#/en/iaas/latest/ComputeCluster/CreateComputeCluster)<br />operation.<br /><br />To determine whether capacity is available for a specific shape before you create a cluster network,<br />use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport)<br />operation.<br />
`update`	`update`	`clusterNetworkId`, `region`	`opc-retry-token`, `if-match`	Updates a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).<br />The OCID of the cluster network remains the same.<br />
`terminate`	`delete`	`clusterNetworkId`, `region`	`if-match`	Deletes (terminates) a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).<br /><br />When you delete a cluster network, all of its resources are permanently deleted,<br />including associated instances and instance pools.<br />
`change_compartment`	`exec`	`clusterNetworkId`, `region`, `compartmentId`	`if-match`, `opc-request-id`, `opc-retry-token`	Moves a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm)<br />into a different compartment within the same tenancy. For<br />information about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br /><br />When you move a cluster network to a different compartment, associated resources such as the instances<br />in the cluster network, boot volumes, and VNICs are not moved.<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
`clusterNetworkId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network.
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
`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)
`displayName`	`string`	A filter to return only resources that match the given display name exactly.
`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 only return resources that match the given lifecycle state. The state value is case-insensitive.
`limit`	`integer`	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50`
`opc-request-id`	`string`	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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`	For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
`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. Note: In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
`sortOrder`	`string`	The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.

`SELECT` examples

get
list

Gets information about a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).

SELECT
id,
compartmentId,
definedTags,
displayName,
freeformTags,
hpcIslandId,
instancePools,
lifecycleState,
networkBlockIds,
placementConfiguration,
timeCreated,
timeUpdated
FROM oci.compute.cluster_networks
WHERE clusterNetworkId = '{{ clusterNetworkId }}' -- required
AND region = '{{ region }}' -- required
;

Lists the [cluster networks with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm) in the specified compartment.

SELECT
id,
compartmentId,
definedTags,
displayName,
freeformTags,
instancePools,
lifecycleState,
timeCreated,
timeUpdated
FROM oci.compute.cluster_networks
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND displayName = '{{ displayName }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
;

`INSERT` examples

create
Manifest

Creates a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal instances that are connected with an ultra low-latency remote direct memory access (RDMA) network. Cluster networks with instance pools use instance pools to manage groups of identical instances. Use cluster networks with instance pools when you want predictable capacity for a specific number of identical instances that are managed as a group. If you want to manage instances in the RDMA network independently of each other or use different types of instances in the network group, create a compute cluster by using the [CreateComputeCluster](#/en/iaas/latest/ComputeCluster/CreateComputeCluster) operation. To determine whether capacity is available for a specific shape before you create a cluster network, use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport) operation.

INSERT INTO oci.compute.cluster_networks (
compartmentId,
definedTags,
displayName,
freeformTags,
instancePools,
placementConfiguration,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ instancePools }}' /* required */,
'{{ placementConfiguration }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
freeformTags,
hpcIslandId,
instancePools,
lifecycleState,
networkBlockIds,
placementConfiguration,
timeCreated,
timeUpdated
;

# Description fields are for documentation purposes
- name: cluster_networks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cluster_networks resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment
      containing the cluster network.
  - 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](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - 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](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: instancePools
    description: |
      The data to create the instance pools in the cluster network.
      Each cluster network can have one instance pool.
    value:
      - definedTags: "{{ definedTags }}"
        displayName: "{{ displayName }}"
        freeformTags: "{{ freeformTags }}"
        instanceConfigurationId: "{{ instanceConfigurationId }}"
        size: {{ size }}
  - name: placementConfiguration
    description: |
      The location for where the instance pools in a cluster network will place instances.
    value:
      availabilityDomain: "{{ availabilityDomain }}"
      primarySubnetId: "{{ primarySubnetId }}"
      primaryVnicSubnets:
        ipv6AddressIpv6SubnetCidrPairDetails:
          - ipv6SubnetCidr: "{{ ipv6SubnetCidr }}"
        isAssignIpv6Ip: {{ isAssignIpv6Ip }}
        subnetId: "{{ subnetId }}"
      secondaryVnicSubnets:
        - ipv6AddressIpv6SubnetCidrPairDetails: "{{ ipv6AddressIpv6SubnetCidrPairDetails }}"
          isAssignIpv6Ip: {{ isAssignIpv6Ip }}
          subnetId: "{{ subnetId }}"
          displayName: "{{ displayName }}"
  - 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). 

`UPDATE` examples

update

Updates a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). The OCID of the cluster network remains the same.

UPDATE oci.compute.cluster_networks
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
instancePools = '{{ instancePools }}'
WHERE 
clusterNetworkId = '{{ clusterNetworkId }}' --required
AND region = '{{ region }}' --required
AND opc-retry-token = '{{ opc-retry-token}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
freeformTags,
hpcIslandId,
instancePools,
lifecycleState,
networkBlockIds,
placementConfiguration,
timeCreated,
timeUpdated;

`DELETE` examples

terminate

Deletes (terminates) a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm). When you delete a cluster network, all of its resources are permanently deleted, including associated instances and instance pools.

DELETE FROM oci.compute.cluster_networks
WHERE clusterNetworkId = '{{ clusterNetworkId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm) into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When you move a cluster network to a different compartment, associated resources such as the instances in the cluster network, boot volumes, and VNICs are not moved.

EXEC oci.compute.cluster_networks.change_compartment 
@clusterNetworkId='{{ clusterNetworkId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​