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

An edge switch contains ports that are assigned an iLan mapping. The ports are shown in the assigned ports resource list.

The following table lists the properties that can be used in the body of an edge-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: EdgeSwitch

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

The MAC address for this edge switch. Must be formatted with colon separators; for example:

01:23:45:67:89:AB

model String No* sortBy, like No The model for this edge switch.
ipAddress String No* sortBy, like No The IP address for this edge switch.

links:

self

distributionSwitch

assignedPorts

 Link Yes* No. No

Self referencing link.

The parent distribution switch for this edge switch.

The list of assigned ports for this edge switch.

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/{dsGuid}/switches

 GET Returns the list of edge switches that are part of the distribution switch (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/{dsGuid}/switches/{guid}

 GET Returns the specified edge switch. 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

Example of Using GET for Edge Switches

This example demonstrates how to obtain information about all the edge switches that are part of a specified distribution switch in a specified network segmentation group.

URI:

This example uses the following URI: 

https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA/switches

where:

  • https://raynsg.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
  • 8C7A153CDCFA is the GUID of the distributiion switch

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 edge switched that are part of the distribution switch specified. 

{
    "page": {
        "page": 1,
        "pageSize": 2,
        "totalCount": 2
    },
    "contents": [
        {
            "guid": "C0C520B0C4F5",
            "description": "NET41XX-MDU-2",
            "szName": "NET41XX-MDU-2",
            "serialNumber": "FMF3834Q015",
            "macAddress": "C0:C5:20:B0:C4:F5",
            "model": "ICX7150-C08P",
            "ipAddress": "10.157.35.42",
            "links": [
                {
                    "rel": "self",
                    "href": "https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA/switches/C0C520B0C4F5",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "distributionSwitches",
                    "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": "assignedPorts",
                    "href": "https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA/switches/C0C520B0C4F5/assignedPorts?page=1&pageSize=10",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "D4C19E10A100",
            "description": "NET41XX-MDU1",
            "szName": "NET41XX-MDU1",
            "serialNumber": "CYR3342P016",
            "macAddress": "D4:C1:9E:10:A1:00",
            "model": "ICX7450-48P",
            "ipAddress": "10.41.0.2",
            "links": [
                {
                    "rel": "self",
                    "href": "https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA/switches/D4C19E10A100",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "distributionSwitches",
                    "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": "assignedPorts",
                    "href": "https://raynsg.cloudpath.net/admin/publicApi/networkSegmentationGroups/4c878282-d6ee-4133-98e4-37b1d113caa1/distributionSwitches/8C7A153CDCFA/switches/D4C19E10A100/assignedPorts?page=1&pageSize=10",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

In this section:

  1. Assigned Port
    You can use REST API calls to obtain information about ports assigned to edge (also called "access") switches.
    new for 5.11
Parent topic: Distribution Switches