VXLAN Network Identifiers (VNIs)

You can use REST API calls to obtain information about existing VNIs being used in a specified network segmentation group.
updated below for 5.11 with assignedPort info

The following table lists the properties that can be used in the body of a VxlanNetworkIdentifier-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).)

Resource: VxlanNetworkIdentifier

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
vni Long Yes orderBy, like No The unique identifier for the VNI. It must be unique within the network segmentation group.

links: self, units, accessPoints, assignedPort

 Link Yes* No. No

Self-referencing link. If the VNI has been assigned to a unit and to an AP, the links to that unit and AP are provided. (The VNI must be added to the unit and access point from those resources.)

New for 5.11 - Please check
The assigned port is mapped if the unit has been mapped to a physical port on an edge switch. The "rel": "assignedPort" response enables the API user to follow this vnlanNetworkIdentifier to the assigned port, and then to the edge switch. Refer also to Assigned Port.

Properties URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

Property URIs and Actions

URI Action Description Return Codes
/networkSegmentationGroups/{guid}/vxlanNetworkIdentifiers GET Returns the list of VNIs that are currently assigned to the network segmentation group specified.

401 - Unauthorized

200 - OK
/networkSegmentationGroups/{guid}/vxlanNetworkIdentifiers/{vni} GET Returns information about the specified VNI.

200- OK

404 - Not Found

401 - Unauthorized

Example of Using GET for VNIs

This example demonstrates how to obtain information about all VNIs that have already been assigned to a specified network segmentation group.

URI:

This example uses the following URI: 

https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/vxlanNetworkIdentifiers

where:

  • https://nsg192.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).
  • 4c878282-d6ee-4133-98e4-37b1d113caa1 is the GUID of the network segmentation group.

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqZWZmLnJob2RpZUBjb21tc2NvcGUuY29tIiwicm9sZVBrIjoiMjEwMDAiLCJhY2NvdW50QWRtaW5QayI6IjIiLCJhcGlLZXkiOiJaV2NjTGpQZUdZMGUiLCJpYXQiOjE1NzU1NzUxNTcsImV4cCI6MTU3NTU3NTQ1N30.2q4KTyDUevkAAz7mJyp529Be1-ip3EC8P06Xarmz5ao

Request Body:

None required.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body indicates with the "totalCount": 1001 that there 1001 assigned VNIs in the specified network segmentation group. Partial output is shown below:

updated output for 5.11 - assignedPort shown

{
    "page": {
        "page": 1,
        "pageSize": 10,
        "totalCount": 1001
    },
    "contents": [
        {
            "vni": 1000,
            "links": [
                {
                    "rel": "self",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/vxlanNetworkIdentifiers/1000",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "networkSegmentationGroups",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "units",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/properties/Property-acbdfa3a-2800-44dd-a943-7d4c58501168/units/Unit-b7ed85d5-cb94-4a76-bc79-e45a3a3b272d",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "vni": 1001,
            "links": [
                {
                    "rel": "self",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/vxlanNetworkIdentifiers/1001",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "networkSegmentationGroups",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "units",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/properties/Property-acbdfa3a-2800-44dd-a943-7d4c58501168/units/Unit-87fb41d0-5dcb-4e49-99ba-6b72ca108fd5",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "vni": 1002,
            "links": [
                {
                    "rel": "self",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/vxlanNetworkIdentifiers/1002",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "networkSegmentationGroups",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "units",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/properties/Property-90478c87-c1e3-4289-a464-6231f8b0f362/units/Unit-9c76a6e4-49e9-4611-967b-9750c2359935",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "assignedPort",
                    "href": "https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA/switches/C0C520B0C4F5/assignedPorts?nasPort=1/1/9",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },

Parent topic: Network Segmentation Groups