attribute
This command allows you to specify the fields and their order in EDRs.
Product
All
Privilege
Security Administrator, Administrator
Mode
Exec > ACS Configuration > EDR Format Configuration
active-charging service service_name > edr-format format_name
Entering the above command sequence results in the following prompt:
[context_name]host_name(config-acs-edr)#
Syntax
attribute attribute { [ format { MM/DD/YY-HH:MM:SS | MM/DD/YY-HH:MM:SS:sss | MM/DD/YYYY-HH:MM:SS | MM/DD/YYYY-HH:MM:SS:sss | YYYY/MM/DD-HH:MM:SS | MM/DD/YYYY-HH:MM:SS:sss | YYYYMMDDHHMMSS | YYYYMMDDHHMMSSsss | seconds } ] [ localtime ] | [ { ip | tcp } { bytes | pkts } { downlink | uplink } ] priority priority }
no attribute attribute [ { ip | tcp } { bytes | pkts } { downlink | uplink } ] [ priority priority ]
no
If added previously, removes the specified attribute from the EDR format.
attribute
Specifies the attribute.
attribute must be one of the following:
Attributes | Description | ||
---|---|---|---|
bandwidth-policy |
This attribute reports the bandwidth policy name of subscriber. Bandwidth policy can be configured or applied to subscriber by —
|
||
radius-called-station-id |
This attribute reports the Called Station ID of the mobile handling the flow. |
||
radius-calling-station-id |
This attribute reports the Calling Station ID of the mobile handling the flow. |
||
radius-fa-nas-identifier |
This attribute reports the RADIUS NAS identifier of Foreign Agent (FA). |
||
radius-fa-nas-ip-address |
This attribute reports the RADIUS IP address of Foreign Agent (FA). |
||
radius-nas-identifier |
This attribute reports the RADIUS NAS identifier. |
||
radius-nas-ip-address |
This attribute reports the RADIUS NAS IP address. Note that this attribute is interchangeable with sn-st16-ip-addr for the user. |
||
radius-user-name |
This attribute reports the user name associated with the flow. |
||
sn-3gpp2-always-on |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-3gpp2-bsid |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-3gpp2-esn |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-3gpp2-ip-qos |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-3gpp2-ip-technology |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-3gpp2-release-indicator |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-3gpp2-service-option |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-3gpp2-session-begin |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-3gpp2-session-continue |
This option has been deprecated. To configure this attribute see the rule-variable command. |
||
sn-acct-session-id |
This attribute reports the unique session identifier for accounting. |
||
sn-app-protocol |
This attribute reports the application protocol for the flow. A value indicating the protocol, such as one of the following:
|
||
|
|||
sn-cf-category-classification-used |
For Category-based Content Filtering, this attribute reports the last classification used by system for the flow, or blank if classification was never successfully performed. For URL Blacklisting, specifies category of the blacklisted URL in the Blacklist database. |
||
sn-cf-category-flow-action |
For Category-based Content Filtering, this attribute reports the last action taken for the flow, or blank if content filtering was never performed. The following are the possible values:
For URL Blacklisting, this attribute reports the last action taken for the flow, or blank if Blacklist matching was never performed. The following are the possible values:
|
||
sn-cf-category-policy |
For Category-based Content Filtering, this attribute reports the category policy identifier that was used for the flow, or blank if content filtering was never attempted for the flow. |
||
sn-cf-category-rating-type |
For Category-based Content Filtering, this attribute reports the type, either "static" or "dynamic" that was last successfully performed for the flow, or blank if content filtering was never successful for the flow. For URL Blacklisting, specifies "blacklisting". |
||
sn-cf-category-unknown-url |
This attribute reports the identifier for unknown URL under content filtering action. It holds either "1" for unknown URLs or "0" for the URLs having static rating in its database. |
||
sn-charge-volume |
This attribute reports the total charge volume excluding bytes/packets dropped/retransmitted by ECS. This behavior can be changed by configuring to allow dropped/retransmitted bytes/packets to be included in the net volume. See the edr sn-charge-volume command in the ACS Rulebase Configuration Mode Commands chapter. |
||
sn-charging-action |
This attribute reports the name of last charging action matched against flow.
|
||
sn-closure-reason |
This attribute reports the reason for termination of the flow/EDR:
|
||
sn-correlation-id |
This attribute reports the RADIUS correlation identifier. |
||
sn-direction |
This attribute reports the direction of the first packet for the flow. It has following values:
|
||
sn-duration |
This attribute reports the duration between the last and first packet for the record. |
||
sn-end-time [ format format ] localtime |
This attribute reports the timestamp for last packet of flow in UTC. |
||
sn-fa-correlation-id |
This attribute reports the RADIUS Correlation Identifier of the Foreign Agent (FA). |
||
sn-fa-ip-address |
This attribute reports IP address of the Foreign Agent (FA). |
||
sn-filler-blank |
This attribute inserts a blank filler field, generates an empty EDR field. |
||
sn-filler-zero |
This attribute inserts a "0" in the EDR field. |
||
sn-flow-end-time |
This attribute reports the time of flow-end EDR generation—when EDRs are generated at hagr, session-end, timeout, or normal-end-signaling conditions. sn-start-time and sn-end-time fields of flow end-condition EDRs cannot be used to determine the duration of the flow if intermediate EDRs are generated (rule-match or transaction-complete or any other intermediate EDR). sn-start-time field in an EDR gives the time the first packet was received after the last EDR was generated. So, whenever an EDR is generated, this field is reset to the time the EDR gets generated. So the sn-start-time field in flow end-condition EDRs may not have the time of the first packet received on that flow. It will have the time at which the last EDR was generated or the first packet time if no EDR was generated for that flow. sn-end-time field gives the time at which the last packet on the flow was received. Flow end-condition EDRs may not be generated immediately after receiving the last packet. For example, in case of session-end or timeout EDRs, last packet time and EDR generation time may be different. sn-flow-start-time gives the time of the first packet of the flow (irrespective of whether intermediate EDRs were generated), and sn-flow-end-time gives the time when EDRs are generated at hagr, session-end, timeout or normal-end-signaling conditions. The values of these fields will be populated in EDRs only for hagr, session-end, timeout and normal-end-signaling EDRs. |
||
sn-flow-id |
This attribute reports the flow-id assigned internally by the ECS module to each flow. |
||
sn-flow-start-time |
This attribute reports the time of the first packet of the flow (irrespective of whether intermediate EDRs were generated). Also see sn-flow-end-time . |
||
sn-format-name |
This attribute reports the name of the EDR/UDR format used. |
||
sn-group-id |
This attribute reports the sequence group ID of the record. |
||
sn-ha-ip-address |
This attribute reports IP address of the Home Agent (HA). |
||
sn-ip-pool-name |
This attribute reports the IP pool name corresponding to the current flow in EDR. |
||
sn-ip-protocol-name |
This attribute reports the IP protocol name for the flow. For IANA registered IP Protocol (Layer 4 Protocol) name, like TCP, UDP, AH, ESP, ICMP, etc. |
||
sn-nat-binding-timer |
For Network Address Translation (NAT) in-line service, this attribute reports the port chunk hold timer. |
||
sn-nat-gmt-offset |
For NAT in-line service, this attribute reports the GMT offset of the node generating NAT bind record. |
||
sn-nat-ip |
For NAT in-line service, this attribute reports the NAT IP address of the port chunk. |
||
sn-nat-last-activity-time-gmt |
For NAT in-line service, this attribute reports the time when the last flow in a specific NAT set of flows was seen. |
||
sn-nat-no-port-packet-dropped |
For NAT in-line service, this attribute reports the number of packets dropped because of no NAT IP/port. |
||
sn-nat-port-block-end |
For NAT in-line service, this attribute reports the last port number of the port chunk. |
||
sn-nat-port-block-start |
For NAT in-line service, this attribute reports the starting port number of the port chunk. |
||
sn-nat-port-chunk-alloc-dealloc-flag |
For NAT in-line service, this attribute reports whether the port chunk is allocated or released. |
||
sn-nat-port-chunk-alloc-time-gmt |
For NAT in-line service, this attribute reports when the port chunk was allocated. |
||
sn-nat-port-chunk-dealloc-time-gmt |
For NAT in-line service, this attribute reports when the port chunk was released. |
||
sn-nat-realm-name |
For NAT in-line service, this attribute reports the name of the NAT realm. |
||
sn-nat-subscribers-per-ip-address |
For NAT in-line service, this attribute reports the subscriber(s) per NAT IP address. |
||
sn-nemo-vrf-name |
This attribute indicates the VRF name associated with UE behind the Network Mobility Services (NEMO) Mobile Router (MR).
|
||
sn-ocs-server-reachable |
This attribute indicates the state of the OCS server. This attribute supports the following values:
|
||
sn-parent-protocol |
This attribute reports the parent protocol of the flow. An integer value like in sn-app-protocol ; for RTCP/RTP flows, the parent protocol may be RTSP or SIP; for GRE flows, the parent protocol will be PPTP, and so on. |
||
sn-port-service-name |
This attribute reports the registered name for the server port. For IANA registered/Well Known Transport Port name mapping for the Server Port like SSL, HTTP, DNS, FTP, TELNET, SSH, Diablo, Rainbox six, UnReal_UT etc. This port service name mapping is done based on the Server port, which means if the flow is "FromMobile", the sn-server-port is mapped as the service name port. If the flow is "ToMobile", the sn-subscriber-port is mapped as the service name. |
||
sn-rulebase |
This attribute reports the name of the ECS rulebase applied. |
||
sn-ruledef-name |
This attribute reports the ruledef name corresponding to the last charging action matched.
|
||
sn-rating-group |
This attribute reports the rating group corresponding to last charging action matched.
|
||
sn-sequence-no |
This attribute reports the unique sequence number (per sn-sequence-group and radius-nas-ip-address ) of EDR identifier and linearly increasing in EDR file. |
||
sn-server-port |
This attribute reports the TCP/UDP port number of the server in a subscriber's data flow. |
||
sn-service-id |
This attribute reports the Service ID corresponding to last charging action matched.
|
||
sn-st16-ip-addr |
This attribute reports the IP address of the chassis handling this flow.
|
||
sn-start-time [ format format ] localtime |
This attribute reports the timestamp for last packet of flow in UTC. |
||
sn-subscriber-imsi |
This attribute reports the IMSI number of the subscriber. |
||
sn-subscriber-nat-flow-ip |
For NAT in-line service, this attribute reports the NAT IP address of NAT-enabled subscriber. |
||
sn-subscriber-nat-flow-port |
For NAT in-line service, this attribute reports the NAT port number of NAT-enabled subscriber. |
||
sn-subscriber-port |
This attribute reports the TCP/UDP port number of the Mobile handling subscriber data flow. |
||
sn-volume-amt { ip | tcp } { bytes | pkts } { uplink | downlink } |
This attribute reports IP/TCP protocol-specific volume amount of downlink/uplink bytes/packets during a flow. This includes all the bytes/packets received by ECS, including the bytes/packets dropped and retransmitted by ECS. |
||
sn-volume-dropped-amt { ip | tcp } { bytes | packets } { downlink | uplink } |
For Stateful Firewall in-line service, this attribute reports IP/TCP protocol-specific volume amount of downlink/uplink bytes/packets dropped by Stateful Firewall during a flow. |
||
sn-volume-ip-with-rtsp-or-rtp bytes { downlink | priority | uplink } |
This attribute reports the IP volume amount of downlink/uplink bytes of an RTSP flow and the RTP flows controlled by it, or Comma Separated Value (CSV) position priority of this field. If uplink or downlink is not specified it shows the total of both. |
||
sn-vrf-name |
This attribute indicates the VRF name associated with the base session of NEMO.
|
||
subscriber-ipv4-address |
For NAT in-line service, this attribute generates the subscriber IPv4 address in the NBR. |
||
subscriber-ipv6-address |
For NAT in-line service, this attribute generates the subscriber IPv6 prefix in the NBR. |
||
transaction-charge-downlink-bytes |
This attribute reports the total charge downlink bytes for the transaction. Excludes the dropped/retransmitted bytes from the total transaction downlink bytes. |
||
transaction-charge-downlink-packets |
This attribute reports the total charge downlink packets for the transaction. Excludes the dropped/retransmitted packets from the total transaction downlink packets. |
||
transaction-charge-uplink-bytes |
This attribute reports the total charge uplink bytes for the transaction. Excludes the dropped/retransmitted bytes from the total transaction uplink bytes. |
||
transaction-charge-uplink-packets |
This attribute reports the total charge uplink packets for the transaction. Excludes the dropped/retransmitted packets from the total transaction uplink packets. |
||
transaction-downlink-bytes |
This attribute reports the total downlink bytes for the transaction. |
||
transaction-downlink-packets |
This attribute reports the total downlink packets for the transaction. |
||
transaction-uplink-bytes |
This attribute reports the total uplink bytes for the transaction. |
||
transaction-uplink-packets |
This attribute reports the total uplink packets for the transaction. |
format { MM/DD/YY-HH:MM:SS | MM/DD/YY-HH:MM:SS:sss | MM/DD/YYYY-HH:MM:SS | MM/DD/YYYY-HH:MM:SS:sss | YYYY/MM/DD-HH:MM:SS | MM/DD/YYYY-HH:MM:SS:sss | YYYYMMDDHHMMSS | YYYYMMDDHHMMSSsss | seconds
Specifies the timestamp format.
In releases prior to 18.0, the current timestamps available in the EDR format configuration allow recording of time information only up to seconds level. In 18.0 and later releases, new timestamp formats are added to allow recording of time information up to milliseconds granularity.
This feature enables to record timestamps of the events at finer granularity. The timestamps will be populated according to the selected timestamp format whenever any of the predefined events/event triggers for generating EDRs is encountered.
localtime
Specifies timestamps with the local time. By default, timestamps are displayed in GMT/UTC.
{ ip | tcp } { bytes | pkts } { downlink | uplink }
Specifies bytes/packets sent/received from/by mobile.
priority priority
Specifies the position priority of the value within the EDR record. Lower numbered priorities (across all attribute, event-label, and rule-variable) occur first.
priority must be an integer from 1 through 65535. Up to 50 position priorities (across all attribute, event-label, and rule-variable) can be configured.
Usage Guidelines
Use this command to set the attributes and priority for EDR file format.
A particular field in EDR format can be entered multiple times at different priorities. While removing the EDR field using the no attribute command either you can remove all occurrences of a particular field by specifying the field name or a single occurrence by additionally specifying the optional priority keyword.
In 21.1 and later releases, a maximum of 75 EDR attribute fields can be configured in an EDR record. The limit is expanded from 50 fields up to 75 fields.
Example
attribute radius-user-name priority 12