APN Profile Configuration
Mode
The APN Profile configuration
mode defines a set of parameters controlling the SGSN or MME behavior
when a specific APN is received or no APN is received in a Request.
An APN profile is a key element in the Operator Policy feature and
an APN profile is not used or valid unless it is associated with
an APN and this association is specified in an operator policy (see
the Operator Policy Configuration
Mode Commands chapter elsewhere in this guide).
Essentially, an APN profile
is a template that consists of a set of APN-specific commands that
may be applicable to one or more APNs. When a subscriber requests
an APN that has been identified in a selected operator policy, the
set of commands in the associated APN profile will be applied. The
same APN profile can be associated with multiple APNs and multiple
operator policies.
The SGSN and the MME
each support a total of 1,000 APN profile configurations per SGSN/MME; up
to 50 APN profiles can be associated with a single operator policy.
For additional SGSN limit information, refer to the Engineering Rules appendix
in the SGSN Administration Guide.
When this mode is accessed,
the command prompt should resemble:
[local]asr5000(apn-profile-<profile_name>)#
IMPORTANT:
The commands or keywords/variables
that are available are dependent on platform type, product version,
and installed license(s).
address-resolution-mode
Identifies the address
resolution mode for this APN profile. This command is specific to
the SGSN.
Privilege:
Security Administrator,
Administrator
Syntax
address-resolution-mode { fallback-for-dns | local }
default address-resolution-mode
default
Resets the configuration
to the default value; i.e. fallback-for-dns.
fallback-for-dns
Instructs the system
to try DNS resolution. If the DNS query fails, the SGSN will use
locally configured addresses, if they have been configured.
Default: enabled
local
Instructs the system
to only use locally configured addresses and not to use DNS query.
Default: disabled
Usage:
Use this command to
specify the DNS query or local address resolution for this APN profile.
Example:
The following command
sets the address resolution mode to use local addresses
only if the DNS query
fails:
address-resolution-mode
fallback-for-dns
apn-resolve-dns-query
Command enables the
SGSN to send Straightforward Name Authority Pointer (SNAPTR) type
DNS query for APN resolution on a per APN basis.
Privilege:
Security Administrator,
Administrator
Syntax
apn-resolve-dns-query
snaptr
remove apn-resolve-dns-query
snaptr
remove
Removes the DNS SNAPTR
function from the configuration.
Usage:
SNAPTR filters based
on the EPC-capability of the user equipment (UE). Use this command
to enable SNAPTR type DNS query for APN resolution for 3G subscribers
with EPC subscription. Configuration in this mode promotes control
of this feature per APN.
When this functionality
is enabled, an SGSN using Gn/Gp interfaces can optionally
select a PGW while activating a context if the subscriber is EPS
capable. This supports EPS-based mobility if the subscriber is anchored
at the PGW. At PDP Context Activation, the SGSN will use the UE
capability as input to select the GGSN or PGW. SNAPTR DNS query
allows for PGW resolution.
By default, this functionality
is not enabled.
Example:
Enable the SGSN to
select a PGW during APN resolution:
apn-resolve-dns-query snaptr
cc
Configures the charging
characteristics (CC) for this APN profile.
Privilege:
Security Administrator,
Administrator
Syntax
cc { local-value-for-scdrs
behavior bit_value profile index_bit | prefer { hlr-value-for-scdrs | local-value-for-scdrs } }
remove cc { local-value-for-scdrs | prefer }
remove
Removes the charging
characteristics configuration from this APN profile.
local-value-for-scdrs
behavior bit_value profile index_bit
Sets the value of the
behavior bits and profile index for the charging characteristics
for S-CDRs locally, when the Home Location Register (HLR) does not
provide these values.
If the HLR provides
the charging characteristics with behavior bits and profile index,
and the operator wants to ignore what the HLR provides, then specify
the prefer local-value-for-scdrs keyword
with this command.
bit_value: must
be a hexadecimal value between 0x0 and 0xFFF.
index_bit: must
be an integer from 1 through 15.
Some of the index values
are predefined according to 3GPP standard:
-
1 for hot billing
-
2 for flat billing
-
4 for prepaid
billing
-
8 for normal billing
Defaults: bit_value = 0x0; index_bit = 8
prefer { hlr-value-for-scdrs | local-value-for-scdrs }
Specify what charging
characteristic settings the system will use for S-CDRs.
- hlr-value-for-scdrs:
instructs the system to use charging characteristic settings received
from the HLR for S-CDRs.
- local-value-for-scdrs:
instructs the profile preference to only use locally configured/stored
charging characteristic settings for S-CDRs.
Default: hlr-value-for-scdrs
Usage:
Use this command to
specify the charging characteristic for S-CDRs -- either from the HLR
or locally from the SGSN.
These charging characteristics
parameters for S-CDRs and M-CDRs are also configurable in the Call-Control
Profile configuration mode. When CC parameters are specified in
both types of profiles, then:
- For generation of M-CDRs,
the parameters configured in the Call-Control Profile configuration
mode will take precedence.
- For generation of S-CDRs,
the parameters configured in the APN Profile configuration mode
will take precedence.
Example:
The following command
configures the APN profile to instruct the SGSN not to use charging
characteristic settings received from the HLR for S-CDR generation:
cc prefer hlr-value-for-scdrs
description
Defines a descriptive
string relevant to the specific APN profile.
Privilege:
Security Administrator,
Administrator
Syntax
description description
remove description
remove
Removes the configured
description from this APN profile.
description
Specifies a description
for this APN profile as an alphanumeric string of 1 through 100 characters.
The string may include spaces, punctuation, and case-sensitive letters
if the string is enclosed in double quotation marks (“).
Usage:
Define information
that identifies this particularly APN profile.
Example:
Indicate that APN
profile
apnprof1 is
to be used for customers in Saudi Arabia and that the profile was
created on April 10th of 2010:
description “apnprof1
defines APNs for customers in Saudi Arabia (4/10/10).”
direct-tunnel
Defines the permission
for direct tunnel establishment by GGSNs. This command is specific
to the SGSN.
Privilege:
Security Administrator,
Administrator
Syntax
direct-tunnel not-permitted-by-ggsn
remove direct-tunnel
remove
Removes the direct
tunnel establishment configuration from this APN profile.
not-permitted-by-ggsn
Specifies that a direct
tunnel is not permitted by the GGSN when resolved by this APN.
Default: disabled.
Usage:
Use this command to
enable/disable the permission for establishment of direct
tunnels between an RNC and a GGSN.
Example:
The following command
instructs the SGSN not to permit establishment of a direct tunnel with
a GGSN:
direct-tunnel not-permitted-by-ggsn
dns-extn
Takes an offset group
of digits from the MSISDN and appends the digits to the DNS query
string to create a new APN intended to assist roaming subscribers
to use the local GGSN.
Privilege:
Security Administrator,
Administrator
Syntax
dns-extn { charg-id { binary | decimal | hexadecimal } | lac-rac | msisdn
start-offset start_digits end-offset end-digits | rnc-id [ charg-id { binary | decimal | hexadecimal } ] }
remove dns-extn { charg-id | lac-rac | msisdn | rnc-id [ charg-id ] }
charg-id { binary | decimal | hexadecimal }
Instructs the SGSN
to take the profile index value of the charging characteristics,
from the PDP subscription record (selected during APN selection)
and include the profile index value in the APN name prior to sending
out DNS queries. The operator can also specify the format (binary, decimal
or hexadecimal) for the CC information to be included.
lac-rac
Enables the SGSN to
append geographical information to the APN string that is being
sent in the DNS query. This information is used during the DNS query
process to select the geographically closest GGSN.
msisdn start-offset start_digits end-offset end-digits
Defines an offset group
of digits from the MSISDN and appends the digits to create a new APN
DNS query string that is intended to assist roaming subscribers
to use the local GGSN.
- start_digits is
an integer from 1 through 14 that identifies the position of the
first digit in the MSISDN to start the offset.
- end-digits is
an integer from 2 through 15 that identifies the position of the
last digit in the MSISDN to be part of the offset.
rnc-id [ charg-id { binary | decimal | hexadecimal } ]
Instructs the SGSN
to include the ID of the calling RNC in the APN DNS query string. Optionally,
the profile index value of the charging characteristics can be inserted
into the APN name prior to sending out DNS queries. As well, the
operator can specify the format (binary, decimal or hexadecimal)
for the CC information to be included.
Usage:
With this command, the
APN in the DNS query string, used for querying the GGSN address,
can be appended with additional information, such as
- digits from the MSISDN
- LAC/RAC info
- RNC-ID
- profile index from the
charging characteristics information (SCHAR)
This
additional information allows some customization of the DNS query
string to facilitate selecting a specific (usually local or nearest)
GGSN.
For example, roaming
subscribers using a specific APN may want to be directed to a specific
GGSN. This can be achieved by having an operator policy for roaming
subscribers associated with an APN profile that includes a configuration
specifying certain digits, from the MSISDN or geographical information
from the LAC/RAC, be appended to the APN. This is then
used as the DNS query string.
In addition, the operator
must configure appropriate DNS entries to enforce the selection of
the required GGSN. After appending the MSISDN digits to the DNS
query string, the string will have the form: ni.<digits>.mnc*.mcc*.gprs
.
After appending the LAC/RAC information to the DNS query
string, the string will have the form: <apn_network_id>.racAAAA.lacBBBB.<apn_operator_id>
,
where the AAAA and BBBB are Hex-coded digits (less than 4 significant
digits and one or more zero (“0”) digits will
be inserted to the left side of the Hex to fill the 4-digit coding).
After appending the charging
characteristic (SCHAR) information, the DNS string will take the
following form: <apn_network_id>.<profile_index>.<apn_operator_id>.
The
profile index in the following example has an integer value 10: quicknet.com.uk.1010.mnc234.mcc027.gprs
.
If the RNC-ID information
is configured to be a part of the APN name, and if inclusion of the
profile index of the charging characteristics information is also
enabled before the DNS query is sent, the profile index is included
after the included RNC-ID and the DNS APN name will appear in the
following form: <apn_network_id>.<rnc_id>.<profile_index>.<apn_operator_id>
.
Once the DNS extension
is defined, the selected extension is applicable when either the wildcard
APN feature or the default APN feature are configured and used.
The information is appended
to the DNS query and the actual APN string sent to the GGSN will
not be modified in any way.
Example:
A sample MSISDN is ‘112233445566778’ and
a sample APN NI (network identifier) is ‘wap98.testnetz.ca’.
The following command instructs the SGSN to create a new APN with
digits pulled from the MSISDN and appended to the APN:
msisdn start-offset
3 end-offset 9
The resulting APN DNS
query string would have appended 7 digits (2233445)to the APN NI
so that it would appear something like wap98.testnetz.ca.2233445.MNC009.MCC262.GPRS
Enable inclusion of geographical
information in the APN string used for the DNS query to locate the
closest GGSN:
lac-rac
In the following example,
the DNS query for a subscriber using RNC 0321 with the profile index
of value 8 would appear as: quicknet.com.uk.0321.1000.mnc234.mcc027.gprs
end
Exits the current
configuration mode and returns to the Exec mode.
Privilege:
Security Administrator,
Administrator
Usage:
Use this command to
return to the Exec mode.
exit
Exits the current
mode and returns to the parent configuration mode.
Privilege:
Security Administrator,
Administrator
Usage:
Use this command to
return to the parent configuration mode.
gateway-address
Configures the IPv4
or IPv6 address of the GGSN supporting the APN associated with this
APN profile. Also, use this command to create a secondary pool of
GGSNs. This command is specific to the SGSN.
Privilege:
Security Administrator,
Administrator
Syntax
gateway-address ip_address { priority priority | weight weight [ secondary-pool ] }
no gateway-address ip_address
no
Disables the GGSN address
configured in this APN profile.
ip_address
Specifies the IP address
for the GGSN in IPv4 dotted-decimal or IPv6 colon-separated notation.
priority priority
Specifies the priority,
for the configured GGSN address, to be considered during address selection.
If the highest priority GGSN fails to respond, the next priority
level GGSN is selected. priority is
an integer from 1 through 100. Note that the lower integer has the
higher priority, so that 1 is the highest priority.
weight weight [ secondary-pool ]
Specifies the weight
(preference) assigned to a GGSN to facilitate load balancing. weight is
an integer from 1 to 100 where 1 is the least preferred and 100
is the most preferred.
If a weight is assigned
to an address, then load balancing (of primary CPC requests) depends on
the weight value. For example:
GGSN1 172.16.130.1
weight 30 and GGSN2 172.16.130.3 weight 70
With this configuration,
30% of the activation requests for this APN will go to
GGSN1 and 70% of the requests will go to GGSN2. Also note
that the sum of the weights does not need to be 100. The calculation
of weight percentiles is carried out proportionately, so the following configuration
will also yield the same 30% - 70% results:
GGSN1 172.16.130.1
weight 6 and GGSN2 172.16.130.3 weight 14
secondary-pool
This optional keyword
allows the operator to enable multiple GGSN pools by assigning the GGSN
to a secondary pool of GGSNs. The selection algorithm for GGSNs
in a secondary pool is weight-based.
Usage:
Use this command to
define priority or load balancing to be applied during GGSN selection.
A maximum of 16 GGSN address can be configured for this APN profile.
Also use this command
to setup GGSN pools - primary and secondary pools with up to 16 GGSNs
in each pool. By default, GGSNs will always be selected from the
primary pool. However, working in tandem with the ggsn-fail-retry-timer command
configuration (SGTP service configuration mode) which enables the
local DNS feature, some of the primary GGSNs can be temporarily
blacklisted if they become unavailable or overburdened.
Example:
Set a GGSN address
with a secondary priority level:
gateway-address 123.123.123.2
priority 2
Add a GGSN to the secondary
GGSN pool and define selection weighting of 7th:
gateway-address 198.168.138.8
weight 7 secondary-pool
gtp
Enables or disables
the GTPC private extension for the Overcharging Protection feature.
This command is specific to the SGSN.
Privilege:
Security Administrator,
Administrator
Syntax
[ remove ] gtp
private-extension loss-of-radio-coverage send-to-ggsn [ send-to-peer-sgsn ]
remove
Disables the inclusion
of the GTPC private extension, thereby disabling the Overcharging Protection
feature.
private-extension
loss-of-radio-coverage send-to-ggsn
Instructs the SGSN
to set a proprietary GTPC private extension (in the LORC Intimation IEs)
in the event of loss of radio coverage (LORC). These private extensions
are only understood by a GGSN with an Overcharging Protection license.
The mandatory loss-of-radio-coverage
send-to-ggsn keyword set instructs the SGSN to forward
the private extension flag to the GGSN in the event of a loss of
radio coverage (LORC).
send-to-peer-sgsn
This optional keyword
instructs the SGSN to also forward
the LORC private extension to the peer SGSN.
Usage:
gtp private-extension is
one of the two commands required to enable the Overcharging Protection
feature. The second command sets the RANAP cause code in the Iu
Release to enable the SGSN to detect the LORC state of the MS/UE.
This second command is configured in the IuPS service and is explained
in the IuPS Service Configuration
Mode chapter.
When there is a loss
of coverage and the Overcharging Protection feature is enabled with the
gtp private-extension command,
the SGSN includes the proprietary private extension in the GTP LORC
Intimation IE messages. This LORC IE is also included in UPCQ, DPCQ,
and SGSN Context Response GTP messages.
Refer to the SGSN Administration
Guide for additional information regarding the Overcharging
Protection feature.
Example:
Use the following
command to have the SGSN send the GGSN the GTPC private extension in
the LORC Intimation IE:
gtp private-extension
loss-of-radio-coverage send-to-ggsn
idle-mode-acl
Configures a
group of access control lists (ACLs) that define rules to apply
to downlink data destined for UEs in an idle mode.
Syntax
[ remove ] idle-mode-acl { ipv4 | ipv6 } access-group acl_name
remove
Removes the specified
ACL name from the access group.
{ ipv4 | ipv6 } access-group acl_name
Specifies the ACL
type to add to the access group.
- ipv4: Specifies
that an IPv4 ACL is being added to the access group.
- ipv6: Specifies
that an IPv6 ACL is being added to the access group.
access-group acl_name specifies
the name of the ACL being added to the access group as an existing
IPv4 or IPv6 ACL name expressed as an alphanumeric string of 1 through
47characters.
Usage:
Use this command to
create a group of ACLs that contain rules to apply to data sent
to UEs that are currently in idle mode.
IPv4 ACLs are configured
through the Context Configuration Mode using the ip access-list command.
IPv6 ACLs are configured
through the Context Configuration Mode using the ipv6 access-list command.
Example:
The following command
configures the APN profile to use an IPv4 ACL named
acl-3-permit to
apply rules to downlink data sent to UEs that are currently in idle
mode:
idle-mode-acl ipv4
access-group acl-3-permit
ip
Defines the IP parameters
for this APN profile.
Syntax
ip { qos-dscp { { downlink | uplink } { background forwarding | conversational forwarding | interactive
traffic-handling-priority priority forwarding | streaming forwarding } + } | source-violation { deactivate [ all-pdp | exclude-from
accounting | linked-pdp | tolerance-limit } | discard
[ exclude-from-accounting ] | ignore }
default ip { qos-dscp [ downlink | uplink ] |
source-violation }
no ip qos-dscp { downlink | uplink } { background | conversational | interactive | streaming } +
IMPORTANT:
All parameters not
specifically configured will be included in the configuration with
default values.
default
Resets the configuration
to the default values.
no
Disables the specified
IP QoS-DSCP mapping.
qos-dscp
Configures the Differentiated
Services Code Point (DCSP) marking to be used for sending packets
of a particular 3GPP QoS class.
downlink | uplink
Configures the packets
for either downlink (network to subscriber) or uplink (subscriber
to network) direction. downlink and uplink configuration
must include one or more of the following:
- background -
Configures the DSCP marking to be used for packets of sessions subscribed
to 3GPP background class. Must be followed by a DSCP marking
- conversational -
Configures the DSCP marking to be used for packets of sessions subscribed
to 3GPP conversational class. Must be followed by a DSCP marking
- interactive -
Configures the DSCP marking to be used for packets of sessions subscribed
to different traffic priorities in the 3GPP interactive class. Must
be followed by a traffic handling priority (THP): 1, 2, or 3.
- streaming -
Configures the DSCP marking to be used for packets of sessions subscribed
to 3GPP streaming class. Must be followed by a DSCP marking
DSCP marking options
Downlink and uplink
must include a DSCP forwarding marking; supported options include:
- af11 - Designates use
of Assured Forwarding 11 PHB
- af12 - Designates use
of Assured Forwarding 12 PHB
- af13 - Designates use
of Assured Forwarding 13 PHB
- af21 - Designates use
of Assured Forwarding 21 PHB
- af22 - Designates use
of Assured Forwarding 22 PHB
- af23 - Designates use
of Assured Forwarding 23 PHB
- af31 - Designates use
of Assured Forwarding 31 PHB
- af32 - Designates use
of Assured Forwarding 32 PHB
- af33 - Designates use
of Assured Forwarding 33 PHB
- af41 - Designates use
of Assured Forwarding 41 PHB
- af42 - Designates use
of Assured Forwarding 42 PHB
- af43 - Designates use
of Assured Forwarding 43 PHB
- be - Designates use
of Best Effort forwarding PHB
- ef - Designates use
of Expedited Forwarding PHB
Forwarding defaults
for both uplink and downlink are:
- conversational - ef;
- streaming - af11;
- interactive 1 - ef;
- interactive 2 - af21;
- interactive 3 - af21;
- background - be
source-violation
Configures settings
related to IP source-violation detection with one of the following criteria:
-
deactivate -
deactivate the PDP context with one of the following conditions:
- all-pdp -
deactivates all PDP context of the MS/UE. Default is to
deactivate errant PDP contexts.
- exclude-from-accounting -
excludes packets having an invalid source IP address from the statistics
used in the accounting records.
- linked-pdp -
deactivate all associated pdp contexts (primary and secondary).
Default is to deactivate errant pdp context.
- tolerance-limit -
Configures maximum number of allowed IP source violations before
the session is deactivated.
- discard -
discard errant packets, can include the following option:
- exclude-from-accounting -
excludes packets having an invalid source IP address from the statistics
used in the accounting records.
- ignore -
ignore checking of packets for MS/UE IP source violation.
Usage:
This command configures
a range of IP functions to be associated with the APN profile; such
as:
- SGSN/S-GW
action in response to detected IP source violations,
- DSCP marking for downlink
and uplink configuration per traffic class,
- QoS class diffserv
code.
Example:
The following command
configures the APN profile to instruct the SGSN or S-GW not to check
incoming packets for IP source violation information:
ip source-violation ignore
pdp-data-inactivity
Configures the APN
profile regarding PDP data inactivity. This command is specific
to the SGSN.
Privilege:
Security Administrator,
Administrator
Syntax
pdp-data-inactivity { action { deactivate [ all-pdp | linked-pdp ] | detach-when { all-pdp-inactive | any-pdp-inactive } } | timeout
minutes minutes }
default pdp-data-inactivity { action | timeout }
no pdp-data-inactivity timeout
default
Resets the APN Profile
configuration to the default values for PDP data-inactivity.
no
Disables the timeout
feature of the PDP data-inactivity configuration for this APN profile.
action
Defines the action
to be taken if PDP data-inactivity occurs:
- deactivate -
defines which PDP context should be deactivated:
- all-pdp -
deactivates all PDP contexts.
- linked-pdp -
deactivates only linked PDP contexts.
- detach-when -
defines the condition that warrants a detach:
- all-pdp-inactive -
detach when all PDP contexts are inactive.
- any-pdp-inactive -
detach when any PDP context is inactive.
timeout minutes minutes
Specifies the inactivity
timeout in minutes. minutes: is
an integer from 1 through 1440. Note that even though the timeout
is set for minutes, the configuration displays in seconds.
Usage:
Use this command to
define how the SGSN will handle a situation where the PDP is not fully
active. Repeat the command, as needed, to configure more than one
keyword-controlled function.
Example:
Use the following
command to have the SGSN deactivate all PDP contexts associated
with the APN when it detects the PDP is inactive:
pdp-data-inactivity
action deactivate all-pdp
Use the following
command to have the SGSN wait
2 minutes after
detecting PDP data inactivity:
pdp-data-inactivity
timeout minutes 2
pgw-address
Syntax
pgw-address ip_address [ s5-s8-protocol
pmip ] [ weight weight ]
no pgw-address ip_address
no
Disables the P-GW address
configured in this APN profile.
ip_address
Specifies the IP address
for the P-GW in IPv4 dotted-decimal or IPv6 colon-separated notation.
s5-s8-protocol pmip
MME only. Configures
the S5-S8 protocol for the gateway.
weight weight
Specifies the weight
(preference) assigned to the addressed P-GW for load balancing. weight is
an integer from 1 through 100 where 1 is the least preferred and
100 is the most preferred. If no weight is specified, the P-GW address
is assigned a default weight of 1.
If a weight is assigned
to an address, the weights of the P-GW(s) (that are operational)
are totaled, and then a weighted round-robin selection is used to
distribute new primary PDP contexts (for MME) or primary CPC requests
(for SGSN) among the P-GW(s) according to their weights. As with
all weighted round-robin algorithms, the distribution does not look
at the current distribution, but simply uses the weights to distribute
new requests. For example, two P-GWs assigned weights of 70 and
30 would distribute 70% of calls to one, and 30% to
the other. The sum of all weights do not need to total 100.
Usage:
Use this command to
define load balancing to be applied during P-GW selection. A maximum
of 16 P-GW addresses can be configured for this APN profile.
Example:
The following command
configures the P-GW IP address for this APN profile as
10.2.3.4:
pgw-address 10.2.3.4
qos apn-ambr
Configures the APN-AMBR
(aggregate maximum bit rate) that will be stored in the Home Subscriber
Server (HSS). This command is specific to the MME.
Privilege:
Security Administrator,
Administrator
Syntax
qos apn-ambr max-ul mbr-up max-dl mbr-dwn
remove qos apn-ambr
remove
Removes the APN-AMBR
changes from the configuration for this APN profile.
max-ul mbr-up max-dl mbr-dwn
Defines the maximum bit
rates for uplink (subscriber to network) and downlink (network to subscriber)
traffic.
mbr-up is an
integer from 0 through 1410065408.
mbr-dwn is
an integer from 0 through 1410065408.
Usage:
Use this command to
define the MBR that will be enforced by the P-GW for both uplink and
downlink traffic shaping.
Example:
qos apn-ambr max-ul 24234222
max-dl 23423423
qos class
Configures local values
for the traffic class (TC) parameters for the quality of service
(QoS) configured for this APN profile.
IMPORTANT:
To enable any of the
values/features configured with this command, the qos prefer-as-cap configuration
(also in the APN profile configuration mode) must be set to either local or both-hlr-and-local.
Privilege:
Security Administrator,
Administrator
Syntax
qos class { background | conversational | interactive | streaming } [ qualif_option ]
remove qos class { background | conversational | interactive | streaming } [ qualif_option ]
remove
Removes previously
defined values for the specified option or for an entire class if
a qualifying option is not included in the command.
background
Selects the background
traffic class. This ‘best-effort’ class manages
traffic that is handled as a background function, like email, where
time to delivery is not a key factor. The selection of background
traffic class can be refined with the addition of one of the following
qualifying options:
-
all-values
-
arp
-
mbr-down
-
mbr-map-down
-
mbr-map-up
-
mbr-up
-
residual-bit-error-rate
-
sdu
All qualifying options
are explained below.
conversational
Selects the ‘real-time’ conversational
traffic class of service, which has the most stringent time requirements
of the four classes and is typically reserved for voice traffic.
The section of the conversational traffic class can be refined with
the addition of one of the following qualifying options:
-
all-values
-
arp
-
gbr-down
-
gbr-up
-
mbr-down
-
mbr-map-down
-
mbr-map-up
-
mbr-up
-
min-transfer-delay
-
residual-bit-error-rate
-
sdu
All qualifying options
are explained below.
interactive
Selects interactive
traffic class of service. This class is characterized by a request/response pattern
(someone sends data and then waits for a response) which requires
the preservation of the data but delivers on a ‘best-effort’ model.
The section of the interactive traffic class can be refined with
the addition of one of the following qualifying options:
-
all-values
-
arp
-
mbr-down
-
mbr-map-down
-
mbr-map-up
-
mbr-up
-
residual-bit-error-rate
-
sdu
-
thp
All qualifying options
are explained below.
streaming
Selects the streaming
traffic class of service, which handles one-way, real-time data transmission
- such as streaming video or audio. The section of the interactive
traffic class can be refined with the addition of one of the following
qualifying options:
-
all-values
-
arp
-
gbr-down
-
gbr-up
-
mbr-down
-
mbr-map-down
-
mbr-map-up
-
mbr-up
-
min-transfer-delay
-
residual-bit-error-rate
-
sdu
All qualifying options
are explained below.
qualif_option
Qualifying options
are the QoS parameters and they include:
Usage:
This command defines
the qualifying options (parameters) for each QoS traffic class defined
for this APN profile.
IMPORTANT:
Typically this command
is only used to define QoS parameters when the APN record does not
exist in the subscription record.
Repeat the command
as often as needed with different options to define all required
QoS criteria. For example, to configure the maximum bit rate (MBR)
for the downlink and uplink directions for a traffic class, this
command must be used twice, specifying mbr-down once
and mbr-up once.
Advantage for local
mapping of MBR: some HLRs cannot be configured with high MBR values.
Using the mbr-map-up and
the mbr-map-down parameters
allows the SGSN to be configured to treat a specific HLR value as
meaning the desired high MBR value. In a case where the HLR does
not support HSPA+ bit rates, but the handsets and network
do, this feature allows the operator to overcome limitations on
the HLR and provide HSPA+ bit rates by overwriting the
provisioned HLR-QoS MBR values with SGSN-configured values. When
MBR mapping is configured, if QoS is preferred as the HLR value,
then the subscription QoS MBR received from the HLR is compared
with the "from" value in the table. If it matches, then it is converted
to the value specified by the "to" value in the table. QoS negotiation
happens based on the converted value.
Advantage for QoS capping
with THP and ARP: Controlling THP and ARP via Operator Policy: This
functionality can differentiate home vs. roaming subscribers, and
prevent visiting subscribers from receiving a high-tiered service.
For example, a service provider could offer service differentiation
using Ultra/Super/Standard service levels based
upon QoS; this could justify charging a corporate customer more
to use the Internet APN than would be charged to a consumer. This
could be accomplished by controlling the traffic handling priority
(THP) over the air interface, i.e. THP 1 = Ultra, THP 2 = Super
and THP 3 = Standard.
Example:
Use the following
command to configure the entire conversational traffic class with predefined
QoS options:
qos class conversational
all-values
Now change the background
class ARP from 3 to 2:
qos class background
arp 2
Invalidate the THP
parameter, by removing all value from the parameter, for the interactive class:
remove qos class interactive thp
qos dedicated-bearer
Configures the quality
of service maximum bit rate (MBR) parameters for the dedicated bearer.
This command is specific to the MME.
Privilege:
Security Administrator,
Administrator
Syntax
qos dedicated-bearer
mbr max-ul mbr-up max-dl mbr-dwn
remove qos dedicated-bearer
remove
Removes the dedicated
bearer maximum bit rate (MBR) changes from the configuration for this
APN profile.
max-ul mbr-up max-dl mbr-dl
Defines the maximum bit
rates for uplink and downlink traffic.
mbr-up is an
integer from 0 through 1410065408.
mbr-dl is an
integer from 0 through 1410065408.
Usage:
Use this command to
define the MBRs that will be enforced by the P-GW for both uplink and
downlink traffic shaping.
Example:
qos dedicated-bearer
mbr max-ul 24234222 max-dl 23423423
qos default-bearer
Configures the quality
of service parameters for the default bearer. This command is specific
to the MME.
Privilege:
Security Administrator,
Administrator
Syntax
qos default-bearer { arp arp_value [ preemption-capability { may | shall-not } | vulnerability { not-preemptable | preemptable } ] | qci qci }
remove qos default-bearer { arp | qci }
remove
Removes the default
bearer QoS configuration from this APN profile.
arp arp_value
Defines the address retention
priority value. arp_value is
an integer from 1 through 15.
preemption-capability { may | shall-not }
Specifies the preemption
capability flag. Options are:
- may: Bearer
may be preempted
- shall-not:
Bearer shall not be preempted
vulnerability { not-preemptable | preemptable }
Specifies the vulnerability
flag. Options are:
- not-preemptable:
Bearer cannot be preempted.
- preemptable:
Bearer can be preempted.
qci qci
Specifies the QoS Class
Identifier for the default bearer profile. qci is an
integer from 0 through 255.
Usage:
Use this command to
set the QoS APR and QCI parameters for the default bearer configuration.
Example:
qos default-bearer arp
2 preemption-capability may
qos prefer-as-cap
Specifies operational
preferences for QoS parameters, specifically QoS bit rates. This
command is specific to the SGSN in releases prior to 14.0.
Privilege:
Security Administrator,
Administrator
Syntax
qos prefer-as-cap { both-hlr-and-local | hlr-subscription | local }
remove qos prefer-as-cap
IMPORTANT:
Command and keyword
names have changed. prefer has
become prefer-as-cap and hlr has
become hlr-subscription.
These changes will not impact configuration generated with earlier
releases as the keywords are aliases for the previous names.
remove
Removes previous configuration
changes and resets the default.
both-hlr-and-local
Instructs the SGSN
to use, as the capping value during session establishment, the lower of either
the locally configured QoS bit rate or the Home Location Register (HLR)
subscription.
hlr-subscription
Instructs the SGSN
to take the QoS bit rates from the HLR configuration and use the
HLR rate as the capping value for session establishment.
Default for SGSN.
local
Instructs the SGSN
to take the QoS bit rate from the local configuration and use it
for session establishment.
Usage:
Use this command to
instruct the SGSN to take QoS configuration as the bit rate for session establishment.
Example:
The following command
specifies use of the bit rate in subscription at the HLR:
qos prefer-as-cap hlr-subscription
The following command
instructs the SGSN to cap the bit rate with the lower rate of the
two configurations, HLR or local:
qos prefer-as-cap
both-hlr-and-local
qos rate-limit direction
Configures the actions
governing the subscriber traffic flow, if the flow violates or exceeds
the configured or netogiated peak or committed data-rates.
This command can be
entered multiple times to specify different combinations of traffic
direction and class. The SGSN only performs traffic policing if qos rate-limit direction is
configured.
Additional information
on the QoS traffic policing functionality is located in the System Administration
Guide.
Privilege:
Security Administrator,
Administrator
Syntax
qos rate-limit direction { downlink | uplink } [ burst-size { auto-readjust [ duration seconds ] | bytes } ] [ class { background | conversational | interactive traffic_priority | streaming } ] [ exceed-action { drop | lower-ip-precedence | transmit } ] [ gbr-qci [ committed-auto-readjust
durarion seconds ] ] [ non-gbr-qci [ committed-auto-readjust durarion seconds ] ] [ violate-action { drop | lower-ip-precedence | transmit } ] +
remove qos rate-limit
direction { downlink | uplink } [ class { background | conversational | interactive traffic_priority | streaming } ]
remove
Removes the qos rate-limit
direction entries from the configuration.
downlink | uplink
Apply the limits and
actions configured with the other keywords to the selected link:
downlink -
This is the direction from the GGSN or P-GW to the MS.
uplink -
This is the direction from the MS to the GGSN or the P-GW.
burst-size { auto-readjust [ duration seconds ] | bytes }
Default: See the table
of class default values in the Usage section
below.
This keyword specifies
the peak burst size allowed. System measurements for this value exclude
the GTP and outer packet headers. Supported options include:
- auto-readjust:
This keyword enables dynamic burst-size calculation using negotiated
peak data-rate and negotiated committed data-rate.
- duration seconds:
Must be an integer from 1 to 30; default is 1. This keyword sets
the number of seconds that the dynamic burst-size calculation will
last. This allows the traffic to be throttled at the negotiated rates.
- bytes: Must
be an integer from 1 to 6000000. This value specifies the static
burst size for traffic policing. This option is present for backward compatibility.
IMPORTANT:
Use of dynamic burst
size (auto-readjust)
for traffic policing is recommended, rather than the static burst
size.
class { background | conversational | interactive traffic_priority | streaming }
The class keyword
configures the specified traffic policing actions per traffic class,
or per traffic priority in the case of interactive traffic class.
The following classes are supported:
- background:
Specifies the traffic action for traffic patterns in which the data
transfer is not time-critical (for example, email exchanges).
- conversational :
Specifies the traffic policing action for traffic patterns in which
there is a constant flow of packets in each direction, upstream
and downstream.
- interactive traffic_priority:
Specifies the traffic policing action for traffic patterns in which
there is an intermittent flow of packets in each direction, upstream
and downstream. traffic_priority is
the 3GPP traffic handling priority and can be an integer 1,2 or
3.
- streaming:
Specifies the traffic policing action for traffic patterns in which
there is a constant flow of data in one direction, either upstream
or downstream.
IMPORTANT:
This is an SGSN-specific
feature. If this keyword is omitted, the same values are used for
all classes.
exceed-action { drop | lower-ip-precedence | transmit }
Default: See the table
of class default values in the Usage section
below.
The action to take
on the packets that exceed the committed-data-rate but do not violate
the peak-data-rate. The following actions are supported:
- drop: Drop
the packet
- lower-ip-precedence:
Transmit the packet after lowering the ip-precedence
- transmit:
Transmit the packet
violate-action { drop | lower-ip-precedence | transmit }
Default: See the table
of class default values in the Usage section
below.
The action to take
on the packets that exceed both the committed-data-rate and the
peak-data-rate. The following actions are supported:
- drop: Drops
the packet
- lower-ip-precedence:
Transmits the packet after lowering the IP precedence
- transmit:
Transmits the packet
+
This symbol indicates
that the keywords can be entered multiple times within a single command.
Usage:
This command configures
the APN’s quality of service (QoS) traffic policing. Configured actions
prevent subscriber flow exceeding or violating configured peak or
negotiated peak or committed data rate limits.
IMPORTANT:
If either exceed action or violate action is
set to lower-ip-precedence,
this command may override the configuration of the ip qos-dscp command
in the APN profile.
Class: Background
|
Downlink Traffic: Disabled
Peak Data Rate (in
bps): 16000000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Uplink Traffic: Disabled
Peak Data Rate (in
bps): 8640000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Class: Conversational
|
Downlink Traffic: Disabled
Peak Data Rate (in
bps): 16000000
Committed Data Rate
(in bps): 16000000
Burst Size (in bytes):
65535
Exceed Action: lower-ip-precedence
Violate Action: drop
|
Uplink Traffic: Disabled
Peak Data Rate (in
bps): 8640000
Committed Data Rate
(in bps): 8640000
Burst Size (in bytes):
65535
Exceed Action: lower-ip-precedence
Violate Action: drop
|
Class: Interactive,
Traffic Handling Priority: 1
|
Downlink Traffic: Disabled
Peak Data Rate (in
bps): 16000000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Uplink Traffic: Disabled
Peak Data Rate (in
bps): 8640000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Class: Interactive,
Traffic Handling Priority: 2
|
Downlink Traffic: Disabled
Peak Data Rate (in
bps): 16000000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Uplink Traffic: Disabled
Peak Data Rate (in
bps): 8640000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Class: Interactive,
Traffic Handling Priority: 3
|
Downlink Traffic: Disabled
Peak Data Rate (in
bps): 16000000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Uplink Traffic: Disabled
Peak Data Rate (in
bps): 8640000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Class: Streaming
|
Downlink Traffic: Disabled
Peak Data Rate (in
bps): 16000000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Uplink Traffic: Disabled
Peak Data Rate (in
bps): 8640000
Committed Data Rate
(in bps): n/a
Burst Size (in bytes):
65535
Exceed Action: n/a
Violate Action: drop
|
Example:
The following command
lowers the IP precedence when the committed-data-rate and the peak-data-rate
are violated in uplink direction:
qos rate-limit direction
uplink violate-action lower-ip-precedence
The following command
drops the excess user packets when the subscriber traffic violates both
the configured peak and the committed data-rate in the uplink direction.
Once either the peak or the committed data-rate for that subscriber
goes below the configured/negotiated limit, it transmits
them.
qos rate-limit direction
uplink exceed-action drop
ranap allocation-retention-priority-ie
Configures the allocation/retention
priority (ARP) IE for this APN profile. This command is specific
to the SGSN.
Privilege:
Security Administrator,
Administrator
Syntax
ranap allocation-retention-priority-ie subscription-priority priority class { { background | conversational | interactive | streaming } { not-pre-emptable | priority | queuing-not-allowed | shall-not-trigger-pre-emptable } + }
IMPORTANT:
All parameters not
specifically configured will be included in the configuration with
default values.
[ default | remove | no ] ranap
allocation-retention-priority-ie [ subscription-priority priority class { background | conversational | interactive | streaming } ]
default
Resets the configuration
to the default values.
no
Disables the specified
configuration
remove
Removes the specified
configuration.
subscription-priority priority
This keyword sets
the subscription priority. The lowest number has the highest priority.
priority must
be an integer from 1 to 3.
class
Configure allocation/retention
priority (ARP) for specific QoS traffic classes. Include one or more
of the following class options:
- background:
background class of service
- conversational:
conversational class of service
- interactive:
interactive class of service
- streaming:
streaming class of service
Default values will
be included in the configuration for any class configuration not specified.
qualifying options
For each of the class
options, the configuration must include one or more of the following qualifying
options:
- not-pre-emptable
- priority:
smallest number is the highest priority. Value must be an integer
from 1 to 15
- queuing-not-allowed
- shall-not-trigger-pre-emptable
When entering more
than one option, we recommend that you do it in the order in which they
are listed.
+
This symbol indicates
that the keywords can be entered multiple times within a single command.
Usage:
Use this command to
configure values for the allocation/retention priority
(ARP) IE in the radio access bearer (RAB) assignment request message
for RANAP that occurs during RAB setup.
This command can be
used multiple times to define multiple priorities, with different combinations
of subscription-priority and class.
If the HLR returns
a matching value for the subscribed ARP for the desired traffic
class, the SGSN includes the configured qualifying options for the
ARP IE in the RANAP message.
If there is no matching
configuration, the SGSN includes the following default values for the
traffic class within the ARP IE:
- Default values for
traffic class = background:
-
priority-level = (subscribed-value * 3) + 3
-
pre-emption-capability = may-trigger-pre-emption
-
pre-emption-vulnerability = pre-emptable
-
queuing-allowed = yes
- Default values for
traffic class = conversational:
- priority-level = (subscribed-value * 3) + 2
-
pre-emption-capability = may-trigger-pre-emption
-
pre-emption-vulnerability = pre-emptable
-
queuing-allowed = yes
- Default values for
traffic class = interactive:
-
priority-level = (subscribed-value * 3) + 3
-
pre-emption-capability = may-trigger-pre-emption
-
pre-emption-vulnerability = pre-emptable
-
queuing-allowed = yes
- Default values for
traffic class = streaming:
-
priority-level = (subscribed-value * 3) + 1
-
pre-emption-capability = may-trigger-pre-emption
-
pre-emption-vulnerability = pre-emptable
-
queuing-allowed = yes
Example:
The following series
of commands define the highest priority for conversational traffic
class with priority level 1-10 (Subscribed priority 0-3), PCI of
shall-not-trigger-pre-emption, PVI of not-pre-emptable with queuing-not-allowed:
ranap allocation-retention-priority-ie subscription-priority
0 priority class conversational not-pre-emptable priority 1 shall-not-trigger-pre-emptable
ranap allocation-retention-priority-ie subscription-priority
1 priority class conversational not-pre-emptable priority 4 shall-not-trigger-pre-emptable
ranap allocation-retention-priority-ie subscription-priority
2 priority class conversational not-pre-emptable priority 7 shall-not-trigger-pre-emptable
ranap allocation-retention-priority-ie subscription-priority
3 priority class conversational not-pre-emptable priority 10 shall-not-trigger-pre-emptable
restrict access-type
Configures the activation
restrictions of PDP context on the basis of the access type and
QoS class. This command is specific to the SGSN.
Privilege:
Security Administrator,
Administrator
Syntax
restrict access-type { { gprs | umts } [ qos-class { background | conversational | interactive | streaming } ] }
no restrict access-type { gprs | umts } [ qos-class ]
default restrict access-type { gprs | umts }
no
Remove the restriction
rules for PDP context activation configured in this APN profile.
default
Resets the restriction
rules for PDP context activation to the default values to allow
all access types and QoS class.
gprs
Configures the APN
profile to restrict the PDP context activation from General Packet
Radio Service (2.5G) network access.
umts
Configures the APN
profile to restrict the PDP context activation from Universal Mobile Telecommunications
Systems (3G) network access.
qos-class
Configures the APN
profile to restrict the PDP context activation for to a specific
QoS traffic class. It is optional and can be configured after selecting
the network access type. Possible traffic classes options are:
- background:
Specifies the QoS class as background service session
- conversational:
Specifies the QoS class as conversational service session
- interactive:
Specifies the QoS class as interactive service session
- streaming:
Specifies the QoS class as streaming service session
Usage:
Use this command to
configure the restriction rules in an APN profile for activation
of PDP context on the basis of the access type. It also provides
the facility to restrict type of traffic QoS class.
Example:
The following command
configures the APN profile to restrict all traffic from a GPRS network
service having a QoS class of interactive:
restrict access-type
grps qos-class interactive