Retrieve all Instance InfiniBand Interfaces

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/instance/:instanceId/infiniband-interface

GET

/v2/org/:org/nico/instance/:instanceId/infiniband-interface

$ curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/instance/instanceId/infiniband-interface \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4     "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
5     "partitionId": "05ef7e84-1d4e-4e4d-980d-38589479a0fe",
6     "device": "MT2910 Family [ConnectX-7]",
7     "deviceInstance": 0,
8     "isPhysical": true,
9     "virtualFunctionId": null,
10     "guid": "946dae0300339498",
11     "status": "Provisioning",
12     "created": "2019-08-24T14:15:22Z",
13     "updated": "2019-08-24T14:15:22Z"
14   },
15   {
16     "id": "c518a0e8-3f49-4a1a-8935-a6d3dee6911e",
17     "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
18     "partitionId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
19     "device": "MT2910 Family [ConnectX-7]",
20     "deviceInstance": 1,
21     "isPhysical": false,
22     "virtualFunctionId": 1,
23     "guid": "946dae0300339499",
24     "status": "Provisioning",
25     "created": "2019-08-24T14:15:22Z",
26     "updated": "2019-08-24T14:15:22Z"
27   }
28 ]

Get all InfiniBand Interfaces for an Instance

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

``` 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 Org

instanceIdstringRequired

ID of the Instance

Query parameters

statusstringOptional

Filter InfiniBand Interfaces by Status

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringformat: "uuid">=1 character

Unique UUID v4 identifier for the InfiniBandInterface

instanceIdstringformat: "uuid"

ID of the associated Instance

partitionIdstringformat: "uuid"

ID of the InfiniBand Partition associated with this interface

devicestring

Name of the InfiniBand device associated with this interface

vendorstring or null

Name of the InfiniBand device vendor associated with this interface

deviceInstanceinteger

Index of the device where partition attach to

isPhysicalboolean

Indicates whether this is a physical interface

virtualFunctionIdinteger or null

Must be specified if isPhysical is false

guidstring or null

Must be specified if isPhysical is false

statusenum

Status of the InfiniBandInterface

createddatetimeRead-only

Date/time when the InfiniBandInterface was created

updateddatetimeRead-only

Date/time when the InfiniBandInterface was last updated

Errors

403

Forbidden Error