Skip to main content

compute_gpu_memory_clusters

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

Overview​

Namecompute_gpu_memory_clusters
TypeResource
Idoci.compute.compute_gpu_memory_clusters

Fields​

The following fields are returned by SELECT queries:

The information of the compute GPU memory cluster was retrieved.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster
availabilityDomainstringThe availability domain of the GPU Memory Cluster.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute GPU memory cluster.
computeClusterIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.
definedTagsobjectDefined 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"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTagsobjectFree-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"}
gpuMemoryClusterScaleConfigobjectConfiguration settings for GPU Memory Cluster scaling.
gpuMemoryFabricIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric.
instanceConfigurationIdstringThe OCID of the Instance Configuration used to source launch details for this instance.
lifecycleStatestringThe lifecycle state of the GPU Memory Cluster (CREATING, ACTIVE, UPDATING, DELETING, DELETED)
privateIpIdsarrayUnique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster
sizeinteger (int64)The size represents the total number of instances in the GPU Memory Cluster, including both running instances and those still in the process of launching.
systemTagsobjectUsage of system tag keys. These predefined keys are scoped to namespaces. Example: { "orcl-cloud": { "free-tier-retained": "true" } }
timeCreatedstring (date-time)The date and time the GPU Memory Cluster was created. Example: 2016-09-15T21:10:29.600Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcomputeGpuMemoryClusterId, regionopc-request-idGets information about the specified compute GPU memory cluster<br />
listselectcompartmentId, regionopc-request-id, computeGpuMemoryClusterId, computeGpuMemoryFabricId, availabilityDomain, displayName, computeClusterId, page, sortBy, sortOrder, limitList all of the compute GPU memory clusters.<br />
createinsertregion, availabilityDomain, compartmentId, computeClusterId, instanceConfigurationIdopc-retry-token, opc-request-idCreate a compute GPU memory cluster instance on a specific compute GPU memory fabric<br />
updateupdatecomputeGpuMemoryClusterId, regionif-match, opc-request-id, opc-retry-tokenUpdates a compute gpu memory cluster resource.<br />
deletedeletecomputeGpuMemoryClusterId, regionif-match, opc-request-idTerminates and deletes the specified compute GPU memory cluster and underlying instances.
change_compartmentexeccomputeGpuMemoryClusterId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a compute GPU memory cluster into a different compartment. For information about moving resources between<br />compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<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.

NameDatatypeDescription
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
computeGpuMemoryClusterIdstringThe OCID of the compute GPU memory cluster.
regionstringOCI 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)
availabilityDomainstringThe name of the availability domain. Example: Uocm:PHX-AD-1
computeClusterIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.
computeGpuMemoryClusterIdstringA filter to return only the listings that matches the given GPU memory cluster id.
computeGpuMemoryFabricIdstringA filter to return only the listings that matches the given GPU memory fabric id.
displayNamestringA filter to return only resources that match the given display name exactly.
if-matchstringFor 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.
limitintegerFor 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-idstringUnique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA 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).
pagestringFor 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).
sortBystringThe 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.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples​

Gets information about the specified compute GPU memory cluster<br />

SELECT
id,
availabilityDomain,
compartmentId,
computeClusterId,
definedTags,
displayName,
freeformTags,
gpuMemoryClusterScaleConfig,
gpuMemoryFabricId,
instanceConfigurationId,
lifecycleState,
privateIpIds,
size,
systemTags,
timeCreated
FROM oci.compute.compute_gpu_memory_clusters
WHERE computeGpuMemoryClusterId = '{{ computeGpuMemoryClusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Create a compute GPU memory cluster instance on a specific compute GPU memory fabric<br />

INSERT INTO oci.compute.compute_gpu_memory_clusters (
availabilityDomain,
compartmentId,
computeClusterId,
definedTags,
displayName,
freeformTags,
gpuMemoryClusterScaleConfig,
gpuMemoryFabricId,
instanceConfigurationId,
privateIpIds,
size,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ availabilityDomain }}' /* required */,
'{{ compartmentId }}' /* required */,
'{{ computeClusterId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ gpuMemoryClusterScaleConfig }}',
'{{ gpuMemoryFabricId }}',
'{{ instanceConfigurationId }}' /* required */,
'{{ privateIpIds }}',
{{ size }},
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
availabilityDomain,
compartmentId,
computeClusterId,
definedTags,
displayName,
freeformTags,
gpuMemoryClusterScaleConfig,
gpuMemoryFabricId,
instanceConfigurationId,
lifecycleState,
privateIpIds,
size,
systemTags,
timeCreated
;

UPDATE examples​

Updates a compute gpu memory cluster resource.<br />

UPDATE oci.compute.compute_gpu_memory_clusters
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
gpuMemoryClusterScaleConfig = '{{ gpuMemoryClusterScaleConfig }}',
instanceConfigurationId = '{{ instanceConfigurationId }}',
privateIpIds = '{{ privateIpIds }}',
size = {{ size }}
WHERE 
computeGpuMemoryClusterId = '{{ computeGpuMemoryClusterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
AND opc-retry-token = '{{ opc-retry-token}}'
RETURNING
id,
availabilityDomain,
compartmentId,
computeClusterId,
definedTags,
displayName,
freeformTags,
gpuMemoryClusterScaleConfig,
gpuMemoryFabricId,
instanceConfigurationId,
lifecycleState,
privateIpIds,
size,
systemTags,
timeCreated;

DELETE examples​

Terminates and deletes the specified compute GPU memory cluster and underlying instances.

DELETE FROM oci.compute.compute_gpu_memory_clusters
WHERE computeGpuMemoryClusterId = '{{ computeGpuMemoryClusterId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods​

Moves a compute GPU memory cluster into a different compartment. For information about moving resources between<br />compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

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