Skip to navigation
API ReferenceNVLink Logical Partition

Retrieve all NVLink Interfaces

View as Markdown

Get all NVLink Interfaces

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

Authentication

AuthorizationBearer
export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired
Name of the NGC Org

Query parameters

statusstringOptional
Filter NVLink Interfaces by Status. Can be specified multiple times to filter on more than one status.
siteIdstringOptional
Filter NVLink Interfaces by Site ID. Can be specified multiple times to filter on more than one ID.
instanceIdstringOptional
Filter NVLink Interfaces by Instance ID. Can be specified multiple times to filter on more than one ID.
nvLinkLogicalPartitionIdstringOptional
Filter NVLink Interfaces by NVLink Logical Partition ID. Can be specified multiple times to filter on more than one ID.
nvLinkDomainIdstringOptional

Filter NVLink Interfaces by Core-reported NVLink domain UUID, not the rack group ID returned by the Domain API. Can be specified multiple times to filter on more than one UUID.

includeRelationenumOptional
Related entity to expand
Allowed values:
pageNumberintegerOptional1-21474836
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query
orderByenumOptional
Ordering for pagination query

Response headers

X-PaginationstringOptional
Pagination result in JSON format

Response

OK
idstringOptionalformat: "uuid">=1 character
Unique UUID v4 identifier for the NVLinkInterface
instanceIdstringOptionalformat: "uuid"
ID of the associated Instance
nvLinkLogicalPartitionIdstringOptionalformat: "uuid"
ID of the NVLink Logical Partition associated with this interface
nvLinkDomainIdstring or nullOptionalformat: "uuid"

Core-reported NVLink domain UUID associated with this Interface, not the rack group ID returned by the Domain API.

deviceInstanceintegerOptional
Index of the device, used to identify the GPU associated with this Interface
gpuGuidstring or nullOptional
Unique ID of the GPU
statusenumOptional
Status of the NVLinkInterface
Allowed values:
createddatetimeOptionalRead-only

Date/time when the NVLinkInterface was created

updateddatetimeOptionalRead-only

Date/time when the NVLinkInterface was last updated

deprecationslist of objectsOptional
Deprecations active for this resource. Returned only if there are active deprecations.

Errors

403
Forbidden Error