Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/part export/sqlradius"

From Freeside
Jump to: navigation, search
(import from POD)
 
m (Edit via perl MediaWiki framework (1.13))
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
; usage_sessions TIMESTAMP_START TIMESTAMP_END [ SVC_ACCT [ IP [ PREFIX [ SQL_SELECT ] ] ] ]
+
; usage_sessions HASHREF; usage_sessions TIMESTAMP_START TIMESTAMP_END [ SVC_ACCT [ IP [ PREFIX [ SQL_SELECT ] ] ] ]
−
:TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see [[Freeside:1.9:Documentation:Developer/perlfunc#time|"time" in perlfunc|perlfunc#time|"time" in perlfunc]]. Also see [[Freeside:1.9:Documentation:Developer/Time/Local|Time::Local]] and [[Freeside:1.9:Documentation:Developer/Date/Parse|Date::Parse]] for conversion functions.
+
:New-style: pass a hashref with the following keys:
 +
:; stoptime_start - Lower bound for AcctStopTime, as a UNIX timestamp:; stoptime_end - Upper bound for AcctStopTime, as a UNIX timestamp:; open_sessions - Only show records with no AcctStopTime (typically used without stoptime_* options and with starttime_* options instead):; starttime_start - Lower bound for AcctStartTime, as a UNIX timestamp:; starttime_end - Upper bound for AcctStartTime, as a UNIX timestamp:; svc_acct:; ip:; prefix
 +
:Old-style:
 +
 
 +
:TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see [[perlfunc#time|"time" in perlfunc]]. Also see [[Freeside:1.9:Documentation:Developer/Time/Local|Time::Local]] and [[Freeside:1.9:Documentation:Developer/Date/Parse|Date::Parse]] for conversion functions.
  
 
:SVC_ACCT, if specified, limits the results to the specified account.
 
:SVC_ACCT, if specified, limits the results to the specified account.
Line 15: Line 19:
 
Hey! '''The above document had some coding errors, which are explained below:'''
 
Hey! '''The above document had some coding errors, which are explained below:'''
  
−
; Around line 506:
+
; Around line 508:
 
:'=item' outside of any '=over'
 
:'=item' outside of any '=over'

Latest revision as of 18:17, 6 February 2009

usage_sessions HASHREF; usage_sessions TIMESTAMP_START TIMESTAMP_END [ SVC_ACCT [ IP [ PREFIX [ SQL_SELECT ] ] ] ]
New-style: pass a hashref with the following keys:
stoptime_start - Lower bound for AcctStopTime, as a UNIX timestamp
; stoptime_end - Upper bound for AcctStopTime, as a UNIX timestamp:; open_sessions - Only show records with no AcctStopTime (typically used without stoptime_* options and with starttime_* options instead):; starttime_start - Lower bound for AcctStartTime, as a UNIX timestamp:; starttime_end - Upper bound for AcctStartTime, as a UNIX timestamp:; svc_acct:; ip:; prefix
Old-style:
TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see "time" in perlfunc. Also see Time::Local and Date::Parse for conversion functions.
SVC_ACCT, if specified, limits the results to the specified account.
IP, if specified, limits the results to the specified IP address.
PREFIX, if specified, limits the results to records with a matching Called-Station-ID.
  1. SQL_SELECT defaults to * if unspecified. It can be useful to set it to #SUM(acctsessiontime) or SUM(AcctInputOctets), etc.
Returns an arrayref of hashrefs with the following fields:
username
; framedipaddress:; acctstarttime:; acctstoptime:; acctsessiontime:; acctinputoctets:; acctoutputoctets:; calledstationid; update_svc_acct

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 508:
'=item' outside of any '=over'
Retrieved from "http://420.am/mediawiki/index.php?title=Freeside:1.9:Documentation:Developer/FS/part_export/sqlradius&oldid=4488"