Network Segmentation Groups

You can use REST API calls to obtain information about existing network segmentation groups and their properties.
new for 5.9R3

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

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
guid String No orderBy, like No The unique identifier for this network segmentation group as provided on creation. (This is the value from SmartZone.)
name String Yes orderBy, like No The display name for this network segmentation group.
description String Yes orderBy, like Yes A description for this network segmentation group.
vniRange VniRange

<Embedded Object>

 Yes None N The VNI range for this network segmentation group. This is used by Cloudpath to generate the list of VNIs which belong to this group. This is an inclusive range as defined in the resource "VniRange" (desribed in the Resource table below).

links

self, properties, vxlanNetworkIdentifiers, accessPoints

 Link No orderBy, like No Self referencing link, vxlanNetworkIdentifiers, the assigned properties, and accessPoints.

Resource: VniRange

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
firstVni Long Yes None No The first VNI to allow, inclusive to the last VNI.
lastVni Long Yes None No The last VNI to use.

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 GET Returns the list of network segmentation groups that are in Cloudpath. If the Cloudpath server has not been correctly configured for SmartZone integration, this URI generates a "403 - Forbidden" message.

200- OK

401 - Unauthorized

403 - Forbidden
/networkSegmentationGroups/{guid} GET Returns information about the specified network segmentation group. If the Cloudpath server has not been correctly configured for SmartZone integration, this URI generates a "403 - Forbidden" message.

200- OK

404 - Not Found

401 - Unauthorized

403 - Forbidden
/networkSegmentationGroups/{guid}/properties GET

The list of properties that have been assigned to this network segmentation group.

If the Cloudpath server has not been correctly configured for SmartZone integration, this URI generates a "403 - Forbidden" message.

200- OK

404 - Not Found

401 - Unauthorized

403 - Forbidden

Example of Using GET for networkSegmentationGroups

This example demonstrates how to obtain information about all networkSegmentationGroups that have already been created.

URI:

This example uses the following URI: 

 https://Jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups

where https://Jeff245.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 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 existing network segmentation groups in your Cloudpath system. In this example, only one network segmentation group, named "chris-1", exists. 

{
    "page": {
        "page": 1,
        "pageSize": 1,
        "totalCount": 1
    },
    "contents": [
        {
            "guid": "fe1b1ea8-87c0-467f-9b9f-7827f576cd82",
            "name": "chris-1",
            "vniRange": {
                "firstVni": 2000000,
                "lastVni": 2001000
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "property",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/properties?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "vxlanNetworkIdentifiers",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/vxlanNetworkIdentifiers?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "accessPoints",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/accessPoints?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Example of Using GET to Obtain a List of Properties for a Specific networkSegmentation Group

This example demonstrates how to obtain the list of properties that have been assigned to a specific networkSegmentation group.

URI:

This example uses the following URI: 

 https://Jeff245.cloudpath.net/admin/publicApi/networkSegmentationGroups/fe1b1ea8-87c0-467f-9b9f-7827f576cd82/properties

where: .

  • 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 networkSegmentation 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 "200 OK" if the GET is successful. In this example, only one property, named "Tech Pubs Building 1", is currently assigned to the network segmentation group.

{
    "page": {
        "page": 1,
        "pageSize": 1,
        "totalCount": 1
    },
    "contents": [
        {
            "guid": "Property-40ac7e72-97ed-4567-a180-7d20967c5a72",
            "name": "Tech Pubs Building 1 ",
            "address": "001 Tech Pubs Road\r\nLake Town, CA",
            "description": "",
            "enforceMaxUnits": false,
            "maxUnits": 0,
            "allowSeparateGuestSecret": true,
            "ssids": [
                "Jeff eDPSK"
            ],
            "managementName": "Sushma A",
            "managementPhone": "0005550200",
            "managementEmail": "sushma@commscope.com",
            "tenantPortalHelpText": "",
            "tenantPortalAnnouncements": "",
            "sendEmail": true,
            "sendSms": true,
            "smsPassphraseChange": "",
            "emailPassphraseSubject": "",
            "emailPassphraseChange": "",
            "smsAssignedUnit": "",
            "emailAssignedUnitSubject": "",
            "emailAssignedUnit": "",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/properties/Property-40ac7e72-97ed-4567-a180-7d20967c5a72",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "uiConfiguration",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/properties/Property-40ac7e72-97ed-4567-a180-7d20967c5a72/uiConfiguration",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "dpskPool",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/dpskPools/AccountDpskPool-390c47b8-5c61-4d06-bb9b-6693c65db8b6",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "units",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/properties/Property-40ac7e72-97ed-4567-a180-7d20967c5a72/units?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "networkSegmentationGroups",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/properties/Property-40ac7e72-97ed-4567-a180-7d20967c5a72/networkSegmentationGroups?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Parent topic: Network Segmentation Groups