Retrieve all Instance InfiniBand Interfaces

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

[
  {
    "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": "Provisioning",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  },
  {
    "id": "c518a0e8-3f49-4a1a-8935-a6d3dee6911e",
    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
    "partitionId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "device": "MT2910 Family [ConnectX-7]",
    "deviceInstance": 1,
    "isPhysical": false,
    "virtualFunctionId": 1,
    "guid": "946dae0300339499",
    "status": "Provisioning",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Get all InfiniBand Interfaces for an Instance

Org must have a Tenant entity. User must have FORGE_TENANT_ADMIN authorization role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

instanceIdstringRequired

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

instanceIdstringformat: "uuid"

partitionIdstringformat: "uuid"

ID of the InfiniBand Partition associated with this interface

devicestring

Name of the InfiniBand device associated with this interface

deviceInstanceinteger

isPhysicalboolean

Indicates whether this is a physical interface

virtualFunctionIdinteger or null

guidstring or null

statusenum

Status values for InfiniBand Interface objects

Allowed values:

createddatetimeRead-only

updateddatetimeRead-only

Errors

403

Forbidden Error