User's Manual

490 | Reference Dell Networking W-ClearPass Guest 6.4 | User Guide
The $format parameter is optional, and defaults to “relative” if not otherwise specified. This parameter may be
one of the following values:
l “relative” or “session_time”: Calculates the session timeout as for the Session-Timeout RADIUS attribute,
that is, the number of seconds before the session should end. If the session does not have a session
timeout, the value returned is 0.
l “time”: Calculates the session end time, as the UNIX time at which the session should end. If the session
does not have an expiration time, the value returned is 0.
l Other values: These are interpreted as a date format (see “NwaDateFormat”) and the session end time is
returned in this format. (Examples: “iso8601”, “longdate”, “recent”, ‘%Y-%m-%d %H:%M’, etc.). If the session
does not have an expiration time, the value returned is a blank string.
GetTime()
GetTime($criteria, $from_time, $to_time = null)
Calculate the sum of session times for accounting records in the database.
This is a multi-purpose function that has a very flexible query interface. For ease of use, consider using one of the
related functions. See "GetCallingStationTime()" on page 487, "GetIpAddressTime()" on page 489, or "GetUserTime()
" on page 491.
$criteria is the criteria on which to search for matching accounting records.
As well as the criteria specified, the time interval specified by $from_time and optionally $to_time is also
used to narrow the search.
If $to_time is not specified, $from_time is a “look back” time, that is, the time interval in seconds before the
current time.
If $to_time is specified, the interval considered is between $from_time and $to_time.
Returns the total session time for all matching accounting records in the time interval specified.
GetTraffic()
GetTraffic($criteria, $from_time, $to_time = null, $in_out = null)
Calculate the sum of traffic counters for accounting records in the database.
Revoking access for a device is only possible This is a multi-purpose function that has a very flexible query interface.
For ease of use, consider using one of the related functions "GetCallingStationTraffic()" on page 487,
"GetIpAddressTraffic()" on page 489, or "GetUserTraffic()" on page 491.
$criteria is the criteria on which to search for matching accounting records. The time interval specified by
$from_time and optionally $to_time is used with the criteria to narrow the search.
If $to_time is not specified, $from_time is a “look back” time, that is, the time interval in seconds before the
current time. If $to_time is specified, the interval considered is between $from_time and $to_time.
$in_out may be “in” to count only input octets, “out” to count only output octets, or any other value to count
both input and output octets towards the traffic total. This argument returns the computed total of traffic for
all matching accounting records.
GetUserActiveSessions()
GetUserActiveSessions($username, $callingstationid = null)