pem protocol profile gx
pem protocol profile gx(1) BIG-IP TMSH Manual pem protocol profile gx(1)
NAME
gx - Configures a Diameter Gx protocol profile in Policy Enforcement
Manager (PEM).
MODULE
pem protocol profile
SYNTAX
Configure the gx component within the pem protocol profile module using
the syntax shown in the following sections.
CP/CREATE/EDIT/MODIFY
cp gx [source_name] [ destination_name]
create gx [name]
modify gx [name]
options:
app-service [[string] | none]
description [string]
messages [add | delete | modify | replace-all-with] {
[ [message-name] ] {
options:
direction [any | in | out]
message-type [ccr-i | cca-i | ccr-u | cca-u | ccr-t | cca-t | rar | raa]
avps [add | delete | modify | replace-all-with] {
[ [avp-name] ] {
options:
default [string]
diameter-avp [ [diameter_avp_name] | none]
flag-mandatory [disabled | enabled]
flag-protected [disabled | enabled]
flag-vendor-specific [disabled | enabled]
interim-message-include [disabled | enabled]
parent-label [string]
reporting-message-include [disabled | enabled]
subscriber-attr [ [subscriber_attribute_name] | none]
}
}
}
}
subscriber-id {
avp [ [diameter_avp_name] | none]
type [e164 | imsi | nai | private]
type-avp [ [diameter_avp_name] | none]
}
edit gx [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list gx
list gx [ [ [name] | [glob] | [regex] ] ... ]
show running-config gx
show running-config gx [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete gx [name]
Note: You must remove all references to a PEM protocol profile gx
before you can delete it.
DESCRIPTION
You can use the gx component to configure PEM protocol profile gx
definitions in Policy Enforcement Manager.
EXAMPLES
create cust_gx messages add {my_ccr direction out message-type ccr {
avps add {avp1 { subscriber-attr 3gpp_location diameter-avp
user_equipment_value flag-mandatory enabled} } } }
Creates a custom PEM Gx protocol profile cust_gx and adds a message.
The message is defined as CCR on the egress direction. PEM will insert
the Diameter AVP as specified in user_equipment_value with the value
stored subscriber attribute 3gpp_location with mandatory flag enabled.
delete gx cust_gx
Deletes the PEM Gx protocol profile named cust_gx.
list gx cust_gx
Displays the properties of the PEM Gx protocol profile named cust_gx.
OPTIONS
app-service
Specifies the name of the application service to which the object
belongs. The default value is none. Note: If the strict-updates
option is enabled on the application service that owns the object,
you cannot modify or delete the object. Only the application
service can modify or delete the object.
description
User defined description.
messages
Adds, deletes, or replaces a set of messages which specify mapping
of Diameter AVPs to subscriber session attribute for specific Gx
message. If a message by the specified name does not exist, it
will be created. You can configure the following options for a
message:
app-service
Specifies the name of the application service to which the
message belongs. The default value is none. Note: If the
strict-updates option is enabled on the application service
that owns the object, you cannot modify or delete the
message. Only the application service can modify or delete
the message.
direction
Specifies the direction of the message.
The options are:
any PEM will process the message in both ingress and egress
directions.
in PEM will process the message in ingress direction.
out PEM will process the message in egress direction.
message-type
Specifies the type of the message.
The options are:
ccr-i
The message is Gx Credit-Control-Request (CCR) Initial.
cca-i
The message is Gx Credit-Control-Answer (CCA) Initial.
ccr-u
The message is Gx Credit-Control-Request (CCR) Update.
cca-u
The message is Gx Credit-Control-Answer (CCA) Update.
ccr-t
The message is Gx Credit-Control-Request (CCR)
Terminate.
cca-t
The message is Gx Credit-Control-Answer (CCA) Terminate.
rar The message is Gx Re-Authorization-Request (RAR).
raa The message is Gx Re-Authorization-Answer (RAA).
avps Adds, deletes, or replaces a set of mapping between Diameter
AVPs and PEM subscriber attributes. You can configure the
following options.
app-service
Specifies the name of the application service to which
the AVP belongs. The default value is none. Note: If the
strict-updates option is enabled on the application
service that owns the object, you cannot modify or
delete the avp. Only the application service can modify
or delete the avp.
default
Specifies the Diameter AVP default value. When inserting
the AVP, the default value is used if the corresponding
subscriber attribute is not defined or is not present.
diameter-avp
Specifies the name of the Diameter AVP. The default
value is none.
flag-mandatory
Specifies the value of the mandatory flag in the
Diameter AVP when inserting into the message. This flag
only applies to Diameter AVP in outgoing message.
flag-protected
Specifies the value of the protected flag in the
Diameter AVP when inserting into the message. This flag
only applies to Diameter AVP in outgoing message.
flag-vendor-specific
Specifies the value of the vendor-specific flag in the
Diameter AVP when inserting into the message. This flag
only applies to Diameter AVP in outgoing message.
interim-message-include
Specifies whether this AVP needs to be included in the
interim-message (ccr-u only) updates which are generated
if there is any change related to session parameters.
This flag only applies to Diameter AVP in outgoing
message.
parent-label
Specifies how grouped AVPs can be combined. The AVPs
with the same parent-label will be combined in the same
grouped AVP.
reporting-message-include
Specifies whether this AVP needs to be included in the
reporting-message (ccr-u only) updates which are
generated for reporting usage information. This flag
only applies to Diameter AVP in outgoing message.
subscriber-attr
Specifies the name of the subscriber session attribute
to be mapped to Diameter AVP. The default value is none.
name Specifies a unique name for the component. This option is required
for the commands create, delete, and modify.
subscriber-id
Specifies how subscriber ID specified by PCRF should be read by
PEM.
avp Subscription ID comes with type and data in diameter. This
field specifies the avp in the message that should be matched
to get subscriber ID data in raw format.
type Specifies the subscriber ID type (imsi. e164, private) that
PEM will use for the session for the ID read by avp.
The options are:
e164 A numbering plan that defines the format of an MSISDN
international phone number (up to 15 digits). The number
typically consists of three fields: country code,
national destination code, and subscriber number.
imsi International Mobile Subscriber Identity. A globally
unique code number that identifies a GSM, UMTS, or LTE
mobile phone user.
nai Network Access Identifier. A fully qualified network
name in the form @; identifies a subscriber
and the home network to which the subscriber belongs.
private
The subscriber id type is private for the given
deployment.
type-avp
Subscription ID comes with type and data in diameter. type-
avp specifies avp in message that should be matched.
SEE ALSO
create, delete, edit, glob, list, modify, pem protocol profile radius,
pem protocol diameter-avp, pem protocol radius-avp, pem subscriber-
attribute, regex, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopying,
recording, or information storage and retrieval systems, for any
purpose other than the purchaser's personal use, without the express
written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2013-2014, 2016. All rights
reserved.
BIG-IP 2016-03-14 pem protocol profile gx(1)