Instance

Retrieve all Instance InfiniBand Interfaces

Changed on

Get all InfiniBand Interfaces for an Instance

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

get/v2/org/{org}/nico/instance/{instanceId}/infiniband-interface

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/instance/{instanceId}/infiniband-interface
  • Auth
    HTTP bearer

Query parameters

statusstring

Filter InfiniBand Interfaces by Status

includeRelation'Instance' | 'InfiniBandPartition'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique UUID v4 identifier for the InfiniBandInterface

instanceIdstring uuid

ID of the associated Instance

partitionIdstring uuid

ID of the InfiniBand Partition associated with this interface

devicestring

Name of the InfiniBand device associated with this interface

vendorstring nullable

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 nullable

Must be specified if isPhysical is false

guidstring nullable

Must be specified if isPhysical is false

status'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error'

Status values for InfiniBand Interface objects

createdstring date-time

Date/time when the InfiniBandInterface was created

updatedstring date-time

Date/time when the InfiniBandInterface was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
    "partitionId": "05ef7e84-1d4e-4e4d-980d-38589479a0fe",
    "device": "MT2910 Family [ConnectX-7]",
    "deviceInstance": 0,
    "isPhysical": true,
    "virtualFunctionId": null,
    "guid": "946dae0300339498",
    "status": "Ready",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes