Access Points
Access points in a network segmentation group are assigned to a unit. When an access point is assigned to a unit, the system locates an available VNI, and assigns that VNI to the unit. If a free port exists, the system assigns that VNI to a port. Any changes to the VNI assignment must be done from the unit. For more information, refer to the RUCKUS SmartZone and Cloudpath Network Segmentation Configuration Guide.
The following table lists the properties that can be used in the body of an AccessPoint-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: AccessPoint
Resource: Ethernet Port
| Property Name | Type | Editable | Sort/Filter | Optional in Request/Response Body? | Description |
|---|---|---|---|---|---|
| portName | String | No* | orderBy, like | No | The port name. This name cannot be changed once it is created. |
| portIndex | number | No* | orderBy, like | No | The port index number. It cannot be changed once created. |
| links, accessPoint, vxlanNetworkIdentifier | Link | No | None | No* | If this ethernet port has been assigned a VNI, the link to that vxlanNetworkIdentifier is provided. The parent access point link is also be provided if the port is listed directly and not within the ethernet resource. |
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
Example of Using GET for Access Points
This example demonstrates how to obtain information about all the APs in a specified network segmentation group.
This example uses the following URI:
https://Jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/accessPoints
- https://Jeff245.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).
- fe1b1ea8-87c0-467f-9b9f-7827f576cd82 is the GUID of the network segmentation group
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 |
None required.
Use the GET action to send the request.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 APs in the network segmentation group. In the following example, the "totalCount": 140 indicates the presence of 140 APs; the response body of the first two is shown below:
{
"page": {
"page": 1,
"pageSize": 10,
"totalCount": 140
},
"contents": [
{
"guid": "003535003468",
"szName": "Sim-100",
"name": "Sim-100:00:35:35:00:34:68",
"serialNumber": "020315597858",
"macAddress": "00:35:35:00:34:68",
"model": "H550",
"ethernetPorts": [
{
"portName": "LAN4",
"portIndex": 0,
"links": []
},
{
"portName": "LAN1",
"portIndex": 0,
"links": [
{
"rel": "vxlanNetworkIdentifiers",
"href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/vxlanNetworkIdentifiers/2000000",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
}
]
},
{
"portName": "LAN2",
"portIndex": 0,
"links": []
},
{
"portName": "LAN3",
"portIndex": 0,
"links": []
}
],
"links": [
{
"rel": "self",
"href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/accessPoints/003535003468",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
},
{
"rel": "networkSegmentationGroups",
"href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
},
{
"rel": "units",
"href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/accessPoints/003535003468/units",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
}
]
},
{
"guid": "0035350034EE",
"szName": "Sim-101",
"name": "Sim-101:00:35:35:00:34:EE",
"serialNumber": "040677579765",
"macAddress": "00:35:35:00:34:EE",
"model": "H550",
"ethernetPorts": [
{
"portName": "LAN1",
"portIndex": 0,
"links": []
},
{
"portName": "LAN2",
"portIndex": 0,
"links": []
},
{
"portName": "LAN3",
"portIndex": 0,
"links": []
},
{
"portName": "LAN4",
"portIndex": 0,
"links": []
}
],
"links": [
{
"rel": "self",
"href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/accessPoints/0035350034EE",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
},
{
"rel": "networkSegmentationGroups",
"href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
},
{
"rel": "units",
"href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/accessPoints/0035350034EE/units",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
}
]
},
{
}
]
}
]
}