This command allows
you to configure UDR file parameters.
Privilege:
Security Administrator,
Administrator
Syntax
file [ charging-service-name { include | omit } ] [ compression { gzip | none } ] [ current-prefix string ] [ delete-timeout seconds ] [ directory directory_name ] [ exclude-checksum-record ] [ field-separator { hyphen | omit | underscore } ] [ file-sequence-number
rulebase-seq-num ] [ headers ] [ name file_name ] [ reset-indicator ] [ rotation [ num-records number | time seconds | volume bytes ] ] [ sequence-number { length length | omit | padded | padded-six-length | unpadded } ] [ storage-limit limit ] [ time-stamp { expanded-format | rotated-format | unix-format } ] [ trailing-text string ] [ trap-on-file-delete ] [ udr-seq-num ] [ xor-final-record ] +
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
Configures the default
setting for the specified keyword(s). Using the default file command
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 corresponding keyword in the command.
charging-service-name { include | omit }
Specifies to include/exclude
name of the charging service in the file name.
- include:
Includes name of the charging service in the UDR file name.
- omit: Excludes
name of the charging service in the UDR file name.
Default: include
compression { gzip | none }
Configures gzip compression
of the UDR file.
- gzip: Enables
GNU zip compression of the UDR file at approximately 10:1 ratio.
- none: Disables
Gzip compression.
Default: none
current-prefix string
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 alphanumeric string of 1 through 31 characters.
Default: curr
delete-timeout seconds
Specifies a timeout
period (in seconds) when completed UDR files are deleted. By default, files
are never deleted.
seconds must
be an integer from 3600 through 31536000.
Default: Disabled
directory directory_name
Specifies a subdirectory
in the default directory in which to store UDR files.
directory_name must
be an alphanumeric string of 1 through 191 characters.
Default: /records/udr
exclude-checksum-record
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.
Default: Disabled,
inserts checksum record into the UDR file header.
field-separator { hyphen | omit | underscore }
Specifies the field
separators to be used between two fields of a UDR file name.
- hyphen:
Specifies to use ‘-’ (hyphen) as the field separator.
- omit: Excludes
the field separator.
- underscore:
Specifies to use ‘_’ (underscore) as
the field separator.
Default: underscore
file-sequence-number
rulebase-seq-num
Generates unique file
sequence numbers for different rulebase-format-name 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 alphanumeric string of 1 through 31 characters. 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: udr
- rulebase:
Specifies the name of the ACS 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 formatted
as: MMDDYYYYHHMMSS.
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 a rulebase named rulebase1 and
a UDR schema named udr_schema1 appears
as follows:
udr_rulebase1_udr_schema1_00005_01302006143409
If file name is not
configured, the system creates files for EDRs/UDRs/FDRs
(xDRs) using the 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 ACS.
- 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 format: “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 ACS
software process on an individual packet processing card
- 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 is a 9-digit integer from
000000000 through 999999999. It is unique on each chassis.
File name for a closed
xDR file in CSV format that contains information for ACS 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
IMPORTANT:
When the "rulebase name" and "edr-format-name"
options are enabled through this file command,
if the "field-separator" value is "underscore" (default value) then,
in the filename, the fields Rulebase name and EDR format name will
be separated by "hyphen". If the "field-separator" value is "hyphen"
then, in the filename, the fields Rulebase name and EDR format name will
be separated by "underscore". This will ensure that the number of
the fields in the filename is not increased and does not affect
the backend billing system.
reset-indicator
Specifies to include
the reset indicator counter value, from 0 to 255, in the UDR file
name and is incremented (by one) whenever any of the following conditions
occur:
- An ACSMgr/SessMgr
process fails.
- An Inter-chassis Session
Recovery (ICSR) peer chassis has transitioned from standby to active.
- The sequence number
in sequence-number keyword has rolled over to zero.
rotation { num-records records | time seconds | volume 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 this specified value,
the file is complete.records must
be an integer from 100 through 10240.Default: 1024
- 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.Default: 3600 seconds
- 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.Default: 102400 bytesNote that higher settings
may provide the best compression ratio when the compression keyword
is set to gzip.
sequence-number { length length | omit | padded | padded-six-length | unpadded }
Specifies including
or excluding the sequence number in the file name.
- length length: Includes
the sequence number with the specified length.length must
be the length of the file sequence number with preceding zeroes
in the file name, and must be an integer from 1 through 9.
IMPORTANT:
The length configuration
is applicable in both UDR and EDR 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 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.
Default: padded
storage-limit limit
Specifies deleting
files when the specified amount of space, in bytes, is used up for
UDR/EDR file storage on packet processing card RAM.
On an
ASR 5000 chassis,
limit must
be an integer from 10485760 through 536870912.
Default: 33554432
IMPORTANT:
On the 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 alphanumeric string of 1 through 30 characters.
trap-on-file-delete
Instructs the system
to send an SNMP notification (starCDRFileRemoved) when an UDR/EDR
file is deleted due to lack of space.
Default: Disabled
udr-seq-num
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 UDR and EDR files.
Default: Disabled
xor-final-record
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.
Default: Disabled
+
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