Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

SessionControl Object

The SessionControl object allows the JavaScript to initiate session management and control capabilities.

Note: The use of SessionControl objects requires a SCM license.

Properties

SUCCESS

The SUCCESS property is returned by the Execute() method when the session control action succeeds.

Example

success = (sc.Execute() == SessionControl.SUCCESS);

FAILURE

The FAILURE property is returned by the Execute() method when the session control action fails.

Example

failure = (sc.Execute() == SessionControl.FAILURE);

TIME_OUT

The TIME_OUT property is returned by the Execute() method when the session control action times out.

Example

time_out = (sc.Execute() == SessionControl.TIME_OUT);

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

missing_info = (sc.Execute() == SessionControl.MISSING_INFO);

SessionControl Methods

These SessionControl methods allow the JavaScript to initiate session management and control capabilities.

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 156: AddAttribute() Parameters

Parameter

Description

name

Specifies the name of the attribute dictionary.

value

Specifies a value for the attribute

Returns

Nothing.

Example

test.AddAttribute("Unisphere-Med-Ip-Address", "1.1.1.1");

Execute()

Purpose

The Execute() method is used to execute built-in Steel-Belted Radius Carrier CoA/DM actions.

Syntax

selector.Execute(name)

Parameters

Table 157: 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.

Example

success = (test.Execute(“interceptOn” ) == SessionControl.SUCCESS);

Modified: 2017-03-07