Retrieve all NVLink Interfaces
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
org
Name of the NGC Org
Query parameters
status
Filter NVLink Interfaces by Status. Can be specified multiple times to filter on more than one status.
siteId
Filter NVLink Interfaces by Site ID. Can be specified multiple times to filter on more than one ID.
instanceId
Filter NVLink Interfaces by Instance ID. Can be specified multiple times to filter on more than one ID.
nvLinkLogicalPartitionId
Filter NVLink Interfaces by NVLink Logical Partition ID. Can be specified multiple times to filter on more than one ID.
nvLinkDomainId
Filter NVLink Interfaces by NVLink Domain ID. Can be specified multiple times to filter on more than one ID.
includeRelation
Related entity to expand
Allowed values:
pageNumber
Page number for pagination query
pageSize
Page size for pagination query
orderBy
Ordering for pagination query
Response headers
X-Pagination
Pagination result in JSON format
Response
OK
id
Unique UUID v4 identifier for the NVLinkInterface
instanceId
ID of the associated Instance
nvLinkLogicalPartitionId
ID of the NVLink Logical Partition associated with this interface
nvLinkDomainId
ID of the NVLink Domain associated with this Interface
deviceInstance
Index of the device, used to identify the GPU associated with this Interface
gpuGuid
Unique ID of the GPU
status
Status of the NVLinkInterface
created
Date/time when the NVLinkInterface was created
updated
Date/time when the NVLinkInterface was last updated
deprecations
List of deprecations for NVLinkInterface API object
Errors
403
Forbidden Error