PEM::subscriber¶

Description¶

This command allows you to create, delete or retreive information of a PEM session using session ip in the PEM Session DB.

Each PEM session carries the following standard attributes: imsi, imeisv, tower-id, user-name, subscriber-type, subscriber-id, state, aaa-reporting-interval, provision.

Note: the Policy Enforcement Manager license is required for functionality to work.

Syntax¶

PEM::subscriber create <subscriber-id> subscriber-id-type <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> ip-address <framed-ip> [imsi <sring>] [user-name <string>] [tower-id <string>] [imeisv <string>] [provision <yes | no>]
PEM::subscriber info <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> imsi
PEM::subscriber info <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> imsi <value>
PEM::subscriber info <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> imeisv
PEM::subscriber info <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> imeisv <value>
PEM::subscriber info <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> tower-id
PEM::subscriber info <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> tower-id <value>
PEM::subscriber info <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> user-name
PEM::subscriber info <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> user-name <value>
PEM::subscriber info <susbcriber-id> subscriber-id-type <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> state
PEM::subscriber info <susbcriber-id> subscriber-id-type <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> state <value>
PEM::subscriber info attr delete <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> <attr>
PEM::subscriber info attr <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> <attr>
PEM::subscriber info attr <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> <attr> <value>
PEM::subscriber delete <susbcriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri>
PEM::subscriber config policy referential set <subscriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> <list of referential policies>
PEM::subscriber config policy referential update <subscriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri> add <list of referential policies> delete <list of referential policies>
PEM::subscriber config policy get <subscriber-id> <e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri>
PEM::subscriber ip <subscriber id> [e164 | imsi | nai | private | mac-address | dhcp | mac-dhcp | dhcp-custom | sip-uri] [all | <ip1 ip2 ... ipN>]

PEM::subscriber create subscriber-id-type ip-address < framed-ip > [imsi ] [user-name ] [tower-id ] [imeisv ] [provision ]¶

Create a PEM subscriber session for of subscriber-id-type from one of with ip-address < framed-ip >

private The subscriber id type is private. Private: The subscriber ID type is private for the given deployment.
subscriber-id sets subscriber to specified value
imsi sets imsi to specified value
user-name sets user-name to specified value
tower-id sets tower name to specified value
imeisv sets imeisv to specified value
provision default is yes, when no it disabled policy retrieval via Gx for this subscriber.

PEM::subscriber info imsi | imeisv | tower-id | user-name | subs-type | subs-id | state¶

retrieve current SPM subscriber session state

PEM::subscriber info imsi | imeisv | tower-id | user-name | state¶

retrieve the current SPM subscriber session state
- State Values:
  - init
  - prov_ssp_sid_pending - subscriber provisioning is waiting for a policy provisioning by SID response from SSP module
  - prov_ppe_sid_pending - subscriber provisioning is waiting for a policy provisioning by SID response from PCRF (Gx endpoin)
  - prov_sid_failed - provisioning by SID failed
  - prov_sid_tbd - provisioning request by IP address is in progress. Provisioning by SID is postponed
  - prov_ip_pending
  - prov_ip_failed
  - prov_conditionally
  - prov_ip
  - provisioned
  - prov_unknown
  - mark_delete
  - final_usage_pending
  - final_usage_sent
  - final_delete_initiated
  - final_delete
  - final

PEM::subscriber info attr delete¶

Delete subscriber session custom attribute

PEM::subscriber info attr¶

get subscriber session custom attribute

PEM::subscriber info attr¶

add a custom attribute to the subscriber session

PEM::subscriber delete¶

delete subscriber session

PEM::subscriber config policy referential set¶

set a referential policy to this pem session

PEM::subscriber config policy referential update add delete¶

update/add a referential policy to this pem session

PEM::subscriber config policy get¶

returns a list of policies applied to the subscriber specifying the IP address

PEM::subscriber ip [subscriber-id] [subscriber-id-type] [all | <ip-addr-list>]¶

return subscriber IP address when given subscriber id and optional type, or

sets the subscriber session with an ip address list.

Examples¶

when HTTP_REQUEST {
    PEM::subscriber create 4086007577 subscriber-type e164 ip-address 10.10.10.10
    PEM::subscriber config policy referential set 4086007577 e164 policy1
    PEM::subscriber ip 4086007577 e164 10.0.0.92 2001::101
    PEM::subscriber info 4086007577 e164 imsi 1223456
    PEM::subscriber info 4086007577 e164 imeisv 2534535
    PEM::subscriber info 4086007577 e164 tower-id 8248249
    PEM::subscriber info 4086007577 e164 user-name 2139449

    log local0.  "policy: [PEM::subscriber config policy get 4086007577 e164]"
    log local0.  "imsi: [PEM::subscriber info 4086007577 e164 imsi]"
    log local0.  "imeisv: [PEM::subscriber info 4086007577 e164 imeisv]"
    log local0.  "tower-id: [PEM::subscriber info 4086007577 e164 tower-id]"
    log local0.  "user-name: [PEM::subscriber info 4086007577 e164 user-name]"
    log local0.  "state: [PEM::subscriber info 4086007577 e164 state]"

    PEM::subscriber info attr 4086007577 e164 custom1 876
    log local0.  "custom1: [PEM::subscriber info attr 4086007577 e164 custom1]"
}

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.