Session variables reference

Access policy result: the access policy ended at Deny. The value is

access_denied

.

Access policy result: the access policy ended at Redirect. The value is

redirect

.

URL specified in the redirect, for example,

http://www.siterequest.com

.

Access policy result: the access policy ended at Allow. The value is

allowed

.

Name of the resource that is automatically started for a network access webtop.

Type of webtop resource:

network_access

or

web_application

.

UI mode, as determined by HTTP headers. UI mode reflects the protocol that the client used to communicate with the server during APM session establishment and access policy execution. UI mode does not directly map to client type (

session.client.type

). For example, when BIG-IP Edge Client uses a web browser component to establish a session, the

session.ui.mode

is set to 0 (Full Browser). Values:

0 - Full Browser
6 - Pocket PC (browser)
7 - Standalone Client (clientless mode, no support for endpoint inspection; not Edge Client)
8 - ActiveSync Client
9 - Mobile Browser (smart phone)
10 - Citrix Receiver

Language in use in the session, for example

"en"

(English).

Character set used in the session.

Client type as determined by HTTP headers: portalclient or "Standalone" (Edge Client).

Mobile device is jailbroken/rooted:

0
- No
1
- Yes

Client is capable of executing JavaScript:

0
- No
1 - Yes

Client is capable of running ActiveX Controls:

0
- No
1
- Yes

Client platform as determined by HTTP headers:

"Android"
"ChromeOS"
"iOS"
"Linux"
"
"MacOS"
"Win10"
"Win2k"
"Win2k"
"Win7"
"Win8.1"
"Win8"
"WindowsPhone"
"WinLH"
"WinNT"
"WinVI"
"
"WinXP"

Enables direct access to a Citrix resource from the webtop. Example:

local

.

0 or 1.

0
- Active Directory query failed
1
- Active Directory query passed

0 or 1.

0
- Active Directory authentication failed
1
- Active Directory authentication passed

Users attributes retrieved during Active Directory query. Each attribute is converted to a separate session variable.

User's group attributes retrieved during Active Directory query. Each group attribute is converted to a separate session variable.

Name of the assigned dynamic bandwidth control policy.

Name of the assigned static bandwidth control policy.

X509 extensions.

Certificate result:

OK

or error string.

0 or 1.

0
- Certificate does not exist
1
- Certificate exists

Certificate version

Certificate subject field

Certificate serial number

Validity end date

Validity start date

Certificate issuer

The whole certificate

0 or 1.

0
- User chooses option 2 on the decision page, which corresponds to the fallback rule branch in the action.
1
-User chooses option 1 on the decision page

0 or 1.

0
- Not all drive encrypted.
1
- All drive encrypted.

Unused session variable; always shows the value

0

.

True

- if all files exist on the client.

Set when files on the client meet the configured attributes.

MD5 value of a checked file.

Version of a checked file.

File size, in bytes.

Date the file was modified in UTC form.

File signer information.

0 or 1.

0
- LDAP authentication failed
1
- LDAP authentication passed

Users attributes retrieved during LDAP query. Each attribute is converted to a separate session variable.

0 or 1.

0
- LDAP query failed
1
- LDAP query passed

A bitmask used when CAPTCHA is enabled.

Bit in 0 position
- Track successful and unsuccessful logon attempts by IP address
Bit in 1 position
- - Track successful and unsuccessful logon attempts by user name

0, 1, 2, or -2.

0
- Neither certificate nor private key found.
1
- Both certificate and private key found.
2
- Certificate found, but private key not found.
-2
- Various errors, such as:
Nothing received from client.
Data received is not in correct format
.
Incorrect configuration.
(For example, CA profile is not configured).
Linux client is trying to access the agent.

Generated one-time password value to send to the end user. Example message:

One-Time Passcode: %{session.otp.assigned.val}

Internally used timestamp; OTP expiration in seconds since this date and time: (

00:00:00 UTC, January 1, 1970

)

OTP time-to-live; configurable as OTP timeout in seconds. Example message:

OTP expires after use or in %{session.otp.assigned.ttl} seconds

0 or 1.

0
- OTP authentication failed
1
- OTP authentication passed

0 or 1.

0
- RADIUS authentication failed
1
- RADIUS authentication passed

User attributes retrieved during RADIUS authentication. Each attribute is converted to a separate session variable.

Space-delimited list of names of assigned App tunnel resources.

Space-delimited list of names of assigned Network Access resources.

Space-delimited list of names of assigned Portal Access resources.

Space-delimited list of names of assigned remote desktop resources.

Space-delimited list of names of assigned SAML resources.

Name of the assigned webtop.

Stores the Internet Explorer version

List of installed SP and KB fixes for Internet Explorer. For example: "¦SP2¦KB12345¦KB54321¦"

Platform.

"Win7"
- Windows 7
"Win8"
- Windows 8
"WinVI"
- Windows
"WinXP"
- Windows XP
"Win2003"
- Windows 2003 Server
"WinLH"
- Windows 2008

List of installed SP and KB fixes for Windows. For example,

"¦SP2¦KB12345¦KB54321¦"

List of current Windows user names

List of computer names

0, 1, or -1.

0
- Failure
1
- Success
-1
- Invalid check expression

0, 1, or -1.

0
- Failure
1
- Success
-1
- Invalid check expression