compute_gpu_memory_fabrics

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

Overview

Name	compute_gpu_memory_fabrics
Type	Resource
Id	oci.compute.compute_gpu_memory_fabrics

Fields

The following fields are returned by SELECT queries:

get

The information of the compute GPU memory fabric was retrieved.

Name	Datatype	Description
id	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU memory fabric
additionalData	object	Additional data that can be exposed to the customer. Right now it will include the switch tray ids.
availableHostCount	integer (int64)	The total number of available bare metal hosts located in this compute GPU memory fabric.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root compartment.
computeGpuMemoryClusters	array	List of GPU memory clusters within this GPU memory fabric.
computeHpcIslandId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island
computeLocalBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block
computeNetworkBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block
currentFirmwareBundleId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for current firmware bundle
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.
fabricHealth	string	The health state of the GPU memory fabric (HEALTHY, UNHEALTHY)
firmwareUpdateReason	string	The reason for updating firmware bundle version of the GPU memory fabric.
firmwareUpdateState	string	The state of Memory Fabric Firmware update (WILL_UPDATE, NO_UPDATE, SKIP_RECYCLE_ENABLED)
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"}
healthyHostCount	integer (int64)	The total number of healthy bare metal hosts located in this compute GPU memory fabric.
hostPlatformName	string	The host platform identifier used for bundle queries
lifecycleState	string	The lifecycle state of the GPU memory fabric (AVAILABLE, OCCUPIED, PROVISIONING, DEGRADED, UNAVAILABLE)
memoryFabricPreferences	object	The preference object specified by customer. Contains customerDesiredFirmwareBundleId, fabricRecycleLevel.
switchPlatformName	string	The switch platform identifier used for bundle queries
systemTags	object	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { "orcl-cloud": { "free-tier-retained": "true" } }
targetFirmwareBundleId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for targeted firmware bundle
timeCreated	string (date-time)	The date and time that the compute GPU memory fabric record was created, in the format defined by [RFC3339] (https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
totalHostCount	integer (int64)	The total number of bare metal hosts located in this compute GPU memory fabric.

list

The list of summary memory fabric details was created and retrieved.

Name	Datatype	Description
id	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU memory fabric
availableHostCount	integer (int64)	The total number of available bare metal hosts located in this compute GPU memory fabric.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root compartment.
computeHpcIslandId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island
computeLocalBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block
computeNetworkBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block
currentFirmwareBundleId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for current firmware bundle
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.
fabricHealth	string	The health state of the GPU memory fabric (x-obmcs-enumref: #/definitions/ComputeGpuMemoryFabric/fabricHealth)
firmwareUpdateState	string	The state of Memory Fabric Firmware update (WILL_UPDATE, NO_UPDATE, SKIP_RECYCLE_ENABLED)
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"}
healthyHostCount	integer (int64)	The total number of healthy bare metal hosts located in this compute GPU memory fabric.
hostPlatformName	string	The host platform identifier used for bundle queries
lifecycleState	string	The lifecycle state of the GPU memory fabric (x-obmcs-enumref: #/definitions/ComputeGpuMemoryFabric/lifecycleState)
memoryFabricPreferences	object	The preference object specified by customer. Contains customerDesiredFirmwareBundleId, fabricRecycleLevel.
switchPlatformName	string	The switch platform identifier used for bundle queries
systemTags	object	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { "orcl-cloud": { "free-tier-retained": "true" } }
targetFirmwareBundleId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for targeted firmware bundle
timeCreated	string (date-time)	The date and time that the compute GPU memory fabric record was created, in the format defined by [RFC3339] (https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
totalHostCount	integer (int64)	The total number of bare metal hosts located in this compute GPU memory fabric.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	computeGpuMemoryFabricId, region	opc-request-id	Gets information about the specified compute GPU memory fabric<br />
list	select	compartmentId, region	opc-request-id, computeGpuMemoryFabricId, availabilityDomain, displayName, computeHpcIslandId, computeNetworkBlockId, computeGpuMemoryFabricLifecycleState, computeGpuMemoryFabricHealth, limit, page, sortBy, sortOrder	Lists the compute GPU memory fabrics that match the specified criteria and compartmentId.
update	update	computeGpuMemoryFabricId, region	if-match, opc-request-id, opc-retry-token	Customer can update displayName, tags and desired firmware bundle, recycle level for <br />compute GPU memory fabric record<br />
change_compartment	exec	computeGpuMemoryFabricId, region, compartmentId	if-match, opc-request-id, opc-retry-token	Moves a compute GPU memory fabric 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.

Name	Datatype	Description
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
computeGpuMemoryFabricId	string	The OCID of the compute GPU memory fabric.
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)
availabilityDomain	string	The name of the availability domain. Example: Uocm:PHX-AD-1
computeGpuMemoryFabricHealth	string	A filter to return ComputeGpuMemoryFabricSummary resources that match the given fabric health.
computeGpuMemoryFabricId	string	A filter to return only the listings that matches the given GPU memory fabric id.
computeGpuMemoryFabricLifecycleState	string	A filter to return ComputeGpuMemoryFabricSummary resources that match the given lifecycle state.
computeHpcIslandId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.
computeNetworkBlockId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.
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.
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

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

SELECT
id,
additionalData,
availableHostCount,
compartmentId,
computeGpuMemoryClusters,
computeHpcIslandId,
computeLocalBlockId,
computeNetworkBlockId,
currentFirmwareBundleId,
definedTags,
displayName,
fabricHealth,
firmwareUpdateReason,
firmwareUpdateState,
freeformTags,
healthyHostCount,
hostPlatformName,
lifecycleState,
memoryFabricPreferences,
switchPlatformName,
systemTags,
targetFirmwareBundleId,
timeCreated,
totalHostCount
FROM oci.compute.compute_gpu_memory_fabrics
WHERE computeGpuMemoryFabricId = '{{ computeGpuMemoryFabricId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists the compute GPU memory fabrics that match the specified criteria and compartmentId.

SELECT
id,
availableHostCount,
compartmentId,
computeHpcIslandId,
computeLocalBlockId,
computeNetworkBlockId,
currentFirmwareBundleId,
definedTags,
displayName,
fabricHealth,
firmwareUpdateState,
freeformTags,
healthyHostCount,
hostPlatformName,
lifecycleState,
memoryFabricPreferences,
switchPlatformName,
systemTags,
targetFirmwareBundleId,
timeCreated,
totalHostCount
FROM oci.compute.compute_gpu_memory_fabrics
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND computeGpuMemoryFabricId = '{{ computeGpuMemoryFabricId }}'
AND availabilityDomain = '{{ availabilityDomain }}'
AND displayName = '{{ displayName }}'
AND computeHpcIslandId = '{{ computeHpcIslandId }}'
AND computeNetworkBlockId = '{{ computeNetworkBlockId }}'
AND computeGpuMemoryFabricLifecycleState = '{{ computeGpuMemoryFabricLifecycleState }}'
AND computeGpuMemoryFabricHealth = '{{ computeGpuMemoryFabricHealth }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;

UPDATE examples

update

Customer can update displayName, tags and desired firmware bundle, recycle level for <br />compute GPU memory fabric record<br />

UPDATE oci.compute.compute_gpu_memory_fabrics
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
memoryFabricPreferences = '{{ memoryFabricPreferences }}'
WHERE 
computeGpuMemoryFabricId = '{{ computeGpuMemoryFabricId }}' --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,
additionalData,
availableHostCount,
compartmentId,
computeGpuMemoryClusters,
computeHpcIslandId,
computeLocalBlockId,
computeNetworkBlockId,
currentFirmwareBundleId,
definedTags,
displayName,
fabricHealth,
firmwareUpdateReason,
firmwareUpdateState,
freeformTags,
healthyHostCount,
hostPlatformName,
lifecycleState,
memoryFabricPreferences,
switchPlatformName,
systemTags,
targetFirmwareBundleId,
timeCreated,
totalHostCount;

Lifecycle Methods

change_compartment

Moves a compute GPU memory fabric 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_fabrics.change_compartment 
@computeGpuMemoryFabricId='{{ computeGpuMemoryFabricId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;