Sign in
VPC

Retrieve a VPC

Retrieve a specific VPC by ID.

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

get/v2/org/{org}/nico/vpc/{vpcId}

Query parameters

includeRelation'InfrastructureProvider' | 'Tenant' | 'Site' | 'NetworkSecurityGroup'

Related entity to expand

Response

OK

idstring uuid

ID of the VPC

namestring

Name of the VPC

descriptionstring nullable

Description of the VPC, can be empty

orgstring

Organization the VPC belongs to

tenantIdstring uuid

ID of the Tenant the VPC belongs to

siteIdstring uuid

ID of the Site the VPC belongs to

controllerVpcIdstring uuid nullable

Legacy attribute, contains the same value as ID

networkVirtualizationType'ETHERNET_VIRTUALIZER' | 'FNN' | 'FLAT' nullable

Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

slaacEnabledboolean

Whether this VPC uses SLAAC allocation mode for instance IPv6 interfaces. When true, Core allocates a /64 to each interface that includes IPv6 and retains the prefix without assigning a concrete IPv6 host address. This value is fixed when the VPC is created. NICo does not yet configure router advertisements (RAs); that support is tracked by https://github.com/NVIDIA/infra-controller/issues/2398.

routingProfilestring nullable

Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

powerResourceGroupstring nullable

External power provisioning resource group associated with the VPC.

requestedVniinteger nullable

Explicitly requested VNI for the VPC if one was requested at creation time

vniinteger nullable

Active VNI assigned to the VPC

networkSecurityGroupIdstring nullable

ID of the Network Security Group attached to the VPC

nvLinkLogicalPartitionIdstring uuid nullable

ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

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

Status values for VPC objects

createdstring date-time

Date/time when VPC was created

updatedstring date-time

Date/time when VPC was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "spark-vpc",
  "description": "Virtual network for machines executing Spark jobs",
  "org": "xskkpgqpeakn",
  "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
  "labels": {
    "region": "us-west-1",
    "env": "dev"
  },
  "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
  "slaacEnabled": false,
  "requestedVni": 12001,
  "vni": 12001,
  "networkSecurityGroupId": "c602eb90-3039-11f0-997a-b38d4fc8389e",
  "networkSecurityGroupPropagationDetails": {
    "objectId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "detailedStatus": "Partial",
    "status": "Synchronizing",
    "details": "",
    "unpropagatedInstanceIds": [
      "b1a5a05e-303c-11f0-b618-7f2e7f9b64ed"
    ],
    "relatedInstanceIds": [
      "b1a5a05e-303c-11f0-b618-7f2e7f9b64ed"
    ]
  },
  "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
  "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"
}

Changes

Changed in 8 of the 90 revisions of this API.937

  • 9c78a8936b341See the full diff
    • ○

      added the optional property powerResourceGroup to the response with the 200 status

      response-optional-property-added

  • a482c2d8f5e21See the full diff
    • ○

      added the optional property slaacEnabled to the response with the 200 status

      response-optional-property-added

  • 484497856a949See the full diff
    • ▲

      the effectiveRoutingProfile/accessTier response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

    • ▲

      the effectiveRoutingProfile/routeTargetImports/items/asn response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

    • ▲

      the effectiveRoutingProfile/routeTargetImports/items/vni response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

    • ▲

      the effectiveRoutingProfile/routeTargetsOnExports/items/asn response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

    • ▲

      the effectiveRoutingProfile/routeTargetsOnExports/items/vni response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

    • ▲

      the routingProfileOverrides/oneOf[subschema #1: VpcRoutingProfileOverrides]/routeTargetImports/items/asn response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

    • ▲

      the routingProfileOverrides/oneOf[subschema #1: VpcRoutingProfileOverrides]/routeTargetImports/items/vni response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

    • ▲

      the routingProfileOverrides/oneOf[subschema #1: VpcRoutingProfileOverrides]/routeTargetsOnExports/items/asn response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

    • ▲

      the routingProfileOverrides/oneOf[subschema #1: VpcRoutingProfileOverrides]/routeTargetsOnExports/items/vni response's property type/format changed from integer/int64 to integer/uint32 for status 200

      response-property-type-changed

  • d9f587ccd19a2See the full diff
    • ○

      added the optional property effectiveRoutingProfile to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property routingProfileOverrides to the response with the 200 status

      response-optional-property-added

  • bc7cf73fe60412See the full diff
    • ●

      removed the optional property networkSecurityGroupPropagationDetails/id from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property networkSecurityGroupPropagationDetails/deprecations to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property networkSecurityGroupPropagationDetails/objectId to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b078e63260c11See the full diff
    • ●

      added the new FLAT enum value to the networkVirtualizationType response property for the response status 200

      response-property-enum-value-added

  • ffa0635230581See the full diff
    • ○

      removed the FLAT enum value from the networkVirtualizationType response property for the response status 200

      response-property-enum-value-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f20872e0979a1See the full diff
    • ●

      added the new FLAT enum value to the networkVirtualizationType response property for the response status 200

      response-property-enum-value-added