SmartZone Network Segmentation

You can use REST API calls to create, or return information about, a SmartZone integrated system that has been established with Cloudpath.
new for 5.11
Note: The SmartZone network segmentation resource represents the connection between Cloudpath and a RUCKUS SmartZone controller supporting network segmentation. Only a single integrated system is permitted here; therefore the URIs do not require a GUID, and only the HTTP verbs POST, GET, and DELETE are supported.

The following table lists the properties that can be used in the body of a SmartZone network segmentation-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: SzNetworkSegmentation

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
displayName String Yes none No The display name for this SmartZone Network Segmentation integrated system
description String Yes none Yes A description for this SmartZone Network Segmentation integrated system
status

String <Enum>

 Yes none No

An enumeration that represents the status of the integration with SmartZone. The status values are: 

ESTABLISHED, CP_AUTH_FAIL, SZ_AUTH_FAIL, SZ_CONN_FAIL, SZ_INVALID_REQUEST,
SZ_LOGON_FAIL, SZ_CERT_VERIFY_FAIL, SZ_CONNECTED_ANOTHER_CP, UNKNOWN

If the status is NOT established and a POST is performed that changes the status, this request triggers an attempt to reconnect to SmartZone. The status updates, based on the results of that connection attempt.
hostName String Yes none No The hostname of the SmartZone instance.
port Number Yes none No The port for the SmartZone APIs,
userName String Yes none No A username on SmartZone that is permitted to access the APIs.
password String Yes none No The password for the defined user.
link Link No No No Self-referencing link

Integrated System 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.

Integrated System URIs and Actions

URI Action Description Return Codes
/integratedSystems/smartZoneNetSeg GET Returns the SmartZone Network Segmentation Integrated System, if one has been established. Will return "NotFound" if there is no established integrated system.

404 - Not Found

401 - Unauthorized

200 - OK
POST Creates or updates the SmartZone Network Segmentation Integrated System. Will return a 201 code if created, or a 200 if updated. The body includes the details.

401 - Unauthorized

201 - Created

200 - OK
DELETE Deletes the SmartZone Network Segmentation Integrated System.

500 - Internal Server Error (for example, pool in use)

401 - Unauthorized

204 - No content

200 - OK

Example of Using GET for Integrated Systems

This example demonstrates how to obtain information about a SmartZone integrated system with Cloudpath UI.

URI:

This example uses the following URI: 

 https://nsg192.cloudpath.net/admin/publicApi/integratedSystems

where https://nsg192.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).

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 eyJhbGciOiJIUzUxMiJ9.eyJhY2NvdW50UGsiOiIxMSIsInJvbGVQayI6IjIwMDAwIiwiYXVkIjoiUkVTVF9BUEkiLCJzdWIiOiI0NyIsImlzcyI6InRrVUJYWnVIZTNtMHdPWnA1TTc0VWpycndKYk53ODRVclkxZUJJQlhtb009IiwiaWF0IjoxNjYyNjA3ODM5LCJleHAiOjE2NjI2MDgxMzl9.r-UU4CA-h2FxQ8udq6krH1kIy9JyVy9SbnsYbzHmA6yC_oMPFfQpUavlb23RkAlPLk9E8bnye7vZ3BxQAWf4wA

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 the integrated system in your Cloudpath system. In this example, the integrated system has an IP address of 10.10.10.10. 

{
    "displayName": "nsg@arris.com",
    "description": "",
    "host": "10.10.10.10",
    "type": "SZ_NET_SEGMENTATION",
    "status": "Established",
    "port": "8443",
    "userName": "admin",
    "password": "sqa4ruckus!",
    "links": [
        {
            "rel": "self",
            "href": "https://nsg192.cloudpath.net/admin/publicApi/integratedSystems/smartZoneNetSeg",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}

Parent topic: Integrated Systems