Command Line Interface Reference, Modes R - Z, StarOS Release 21.5

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents

Find Matches in This Book

Available Languages

Download Options

Book Title

Command Line Interface Reference, Modes R - Z, StarOS Release 21.5

Chapter Title

UDR Format Configuration Mode Commands

PDF - Complete Book (6.76 MB) PDF - This Chapter (1.33 MB)
View with Adobe Reader on a variety of devices

Results

Updated:: November 30, 2017

Chapter: UDR Format Configuration Mode Commands

attribute
do show
end
event-label
exit
rule-variable

UDR Format Configuration Mode Commands

The UDR Format Configuration Mode enables configuring User Detail Record (UDR) formats.

Mode

Exec > ACS Configuration > UDR Format Configuration

active-charging service service_name > udr-format format_name

Entering the above command sequence results in the following prompt:

[local]host_name(config-acs-udr)#

Important:

The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).

attribute
do show
end
event-label
exit
rule-variable

attribute

This command allows you to specify the fields and their order in UDRs.

Product

All

Privilege

Security Administrator, Administrator

Mode

Exec > ACS Configuration > UDR Format Configuration

active-charging service service_name > udr-format format_name

Entering the above command sequence results in the following prompt:

[local]host_name(config-acs-udr)#

Syntax

Syntax Description

attribute attribute { [ format { MM/DD/YY-HH:MM:SS | MM/DD/YYYY-HH:MM:SS | YYYY/MM/DD-HH:MM:SS | YYYYMMDDHHMMSS | seconds } [ localtime ] | [ { bytes | pkts } { downlink | uplink } ] ] priority priority }
no attribute attribute [ priority priority ]

no

If added previously, removes the specified attribute from the UDR format.

attribute attribute

Specifies the attribute.

attribute must be one of the following:

Attribute	Description
diameter-session-id	This attribute reports Diameter session identifier. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
failure-handling-mode	This attribute reports failure handling mode in case the Online Charging System (OCS) goes abnormal.
nemo-prefix-list	This attribute reports the VRF names associated with the base session of NEMO, and NEMO MR Prefixes. Important: This attribute is customer specific, and is available only with NEMO license.
num-nemo-prefix	This attribute reports the number of NEMO MR Prefixes. Important: This attribute is customer specific, and is available only with NEMO license.
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-bsid	This option has been deprecated. To configure this attribute see the rule-variable command.
sn-3gpp2-carrier-id	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-meid	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-acct-beginning-session	This attribute reports the Session Beginning information. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-acct-session-continue	This attribute reports the Session Continue information. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-acct-session-id	This attribute reports the Accounting Session identifier.
sn-acct-session-time	This attribute reports the duration from acct-status-type:start to acct-status-type:stop. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-acct-status-type	This attribute reports the Accounting Status identifier. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-charging-type	This attribute reports the charging type: offline or online. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-closure-reason	This attribute reports the reason for termination of the flow/UDR: 0 = CALL_TERMINATION — normal, such as subscriber session ended 1 = PDSN_HO — handoff control processing specified 2 = TIME_LIMIT 3 = VOLUME_LIMIT 4 = MGMT_INTERVENTION 5 = ACCT_SESS_START 6 = CCRU_RESPONSE 7 = OFFLINE_CHARGING — for UDRs generated when offline charging trigger is received from DCCA
sn-content-id	This attribute reports the unique identifier for the content-id.
sn-content-label	This attribute reports the identifier for text label for content-id.
sn-content-vol	This attribute reports the identifier for content volume.
sn-correlation-id	This attribute reports the RADIUS correlation identifier.
sn-duration	This attribute reports the time difference between the first and last packet of a single data flow accounted in the UDR record. For example, the time difference between the first ICMP echo request and the last ICMP echo response before the record gets written for the content-id.
sn-end-time [ format format]	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 FA.
sn-filler-blank	This attribute inserts a blank filler field, generates an empty UDR field.
sn-filler-zero	This attribute inserts a "0" in the UDR field.
sn-format-name	This attribute reports name of the UDR format used.
sn-group-id	This attribute reports the sequence group identifier for the records.
sn-ha-ip-address	This attribute reports IP address of the Home Agent (HA). Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-local-seq-no	This attribute reports unique local sequence number of UDR identifier per ACSMgr/SessMgr and linearly increasing in UDR file.
sn-ocs-ip-address	This attribute reports IP address of the Online Charging Server. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-rulebase	This attribute reports name of the ACS rulebase used.
sn-sequence-no	This attribute reports unique sequence number (per sn-sequence-group and radius-nas-ip-address) of UDR identifier and linearly increasing in UDR file.
sn-served-bsa-addr	This attribute reports address of Base Station Area being served.
sn-service-name	This attribute reports name of the ACS service.
sn-st16-ip-addr	This option has been deprecated. This attribute reports IP address of the chassis handling this flow. This attribute is interchangeable with radius-nas-ip-address for other systems.
sn-start-time [ format format ]	This attribute reports timestamp for first packet of flow in UTC.
sn-stream-number	This attribute reports unique UDR billing record identifier. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-subscriber-id	This attribute reports subscriber ID.
sn-subscriber-ipv4-address	This attribute reports the IPv4 address of the subscriber.
sn-subscriber-ipv6-address	This attribute reports the IPv6 address of the subscriber.
sn-subscriber-nat-flow-ip	This attribute reports NAT IP address(es) of NAT-enabled subscriber.
sn-timestamp	This attribute reports timestamp when the UDR is actually generated. Important: This attribute is customer specific, and is only available in 8.3 and later releases.
sn-vrf-name	This attribute indicates the VRF name associated with the base session of NEMO. Important: This is a customer-specific attribute.

format { MM/DD/YY-HH:MM:SS | MM/DD/YYYY-HH:MM:SS | YYYY/MM/DD-HH:MM:SS | YYYYMMDDHHMMSS | seconds }

Specifies the timestamp format.

localtime

Specifies the local time. By default, timestamps are displayed in Coordinated Universal Time (UTC).

{ bytes | pkts } { downlink | uplink }

Specifies bytes/packets sent/received from/by mobile.

priority priority

Specifies the position priority of the field within the UDR. 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 UDR file format.

A particular field in UDR format can be entered multiple times at different priorities. While removing the UDR field using the no attribute command, you can either remove all occurrences of a particular field by specifying the field name or remove a single occurrence by additionally specifying the optional priority keyword.

Consider the following scenario. If the volume/time threshold interval is large enough (or disabled). At time t=0, 10 ICMP packets are sent, which takes 9 seconds. There is nothing for the next 100 seconds, and then again 10 ICMP packets are sent which takes 10 seconds, and then again nothing for next the 60 seconds and then the session is terminated.

In this scenario:

sn-start-time should be t = 0.
sn-end-time should be t = 0+9+100+10 (sn-end-time would be the last ICMP packet sent).
sn-duration should be sn-end-time minus sn-start-time, i.e. 0+9+100+10 – 0 = 119 seconds (since the ICMP flow would exist between the two intervals of sending ICMP packets, the sn-start-time would be that of the first packet of the flow and sn-end-time of the last packet (20th packet). Hence, sn-duration would take into account all the seconds between the first and last packet of the flow).

Examples

The following is an example of this command:

attribute radius-user-name priority 12

do show

Executes all show commands while in Configuration mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

Syntax Description

do show

Usage Guidelines

Use this command to run all Exec mode show commands while in Configuration mode. It is not necessary to exit the Config mode to run a show command.

The pipe character | is only available if the command is valid in the Exec mode.

Caution

There are some Exec mode show commands which are too resource intensive to run from Config mode. These include: do show support collection, do show support details, do show support record and do show support summary. If there is a restriction on a specific show command, the following error message is displayed:

Failure: Cannot execute 'do	show support' command from Config mode.

end

Exits the current configuration mode and returns to the Exec mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

Syntax Description

end

Usage Guidelines

Use this command to return to the Exec mode.

event-label

This command allows you to specify an optional event label/identifier to be used as an attribute in the UDRs.

Product

All

Privilege

Security Administrator, Administrator

Mode

Exec > ACS Configuration > UDR Format Configuration

active-charging service service_name > udr-format format_name

Entering the above command sequence results in the following prompt:

[local]host_name(config-acs-udr)#

Syntax

Syntax Description

event-label event_label priority priority
no event-label

no

If previously configured, removes the event label configuration.

event_label

Specifies the event label/identifier to be used as UDR attribute.

event_label must be an alphanumeric string of 1 through 63 characters.

priority priority

Specifies the Comma Separated Value (CSV) position of the attribute (label/identifier) in the UDR.

priority must be an integer from 1 through 65535.

Usage Guidelines

Use this command to configure an optional event label/identifier as an attribute in the UDR and its position in the UDR.

Examples

The following is an example of this command:

event-label radius_csv1 priority 23

exit

Exits the current mode and returns to the parent configuration mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

Syntax Description

exit

Usage Guidelines

Use this command to return to the parent configuration mode.

rule-variable

This command allows you to specify fields and their order in UDRs.

Product

All

Privilege

Security Administrator, Administrator

Mode

Exec > ACS Configuration > UDR Format Configuration

active-charging service service_name > udr-format format_name

Entering the above command sequence results in the following prompt:

[local]host_name(config-acs-udr)#

Syntax

Syntax Description

rule-variable rule_variable priority priority
no rule-variable rule_variable [ priority priority ]

no

If previously configured, removes the specified rule variable configuration.

rule-variable rule_variable

Specifies the rule variable for the UDR format.

rule_variable must be one of the following options:

bearer 3gpp2: Bearer-related configuration:
- always-on
- bsid
- carrier-id
- esn
- ip-qos
- ip-technology
- meid
- release-indicator
- serv-MDN
- service-option
- session-begin
- session-continue

Important:

For more information on protocol-based rules see the ACS Ruledef Configuration Mode Commands chapter.

priority priority

Specifies the CSV position of the field (protocol rule) in the UDR.

priority must be an integer from 1 through 65535.

Usage Guidelines

Use this command to specify what field appears in which order in the UDR.

A particular field in UDR format can be entered multiple times at different priorities. While removing the UDR field using the no rule-variable command, you can either remove all occurrences of a particular field by specifying the field name, or remove a single occurrence by additionally specifying the optional priority keyword.

Examples

The following is an example of this command:

rule-variable bearer 3gpp2 bsid priority 36

Was this Document Helpful?

Feedback

Contact Cisco

Open a Support Case
(Requires a Cisco Service Contract)