Retrieve IP Block | NVIDIA Infra Controller

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Public Network Overlay for Site SJC4",
  "description": "This is the primary IP overlay for SJC4. All IPs are publicly routable",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "tenantId": null,
  "routingType": "Public",
  "prefix": "202.168.16.0",
  "prefixLength": 20,
  "protocolVersion": "IPv4",
  "usageStats": {
    "availableIPs": 256,
    "acquiredIPs": 2,
    "availablePrefixes": [
      "192.168.201.0/24"
    ],
    "availableSmallestPrefixes": 64,
    "acquiredPrefixes": 0
  },
  "status": "Pending",
  "statusHistory": [
    {
      "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 an IP Block by ID.

User must have FORGE_PROVIDER_ADMIN or 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

ipBlockIdstringRequired

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"

Filter IP Blocks by Infrastructure Provider ID

tenantIdstringOptionalformat: "uuid"

Filter IP Blocks by Tenant ID

includeUsageStatsbooleanOptional

Include IP Block usage stats in response

includeRelationenumOptional

Related entity to expand

Allowed values:

Response

idstringRead-onlyformat: "uuid"

namestring2-256 characters

descriptionstring

siteIdstringformat: "uuid"

infrastructureProviderIdstringformat: "uuid"

tenantIdstring or nullformat: "uuid"

routingTypeenum

Allowed values:

prefixstring

Either IPv4 or IPv6 address

prefixLengthinteger

Min: 1, Max: 32 for ipv4, 128 for ipv6

protocolVersionenum

Allowed values:

usageStatsobject

Usa statistics for an IP Block

statusenum

Status values for IP Block objects

Allowed values:

statusHistorylist of objects

deprecationslist of objects

createddatetimeRead-only

updateddatetimeRead-only

Errors

403

Forbidden Error