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.
This object has no members.
Identification of the Captive Portal Profile that is associated with this instance of SSID connection.
Allowed characters: Restricted to UUID
Format: free
SDK attribute: associatedCaptivePortalProfileID
Identification of the Egress QoS policy that is associated with this instance of an SSID Connection.
Allowed characters: Limited to UUID
Format: free
SDK attribute: associatedEgressQOSPolicyID
Which mode of authentication is defined for a particular SSID Connection instance.
Allowed values: CAPTIVE_PORTAL, OPEN, WEP, WPA, WPA2, WPA_OTP, WPA_WPA2
Default value: WPA2
SDK attribute: authenticationMode
List of all the black listed MAC Addresses for a particular SSID.
SDK attribute: blackList
Boolean that defines if the SSID name is to be broadcasted or not.
Default value: true
SDK attribute: broadcastSSID
Brief description of the SSID.
Format: free
Max length: 255
SDK attribute: description
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
The Gateway (NSG) associated with this SSID. This is a read only attribute
Format: free
SDK attribute: gatewayID
Blob type attribute that serves to define non-mandatory properties that can be defined in the WiFi Card configuration file.
Format: free
SDK attribute: genericConfig
A read-only attribute that represents the generated interface name for the SSID connection to be provisioned on the NSG.
Format: free
SDK attribute: interfaceName
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
The name associated to the SSID instance. Has to be unique within an NSG.
Format: free
Min length: 1
Max length: 32
SDK attribute: name
Password or passphrase associated to an SSID instance. Based on the authenticationMode selected.
Format: free
SDK attribute: passphrase
The permitted action to USE/EXTEND this SSID Connection
Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction
Determines whether this entity is read only. Read only objects cannot be modified or deleted.
SDK attribute: readonly
Redirection action to exercise once the connecting user has accepted the use policy presented on the Wireless Captive Portal.
Allowed values: CONFIGURED_URL, ORIGINAL_REQUEST
Default value: ORIGINAL_REQUEST
SDK attribute: redirectOption
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.
Format: free
Max length: 255
SDK attribute: redirectURL
Determines whether this entity can be used in associations with other properties.
SDK attribute: restricted
Status of the SSID/VLAN. Possible values are - INITIALIZED, ORPHAN, READY, MISMATCH
Allowed values: INITIALIZED, MISMATCH, ORPHAN, READY
SDK attribute: status
A VLAN representation of the SSID ordering on a Wireless Card/Port.
Max value: 4096
SDK attribute: vlanID
The Vport associated with this SSID connection. The attribute can't be modified directly from the SSID Connection.
Format: free
SDK attribute: vportID
List of all white listed MAC Addresses for a particular SSID.
SDK attribute: whiteList