Retrieve all Interfaces | NVIDIA Infra Controller

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

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",
    "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
    "isPhysical": true,
    "virtualFunctionId": null,
    "macAddress": "2F-FC-34-AE-9C-2A",
    "ipAddresses": [
      "200.32.11.190"
    ],
    "status": "Pending",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  },
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instanceId": "d57b373a-5a59-4fa4-b080-50e9a1095aeb",
    "vpcPrefixId": "26be5f71-3d51-487b-a940-6513c7725cfd",
    "isPhysical": true,
    "virtualFunctionId": null,
    "macAddress": "2F-FC-34-AE-9C-2A",
    "ipAddresses": [
      "200.32.11.190"
    ],
    "status": "Pending",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Get all 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 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"

subnetIdstring or nullformat: "uuid"

vpcPrefixIdstring or nullformat: "uuid"

isPhysicalboolean

devicestring or null

Name of the device to use

deviceInstanceinteger or null

Index of the device, used to identify which interface card to attache the Partition to

virtualFunctionIdinteger or null

Must be specified if isPhysical is false

macAddressstring or null

ipAddresseslist of strings

A list of IPv4 or IPv6 addresses

requestedIpAddressstring or null

Explicitly requested IP address for the interface. This is only used for VPC Prefix based interfaces and is not valid for Subnet based interfaces. The least-significant host bit must be 1.

statusenum

Status values for Interface objects

Allowed values:

createddatetimeRead-only

updateddatetimeRead-only

Errors

403

Forbidden Error