gpus

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

Overview

Name	gpus
Type	Resource
Id	nvidia.catalog.gpus

Fields

The following fields are returned by SELECT queries:

get_by_vendor_subsystem

Name	Datatype	Description
pci_device_id	string	PCI Device ID (wire: pciDeviceId)
pci_subsystem_device_id	string	PCI Subsystem Device ID (wire: pciSubsystemDeviceId)
pci_vendor_id	string	PCI Vendor ID (wire: pciVendorId)
display_name	string	Display name for the GPU (wire: displayName)
label_name	string	Label name for the GPU (wire: labelName)
created_at	string (date_time)	Creation timestamp (wire: createdAt)
cuda_major_version	string	CUDA major version (wire: cudaMajorVersion)
cuda_minor_version	string	CUDA minor version (wire: cudaMinorVersion)
form_factor	string	GPU form factor (wire: formFactor)
gpu_counts	array	(wire: gpuCounts)
memory_size_gb	integer (int32)	Memory size in GB (smallint range) (wire: memorySizeGb)
request_status	object	Request status information (wire: requestStatus)
updated_at	string (date_time)	Last update timestamp (wire: updatedAt)

get_by_vendor

Response for GPU by PCI ID lookup

Name	Datatype	Description
pci_device_id	string	PCI Device ID (wire: pciDeviceId)
pci_subsystem_device_id	string	PCI Subsystem Device ID (wire: pciSubsystemDeviceId)
pci_vendor_id	string	PCI Vendor ID (wire: pciVendorId)
display_name	string	Display name for the GPU (wire: displayName)
label_name	string	Label name for the GPU (wire: labelName)
created_at	string (date_time)	Creation timestamp (wire: createdAt)
cuda_major_version	string	CUDA major version (wire: cudaMajorVersion)
cuda_minor_version	string	CUDA minor version (wire: cudaMinorVersion)
form_factor	string	GPU form factor (wire: formFactor)
gpu_counts	array	(wire: gpuCounts)
memory_size_gb	integer (int32)	Memory size in GB (smallint range) (wire: memorySizeGb)
request_status	object	Request status information (wire: requestStatus)
updated_at	string (date_time)	Last update timestamp (wire: updatedAt)

get

Response for GPU by PCI ID lookup

Name	Datatype	Description
pci_device_id	string	PCI Device ID (wire: pciDeviceId)
pci_subsystem_device_id	string	PCI Subsystem Device ID (wire: pciSubsystemDeviceId)
pci_vendor_id	string	PCI Vendor ID (wire: pciVendorId)
display_name	string	Display name for the GPU (wire: displayName)
label_name	string	Label name for the GPU (wire: labelName)
created_at	string (date_time)	Creation timestamp (wire: createdAt)
cuda_major_version	string	CUDA major version (wire: cudaMajorVersion)
cuda_minor_version	string	CUDA minor version (wire: cudaMinorVersion)
form_factor	string	GPU form factor (wire: formFactor)
gpu_counts	array	(wire: gpuCounts)
memory_size_gb	integer (int32)	Memory size in GB (smallint range) (wire: memorySizeGb)
request_status	object	Request status information (wire: requestStatus)
updated_at	string (date_time)	Last update timestamp (wire: updatedAt)

list

Response for GPU by PCI ID lookup

Name	Datatype	Description
pci_device_id	string	PCI Device ID (wire: pciDeviceId)
pci_subsystem_device_id	string	PCI Subsystem Device ID (wire: pciSubsystemDeviceId)
pci_vendor_id	string	PCI Vendor ID (wire: pciVendorId)
display_name	string	Display name for the GPU (wire: displayName)
label_name	string	Label name for the GPU (wire: labelName)
created_at	string (date_time)	Creation timestamp (wire: createdAt)
cuda_major_version	string	CUDA major version (wire: cudaMajorVersion)
cuda_minor_version	string	CUDA minor version (wire: cudaMinorVersion)
form_factor	string	GPU form factor (wire: formFactor)
gpu_counts	array	(wire: gpuCounts)
memory_size_gb	integer (int32)	Memory size in GB (smallint range) (wire: memorySizeGb)
request_status	object	Request status information (wire: requestStatus)
updated_at	string (date_time)	Last update timestamp (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_vendor_subsystem	select	pci_device_id, pci_vendor_id, pci_subsystem_device_id		Get a single GPU record matching the full PCI composite key
get_by_vendor	select	pci_device_id, pci_vendor_id		Get all GPUs by PCI records matching the given PCI Device ID and Vendor ID
get	select	pci_device_id		Get all GPU records matching the given PCI Device ID
list	select			Get all GPU by PCI records
create_by_vendor_subsystem	insert	pci_device_id, pci_vendor_id, pci_subsystem_device_id, display_name, pci_device_id		Create a new GPU record using the full PCI composite key
create	insert	pci_device_id, display_name, pci_device_id		Create a new GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown')
update_by_vendor_subsystem	update	pci_device_id, pci_vendor_id, pci_subsystem_device_id		Partially update a GPU record matching the full PCI composite key. Only provided fields will be updated.
update	update	pci_device_id		Partially update a GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown'). Only provided fields will be updated.
delete_by_vendor_subsystem	delete	pci_device_id, pci_vendor_id, pci_subsystem_device_id		Delete a GPU record matching the full PCI composite key
delete	delete	pci_device_id		Delete a GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown')

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
pci_device_id	string (UTF-8)	PCI Device ID
pci_subsystem_device_id	string (UTF-8)	PCI Subsystem Device ID
pci_vendor_id	string (UTF-8)	PCI Vendor ID

SELECT examples

get_by_vendor_subsystem

Get a single GPU record matching the full PCI composite key

SELECT
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
display_name,
label_name,
created_at,
cuda_major_version,
cuda_minor_version,
form_factor,
gpu_counts,
memory_size_gb,
request_status,
updated_at
FROM nvidia.catalog.gpus
WHERE pci_device_id = '{{ pci_device_id }}' -- required
AND pci_vendor_id = '{{ pci_vendor_id }}' -- required
AND pci_subsystem_device_id = '{{ pci_subsystem_device_id }}' -- required
;

get_by_vendor

Get all GPUs by PCI records matching the given PCI Device ID and Vendor ID

SELECT
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
display_name,
label_name,
created_at,
cuda_major_version,
cuda_minor_version,
form_factor,
gpu_counts,
memory_size_gb,
request_status,
updated_at
FROM nvidia.catalog.gpus
WHERE pci_device_id = '{{ pci_device_id }}' -- required
AND pci_vendor_id = '{{ pci_vendor_id }}' -- required
;

get

Get all GPU records matching the given PCI Device ID

SELECT
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
display_name,
label_name,
created_at,
cuda_major_version,
cuda_minor_version,
form_factor,
gpu_counts,
memory_size_gb,
request_status,
updated_at
FROM nvidia.catalog.gpus
WHERE pci_device_id = '{{ pci_device_id }}' -- required
;

list

Get all GPU by PCI records

SELECT
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
display_name,
label_name,
created_at,
cuda_major_version,
cuda_minor_version,
form_factor,
gpu_counts,
memory_size_gb,
request_status,
updated_at
FROM nvidia.catalog.gpus
;

INSERT examples

create_by_vendor_subsystem

Create a new GPU record using the full PCI composite key

INSERT INTO nvidia.catalog.gpus (
cuda_major_version,
cuda_minor_version,
display_name,
form_factor,
gpu_counts,
label_name,
memory_size_gb,
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
pci_device_id,
pci_vendor_id,
pci_subsystem_device_id
)
SELECT 
'{{ cuda_major_version }}',
'{{ cuda_minor_version }}',
'{{ display_name }}' /* required */,
'{{ form_factor }}',
'{{ gpu_counts }}',
'{{ label_name }}',
{{ memory_size_gb }},
'{{ pci_device_id }}' /* required */,
'{{ pci_subsystem_device_id }}',
'{{ pci_vendor_id }}',
'{{ pci_device_id }}' /* required */,
'{{ pci_vendor_id }}',
'{{ pci_subsystem_device_id }}'
RETURNING
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
display_name,
label_name,
created_at,
cuda_major_version,
cuda_minor_version,
form_factor,
gpu_counts,
memory_size_gb,
request_status,
updated_at
;

create

Create a new GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown')

INSERT INTO nvidia.catalog.gpus (
cuda_major_version,
cuda_minor_version,
display_name,
form_factor,
gpu_counts,
label_name,
memory_size_gb,
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
pci_device_id
)
SELECT 
'{{ cuda_major_version }}',
'{{ cuda_minor_version }}',
'{{ display_name }}' /* required */,
'{{ form_factor }}',
'{{ gpu_counts }}',
'{{ label_name }}',
{{ memory_size_gb }},
'{{ pci_device_id }}' /* required */,
'{{ pci_subsystem_device_id }}',
'{{ pci_vendor_id }}',
'{{ pci_device_id }}' /* required */
RETURNING
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
display_name,
label_name,
created_at,
cuda_major_version,
cuda_minor_version,
form_factor,
gpu_counts,
memory_size_gb,
request_status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: gpus
props:
  - name: pci_device_id
    value: "{{ pci_device_id }}"
    description: Required parameter for the gpus resource.
  - name: pci_vendor_id
    value: "{{ pci_vendor_id }}"
    description: Required parameter for the gpus resource.
  - name: pci_subsystem_device_id
    value: "{{ pci_subsystem_device_id }}"
    description: Required parameter for the gpus resource.
  - name: cuda_major_version
    value: "{{ cuda_major_version }}"
    description: |
      CUDA major version
  - name: cuda_minor_version
    value: "{{ cuda_minor_version }}"
    description: |
      CUDA minor version
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Display name for the GPU
  - name: form_factor
    value: "{{ form_factor }}"
    description: |
      GPU form factor
  - name: gpu_counts
    value:
      - {{ gpu_counts }}
  - name: label_name
    value: "{{ label_name }}"
    description: |
      Label name for the GPU
  - name: memory_size_gb
    value: {{ memory_size_gb }}
    description: |
      Memory size in GB (smallint range)
  - name: pci_device_id
    value: "{{ pci_device_id }}"
    description: |
      PCI Device ID
  - name: pci_subsystem_device_id
    value: "{{ pci_subsystem_device_id }}"
    description: |
      PCI Subsystem Device ID
  - name: pci_vendor_id
    value: "{{ pci_vendor_id }}"
    description: |
      PCI Vendor ID

UPDATE examples

update_by_vendor_subsystem

Partially update a GPU record matching the full PCI composite key. Only provided fields will be updated.

UPDATE nvidia.catalog.gpus
SET 
cuda_major_version = '{{ cuda_major_version }}',
cuda_minor_version = '{{ cuda_minor_version }}',
display_name = '{{ display_name }}',
form_factor = '{{ form_factor }}',
gpu_counts = '{{ gpu_counts }}',
label_name = '{{ label_name }}',
memory_size_gb = {{ memory_size_gb }}
WHERE 
pci_device_id = '{{ pci_device_id }}' --required
AND pci_vendor_id = '{{ pci_vendor_id }}' --required
AND pci_subsystem_device_id = '{{ pci_subsystem_device_id }}' --required
RETURNING
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
display_name,
label_name,
created_at,
cuda_major_version,
cuda_minor_version,
form_factor,
gpu_counts,
memory_size_gb,
request_status,
updated_at;

update

Partially update a GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown'). Only provided fields will be updated.

UPDATE nvidia.catalog.gpus
SET 
cuda_major_version = '{{ cuda_major_version }}',
cuda_minor_version = '{{ cuda_minor_version }}',
display_name = '{{ display_name }}',
form_factor = '{{ form_factor }}',
gpu_counts = '{{ gpu_counts }}',
label_name = '{{ label_name }}',
memory_size_gb = {{ memory_size_gb }}
WHERE 
pci_device_id = '{{ pci_device_id }}' --required
RETURNING
pci_device_id,
pci_subsystem_device_id,
pci_vendor_id,
display_name,
label_name,
created_at,
cuda_major_version,
cuda_minor_version,
form_factor,
gpu_counts,
memory_size_gb,
request_status,
updated_at;

DELETE examples

delete_by_vendor_subsystem

Delete a GPU record matching the full PCI composite key

DELETE FROM nvidia.catalog.gpus
WHERE pci_device_id = '{{ pci_device_id }}' --required
AND pci_vendor_id = '{{ pci_vendor_id }}' --required
AND pci_subsystem_device_id = '{{ pci_subsystem_device_id }}' --required
;

delete

Delete a GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown')

DELETE FROM nvidia.catalog.gpus
WHERE pci_device_id = '{{ pci_device_id }}' --required
;