Retrieve all NVLink Logical Partitions
Retrieve all NVLink Logical Partitions for the org
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
siteId
Filter NVLink Logical Partitions by Site
status
Filter NVLink Logical Partitions by Status
query
Search for matches across all NVLink Logical Partitions. Input will be matched against name, description, and status fields
includeInterfaces
Include NVLink Interfaces in response.
includeStats
Include NVLink Logical Partition Stats in response.
includeVpcs
Include VPCs in response.
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 ID of the NVLink Logical Partition
name
Name of the NVLink Logical Partition
description
Optional description of the NVLink Logical Partition
siteId
ID of the Site the NVLink Logical Partition belongs to
tenantId
ID of the Tenant the NVLink Logical Partition belongs to
status
Status of the NVLink Logical Partition
statusHistory
Details of status changes for the NVLink Logical Partition over time
nvLinkLogicalPartitionStats
GPU and Instance usage counts for the NVLink Logical Partition. Returned if the includeStats query parameter is set to true in retrieval endpoints
created
Date and time the NVLink Logical Partition was created
updated
Date and time the NVLink Logical Partition was last updated
Errors
403
Forbidden Error