pem reporting format-script¶

pem reporting format-script(1) BIG-IP TMSH Manual pem reporting format-script(1)

NAME
format-script - Configures format scripts for the Policy Enforcement Manager (PEM).

MODULE
pem reporting

SYNTAX
Modify the format-script component within the pem reporting module using the syntax shown in the following sections.

CREATE/MODIFY
create format-script [name]
modify format-script [name]
options:
app-service [[string] | none]
definition [string]
description [string]

edit format-script [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties

DISPLAY
list format-script
list format-script [ [ [name] | [glob] | [regex] ] ... ]
show running-config format-script
show running-config format-script [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition

DELETE
delete format-script [name]

Note: You must remove all references to a format script object before you can delete it.

DESCRIPTION
You can use the format-script component to create scripts for HSL reporting. The scripts use TCL syntax and define a custom
format that is applied in an enforcement policy rule. The format and fields available differ depending on whether the rule
specifies session-based or flow-based reporting.

EXAMPLES
create format-script fm1 { definition { return "(flow app_id[PEM::flow stats reported app-id], bytes-in:[PEM::flow stats
reported bytes-in])" } }

Creates a PEM reporting format script named fm1.

delete format-script fm1

Deletes the format script named fm1.

list format-script fm1

Displays the properties of the format script named fm1.

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.

definition
Specifies a script using TCL syntax that defines a custom format for HSL reporting applied in an enforcement policy
rule. The format and fields available differ depending on whether you are using session-based or flow-based reporting
in the rule.

Session-based formats:
The options are:

app-id
Specifies the application id of the session record.

bytes-in
Specifies the aggregate incoming bytes of the session.

bytes-out
Specifies the aggregate outgoing bytes of the session.

calling-station-id
Specifies the calling station Id.

called-station-id
Specifies the called station Id.

flows-concurrent
Specifies the number of concurrent flows in the session.

flows-duration
Specifies the duration of the flow in the session.

flows-ended
Specifies the number of flows ended in the session.

flows-new
Specifies the number of new flows in the session.

last-sent-sec
Specifies the value of seconds of the timestamp since the previous record was sent.

param-3gpp
Specifies the comma-separated string of the value of imsi, imeisv, tower-id, and user-name.

record-reason
Specifies the reason for sending report. The values are 1: period time, 2: volume threshold, 3: subscriber
logout, 4: inactivity.

record-type
Specifies the type of the session-based record (always 3).

report-id
Specifies the report Id.

report-version
Specifies the report version.

subscriber-id
Specifies the subscriber id.

subscriber-id-type
Specifies the subscriber id type (e164, imsi, nai, or private).

timestamp
Specifies the seconds value of the timestamp when the record was generated. The Unix epoch is
1970-01-01T00:00:00Z.

timestamp-milliseconds
Specifies the milliseconds value of the timestamp when the record was generated.

Note:Recommend not to use the following options. They are available for backward compatibility.

last-send-usec
Specifies the value of microseconds of the timestamp since the previous record was sent.

rec-reason
Specifies the reason for sending report. The values are 1: period time, 2: volume threshold, 3: subscriber
logout, 4: inactivity.

rec-type
Specifies the type of the session-based record (always 3).

subs-id
Specifies the subscriber id.

subs-id-type
Specifies the subscriber id type (e164, imsi, nai, or private).

timestamp-sec
Specifies the seconds value of the timestamp when the record was generated. The Unix epoch is
1970-01-01T00:00:00Z.

timestamp-usec
Specifies the microseconds value of the timestamp when the record was generated.

Flow-based formats:
The options are:

app-id
Specifies the application id of the flow record.

bytes-in
Specifies the aggregate incoming bytes of the flow.

bytes-out
Specifies the aggregate outgoing bytes of the flow.

dst-ip
Specifies the destination ip address of the flow.

dst-port
Specifies the destination port of the flow.

flow-start-milli-seconds
Specifies the milliseconds value of the timestamp when the flow starts.

flow-start-time-sec
Specifies the seconds value of the timestamp when the flow starts. The Unix epoch is 1970-01-01T00:00:00Z.

flow-end-milli-seconds
Specifies milliseconds value of the timestamp when the flow ends.

flow-end-time-sec
Specifies the seconds value of the timestamp when the flow ends. The Unix epoch is 1970-01-01T00:00:00Z.

proto
Specifies the protocol of the flow.

record-type
Specifies the type of the flow-based record. The value is 0: flow init, 1: flow interim, and 2: flow end.

report-id
Specifies the report Id.

route-domain
Specifies the route domain Id of the traffic.

report-version
Specifies the report version.

src-ip
Specifies the source ip address of the flow.

src-port
Specifies the destination port of the flow.

subscriber-id
Specifies the subscriber id.

subscriber-id-type
Specifies the subscriber id type (e164, imsi, nai, or private).

timestamp
Specifies the of seconds value of the timestamp when the record was generated. The Unix epoch is
1970-01-01T00:00:00Z.

timestamp-milliseconds
Specifies the milliseconds value of the timestamp when the record was generated.

transactions
Specifies the number of transactions in the flow.

urlcat-id
Specifies the unique number that represents the first (most relevant) URL category that is classified for
the flow.

vlan-id
Specifies the vlan Id of the traffic.

Note:Recommend not to use the following options. They are available for backward compatibility.

flow-start-time-usec
Specifies microseconds value of the timestamp when the flow starts.

flow-end-time-usec
Specifies microseconds value of the timestamp when the flow ends.

rec-type
Specifies the type of the flow-based record. The value is 0: flow init, 1: flow interim, and 2: flow end.

subs-id
Specifies the subscriber id.

subs-id-type
Specifies the subscriber id type (e164, imsi, nai, or private).

timestamp-sec
Specifies the of seconds value of the timestamp when the record was generated. The Unix epoch is
1970-01-01T00:00:00Z.

timestamp-usec
Specifies the microseconds value of the timestamp when the record was generated.

description
Specifies a user-defined description.

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 service-chain-endpoint, pem subscriber, pem subscribers, 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 2017-03-02 pem reporting format-script(1)