Gets a list of all format scripts.

Creates a set of PEM format scripts.

Deletes the specified format scripts.

Deletes all user defined format scripts.

Sets the definitions for the specified format scripts. A definition specifies a script using TCL syntax that defines a custom format for HSL reporting applied in an enforcement policy rule. You can use 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. (*) last-send-sec Specifies the value of seconds of the timestamp since the previous record was sent. (*) last-send-usec Specifies the value of microseconds of the timestamp since the previous record was sent. (*) param-3gpp Specifies the the comma-separated string of the value of imsi, imeisv, tower-id, and user-name. (*) rec-reason Specifies the reason for sending report. The values are 1: period time, 2: valume 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-end-time-sec Specifies the seconds value of the timestamp when the flow ends. The Unix epoch is 1970-01-01T00:00:00Z. (*) flow-end-time-usec Specifies microseconds value of the timestamp when the flow ends. (*) 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-start-time-usec Specifies microseconds value of the timestamp when the flow starts. (*) proto Specifies the protocol of the flow. (*) rec-type Specifies the type of the flow-based record. The value is 0: flow init, 1: flow interim, and 2: flow end. (*) src-ip Specifies the source ip address of the flow. (*) src-port Specifies the destination port of the flow. (*) 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.

Gets the definitions for the specified format scripts.

Sets the description for a set of format scripts. This is an arbitrary field which can be used for any purpose.

Gets the description for a set of format scripts.

Gets the version information for this interface.

Gets a list of all format scripts.

Creates a set of PEM format scripts.

Deletes the specified format scripts.

Deletes all user defined format scripts.

Sets the definitions for the specified format scripts. A definition specifies a script using TCL syntax that defines a custom format for HSL reporting applied in an enforcement policy rule. You can use 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. (*) last-send-sec Specifies the value of seconds of the timestamp since the previous record was sent. (*) last-send-usec Specifies the value of microseconds of the timestamp since the previous record was sent. (*) param-3gpp Specifies the the comma-separated string of the value of imsi, imeisv, tower-id, and user-name. (*) rec-reason Specifies the reason for sending report. The values are 1: period time, 2: valume 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-end-time-sec Specifies the seconds value of the timestamp when the flow ends. The Unix epoch is 1970-01-01T00:00:00Z. (*) flow-end-time-usec Specifies microseconds value of the timestamp when the flow ends. (*) 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-start-time-usec Specifies microseconds value of the timestamp when the flow starts. (*) proto Specifies the protocol of the flow. (*) rec-type Specifies the type of the flow-based record. The value is 0: flow init, 1: flow interim, and 2: flow end. (*) src-ip Specifies the source ip address of the flow. (*) src-port Specifies the destination port of the flow. (*) 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.

Gets the definitions for the specified format scripts.

Sets the description for a set of format scripts. This is an arbitrary field which can be used for any purpose.

Gets the description for a set of format scripts.

Gets the version information for this interface.

You can use the format script component to create scripts for High-Speed Logging (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.