Object representing a Wireless Access Captive Portal Profile which can be associated with SSID entities from which end users may be presented with instructions and condition of use when connecting to an open wireless access point.
| captivePage |
| description |
| entityScope |
| externalID |
| lastUpdatedBy |
| name |
| portalType |
This object has no children.
This object has no members.
Attribute having the contents of captive portal page displayed to end user. User can possibly include very basic HTML tags like
,
Format: free
Min length: 1
Max length: 65535
SDK attribute: captivePage
Description for the captive portal profile.
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
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Name of the captive portal profile.
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Type of the portal page. Will decide if the NSG rendering the page will have a strict rendering of the welcoming page based on what is given by VSD, or if the information can be made customisable by an operator to include animations, videos, images, and other types of more complex scripts.
Allowed values: CLICK_THROUGH
Default value: CLICK_THROUGH
SDK attribute: portalType