Set command

The APN rate control configuration and status changes are available also as +CGEV notifications.

APN rate control is active only when the context is active. An indication of context deactivation, such as +CGEV ME PDN DEACT <cid>, received by a client also indicates that the APN rate control configuration is removed for the context identified by <cid>. If the context is activated again, a new APN rate control configuration is indicated to the client if it is configured by the network.

The network can assign a separate APN rate control for exceptional data called additional APN rate control.

Syntax:

%APNRATECTRL=<mode>[,<cid>]

Response syntax for status query:

%APNRATECTRL: <mode>,<cid>,<status>,<remaining_time>,<exceptional_data_allowed>,<additional_rc_status>,
<additional_rc_remaining_time>

Response syntax for configuration query:

%APNRATECTRL: <mode>,<cid>,<rate>,<time_window>,<exceptional_data_allowed>,<additional_rc_rate>,
<additional_rc_time_window>

The set command parameters and their defined values are the following:

<mode>

0 – Request APN rate control status for a CID.

1 – Request APN rate control configurations.

<cid>

Integer, 0–10.

Mandatory in mode 0. Not used in mode 1.

<status>

0 – APN rate control is configured and currently not blocking uplink data.

1 – APN rate control is configured and currently blocking uplink data.

2 – APN rate control is not configured for this CID.

<remaining_time>

0–604 800 – Remaining uplink data blocking time in seconds when status is 1.

Can be 0 if less than a full second remains, but rate control blocks uplink data if <status> is 1.

<exceptional_data_allowed>

Indicates if exceptional data is allowed when APN rate control blocks the sending of data. Valid only if additional APN rate control is not configured (<additional_rc_status> is 2).

0 – Not allowed.

1 – Allowed.

<additional_rc_status>

0 – APN rate control is configured for exceptional data and currently not blocking exceptional uplink data.

1 – APN rate control is configured for exceptional data and currently blocking exceptional uplink data.

2 – APN rate control is not configured for exceptional data for this CID.

<additional_rc_remaining_time>

0–604 800 – Remaining exceptional uplink data blocking time in seconds when <additional_rc_status> is 1.

Can be 0 if less than a full second remains, but rate control blocks exceptional data if <additional_status> is 1. 0 when <additional_rc_status> is 0.

<rate>

0–16 777 215 – Configured data rate. Number of data packets that the User Equipment (UE) is allowed to send during the time period indicated in <time_window>.

Values 0,0 of <rate>,<time_window> mean that APN rate control is not configured.

<time_window>

60–604 800 – Time window in seconds (1 minute to 1 week).

<additional_rc_rate>

0–65535 – Additional configured exceptional data rate. Number of additional exceptional data packets that the UE is allowed to send when <rate> is exceeded during the time period indicated in <additional_rc_time_window>.

Values 0,0 of <additional_rc_rate>,<additional_rc_time_window> indicate that additional APN rate control is not configured.

If additional APN rate control is configured, it controls the sending of exceptional data, and the value of<exceptional_data_allowed> is 0.

<additional_rc_time_window>

60–604 800 – Additional time window in seconds (1 minute to 1 week).

The time window is used to calculate exceptional data packets configured at <additional_rc_rate>.

The following command example requests the status of CID 1. APN rate control is configured and blocking uplink data with one minute remaining. Additional APN rate control is not configured for CID 1:

AT%APNRATECTRL=0,1
%APNRATECTRL: 0,1,1,60,0,2,0
OK

The following command example requests the status of CID 1. APN rate control is configured and blocking uplink data with one minute remaining. Additional APN rate control is blocking with two minutes remaining:

AT%APNRATECTRL=0,1
%APNRATECTRL: 0,1,1,60,0,1,120
OK

The following command example requests the status of CID 1. APN rate control is configured and blocking uplink data with one minute remaining. Exceptional data is allowed:

AT%APNRATECTRL=0,1
%APNRATECTRL: 0,1,1,60,1,2,0
OK

The following command example requests the status of CID 1. APN rate control is configured and not blocking uplink data, but if <rate> is exceeded before <additional_remaining_time> is elapsed, also exceptional data is blocked immediately:

AT%APNRATECTRL=0,1
%APNRATECTRL: 0,1,0,0,0,1,180
OK

The following command example requests the status of CID 2. APN rate control is configured and not blocking uplink data. Additional APN rate control is not configured for CID 2:

AT%APNRATECTRL=0,2
%APNRATECTRL: 0,2,0,0,0,2,0
OK

The following command example requests the status of CID 2. APN rate control and additional APN rate control are not configured:

AT%APNRATECTRL=0,2
%APNRATECTRL: 0,2,2,0,0,2,0
OK

The following command example requests APN rate control configurations. APN rate control is configured for CID 1 and 2. Additional APN rate control is not configured:

AT%APNRATECTRL=1
%APNRATECTRL: 1,1,10,180,0,0,0
%APNRATECTRL: 1,2,100,60,0,0,0
OK

The following command example requests APN rate control configurations. APN rate control is configured for CID 1 and 2. Exceptional data is allowed for CID1. Additional configuration for CID2:

AT%APNRATECTRL=1
%APNRATECTRL: 1,1,10,180,1,0,0
%APNRATECTRL: 1,2,100,60,0,400,120
OK

The following command example requests APN rate control configurations. No configurations are active:

AT%APNRATECTRL=1
%APNRATECTRL: 1,0,0,0,0,0,0
OK