Usage Data API

(Billing API)

Aptilo MAS 9.1

Document Revision: G

Aptilo Protocol Specification

 Copyright © 2011 Aptilo Networks

Table of contents

1 Usage data API .............................................................................................................. 4

1.1 Introduction.................................................................................................................................................... 4
2 Settings ........................................................................................................................... 5
2.1 FTP Accounts ................................................................................................................................................. 5
2.2 CSV-file size and creation timers ......................................................................................................... 5
2.3 Events in Aptilo CSV................................................................................................................................... 5
2.3.1 Usage related: .................................................................................................................................................................................... 5
2.3.2 Account related ................................................................................................................................................................................. 6
2.3.3 System related ................................................................................................................................................................................... 6
2.3.4 Not Used / Obsolete / Depreciated ....................................................................................................................................... 7

2.4 Events in Aptilo CSV-RAW....................................................................................................................... 7

2.4.1 Usage related: .................................................................................................................................................................................... 7

2.5 Other configurations items ..................................................................................................................... 8

3 CSV Format ..................................................................................................................... 8
3.1 CSV Templates .............................................................................................................................................. 8
3.2 CSV File Example ....................................................................................................................................... 11
3.3 CSV SESSION_ESTABLISHED – Parameter Values & Formats ................................................ 11
3.4 CSV SESSION_TERMINATED – Parameter Values & Formats ................................................ 12
4 CSV-RAW Format ........................................................................................................ 15
4.1 CSV-RAW Templates ................................................................................................................................ 15
4.2 CSV-RAW File Example ........................................................................................................................... 16
4.3 CSV-RAW SESSION-ESTABLISHED – Parameter Values & Formats .................................... 17
4.4 CSV-RAW SESSION-UPDATED – Parameter Values & Formats............................................ 18
4.5 CSV-RAW SESSION-TERMINATED – Parameter Values & Formats .................................... 19

Revision History:
- Rev A: 2010-06-23 Version updated for Aptilo release 9.1.
- Rev B: 2011-11-23 Updated to match MAS 9.1 SP7
- Rev C: 2011-11-29 Added CSV parameter descriptions
- Rev D: 2011-12-19 Added parameter examples and lengths
- Rev E: 2012-02-16 Added Termination-Cause 104, 105 and 106
- Rev F: 2012-03-05 Added scenario details to Termination-Cause 104, 105 and 106
- Rev G: 2012-05-07 Corrected denomination on Acct_Session_Time

Page 2 (20)
 Copyright © 2011 Aptilo Networks

All rights reserved

Confidentiality – Only applies if this document is marked as confidential in the header

THE RECIPIENT receives this document under the explicit condition that THE RECIPIENT will treat it confidentially and that
THE RECIPIENT, if he/she chooses not to comply with it, will not use its contents without the prior permission, in writing,
from Aptilo Networks. Moreover, THE RECIPIENT may not disclose the contents of this document in any form to third
parties without the prior permission, in writing, from Aptilo Networks. Aptilo Networks reserves all copyrights related to
this document. This document is subject to the General Conditions of Aptilo Networks.

Intellectual property rights

Aptilo Networks retains all intellectual property rights relating to this document and all materials used in conjunction with
the preparation of this document. THE RECIPIENT will only have the right to use the documentation and other materials if
a specific license to do so has been issued in writing. THE RECIPIENT will not be permitted to transfer documentation and
other materials to any third party, to permit inspection thereof by third parties or otherwise to make such materials
available to third parties.

Trademarks
Aptilo, the Aptilo logo and all other Aptilo names, products and services are trademarks of Aptilo Networks. All other
names, products and services are trademarks of their respective owners.

Page 3 (20)
 Copyright © 2011 Aptilo Networks

1 Usage data API

1.1 Introduction
This document describes the usage data format and how to retrieve the usage data from the
Aptilo Mobile Access Server (MAS) for e.g. billing purposes.

Billing generates usage data and billing data, this data is stored on the Aptilo MAS in a CSV
format. CSV (Comma Separated Values) is a text file where the data items are separated by the
character comma (‘,’).

Aptilo MAS 9.1 supports two different sets of CSV-formats:

 Aptilo CSV: This format supports session event types such as Session-Established, Session-
Terminated but also other events such as TRANSACTION-COMPLETE, ACCESS-DENIED
from the Aptilo Payment Server. This format is supported by the Aptilo Service Portal as
input format for usage reports.
 Aptilo CSV-RAW: This format supports RADIUS accounting based events only such as
SESSION-ESTABLISHED (Accounting-Start), SESSION-UPDATED (Accounting-Interim), and
SESSION-TERMINATED (Accounting-Stop). Some WiMAX specific radius attributes are also
included.

An IPDR (Internet Protocol Data Record), XML, format is also available for a limited number of
usage events. This format is depreciated and will not be supported in future releases and is not
recommended.

The event record files can be accessed by an external system using FTP. This external system can
e.g. be a billing system or an external storage server. The Aptilo MAS supports access from several
FTP servers. The FTP access can be controlled to allow certain accounts to fetch only certain
events. This can be used when more than one organization uses the same Aptilo MAS.

Each FTP access account can be configured to access events for certain organizations only. The
actual events can also be customized per FTP account. The below text describes the access end
event settings.

Page 4 (20)
 Copyright © 2011 Aptilo Networks

2 Settings
2.1 FTP Accounts
The basic access settings for the FTP account are as below. Please note that there can be several
FTP accounts on one Aptilo MAS. Each FTP-account stores billing events according to its own
settings.

 Name: Username of the FTP access account

 Password/Confirm Password: Password of the account
 Server ID: String that will show up in the billing records. Can be used for server
identification. Must not be left blank.

2.2 CSV-file size and creation timers

The Aptilo MAS generates complete files containing one or more usage data record(s). The default
setting is to generate a file every 40 seconds or when 20 records has been written. The number of
records stored in each file depends on the number of events during the 40 seconds.

2.3 Events in Aptilo CSV

Several events are available to be added to the billing files. The wanted events are selected in the
web-configuration. Select the events you want stored for this FTP-account. At least one event
needs to be selected.

The events are grouped in a few categories, please note that several of the events are not used,
are obsolete or will be removed in a future release. These events are not described in details.

Our recommendation is that events 1, 2, 5, 6, 7 are selected, especially as these are used by the
Aptilo SPA. The others are not used and the generation will only create extra load. Number 3&4
are created in large numbers.

2.3.1 Usage related:

1. Session established
The event corresponds to the Radius accounting start message, including information
available when a session starts.

Page 5 (20)
 Copyright © 2011 Aptilo Networks

2. Session terminated
The event correspond to the Radius accounting stop message, including information
available when a session has been terminated. Includes information such as session
duration and bytes sent.

3. PAS start page accessed

The event is sent when an end-user has accessed the start page.

4. PAS topup page accessed

The event is sent when an end-user has accessed the topup start page.

5. PAS transaction completed

The event is sent when the Aptilo PAS server has completed a transaction successfully.
This normally includes the creation/update of an account in the Aptilo MAS and the
completion of a payment towards an external system. Includes information of the product
and payment details.

6. PAS transaction failed

The event is sent when a transaction has failed. Includes the reason for the failure.

7. Access denied
The event is sent when an end-user authentication has failed. Includes the reason for the
failure.

2.3.2 Account related

8. User account created by CCS

The event is sent when an account has been created through the CCS API.

9. User purged
The event is sent when an account has been automatically deleted (purged).
This is only applicable for accounts that have a purge date & time set.

2.3.3 System related

10. AC auto-initialization completed

Page 6 (20)
 Copyright © 2011 Aptilo Networks

11. AC auto-initialization conflict

12. AC auto-initialization denied

2.3.4 Not Used / Obsolete / Depreciated

- Session purged
- Positioning request completed
- Positioning request failed
- Positioning subscription completed
- Positioning subscription failed
- Positioning unsubscription completed
- Zone information delivered
- User information delivered

2.4 Events in Aptilo CSV-RAW

Three types of session events are available to the CSV-RAW billing files. The wanted events are
selected in the web-configuration. Select the events you want stored for this FTP-account. At least
one event needs to be selected.

2.4.1 Usage related:

1. Session established
The event correspond to the Radius accounting start message, including information
available when a session starts.
2. Session updated
The event correspond to the Radius accounting interim message. Includes information
such as session duration and bytes sent/received.
3. Session terminated
The event correspond to the Radius accounting stop message, including information
available when a session has been terminated. Includes information such as session
duration and bytes sent/received.

Page 7 (20)
 Copyright © 2011 Aptilo Networks

2.5 Other configurations items

Select Organization, Zone and PAS-sites

This specifies which Organizations, Zones and PAS-sites shall be reported for this FTP-account
 Setting Organizations – Set “Enable all” to yes to capture events for all organizations.
 Setting Organizations – Set “Enable all” to no to capture events for selected organizations
only.
 Setting Zones – Set “enable all” to yes to capture events for all or zones.
 Setting Zones – Set “enable all” to no to capture events for selected zones only.
 Setting Aptilo PAS sites - Set “enable all” to yes to capture events for all or Aptilo PAS
sites.
 Setting Aptilo PAS sites - Set “enable all” to no to capture events for the listed Aptilo PAS
sites only.

3 CSV Format
3.1 CSV Templates
The content of the CSV files is controlled by templates. These templates are listed below for each
event type.

The following data types are used:

QSTR: Quoted string: The text is enclosed in double quotes, double quotes are duplicated.
ZSTR: Quoted string: The text is enclosed in double quotes, double quotes are duplicated. Empty
strings are not quoted.
Time: timestamp according to ISO8601
IP: represented as 32bit value converted into a signed integer), most significant octet first
(e.g. -1408229627)
IP-Addr: IP-address formatted as readable string (e.g. 172.16.10.10)

Any empty value will be left out but the separator character (comma) will remain. This means that
it can be expected and valid to find two or more commas after each other inside a CSV-event.

Page 8 (20)
 Copyright © 2011 Aptilo Networks

Each CSV event file uses this prelude template for "csv-all-attrs"

"Account:",{account.name:QSTR},{account.server-id:QSTR},{account.server-version:QSTR}

# Event type 202: SESSION_ESTABLISHED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.uname:ZSTR},{event
.realm_sid},{event.session_type},{event.NAS_IP_Address:ZSTR},{event.NAS_Ide
ntifier:ZSTR},{event.APC_ID:ZSTR},{event.NAS_Port_Id},{event.NAS_Port_Type}
,{event.Acct_Session_Id:ZSTR},{event.Service_Type:ZSTR},{event.Framed_Proto
col},{event.Acct_Delay_Time},{event.connection_ip},{event.Subnet_Name:ZSTR}
,{event.client_ip},{event.Called_Station_Id:ZSTR},{event.Calling_Station_Id
:ZSTR},"{event.start_t}",{event.Session_Timeout},{event.access_point},{even
t.useracct},{event.NAS_Acct_Session_Id:ZSTR}

# Event type 203: SESSION_TERMINATED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.uname:ZSTR},{event
.fname:ZSTR},{event.lname:ZSTR},{event.organization:ZSTR},{event.phone:ZSTR
},{event.email:ZSTR},{event.realm:ZSTR},{event.realm_sid},{event.NAS_IP_Add
ress:ZSTR},{event.NAS_Identifier:ZSTR},{event.APC_ID:ZSTR},{event.NAS_Port_
Id},{event.NAS_Port_Type},{event.Acct_Session_Id:ZSTR},{event.Service_Type:
ZSTR},{event.Framed_Protocol},{event.Acct_Output_Octets},{event.Acct_Input_
Octets},{event.Acct_Session_Time},{event.Acct_Terminate_Cause},{event.conne
ction_ip},{event.zone:ZSTR},{event.Subnet_Name:ZSTR},{event.client_ip},{eve
nt.Called_Station_Id:ZSTR},{event.Calling_Station_Id:ZSTR},{event.access_po
int},{event.useracct},{event.NAS_Acct_Session_Id:ZSTR}

# Event type 1210: STARTPAGE_ACCESSED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.sitename:ZSTR},{ev
ent.username:ZSTR},{event.sessionid:ZSTR},{event.location:ZSTR},{event.nasi
d:ZSTR}

# Event type 1211: TOPUP_ACCESSED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.sitename:ZSTR},{ev
ent.username:ZSTR},{event.sessionid:ZSTR},{event.location:ZSTR},{event.nasi
d:ZSTR}

# Event type 1201: TRANSACTION_COMPLETE

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.sitename:ZSTR},{ev
ent.username:ZSTR},{event.firstname:ZSTR},{event.lastname:ZSTR},{event.tran
sactionid:ZSTR},{event.localtransactionid:ZSTR},{event.remotetransactionid:
ZSTR},{event.amount:ZSTR},{event.sessionid:ZSTR},{event.extra:ZSTR},{event.
purchasedata:ZSTR},{event.paymentmethod:ZSTR},{event.location:ZSTR},{event.
freetext:ZSTR},{event.nasid:ZSTR}

Page 9 (20)
 Copyright © 2011 Aptilo Networks

# Event type 1202: TRANSACTION_FAILED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.sitename:ZSTR},{ev
ent.username:ZSTR},{event.firstname:ZSTR},{event.lastname:ZSTR},{event.tran
sactionid:ZSTR},{event.localtransactionid:ZSTR},{event.remotetransactionid:
ZSTR},{event.reason:ZSTR},{event.state:ZSTR},{event.amount:ZSTR},{event.ses
sionid:ZSTR},{event.extra:ZSTR},{event.purchasedata:ZSTR},{event.paymentmet
hod:ZSTR},{event.location:ZSTR},{event.nasid:ZSTR}

# Event type 201: ACCESS_DENIED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.uname:ZSTR},{event
.NAS_IP_Address:ZSTR},{event.NAS_Port_Id},{event.NAS_Port_Type},{event.NAS_
Identifier:ZSTR},{event.APC_ID:ZSTR},{event.Called_Station_Id:ZSTR},{event.
Calling_Station_Id:ZSTR},{event.Framed_Protocol},{event.connection_ip},{eve
nt.condition_code},{event.condition_message:ZSTR},{event.access_point},{eve
nt.Subnet_Name:ZSTR}

# Event type 901: ACCT_CREATED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.uid},{event.userna
me:ZSTR}

# Event type 302: USER_PURGED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.uid},{event.uname:
ZSTR},"{event.termbegin}","{event.termend}","{event.purge}",{event.organiza
tion:ZSTR},{event.productdescriptor:ZSTR},{event.remainder:ZSTR},{event.acc
ounttype:ZSTR},{event.accessprofile:ZSTR},{event.fname:ZSTR},{event.lname:Z
STR}

# Event type 1301: APCCONF_SUCCESS

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.nas_id:ZSTR},{even
t.ipaddr},{event.name:ZSTR}

# Event type 1303: APCCONF_CONFLICT

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.nas_id:ZSTR},{even
t.ipaddr}

# Event type 1302: APCONF_DENIED

#
"{event.timestamp}",{event.type},{event.tag:QSTR},{event.nas_id:ZSTR},{even
t.ipaddr}

Page 10 (20)
 Copyright © 2011 Aptilo Networks

3.2 CSV File Example

This example contains one SESSION_ESTABLISHED event followed by a SESSION_TERMINATED
event.

[aptilo@supmas1 ftp]$ less generic2/CSV_1323187441934.txt

"Account:","generic2","generic","9.1"

"2011-12-06T16:03:21Z",202,"SESSION_ESTABLISHED","mattiash",0,0,"172.16.31.5",
"SupAC1-NASID","SupAC1-ACID",0,19,"c477809990109692",,0,0,-1408229627,"NotSet",
-1062731289,"00:0A:E4:0B:C4:B7","044665739d01",
"2011-12-06T16:03:21Z",63157631,100000,53092047,"4ede3ccd52f25160”,

"2011-12-06T16:03:39Z",203,"SESSION_TERMINATED","mattiash",
"First","Last","Lab","1234567","nobody@aptilo.com","LOCAL",0,"172.16.31.5",
"SupAC1-NASID","SupAC1-ACID",0,19,"c477809990109692",,0,1921265,103673,
18000,1,-1408229627,"root:LAB:sub1","NotSet",-1062731289,
"00:0A:E4:0B:C4:B7","044665739d01",100000,53092047,"4ede3ccd52f25160",

3.3 CSV SESSION_ESTABLISHED – Parameter Values & Formats

Parameter Example value Type Max Comment
Length
Timestamp 2011-05-10T05:09:23Z Time 22 iso8601 time format
Type 202 Integer 10 Event type: 202=session
established
Tag SESSION_ESTABLISHED String 30 Fixed value to indicate
SESSION_ESTABLISHED
Uname mattiash String 254 Username
Realm_sid 4 Integer 10 Internal realm id
Session_type 2 Integer 10 Not used (fixed value)
NAS_IP_Address 172.16.31.5 IP-Addr 15 IP-address of radius client
NAS_Identifier SupAC1-NASID String 254 NAS-Identifier
APC_ID SupAC1-ACID String 254 AC-Identifier Configured in
AC
NAS_Port_Id 0 Integer 10 NAS-Port as received over
RADIUS
NAS_Port_Type 19 Integer 10 NAS-Port-Type as
received over RADIUS
Acct_Session_Id c477809990109692 String 254 Acct-Session-ID for the
started session.
Service_Type Integer 10 Not used with Aptilo AC
Framed_Protocol 0 Integer 10 Not used with Aptilo AC
Acct_Delay_Time 0 Integer 10 Acct-Delay-Time as
received over RADIUS
(seconds)
IP 11 MAS IP-address in TCP/IP
connection_ip -1408229628
format
Subnet_Name vlan81 String 254 Location as received as

Page 11 (20)
 Copyright © 2011 Aptilo Networks

Subnet-name over
RADIUS. Set in Aptilo AC
based on the following:
1. Location defined for the
AP in the AC
2. Location derived from
AP name using location
name function.
2. Location from subnet
4. Location from primary
subnet
5. hard coded: NotSet
client_ip Client IP-address in
1847400260 IP 11
TCP/IP string format
Called_Station_Id 3C:4A:92:78:24:08 String 254 RADIUS client mac-
address
Calling_Station_Id 044665739d01 String 254 User device mac-address
in “Aptilo format” (lower
case and no delimiters)
start_t 2011-05-10T05:09:23Z Time 22 Session start time iso8601
time format
Session_Timeout 86400 Integer 10 Session-Timeout as sent
in Access-Accept
(seconds)
access_point 100002 Integer 10 Internal Access Node id
useracct 53092047 String 254 Internal user account id
NAS_Acct_Session_Id 4dc8c79c503adc27 String 254 System wide unique
Session Id

3.4 CSV SESSION_TERMINATED – Parameter Values & Formats

Parameter Example value Type Max Comment
Length
Timestamp 2011-05-10T05:09:23Z Time 22 iso8601 time format
Type 203 Integer 10 Event type: 203=session
terminated
Tag SESSION_TERMINATED String 30 Fixed value to indicate
SESSION-TERMINATED
Uname mattiash String 254 Username
fname John String 32 First name as defined in user
account
lname Doe String 40 Last name as defined in user
account
organization myOrg String 50 Organization as defined in
user account
phone +46850890000 String 20 Phone number as defined in
user account
email john.doe@aptilo.com String 50 E-mail address as defined in
user account
realm wifiNet String 256 Realm name as configured
in MAS
Realm_sid 4 Integer 10 Internal realm id
NAS_IP_Address 172.16.31.5 IP-Addr 15 IP-address of radius client
NAS_Identifier SupAC1-NASID String 254 NAS-Identifier as received
over RADIUS.
APC_ID SupAC1-ACID String 254 AC-Identifier . Configured in
AC
NAS_Port Integer 10 NAS-Port as received over

Page 12 (20)
 Copyright © 2011 Aptilo Networks

RADIUS
NAS_Port_Type 19 Integer 10 NAS-Port-Type as received
over RADIUS
Acct_Session_Id c477809990109692 String 254 Acct-Session-ID for the
started session.
Service_Type Integer 10 Not used with Aptilo AC
Framed_Protocol 0 Integer 10 Not used with Aptilo AC
Acct_Output_Octets 1921265 Integer 20 Bytes sent from client to
Internet
Acct_Input_Octets 103673 Integer 20 Bytes sent from client to
Internet
Acct_Session_Time 2643 Integer 10 Active session length. Idle
timeout time not included.
(in milliseconds)
Acct_Terminate_Cause 4 Integer 10 Causes follows RFC
1: User-Request: Active
logout.
4: Idle-Timeout: When AC
detects that the session has
been idle too long.
5: Session-Timeout: When
AC detects that the session
has expired.
6: Admin-Reset: apc-cmd
logout will by default logout
with Admin-Reset or when a
session is terminated using
SNMP from the MAS.
10: NAS-Request: When
AC detects that the byte
limitations are reached.
11: NAS-reboot: When the
AC is rebooted all sessions
will be logged out with this
code.
13: Port-Preempted: This is
used when there is top-up a
session with a new
username. Then a new
session is started and the
old session is terminated
with this code. Or when
automatic MAC login detects
that the IP has a new MAC
address,
20: Reauthentication-
Failure: When a
reauthentication fails, the
session is terminated.
104: Idle-Timeout *:
Created by the MAS without
any Accounting-Stop from
GW when the MAS detects
that the session has been
idle too long.
105: Session-Timeout *:
Created by the MAS without
any Accounting-Stop from
GW when the MAS detects
that the session has expired.
106: Admin-Reset *:
Created by the MAS when a
session is terminated using
SNMP but no Accounting-

Page 13 (20)
 Copyright © 2011 Aptilo Networks

Stop arrives from Aptilo AC.

[* Acct-Terminate-Cause
above 100 may be
generated from a standby
SMP after a redundancy
takeover. In such case there
will be a corresponding
session CDR in the active
SMP with the same Acct-
Session-Id. In this case this
CDR with Acct-Terminate-
Cause above 100 can be
ignored.]

IP 11 MAS IP-address in TCP/IP

connection_ip -1408229628
format
Zone root:LAB:sub1 String 256 Zone name as defined in
MAS

Subnet_Name vlan81 String 254 Location as received as

Subnet-name over RADIUS.
Set in Aptilo AC based on
the following:
1. Location defined for the
AP in the AC
2. Location derived from AP
name using location name
function.
2. Location from subnet
4. Location from primary
subnet
5. hard coded: NotSet
client_ip Client IP-address in TCP/IP
1847400260 IP 11
string format
Called_Station_Id 3C:4A:92:78:24:08 String 254 RADIUS client mac-address
Calling_Station_Id 044665739d01 String 254 User device mac-address in
“Aptilo format” (lower case and
no delimiters)
access_point 100002 Integer 10 Internal Access Node id
useracct 53092047 String 254 Internal user acct id
NAS_Acct_Session_Id 4dc8c79c503adc27 String 254 System wide unique Session Id

Page 14 (20)
 Copyright © 2011 Aptilo Networks

4 CSV-RAW Format
4.1 CSV-RAW Templates

The content of the CSV-RAW files is controlled by templates. These templates are listed below for
each event type.
Any empty value will be left out but the separator character (comma) will remain. This means that
it can be expected and valid to find two or more commas after each other inside a CSV-event.

#
# Event type 202: SESSION_ESTABLISHED
#
{event.uname},
{event.radius.NAS-IP-Address},
{event.radius.Framed-IP-Address},
Start,
{event.unixtimestamp},
{event.Acct_Session_Id},
{event.realm},
{event.Calling_Station_Id},
,,,,,,,
{event.radius.NAS-Identifier},
{event.radius.Acct-Authentic},
{event.radius.Acct-Delay-Time},
{event.radius.NAS-Port-Type},
,
{event.radius.NAS-Port},
{event.NAS_Acct_Session_Id},
{event.realm},
{event.radiuslookup.WiMAX-Session-Continue},
{event.radius.WiMAX-BS-ID},
{event.radius.WiMAX-PDFID},
,
{event.timestamp:SIMPLETIME}

#
# Event type 205: SESSION_UPDATED
#
{event.uname},
{event.radius.NAS-IP-Address},
{event.radius.Framed-IP-Address},
Interim-Update,
{event.unixtimestamp},
{event.Acct_Session_Id},
{event.realm},
{event.Calling_Station_Id},
,
{event.radius.Acct-Input-Octets},
{event.radius.Acct-Output-Octets},
{event.radius.Acct-Input-Packets},
{event.radius.Acct-Output-Packets},

Page 15 (20)
 Copyright © 2011 Aptilo Networks

{event.radius.Acct-Input-Gigawords},
{event.radius.Acct-Output-Gigawords},
{event.radius.NAS-Identifier},
{event.radius.Acct-Authentic},
{event.radius.Acct-Delay-Time},
{event.radius.NAS-Port-Type},
{event.radius.Acct-Session-Time},
{event.radius.NAS-Port},
{event.NAS_Acct_Session_Id},
{event.realm},
{event.radiuslookup.WiMAX-Session-Continue},
{event.radius.WiMAX-BS-ID},
{event.radius.WiMAX-PDFID},
,
{event.timestamp:SIMPLETIME}

#
# Event type 203: SESSION_TERMINATED
#
{event.uname},
{event.radius.NAS-IP-Address},
{event.radius.Framed-IP-Address},
Stop,
{event.unixtimestamp},
{event.Acct_Session_Id},
{event.realm},
{event.Calling_Station_Id},
{event.radiuslookup.Acct-Terminate-Cause},
{event.radius.Acct-Input-Octets},
{event.radius.Acct-Output-Octets},
{event.radius.Acct-Input-Packets},
{event.radius.Acct-Output-Packets},
{event.radius.Acct-Input-Gigawords},
{event.radius.Acct-Output-Gigawords},
{event.radius.NAS-Identifier},
{event.radius.Acct-Authentic},
{event.radius.Acct-Delay-Time},
{event.radius.NAS-Port-Type},
{event.radius.Acct-Session-Time},
{event.radius.NAS-Port},
{event.NAS_Acct_Session_Id},
{event.realm},
{event.radiuslookup.WiMAX-Session-Continue},
{event.radius.WiMAX-BS-ID},
{event.radius.WiMAX-PDFID},
,
{event.timestamp:SIMPLETIME}

4.2 CSV-RAW File Example

This example contains one SESSION_ESTABLISHED (Start) event followed by a
SESSION_TERMINATED (Stop) event.

Page 16 (20)
 Copyright © 2011 Aptilo Networks

[aptilo@supmas1 ftp]$ less raw/RAW_1323187441935.txt

mattiash,172.16.31.5,192.168.1.231,Start,1323187401,c477809990109692,LOCAL,044665739d01,,,,,,,,
SupAC1-NASID,1,0,19,,,4ede3ccd52f25160,LOCAL,,,,,2011-12-06 16:03:21

mattiash,172.16.31.5,192.168.1.231,Stop,1323187419,c477809990109692,LOCAL,044665739d01,
User-Request,103673,1921265,1031,1375,,,SupAC1-NASID,1,0,19,18,,4ede3ccd52f25160,
LOCAL,,,,,2011-12-06 16:03:39

4.3 CSV-RAW SESSION-ESTABLISHED – Parameter Values & Formats

Parameter Example value Type Max Comment
Length
Uname mattiash String 254 Username
NAS-IP-Address 172.16.31.5 IP-Addr 15 IP-address of radius client
Framed-IP-Address 192.168.1.231 IP-Addr 15 IP-address of user device
Start Start String 15 Fixed value to indicate
SESSION-ESTABLISHED
unixtimestamp 1323187401 Integer 10 Unix time stamp is seconds
(Server time zone)
Acct_Session_Id c477809990109692 String 254 Acct-Session-ID for the
started session.
Realm LOCAL String 256 Realm name as configured
in MAS
Calling_Station_Id 044665739d01 String 254 User device mac-address in
“Aptilo format” (lower case
and no delimiters)
NAS-Identifier SupAC1-NASID String 254 NAS-Identifier
Acct-Authentic 1 Integer 10 Acct-Authentic as received
over RADIUS
Acct-Delay-Time 0 Integer 10 Acct-Delay-Time as
received over RADIUS
(seconds)
NAS-Port-Type 19 Integer 10 NAS-Port-Type as received
over RADIUS
NAS-Port Integer 10 NAS-Port as received over
RADIUS
NAS_Acct_Session_Id 4ede3ccd52f25160 String 254 System wide unique
Session Id
Realm LOCAL String 256 Realm name as configured
in MAS
WiMAX-Session-Continue 0 Integer 10 Indicates if this is an
ongoing session as received
over RADIUS
WiMAX-BS-ID NA1BS1 String 254 WiMAX-BS-ID as received
over RADIUS
WiMAX-PDFID 5 Integer 10 WiMAX-PDFID as received
over RADIUS
timestamp 2011-12-06 16:03:23 Time 22 Event timestamp
(Server time zone)

Page 17 (20)
 Copyright © 2011 Aptilo Networks

4.4 CSV-RAW SESSION-UPDATED – Parameter Values & Formats

Parameter Example value Type Max Comment
Length
Uname mattiash String 254 Username
NAS-IP-Address 172.16.31.5 IP-Addr 15 IP-address of radius client
Framed-IP-Address 192.168.1.231 IP-Addr 15 IP-address of user device
Update Update String 30 Fixed value to indicate
SESSION-UPDATED
Unixtimestamp 1323187401 Integer 10 Unix time stamp is seconds
(Server time zone)
Acct-Session-Id c477809990109692 String 254 Acct-Session-ID for the
started session.
Realm LOCAL String 256 Realm name as configured
in MAS
Calling_Station-Id 044665739d01 String 254 User device mac-address in
“Aptilo format” (lower case
and no delimiters)
Acct-Input-Octets 1921265 Integer 10 Bytes sent to client from
Internet
Acct-Output-Octets 103673 Integer 10 Bytes sent from client to
Internet
Acct-Input-Packets 1031 Integer 10 Control packets received
Acct-Output-Packets 1375 Integer 10 Control packets sent
Acct-Input-Gigaword 0 Integer 10 Overflow (wrap around) in
Acct-Input-Octets
Acct-Output-Gigaword 0 Integer 10 Overflow (wrap around) in
Acct-Output-Octets
RADIUS-NAS-Identifier SupAC1-NASID String 254 NAS-Identifier as received
over RADIUS.
Acct-Authentic 1 Integer 1 Acct-Authentic as received
over RADIUS
Acct-Delay-Time 0 Integer 10 Acct-Delay-Time as received
over RADIUS (seconds)
NAS-Port-Type 19 Integer 10 NAS-Port-Type as received
over RADIUS
Acct-Session-Time 2643 Integer 10 Active session length. Idle
timeout time not included.
(in milliseconds)
NAS-Port Integer 10 NAS-Port as received over
RADIUS
NAS_Acct_Session_Id 4ede3ccd52f25160 String 254 System wide unique Session
Id
Realm LOCAL String 256 Realm name as configured
in MAS
WiMAX-Session-Continue 0 Integer 10 Indicates if this is an ongoing
session as received over
RADIUS
WiMAX-BS-ID NA1BS1 String 254 WiMAX-BS-ID as received
over RADIUS
WiMAX-PDFID 5 Integer 10 WiMAX-PDFID as received
over RADIUS
timestamp 2011-12-06 16:03:23 Time 22 Event timestamp
(Server time zone)

Page 18 (20)
 Copyright © 2011 Aptilo Networks

4.5 CSV-RAW SESSION-TERMINATED – Parameter Values & Formats

Parameter Example value Type Max Comment
Length
Uname mattiash String 254 Username
NAS-IP-Address 172.16.31.5 IP-Addr 15 IP-address of radius client
Framed-IP-Address 192.168.1.231 IP-Addr 15 IP-address of user device
Stop Stop String 30 Fixed value to indicate
SESSION-TERMINATED
Unixtimestamp 1323187401 Integer 10 Unix time stamp is seconds
(Server time zone)
Acct-Session-Id c477809990109692 String 254 Acct-Session-ID for the
started session.
Realm LOCAL String 256 Realm name as configured
in MAS
Calling_Station-Id 044665739d01 String 254 User device mac-address in
“Aptilo format” (lower case
and no delimiters)
Acct-Terminate-Cause User-Request String 30 User-Request: Active
logout.
Idle-Timeout: When AC
detects that the session has
been idle too long.
Session-Timeout: When AC
detects that the session has
expired.
Admin-Reset: apc-cmd
logout will by default logout
with Admin-Reset or when a
session is terminated using
snmp from the MAS.
NAS-Request: When AC
detects that the byte
limitations are reached.
NAS-reboot: When the AC
is rebooted all sessions will
be logged out with this code.
Port-Preempted: This is
used when there is top-up a
session with a new
username. Then a new
session is started and the
old session is terminated
with this code or when
automatic MAC login detects
that the IP has a new MAC
address,
Reauthentication-Failure:
When a reauthentication
fails, the session is
terminated.
Acct-Input-Octets 1921265 Integer 10 Bytes sent to client from
Internet
Acct-Output-Octets 103673 Integer 10 Bytes sent from client to
Internet
Acct-Input-Packets 1031 Integer 10 Control packets received
Acct-Output-Packets 1375 Integer 10 Control packets sent
Acct-Input-Gigaword 0 Integer 10 Overflow (wrap around) in
Acct-Input-Octets
Acct-Output-Gigaword 0 Integer 10 Overflow (wrap around) in
Acct-Output-Octets
RADIUS-NAS-Identifier SupAC1-NASID String 254 NAS-Identifier as received

Page 19 (20)
 Copyright © 2011 Aptilo Networks

over RADIUS.
Acct-Authentic 1 Integer 1 Acct-Authentic as received
over RADIUS
Acct-Delay-Time 0 Integer 10 Acct-Delay-Time as received
over RADIUS (seconds)
NAS-Port-Type 19 Integer 10 NAS-Port-Type as received
over RADIUS
Acct-Session-Time 2643 Integer 10 Active session length. Idle
timeout time not included.
(in milliseconds)
NAS-Port Integer 10 NAS-Port as received over
RADIUS
NAS_Acct_Session_Id 4ede3ccd52f25160 String 254 System wide unique Session
Id
Realm LOCAL String 256 Realm name as configured
in MAS
WiMAX-Session-Continue 0 Integer 10 Indicates if this is an ongoing
session as received over
RADIUS
WiMAX-BS-ID NA1BS1 String 254 WiMAX-BS-ID as received
over RADIUS
WiMAX-PDFID 5 Integer 10 WiMAX-PDFID as received
over RADIUS
timestamp 2011-12-06 16:03:23 Time 22 Event timestamp
(Server time zone)

Page 20 (20)