> UDR Module Configuration Mode Commands
> To access the UDR Module Configuration Mode, in the Context Configuration Mode, enter the udr-module active-charging-service command.
> Important: The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).
> cdr
> This command configures the EDR/UDR file parameters.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> cdr [ push-interval value ] [ push-trigger space-usage-percent trigger_percentage ] [ remove-file-after-transfer ] [ transfer-mode { pull | push primary { encrypted-url enc_url | url url } [ via local-context ] [ secondary { encrypted-secondary-url enc_sec_url | url sec_url } ] } ] + | use-harddisk ]
> no cdr [ remove-file-after-transfer | use-harddisk ] +
> default cdr [ push-interval | push-trigger space-usage-percent | remove-file-after-transfer | transfer-mode [ push via ] | use-harddisk ] +
> no
> Disables the configured CDR storage and CDR file processing in this mode:

> • | remove-file-after-transfer: Retains a copy of the file even after it has been pushed or pulled to another server.

> • | use-harddisk: Disables data storage on the SMC harddisk.

> Important: use-harddisk keyword is available only on the ASR 5000 chassis.
> default
> Configures the default settings:

> • | push-interval: 300 seconds

> • | push-trigger: 80 percent

> • | remove-file-after-transfer: Disabled

> • | transfer mode: Pull

> • | push via: LC is used for push

> • | use-harddisk: Disabled

> Important: use-harddisk keyword is only available on ASR 5000 chassis.
> push-interval value
> Default: 300
> Specifies the transfer interval, in seconds, to push EDR and UDR files to an external file server.
> value must be an integer from 60 through 3600.
> push-trigger space-usage-percent trigger_percentage
> Default: 80%
> Specifies the EDR/UDR disk space utilization percentage, upon reaching which an automatic push is triggered and files are transferred to the configured external server.
> trigger_percentage specifies the EDR/UDR disk utilization percentage for triggering push, and must be an integer from 10 through 80.
> remove-file-after-transfer
> Default: Disabled
> Specifies that the system must delete EDR/UDR files after they are transferred to the external file server.
> transfer-mode { pull | push primary { encrypted-url enc_url | url url } [ via local-context ] [ secondary { encrypted-secondary-url enc_sec_url | secondary-url sec_url } ] }
> Specifies the EDR/UDR file transfer mode.

> • | pull: Specifies that the L-ESS is to pull the CDR files.

> • | push: Specifies that the system is to push CDR files to the configured L-ESS.

> • | primary encrypted-url enc_url: Specifies the primary URL location in encrypted format to which the system pushes the CDR files. enc_url must be the location name in an encrypted format, and must be an alpha and/or numeric string of 1 through 1024 characters in length.

> • | primary url url: Specifies the primary URL location to which the system pushes the CDR files. url must be an alpha and/or numeric string of 1 through 1024 characters in the //user:password@host:[port]/directory format.

> • | via local-context: Configuration to select LC/SPIO for transfer of CDRs. The system pushes the UDR files via SPIO in the local context.

> • | encrypted-secondary-url enc_sec_url: Specifies the secondary URL location in encrypted format to which the system pushes the CDR files when the primary location is unreachable or fails. enc_sec_url must be the location name in an encrypted format, and must be an alpha and/or numeric string of 1 through 1024 characters in length.

> • | secondary-url sec_url: Specifies the secondary URL location to which the system pushes the CDR files when the primary location is unreachable or fails. sec_url must be an alpha and/or numeric string of 1 through 1024 characters in //user:password@host:[port]/directory format.

> use-harddisk
> Default: Disabled
> Specifies that on ASR 5000 chassis the hard disk on the SMC be used to store EDR/UDR files. On configuring to use the hard disk for EDR/UDR storage, EDR/UDR files are transferred from RAMFS on the PSC to the hard disk on the SMC.
> Important: use-harddisk keyword is available only on the ASR 5000 chassis.
> +
> Indicates that more than one of the previous keywords can be entered within a single command.
> Usage
> Use this command to configure how charging data records (CDR) are moved and stored.
> On the ST16 chassis, run this command only from the context where the EDR/UDR module is configured. Running in any other context will fail and deliver an error message.
> On the ASR 5000 chassis, run this command only from the local context. Running in any other context would fail and deliver an error message.
> The use-harddisk keyword is only available on the ASR 5000 system. This command can be run only in a context where CDRMOD is running. Configuring in any other context will result in failure with the message “Failure: Please Check if CDRMOD is running in this context or not.”
> This config can be applied either in the EDR/UDR module, but will be applicable both to the EDR and UDR modules. Configuring in one of the modules prevents the configuration to be done in the other module.
> If PUSH transfer mode is selected, the L-ESS server URL to which the CDR files need to be transferred to must be specified. The configuration allows a primary and a secondary server to be configured. Configuring the secondary server is optional. Whenever a file transfer to the primary server fails for four consecutive times, the files will be transferred to the secondary server. The transfer will switch back to the original primary server when:

> • | Four consecutive transfer failures to the secondary server occur

> • | After switching from the primary server, 30 minutes elapses

> When changing transfer-mode from pull to push, disable the PULL from L-ESS and then change the transfer mode to push. Make sure that the push server URL configured is accessible from the local context. Also, make sure that the base directory that is mentioned contains udr directory created within it.
> When changing transfer-mode from push to pull, after changing, enable PULL on the L-ESS. Any of the ongoing PUSH activity will continue till all the scheduled file transfers are completed. If there is no PUSH activity going on at the time of this configuration change, all the PUSH related configuration is nullified immediately.
> Example
> The following command configures the system to retain a copy of the data file after it has been transferred to the storage location:
> no cdr remove-file-after-transfer
> end
> This command returns the CLI prompt to the Exec mode.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> end
> Usage
> Use this command to change to the Exec mode.
> exit
> This command exits the current mode and returns to the parent configuration mode.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> exit
> Usage
> Use this command to return to the parent configuration mode.
> file
> This command sets UDR file parameters.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> default file [ charging-service-name ] [ compression ] [ current-prefix ] [ delete-timeout ] [ directory ] [ field-separator ] [ file-sequence-number ] [ headers ] [ name ] [ reset-indicator ] [ rotation { num-records | time | volume } ] [ sequence-number ] [ storage-limit ] [ time-stamp ] [ trailing-text ] [ udr-seq-num ]
> default
> Using default file will reset some but not all keyword parameters to their default values. To ensure that the default is reset for a specific parameter, include the keyword in the default file syntax.
> charging-service-name { include | omit }
> Configures the inclusion and exclusion of charging service name in the file name.
> Default: include

> • | include: Sets this command to include the Charging service name in UDR file name.

> • | omit: Sets this command to exclude or omit the Charging service name from UDR file name.

> compression { gzip | none }
> Configures the compression of the UDR file.
> Default: none

> • | gzip: Enables GNU zip compression of the UDR file at approximately 10:1 ratio.

> • | none: Disables Gzip compression.

> current-prefix string
> Default: curr
> Specifies a string to add to the beginning of the UDR file that is currently being used to store UDR records. string must be an alpha and/or numeric string of 1 through 31 characters in length.
> delete-timeout seconds
> Default: Disabled
> Specifies a time period, in seconds, when completed UDR files are deleted. By default, files are never deleted. seconds must be an integer from 3600 through 31536000.
> directory dir_name
> Default: /records/udr
> Specifies a subdirectory in the default directory in which to store UDR files. dir_name must be an alpha and/or numeric string of 1 through 191 characters in length.
> exclude-checksum-record
> Default: Disabled, inserts checksum record into the UDR file header.
> When entered, this keyword excludes the final record containing #CHECKSUM followed by the 32-bit Cyclic redundancy check (CRC) of all preceding records from the UDR file.
> field-separator { hyphen | omit | underscore }
> Specifies the field separators between two fields of UDR file name.
> Default: underscore

> • | hyphen: specifies the field separator as ‘-’ (hyphen) symbol between two fields.

> • | omit: removes or omits the field separator between two fields.

> • | underscore: specifies the field separator as ‘_’ (underscore) symbol between two fields.

> file-sequence-number rulebase-seq-num
> Generates unique file sequence numbers for different rulebase-formatname combinations.
> headers
> Includes a file header summarizing the record layout.
> name file_name
> Default: udr
> Specifies a string to use as the base file name for UDR files.
> file_name must be an alpha and/or numeric string of 1 through 31 characters in length. The file name format is as follows:
> base_rulebase_format_sequencenum_timestamp

> • | base: Specifies type of record in file or contains the operator-specified string. Default is udr.

> • | rulebase: Specifies the name of the Rulebase. UDRs from different Rulebases go into different UDR files.

> • | format: Specifies the name of the UDR format if single-udr-format is specified else the format field (and the trailing underscore) is omitted from the file name.

> • | sequencenum: This is a 5-digit sequence number to detect the missing file sequence. It is unique among all UDR files on the system.

> • | timestamp: Contains a timestamp based on file creation time in UTC time in MMDDYYYYHHMMSS format.

> UDR files that have not been closed have a string added to the beginning of their file names.
> File name for a UDR file in CSV format that contains information for rule base named rulebase1 and a UDR schema named udr_schema1 appears as follows:
> udr_rulebase1_udr_schema1_00005_01302006143409
> If file name is not configured it creates files for EDRs/UDRs/FDRs (xDRs) having following name template with limits to 256 characters:
> basename_ChargSvcName_ timestamp_SeqNumResetIndicator_FileSeqNumber

> • | basename: A global-based configurable text string that is unique per system that uniquely identifies the global location of the system running ECS

> • | ChargSvcName: A system context-based configurable text string that uniquely identifies a specific context-based charging service

> • | timestamp: Date and time at the instance of file creation. Date and time in the form of “MMDDYYYYHHmmSS” where HH is a 24-hour value from 00-23

> • | SeqNumResetIndicator: A one byte counter used to discern the potential for duplicated FileSeqNumber with a range of 0 through 255 which is incremented by a value of 1 for the following conditions:

> • | Failure of an ECS software process on an individual PAC/PSC

> • | Failure of the system such that a second system takes over (for example, a standby or backup chassis put in place according to Inter-chassis Session Recovery)

> • | File Sequence Number (FileSeqNumber) rollover from 999999999 to 0

> • | FileSeqNumber: unique file sequence number for the file with 9 digit integer having range from 000000000 to 999999999. It is unique on each chassis system.

> File name for a closed xDR file in CSV format that contains information for ECS system xyz_city1 and charging service name preapaid2 with timestamp 12311969190000, and file sequence number counter reset indicator to 002 for file sequence number 034939002 appears as follows:
> xyz_city1_preapaid2_12311969190000_002_034939002
> File name for a running xDR file in CSV format that contains information for the same parameters for file sequence number 034939003 prefixed with curr_ and appears as follows:
> curr_xyz_city1_preapaid2_12311969190000_002_034939002
> reset-indicator
> This option includes the reset indicator counter value from 0 to 255 in UDR file name and is incremented (by one) whenever any of the following conditions occur:

> • | An ACSMgr process fails

> • | A peer chassis has taken over in compliance with our Inter-chassis Session Recovery feature

> • | The sequence number in sequence-number keyword has rolled over to zero

> rotation { num-records records | time seconds | volume bytes }
> Defaults: num-records: 1024
> time: 3600 seconds
> volume: 102400 bytes
> Specifies when to close a UDR file and create a new one.
> num-records records: Specifies the number of records that should be added to the file. When the number of records in the file reaches the specified value, the file is complete. records must be an integer from 100 through 10240.
> time seconds: Specifies the period of time to wait before closing the UDR file and creating a new one. seconds must be an integer from 30 through 86400.
> volume bytes: Specifies the maximum size of the UDR file before closing it and creating a new one. bytes must be an integer from 51200 through 62914560. Note: Higher sets may provide the best compression ratio when the compression keyword is set to gzip.
> sequence-number { length length | omit | padded | padded-six-length | unpadded }
> Default: padded
> Specifies including/excluding sequence number in the file name.

> • | length length: Includes the sequence number with the specified length. length must be the file sequence number length with preceding zeroes in the file name, and must be an integer from 1 through 9.

> Important: The length configuration is applicable in both EDR and UDR modules. When applied in both modules without the file udr-seq-num configuration, the minimum among the two values will come into effect for both the modules. With the file udr-seq-num config, each module will use its own value of length.

> • | omit: Excludes the sequence number from the file name.

> • | padded: Includes the padded sequence number with preceding zeros in the file name. This is the default setting.

> • | padded-six-length: Includes the padded sequence number with six preceding zeros in the file name.

> • | unpadded: Includes the unpadded sequence number in the file name.

> storage-limit limit
> Default: 33554432
> Specifies deleting files when the specified amount of space, in bytes, is used up for UDR/EDR file storage on the PSC/PACs RAM.
> On ST16 chassis, limit is an integer from 10485760 through 268435456.
> On ASR 5000 chassis, limit is an integer from 10485760 through 536870912.
> Important: On ST16 chassis, the total storage limit is 268435456 bytes (256 MB). This limit is for both UDR and EDR files combined.
> Important: On ASR 5000 chassis, the total storage limit is 536870912 bytes (512 MB). This limit is for both UDR and EDR files combined.
> time-stamp { expanded-format | rotated-format | unix-format }
> Specifies the timestamp of when the file was created be included in the file name.

> • | expanded-format: Specifies the UTC MMDDYYYYHHMMSS format.

> • | rotated-format: Specifies the YYYYMMDDHHMMSS format.

> • | unix-format: Specifies the UNIX format of x.y, where x is the number of seconds since 1/1/1970 and y is the fractional portion of the current second that has elapsed.

> trailing-text string
> Specifies the inclusion of arbitrary text string in the file name.
> string must be an alpha and/or numeric string of 1 through 30 characters in length.
> trap-on-file-delete
> Default: Disabled
> This keyword instructs the system to send an SNMP notification (trap) when an EDR/UDR file is deleted due to lack of space.
> udr-seq-num
> Default: Disabled
> Specifies that the file sequence numbers that are part of the UDR file names be independently generated. If disabled, a single set of sequence numbers are shared by both EDR files and UDRs.
> xor-final-record
> Default: Disabled
> Specifies inserting an xor checksum (in place of the CRC checksum) into the UDR file header if the exclude-checksum-record keyword is left at its default setting.
> +
> More than one of the previous keywords can be entered within a single command.
> Usage
> Use this command to configure UDR file characteristics.
> Example
> The following command sets the prefix of the current active UDR file to current:
> file current-prefix current
> The following command sets the base file name to UDRfile:
> file name UDRfile

Cisco Systems Inc.
Tel: 408-526-4000
Fax: 408-527-0883