SSIDConnection

An SSID Connection instance represents an SSID defined on a WiFi interface. One SSID Connection is required per SSID created on a WiFi Card/Port.

Overview

associatedCaptivePortalProfileID string
associatedEgressQOSPolicyID string
authenticationMode enum (CAPTIVE_PORTAL | OPEN | WEP | WPA | WPA2 | WPA_OTP | WPA_WPA2) filterable   orderable  
blackList list
broadcastSSID boolean filterable   orderable  
description string
genericConfig string
interfaceName string autogenerated   filterable   orderable   locally unique  
name string required   filterable   orderable   locally unique  
passphrase string
redirectOption enum (CONFIGURED_URL | ORIGINAL_REQUEST) filterable   orderable  
redirectURL string
whiteList list

API Resource

/ssidconnections/id
delete get put

Parents

/wirelessports/id/ssidconnections
get post

Children

/ssidconnections/id/alarms
get
/ssidconnections/id/eventlogs
get

Members

/ssidconnections/id/captiveportalprofiles
get put

Attributes documentation

associatedCaptivePortalProfileID string
Discussion

Identification of the Captive Portal Profile that is associated with this instance of SSID connection.

Charateristics

Format: free
SDK attribute: associatedCaptivePortalProfileID

associatedEgressQOSPolicyID string
Discussion

Identification of the Egress QoS policy that is associated with this instance of an SSID Connection.

Charateristics

Format: free
SDK attribute: associatedEgressQOSPolicyID

authenticationMode enum filterable   orderable  
Discussion

Which mode of authentication is defined for a particular SSID Connection instance.

Charateristics

Allowed values: CAPTIVE_PORTAL, OPEN, WEP, WPA, WPA2, WPA_OTP, WPA_WPA2
Default value: OPEN
SDK attribute: authenticationMode

blackList list
Discussion

List of all the black listed MAC Addresses for a particular SSID.

Charateristics

SDK attribute: blackList

broadcastSSID boolean filterable   orderable  
Discussion

Boolean that defines if the SSID name is to be broadcasted or not.

Charateristics

Default value: true
SDK attribute: broadcastSSID

description string
Discussion

Brief description of the SSID.

Charateristics

Format: free
Max length: 255
SDK attribute: description

genericConfig string
Discussion

Blob type attribute that serves to define non-mandatory properties that can be defined in the WiFi Card configuration file.

Charateristics

Format: free
SDK attribute: genericConfig

interfaceName string autogenerated   filterable   orderable   locally unique  
Discussion

A read-only attribute that represents the generated interface name for the SSID connection to be provisioned on the NSG.

Charateristics

Format: free
SDK attribute: interfaceName

name string required   filterable   orderable   locally unique  
Discussion

The name associated to the SSID instance. Has to be unique within an NSG.

Charateristics

Format: free
Min length: 1
Max length: 32
SDK attribute: name

passphrase string
Discussion

Password or passphrase associated to an SSID instance. Based on the authenticationMode selected.

Charateristics

Format: free
SDK attribute: passphrase

redirectOption enum filterable   orderable  
Discussion

Redirection action to exercise once the connecting user has accepted the use policy presented on the Wireless Captive Portal.

Charateristics

Allowed values: CONFIGURED_URL, ORIGINAL_REQUEST
Default value: ORIGINAL_REQUEST
SDK attribute: redirectOption

redirectURL string
Discussion

URL to have a newly connected user redirected to once the use policy defined on the Wireless Captive Portal has been accepted by the user.

Charateristics

Format: free
Max length: 255
SDK attribute: redirectURL

whiteList list
Discussion

List of all white listed MAC Addresses for a particular SSID.

Charateristics

SDK attribute: whiteList