EDR Module Configuration Mode Commands


EDR Module Configuration Mode Commands
 
To access the EDR Module Configuration Mode, in the Context Configuration Mode, enter the edr-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 only available on an ASR 5000 chassis.
default
Configures the default settings:
push-interval: 300 seconds
push-trigger: 80 percent
push via: LC is used for push
use harddisk: Disabled
Important: use-harddisk keyword is available only on the 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—how the EDR and UDR files are transferred to an external file server.
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 EDR 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 only available on 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 the charging data records (CDR) are moved and stored.
Run this command on the ASR 5000 chassis only from the local context. Running this command in any other context will cause a failure and deliver an error message.
The use-harddisk keyword is only available on ASR 5000 chassis. 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:
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 retains 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 configures EDR file parameters.
Product
All
Privilege
Security Administrator, Administrator
Syntax
file [ charging-service-name { include | omit } ] [ compression { gzip | none } ] [ current-prefix string] [ delete-timeoutseconds] [ directorydir_name] [ edr-format-name ] [ exclude-checksum-record ] [ field-separator { hyphen | omit | underscore } ] [ file-sequence-number rulebase-seq-num ] [ headers ] [ namefile_name] [ reset-indicator ] [ rotation [ num-recordsnumber| timeseconds| volumebytes] ] [ sequence-number { length length| omit | padded | padded-six-length | unpadded } ] [ storage-limitlimit][ single-edr-format ][ time-stamp { expanded-format | rotated-format | unix-format } ] [ trailing-textstring] [ trap-on-file-delete ] [ xor-final-record ] +
default file [ charging-service-name ] [ compression ] [ current-prefix ] [ delete-timeout ] [ directory ] [ edr-format-name ] [ field-separator ] [ file-sequence-number ] [ headers ] [ name ] [ reset-indicator ] [ rotation { num-records | time | volume } ] [ sequence-number ] [ storage-limit ][ time-stamp ] [ trailing-text ] +
default
Sets the default configuration.
charging-service-name { include | omit }
Specifies the inclusion/exclusion of charging service name in the file name.
include: Sets this command to include the charging service name in EDR file name.
omit: Sets this command to exclude the charging service name in EDR file name.
compression { gzip | none }
Specifies compression of EDR files.
gzip: Enables GNU zip compression of the EDR 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 EDR file that is currently being used to store EDR 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 EDR files are deleted. By default, files are never deleted. seconds must be an integer from 3600 through 31536000.
directory dir_name
Default: /records/edr
Specifies a subdirectory in the default directory in which to store EDR files. dir_name must be an alpha and/or numeric string of 1 through 191 characters in length.
edr-format-name
Specifies creation of separate files for EDRs that have different formats. The EDR format name will be included in the file name.
exclude-checksum-record
Default: Disabled, inserts checksum record into the EDR 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 EDR file.
field-separator [ hyphen | omit | underscore ]
Specifies the field inclusion/exclusion type of separators between two fields of EDR file name.
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
Specifies that the file name sequence numbers be unique per rulebase and EDR format name combination.
headers
Includes a file header summarizing the record layout.
name file_name
Default: edr
Specifies a string to be used as the base file name for EDR 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
format: Specifies the name of the EDR format if single-edr-format is specified else the format field (and the trailing underscore) is omitted from the filename.
EDR files that have not been closed have a string added to the beginning of their filenames.
Filename for an EDR file in CSV format that contains information for rule base named rulebase1 and an EDR schema named edr_schema1 appears as follows:
edr_rulebase1_edr_schema1_00005_01302006143409
If the file name is not configured it will create files for EDRs/UDRs/FDRs (xDRs) with following template with limits to 256 characters:
basename_ChargSvcName_ timestamp_SeqNumResetIndicator_FileSeqNumber
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, not closed, 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
Specifies inclusion of the reset indicator counter value from 0 through 255 in EDR file name, and is incremented (by one) whenever any of the following conditions occur:
the sequence number, see sequence-number keyword, has rolled over to zero.
rotation { num-records number | time seconds | volume bytes }
Defaults: num-records: 1024
time: 3600 seconds
volume: 102400 bytes
Specifies when to close an EDR file and create a new one.
num-records number: 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. number must be an integer 100 through 10240.
time seconds: Specifies the period of time to wait before closing the EDR file and creating a new one. seconds must be an integer from 30 through 86400.
volume bytes: Specifies the maximum size of the EDR file before closing it and creating a new one. bytes must be an integer from 51200 to 62914560. (Note, a higher setting may improve the 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.
single-edr-format
Default: Disabled
Creates separate files for EDRs having different formats.
storage-limit limit
Default: 33554432
Specifies deleting files when the specified amount of space, in bytes, is used up for EDR/UDR file storage on the PSC’s RAM.
On an ASR 5000 chassis, limit must be an integer from 10485760 through 536870912.
Important: On an 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 time stamp format to 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.
xor-final-record
Default: Disabled
Specifies inserting an xor checksum (in place of the CRC checksum) into the EDR file header if the exclude-checksum-record 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 EDR file characteristics.
Example
The following command sets the prefix of the current active EDR file to Current:
file current-prefix Current
The following command sets the base file name to EDRfile:
file name EDRfile
 
 

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