Retrieve Device Connection API – Key Attributes

BytesUsed

The sum of InputBytes and OutputBytes

Determine total throughput for billing reconciliation.

Stop

Event

This is the timestamp for when the event was reported. 

Verify when an event occured

Start and Stop

Msisdn

The Mobile Station International Subscriber Directory Number

Verify the correct device is being queried

Start and Stop

Username

Name of device to be authenticated by the RADIUS server. Sent either in an Access-Request or Access-Accept packet.

Field is often used to populate Network Address Identifier. When used as NAI, uses the form user@domain to identify user and home network of device.

Verify the mobile IP NAI of a device.  NAI must map to the same ESN/MDN pair. May indicate fraudulent use when the mapping cannot be verified.

Start and Stop

FramedIpAddress

Mobile IP address assigned to device. Can be a static private or dynamic private address.

Verify that IP address belongs to a customer's pool range, particularly for Private Network customers.

Start and Stop

AccountCallingStationId

Phone number of device that initiated data session. Sent by NAS in an Access-Request packet. Uses ANI or similar technology.

Correlate a data session to a device’s unique MDN, to ensure that the device is using its own line subscription and not another device's.

Start and Stop

NasIpAddress

Equivalent to IP address of PDSN/FA in VZW data network that is requesting authentication for the device requesting a data session.

Address should be unique within scope of RADIUS server.

Determine that device was in an area of network coverage served by specific PDSN/FA. Device may experience sub-optimal data session performance when it is on a boundary between two PDSNs. When too many mobile IP re-registration requests are made because the point of attachment is not well-defined, thrashing may occur.

Start and Stop

NasPort

Physical port type of AAA server in VZW data network that authenticated device requesting data session. May be any of the following:

§  Async

§  Sync

§  ISDN

§  ISDN-V120

§  ISDN-V110

Ensure that the correct AAA port type was used to authenticate device.

Start and Stop

Account3Gpp2HomeAgentIpAddress

IPv4 address of Home Agent (Packet Serving Data Node).

Identify any issues with mobile IP authentication and authorization by establishing the chain of network servers involved in the process of setting up the requested data session.

Start and Stop

3GPP2-PCF-IP-Address

IPv4 address of serving Point Coordinatin Function (PCF) in serving Radio Access Network (RAN).

Identify any issues with mobile IP authentication and authorization by establishing the chain of network servers involved in the process of setting up the requested data session.

Start and Stop

3GPP2-BSID

Base Station Identifier servicing point of attachment for device. Format is: Concatenation of Station ID (SID) 4 octets + Network ID (NID) 4 octets + Cell Identifier Type 2 (4 octets). In the Cell Identifier, 12 upper bits are Cell ID; 4 lower bits are Sector. Each item is encoded using hexadecimal uppercase ASCII characters.

Locate a device, even down to its cell/sector, which is useful for:

§  Diagnosing problems by location, For example, when RF signal is not good due to fade.

§  Integrating or overlaying geographic information into M2M application.

§  Forming device groups for monitoring, diagnostics (DPS), and/or provisioning.

Start and Stop

Account3Gpp2CompulsoryTunnelIndicator

Compulsory tunnel that was established on behalf of advice for providing Private Network and/or ISP access during a single packet data connection.

Ensure that reverse tunneling is enforced (That is, there is no triangular routing for mobile IP). Normally, triangular routing is used for routing to public addresses from a device.

Start and Stop

NAS-Identifier

Identifier of Packet Data Serving Node/Foreign Agent (PDSN/FA) in VZW data network requesting authentication of device requesting data session.

Either NAS-IP-Address or NAS-Identifier MUST be present in Access-Request packet.

Verify connection to the correct Network Access Server (NAS).

Start and Stop

Account3Gpp2ReleaseIndicator

Reason for sending stop record.

Troubleshooting various issues.

Stop

Account3GPP2CorrelationId

Unique accounting ID, in ASCII format, created by serving PDSN (Packet Data Service Network) for each packet data session.

Correlate multiple accounting records for each associated R-P (Radio Network to PDSN) or P-P (PDSN to PDSN) connection.

Start and Stop

Account3Gpp2InboundMobileIpSigBytes

This is the total number of octets in registration requests and solicitations sent from the MS (Mobile Station) based on the specific account.

Troubleshooting registration and connectivity issues.

Start and Stop

3GPP2-Inbound-Mobile-IP-Sig-Octets

Total number of octets in registration requests and solicitations sent from the MS (Mobile Station).

Troubleshooting registration and connectivity issues.

Start and Stop

Integer value: 0=False; 1=True.

'True' means it is not the end of a session and an Accounting Stop is immediately followed by an Accounting Start record. 'False' means end of session.

Troubleshooting connectivity and throughput issues.

Stop

Account3Gpp2ActiveTime

The total active connection time on traffic channel in seconds.

Troubleshooting connectivity and throughput issues.

Stop

Timestamp (in number of seconds from Jan 1 1970 UTC) of last known user activity.

Verify when the last data packet was sent or received from device. Can be used to determine if session remained active too long after device went idle. Also can help troubleshoot session drop problems, for example, if device made too many back-to-back session requests or if last sent/rcvd packet time had the same time as previous session end time.These conditions mean that device had more data to exchange but session was dropped for some reason.

Stop

Account3Gpp2BeginSession

Integer value: 0=False; 1=True,

'True’ means new packet data session is established; 'False' means continuation of previous packet data session.

Verify session starts for troubleshooting various issues.

Stop

AccountStatusType

Indicates whether Accounting-Request marks beginning of user service (Start) or end (Stop).  Value field is four octets:

§  1= Start

§  2= Stop

§  3= Interim-Update

§  7= Accounting-On

§   8=Accounting-Off

§   9-14=Reserved for Tunnel Accounting

§  15=Reserved for Failure

Identify session Starts and Stops, which could be used as a trigger by an M2M application, for example.

Start and Stop

AccountSessionId

Unique Accounting ID. Start and Stop records for given session MUST have same Acct-Session-Id. Accounting-Request packet MUST have Acct-Session-Id. Access-Request packet MAY have Acct-Session-Id; if it does, NAS MUST use same Acct-Session-Id in Accounting-Request packets for the session.

Correlate Start and Stop records for diagnostics and debugging,

Start and Stop

AccountSessionTime

Number of seconds during which user received service. Can only be present in Accounting-Request records where Acct-Status-Type is set to Stop.

Useful for debugging as well as calculating billed usage

Stop

AccountInputPackets

Number of packets received from port over the course of service being provided to framed user. Can only be present in Accounting-Request records where Acct-Status-Type is set to Stop.

Debug issues related to packet overhead. If, for example, there are too many packets for too few octets, there is too much header overhead since IP packets are small. In this case, the customer needs to optimize packet size to minimize amount of header overhead and stay within limits of service plan budget.

Stop

AccountOutputPackets

Number of packets sent to port while delivering service to framed user. Can only be present in Accounting-Request records where Acct-Status-Type is set to Stop.

Debug issues related to packet overhead. If, for example, there are too many packets for too few octets, there is too much header overhead since IP packets are small. In this case, the customer needs to optimize packet size to minimize the amount of header overhead and stay within limits of service plan budget.

Stop

AccountTerminateCause

Indicator of how session was terminated. Can only be present in Accounting-Request records where Acct-Status-Type is set to Stop.

Possible causes include:

Admin-Reset – Port was reset by Administrator.

Host-Request – Session was terminated by Login-IP-Host. Can indicate normal termination or that remote host crashed or became unreachable.

Idle-Timeout – Idle time expired for user or port.

Lost-Carrier – Modem disconnected because user or modem hung up on other end (no problem), line was dropped, line took noise hit too extreme for modem recovery, etc.

Port-Error – PortMaster had to reset port. Most commonly done when device attached to port causes too many interrupts.

Session-Timeout – Session time expired for user.

User-Error – PortMaster ended session because it received PPP Configuration Request or ACK during established session. Caused by PPP implementation error in dial-in client.

User-Request – Dial-in PPP client requested session termination as expected.

Diagnose reason for data session termination. 

Stop

Event-Timestamp

Time reference as seconds since Jan 1, 1970 00:00 UTC.

Decide when to connect to device next, when to change a sensor configuration on device, and so forth.

Start and Stop

Account3Gpp2ForwardFchMuxOption

Forward FCH Multiplex option.

Determining Up or Down multiplexing direction for troubleshooting.

Stop

Account3Gpp2ReverseFchRc

The format and structure of the radio channel in the reverse Fundamental Channel. A set of reverse transmission formats that are characterized by data rates, modulation characterized, and spreading rates.

Troubleshooting transmission and signal strength issues.

Stop

Account3Gpp2ReverseFchMuxOption

Reverse FCH Multiplex option.

Determining Up or Down multiplexing direction for troubleshooting.

Stop

Account3Gpp2ServiceOption

Service option received from RAN that indicates type of service granted, voice, packet data etc.

Determine if EV-DO-capable device is falling back to 1xRTT data speeds, which causes slow data rates from device or intermittent connectivity issues).  Also may indicate problem with device radio modem hardware, software, or device needing PRL update.

Start and Stop

Account3Gpp2ForwardTrafficType

Forward direction traffic type; either Primary or Secondary. Usually Primary.

Determining traffic flow direction for troubleshooting.

Start and Stop

Account3Gpp2ReverseTrafficType

Reverse direction traffic type; either Primary or Secondary. Usually Primary.

Determining traffic flow direction for troubleshooting.

Start and Stop

Account3Gpp2FchFrameSize

Quality of RF (Radio Frequency) conditions experienced by device.

Evaluate quality of RF conditions.

Start and Stop

Account3Gpp2ForwardFchRc

Format and structure of radio channel in Forward Fundamental Channel.

Set of forward transmission formats that are characterized by data rates, modulation characteristics, and spreading rates.

Troubleshoot throughput problems.

Start and Stop

Account3Gpp2ReverseFchRc

Format and structure of radio channel in Reverse Fundamental Channel.

Set of reverse transmission formats that are characterized by data rates, modulation characteristics, and spreading rates.

Troubleshoot throughput problems.

Start and Stop

Account3Gpp2IpTechnology

IP technology to use for call: Simple IP or Mobile IP. On some roaming partner networks, only Simple IP may be available. 

Diagnose connectivity issues.

Start and Stop

Account3Gpp2BadPppFrameCount

Number of bad PPP frames.

Evaluate connectivity or throughput problems with Mobile IP by checking whether PPP frames are being sent or received correctly (e.g., bad CRC).

Stop

Total number of octets sent to MS via SDBs. Direct proxy for volume of SMS data sent to device.

Track SMS usage information.

Start and Stop

3Gpp2OriginatingSdbByteCount

The total number of octets sent from the MS (mobile Service) via Short Data Bursts.

Troubleshooting data drop and packet drop issues

Stop

Total number of octets sent by MS via SDBs. Direct proxy for volume of SMS data sent from device.

Track SMS usage information.

Start and Stop

Account3Gpp2TerminatingSdbByteCount

The total number of octets sent to the MS (Mobile Service) via Short Data Bursts.

Troubleshooting data drop and packet drop issues

Stop

Account3Gpp2TerminatingNumberSdbs

Total number of SDB transactions with MS. Direct proxy for number of SMS messages sent to mobile.

Troubleshoot device wakeups, PRL updates, and general SMS messaging to device.

Stop

Account3Gpp2CorrelationId

The Correlation ID is a unique accounting ID created by the Serving PDSN(Packet Data Serving Node) for each packet data session that allows multiple accounting events for each associated R-P (Radio network to PDSN)  connection or P-P (PDSN to PDSN) connection to be correlated.

Troubleshooting connection and data transfer issues

Start and Stop

Account3Gpp2OriginatingnumberSdbs

Total number of SDB transactions with MS. Direct proxy for number of SMS messages sent to mobile.

Diagnose general SMS messaging from device.

Start and Stop

InputBytes

Complete number of Bytes inbound calculated by adding the payload and signalling octets.

Verify total input during a session

Stop

Acct-Input-Octets

Number of octets received from port during provision of service. Can only be present in Accounting-Request records where Acct-Status-Type is set to Stop.

Verify number of bytes received during session.

Stop

OutputBytes

Complete number of Bytes outbound calculated by adding the payload and signalling octets.

Verify total output during a session

Stop

Acct-Output-Octets

Number of octets sent to port during delivery of service. Can only be present in Accounting-Request records where Acct-Status-Type is set to Stop.

Verify number of bytes sent during session.

Stop

Account3Gpp2OutboundMobileIpSigBytes

This is the total number of octets in registration replies and agent advertisements sent to the MS(Mobile station) prior to any compression and/or fragmentation. 

 Troubleshooting registration errors and dropped packets

Start and Stop