Distribution Switches

You can use REST API calls to obtain information about any distribution switches that are being used in your network segmentation groups.
new for 5.11

Distribution switches define the set of vlans that can be assigned to the vni/vlan mapping for network segmentation

The following table lists the properties that can be used in the body of a distribution-switch-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: DistributionSwitch

Property Name Type Editable Sort/Filter Optional Description
guid String No sortBy, like No The unique identifier for this distribution switch,
szName String No* sortBy, like No The name that SmartZone has assigned to this distribution switch.
description String Yes sortBy, like Yes A description for this distribution switch.
serialNumber String No* sortBy, like No The serial number for this distribution switch.
macAddress String No* sortBy, like No

The MAC address for this distribution switch. Must be formatted with colon separators, as shown in the following example:

01:23:45:67:89:AB

model String No* sortBy, like No The model for this distribution switch
vlanList

List<Vlan>

 Yes* No No The list of available Vlans that are on provided for the segmentation group on this distribution switch. Must be between 1-4096. A VLan gets mapped to a unit if there is an assigned port on one of the mapped core switches.
vniRanges

List <VniRange>

 Yes No Yes

The list of vni ranges assigned to this switch. A list of Vni ranges must be contain a unique range, and cannot be within the range of any other range assigned to this switch. All ranges must be within the VNI range assigned to the segmentation group that this switch belongs to.

See VniRange as defined in: Network Segmentation Groups

links:

self, networkSegmentationGroup, vlans, edgeSwitches

 Link Yes* No. No*

Self referencing link.

The parent networkSegmentationGroup for this distribution switch.

The vlans for this distribution switch

The edge switches for this distribution switch

Resource: VLan

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
vlanNumber Number No* sortBy, like No Vlan number. Must be between 1-4096 and with no duplicates.

links:

vxlanNetworkIdentifier

 Link No No. No If this Vlan has been assigned a vni, the link to that vxlanNetworkIdentifier is provided.

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/{groupGuid}/distributionSwitches

 GET Returns the list of distribution switches that are in this networkSegmentationGroup. (with paging and sorting and filtering.) If the Cloudpath server has not been correctly configured for SmartZone integration, this URI will generate a 403 message.

200- OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

/networkSegmentationGroups/{groupGuid}/distributionSwitches/{guid}

 GET Returns the specific access point. If the Cloudpath server has not been correctly configured for SmartZone integration, this URI will generate a 403 message.

200- OK

404 - Not Found

401 - Unauthorized

/networkSegmentationGroups/{groupGuid}/distributionSwitches/{guid}/vlans

 GET Returns the list of vlans on the specified distribution switch that are in this networkSegmentationGroup. (with paging and sorting and filtering.) If the Cloudpath server has not been correctly configured for SmartZone integration, this URI will generate a 403 message..

204 - No content

200 - OK

401 - Unauthorized

403 - Forbidden

/networkSegmentationGroups/{groupGuid}/distributionSwitches/{guid}/vlans/{vlanNumber}

 GET Returns the specific vlan on the distribution switch. The "guid" is the vlan number itself. If the Cloudpath server has not been correctly configured for SmartZone integration, this URI will generate a 403.

204 - No content

200 - OK

401 - Unauthorized

403 - Forbidden

Example of Using GET for Distribution Switches

This example demonstrates how to obtain information about the distribution switches in a specified network segmentation group.

URI:

This example uses the following URI: 

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

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 provides information about all the distribution switches in the specified network segmentation group. In the following example, there is only distribution switch - given the description of "NET41XX-CORE-DIS" :

{
    "page": {
        "page": 1,
        "pageSize": 1,
        "totalCount": 1
    },
    "contents": [
        {
            "guid": "8C7A153CDCFA",
            "description": "NET41XX-CORE-DIS",
            "szName": "NET41XX-CORE-DIS",
            "serialNumber": "FMQ4234S0DW",
            "macAddress": "8C:7A:15:3C:DC:FA",
            "model": "ICX7550-48ZP",
            "links": [
                {
                    "rel": "self",
                    "href": "https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "networkSegmentationGroups",
                    "href": "https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "vlans",
                    "href": "https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA/vlans?page=1&pageSize=10",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "edgeSwitches",
                    "href": "https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA/switches?page=1&pageSize=10",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

In this section:

  1. Edge Switches
    You can use REST API calls to obtain information about any edge switches (also referred to as "access switches") that have been added to a distribution switch in your network segmentation group.
    new for 5.11
Parent topic: Network Segmentation Groups