VPC

Retrieve all VPCs

Changed on

Retrieve all VPCs for the org.

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

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

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/vpc
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid

Filter VPCs by Site ID. Can be specified multiple times to filter on more than one Site.

statusstring

Filter VPCs by Status. Can be specified multiple times to filter on more than one Status.

networkSecurityGroupIdstring

Filter VPCs by Network Security Group ID. Can be specified multiple times to filter on more than one Network Security Group.

nvLinkLogicalPartitionIdstring uuid

Filter VPCs by NVLink Logical Partition ID. Can be specified multiple times to filter on more than one NVLink Logical Partition.

querystring

Search for matches across all VPCs. Input will be matched against name, description, labels, and status fields

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

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

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. The DPU sends router advertisements (RAs) on routed FNN interfaces. With SLAAC enabled, it sends them only when the interface prefix is exactly a /64.

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

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

status'Pending' | 'Provisioning' | 'Ready' | '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

  • 34144cb5f951Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 273aadbf1c41Revision changes
    • info

      removed the Configuring enum value from the / response property for the response status