Retrieve Subnet | NVIDIA Infra Controller

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "spark-gpu-net",
  "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
  "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "controllerNetworkSegmentId": "abe7b0e8-67db-4e89-903e-fc4f2bd7f034",
  "ipv4Prefix": "202.168.16.0",
  "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
  "ipv4Gateway": "202.168.0.1",
  "ipv6Prefix": null,
  "ipv6BlockId": null,
  "ipv6Gateway": null,
  "prefixLength": 20,
  "routingType": "Public",
  "status": "Ready",
  "statusHistory": [
    {
      "status": "Ready",
      "message": "Subnet has been successfully provisioned on Site",
      "created": "2019-08-24T16:02:38Z",
      "updated": "2019-08-24T16:02:38Z"
    },
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Retrieve a specific Subnet

Org must have a Tenant entity. User must have FORGE_TENANT_ADMIN 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

subnetIdstringRequired

Query parameters

includeRelationenumOptional

Related entity to expand

Allowed values:

Response

idstringRead-onlyformat: "uuid"

namestring2-256 characters

descriptionstring

siteIdstringformat: "uuid"

vpcIdstringformat: "uuid"

tenantIdstringformat: "uuid"

controllerNetworkSegmentIdstring or nullformat: "uuid"

ipv4Prefixstring or nullformat: "ipv4"

The prefix that gets assigned to the subnet if ipv4 block is chosen

ipv4BlockIdstring or nullformat: "uuid"

ipv4Gatewaystring or nullformat: "ipv4"

ipv6Prefixstring or nullformat: "ipv6"

ipv6BlockIdstring or nullformat: "uuid"

ipv6Gatewaystring or nullformat: "ipv6"

mtuintegerRead-only

Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

prefixLengthinteger

Max value depends on prefix length of parent IP Block

routingTypeenum

Allowed values:

statusenum

Status values for Subnet objects

Allowed values:

statusHistorylist of objectsRead-only

createddatetimeRead-only

updateddatetimeRead-only

deprecationslist of objects

Errors

403

Forbidden Error