pem subscriber
pem subscriber(1) BIG-IP TMSH Manual pem subscriber(1)
NAME
subscriber - Configures subscribers for the Policy Enforcement Manager (PEM).
MODULE
pem
SYNTAX
Modify static subscriber component within PEM module using the syntax shown in the following sections.
CREATE/MODIFY
create subscriber [name]
modify subscriber [name]
options:
app-service [[string] | none]
ip-address-list [add | delete | replace-all-with] {
[ip address ...]
}
policies [add | delete | replace-all-with] {
[policy_name ...]
}
policies [default | none]
subscriber-id-type [dhcp | dhcp-custom | e164 | imsi | mac-address | mac-dhcp | nai | private ]
edit subscriber [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list subscriber
list subscriber [ [ [name] | [glob] | [regex] ] ... ]
show running-config subscriber
show running-config subscriber [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete subscriber [name]
Note: You must remove all references to a subscriber before you can delete the subscriber.
DESCRIPTION
You can use the subscriber component to configure subscriber definitions for the Policy Enforcement Manager.
Subscriber session IP addresses may optionally include a route domain ID. When specified, the route domain ID
follows the IP address, after '%' separator. For example, 10.10.10.100%5 is an IP address in route domain 5.
A subscriber session may have multiple IP addresses in different route domains.
EXAMPLES
create subscriber 4085551212 { ip-address-list add { 10.10.10.2 10.10.10.3 } policies add { policy1 }
subscriber-id-type imsi }
Creates a PEM subscriber 4085551212 with IP addresses 10.10.10.2 and 10.10.10.3, subscriber id type imsi, and
a policy policy1.
create subscriber 4085551212 { ip-address-list add { 10.10.10.2%5 10.10.10.3%77 } policies add { policy1 }
subscriber-id-type imsi }
Creates a PEM subscriber 4085551212 with IP addresses 10.10.10.2 and 10.10.10.3 in route domains 5 and 77
respectively, subscriber id type imsi, and a policy policy1.
create subscriber 4085551212 { ip-address-list add { 10.10.10.2%5 10.10.10.2%77 } policies add { policy1 }
subscriber-id-type imsi }
Creates a PEM subscriber 4085551212 with two IP address entries that consist of the same IP address 10.10.10.2
and different route domain IDs: 5 and 77, subscriber id type imsi, and a policy policy1.
delete subscriber sub1
Deletes the subscriber named sub1.
list subscriber sub1
Displays the properties of the subscriber named sub1.
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.
name Specifies a unique subscriber identifier (up to 64 characters). This option is required for the commands
create, delete, and modify.
ip-address-list
Adds, deletes, or replaces a list of the ip address to associate with the subscriber.
policies
Adds, deletes, or replaces a set of the policies to associate with the subscriber.
subscriber-id-type
Specifies the format to use for the subscriber id. The default value is imsi.
The options are:
dhcp For subscribers discovered via DHCP: an identifier comprises either Relay Option (option 82) for
DHCPv4 based subscriber IDs or REMOTE-ID and SUBSCRIBER-ID Options (options 37 and 38) for DHCPv6,
as configured in the corresponding DHCP profile.
dhcp-custom
For subscribers discovered via DHCP: an identifier created using a custom TCL snippet.
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.
mac-address
For subscribers discovered via DHCP: subscriber MAC address in a standard IEEE 802 format for MAC-48
(six groups of two hexadecimal digits, separated by colons ':').
mac-dhcp
For subscribers discovered via DHCP: a concatenation of mac-address and dhcp identifier as
configured in the corresponding DHCP profile.
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.
SEE ALSO
create, delete, edit, glob, list, modify, pem forwarding-endpoint, pem interception-endpoint, pem listener,
pem policy, pem profile diameter-endpoint, pem profile spm, pem reporting format-script, pem service-chain-
endpoint, 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.
F5 Networks and BIG-IP (c) Copyright 2012-2013, 2016. All rights reserved.
BIG-IP 2016-03-14 pem subscriber(1)