pem protocol diameter-avp¶

pem protocol diameter-avp(1) BIG-IP TMSH Manual pem protocol diameter-avp(1)

NAME
diameter-avp - Configures diameter AVPs in Policy Enforcement Manager (PEM).

MODULE
pem protocol

SYNTAX
Configure the diameter-avp component within the pem protocol module using the syntax shown in the following sections.

edit diameter-avp [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties

DISPLAY
list diameter-avp
list diameter-avp [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition

DELETE
delete diameter-avp [name]

Note: You must remove all references to a diameter-avp before you can delete the diameter-avp.

DESCRIPTION
You can use the diameter-avp component to configure Diameter AVP definitions in Policy Enforcement Manager.

EXAMPLES
create diameter-avp user_equipment_value { data-type octetstring avp-code 460 }

Creates a PEM diameter-avp user_equipment_value with avp-code 460 and data-type octetstring.

delete diameter-avp user_equipment_value

Deletes the diameter-avp named user_equipment_value.

list diameter-avp user_equipment_value

Displays the properties of the diameter-avp named user_equipment_value.

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.

avp-code
Specifies the avp-code of the Diameter AVP.

data-type
Specifies the data type of the Diameter AVP. The default value is octetstring.

Note: The 'V' bit, known as the Vendor-Specific bit, indicates whether the optional vendor-id field is present in the
AVP header. When set, the AVP code belongs to the specific vendor code address space. The 'V' bit is defined as flag-
vendor-specific property in pem protocol profile gx.

The options are:

address
The address format is derived from the octetstring AVP base format. It is a discriminated union, representing,
for example a 32-bit (IPv4) or 128-bit (IPv6) address, most significant octet first. The first two octets of the
address AVP represents the AddressType, which contains in address family. The AddressType is used to discriminate
the content and format the remaining octets.

enumerated
Enumerated is derived from the integer32 AVP Base Format. The definition contains a list of valid values and
their interpretation and is described in the Diameter application introducing the AVP.

float32
This represents floating point values of single precision. The 32-bit value is transmitted in network byte order.
The AVP length field MUST be set to 12 (16 if the 'V' bit is enabled).

float64
This represents floating point values of double precision. The 64-bit value is transmitted in network byte order.
The AVP length field MUST be set to 16 (20 if the 'V' bit is enabled).

grouped
The data field is specified as a sequence of AVPs. Each of these AVPs follows - in the order in which they are
specified - including their headers and padding. The AVP length field is set to 8 (12 if the 'V' bit is enabled)
plus the total length of all included AVPs, including their headers and padding. Thus the AVP length field of an
AVP of type grouped is always a multiple of 4.

integer32
32 bit signed value, in network byte order. The AVP length field MUST be set to 12 (16 if the 'V' bit is
enabled).

integer64
64 bit signed value, in network byte order. The AVP length field MUST be set to 16 (20 if the 'V' bit is
enabled).

octetstring
The data contains arbitrary data of variable length. Unless otherwise noted, the AVP length field MUST be set to
at least 8 (12 if the 'V' bit is enabled). AVP Values of this type that are not a multiple of four-octets in
length is followed by the necessary padding so that the next AVP (if any) will start on 32-bit boundary.

rat-type
specifies the value format to be encoded or decoded as the RAT-Type defined in 3GPP TS 29.212.

time The time format is derived from the octetstring AVP base format. The string MUST contain four octets, in the same
format as the first four bytes are in the NTP timestamp format.

unsigned32
32 bit unsigned value, in network byte order. The AVP length field MUST be set to 12 (16 if the 'V' bit is
enabled).

unsigned64
64 bit signed value, in network byte order. The AVP length field MUST be set to 16 (20 if the 'V' bit is
enabled).

utf8string
The utf8string format is derived from the octetstring AVP base format. This is a human readable string
represented using the ISO/IEC IS 10646-1 character set, encoded as an octetstring using the UTF-8 transformation
format described in RFC 2279.

description
User defined description.

length
Specifies the data length of the Diameter AVP.

name Specifies a unique name for the component. This option is required for the commands create, delete, and modify.

parent-avp
Specifies the name of the parent AVP if it is in a grouped AVP.

vendor-id
Specifies the vendor-id of the Diameter VSA.

SEE ALSO
create, delete, edit, glob, list, modify, pem protocol profile gx, pem protocol profile radius, pem protocol radius-avp,
pem subscriber-attribute, regex, show, 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.

BIG-IP 2016-03-14 pem protocol diameter-avp(1)