SessionControl Object
The SessionControl object allows the JavaScript to initiate session management and control capabilities.
The use of SessionControl objects requires a SCM license.
Properties
Properties
SUCCESS
SUCCESS
The SUCCESS property is returned by the Execute() method when the session control action succeeds.
Example
FAILURE
FAILURE
The FAILURE property is returned by the Execute() method when the session control action fails.
Example
TIME_OUT
TIME_OUT
The TIME_OUT property is returned by the Execute() method when the session control action times out.
Example
MISSING_INFO
MISSING_INFO
The MISSING_INFO property is returned by the Execute() method when the session control action needs more information to execute the action requested.
Example
SessionControl Methods
SessionControl Methods
These SessionControl methods allow the JavaScript to initiate session management and control capabilities.
AddAttribute()
AddAttribute()
Purpose
The AddAttribute() method is used to add a named attribute to the Session Control action. If an attribute of the same name exists, the new data value is appended to the end of the attribute list.
Syntax
AddAttribute(name, value)
Parameters
Table 157: AddAttribute() Parameters
Parameter | Description |
---|---|
name | Specifies the name of the attribute dictionary. |
value | Specifies a value for the attribute |
Returns
Nothing.
Example
Execute()
Execute()
Purpose
The Execute() method is used to execute built-in Steel-Belted Radius Carrier CoA/DM actions.
Syntax
selector.Execute(name)
Parameters
Table 158: Execute() Parameters—SessionControl Methods
Parameter | Description |
---|---|
Name | Specifies the name of the CoA/DM action to execute. The deviceModels.xml file defines the CoA/DM actions supported by the client devices in your network. For more information, see Overview of the Optional Session Control Module. |
Returns
SUCCESS, FAILURE, TIME_OUT, or MISSING_INFO properties.