This command allows you to configure the HDD specific parameters.
Important:
This command is license dependent. For more information, contact
your Cisco account representative.
Privilege
Security Administrator, Administrator
Mode
Exec > Global Configuration > Context Configuration >
Diameter HDD Module Configuration
configure > context
context_name
> diameter-hdd-module
Entering the above command sequence results in the following prompt:
[context_name]host_name(config-diameter-hdd)#
Syntax
Syntax Description
diameter-event { purge { storage-limit storage_limit | time-limit time_limit } [ max-files max_records_to_purge ] | push-interval push_interval | push-trigger space-usage-percent trigger_percentage | remove-file-after-transfer | transfer-mode { pull [ module-only ] | push primary { encrypted-url encrypted_url | url url } [ [ max-files max_records ] [ max-tasks task_num ] [ module-only ] [ secondary { encrypted-secondary-url encrypted_secondary_url | secondary-url secondary_url } ] [ via local-context ] + ] | use-harddisk }
default diameter-event [ purge | push-interval | push-trigger space-usage-percent | remove-file-after-transfer | transfer-mode [ module-only | push via ] | use-harddisk ] +
no diameter-event [ purge | remove-file-after-transfer | use-harddisk ] +
default
Configures the default setting for the specified keyword(s):
-
purge: Disabled
-
push-interval: 300 seconds
-
push-trigger: 80 percent
-
remove-file-after-transfer: Disabled
-
transfer mode: Pull
-
push via: Line Card (LC) is used for
push
-
use-harddisk: Disabled
Important:
The
use-harddisk keyword is available only on
the ASR 5000 and ASR 5500 chassis.
no
If previously configured, disables the specified configuration:
-
purge: Disables purging of Diameter
records.
-
remove-file-after-transfer: Retains a
copy of the Diameter file even after it has been pushed or pulled to another
server.
-
use-harddisk: Disables data storage on
the ASR 5000 SMC hard disk or ASR 5500 hard disk array.
Important:
The
use-harddisk keyword is available only on
the ASR 5000 and ASR 5500 chassis.
purge { storage-limit
storage_limit
| time-limit
time_limit
} [ max-files
max_records_to_purge
]
Specifies to purge/delete the Diameter records based on "time" or
"volume" limit.
When the configured threshold limit is reached on the hard disk drive,
the records that are created dynamically in the
/mnt/hd-raid/data/records/
directory are automatically deleted. Files that are manually
created should be deleted manually.
-
storage-limit
storage_limit: Specifies
to start deleting files when the specified megabytes of space is used for
storage.
storage_limit specifies the volume limit
for the record files, in megabytes, and must be an integer from 10 through
143360.
-
time-limit
time_limit: Specifies to
start deleting files older than the specified time limit.
time_limit specifies the time limit for
the record files, and must be an integer from 600 through 2592000.
-
max-files
max_records_to_purge:
Specifies the maximum number of records to purge.
max_records_to_purge can be 0, or an
integer from 1000 through 10000. If the value is set to 0, during each cycle,
the records will be deleted until the purge condition is satisfied. If the
value is set between 1000 and 10000, during each cycle, the records will be
deleted until either the purge condition is satisfied or the number of records
deleted equals the configured
max-files value.
Default: 0
push-interval
push_interval
Specifies the transfer interval (in seconds) to push Diameter files to
an external file server.
push_interval must be an integer from 60
through 3600.
Default: 300
push-trigger space-usage-percent
trigger_percentage
Specifies the record 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 record disk
utilization percentage for triggering push, and must be an integer from 10
through 80.
Default: 80
remove-file-after-transfer
Specifies that the system must delete Diameter files after they are
transferred to the external file server. Default: Disabled
transfer-mode { pull
[ module-only ]
| push primary { encrypted-url
encrypted_url
| url
url
} [
[ max-files
max_records
]
[ max-tasks
task_num
]
[ module-only ]
[ secondary {
encrypted-secondary-url
encrypted_secondary_url
| secondary-url
secondary_url
} ]
[ via local-context ] + ]
Specifies the file transfer mode—how the Diameter files are
transferred to an external file server.
-
pull: Specifies that the external server
is to pull the Diameter files.
-
push: Specifies that the system is to
push Diameter files to the configured external server.
-
max-files
max_records: Specifies
the maximum number of files sent per iteration based on configured file size.
Default: 4000
-
max-tasks
task_num: Specifies the
maximum number of tasks (child processes) that will be spawned to push the
files to the remote server. The
task_num must be an integer from 4
through 8.
Default: 4
Important:
Note that increasing the number of child processes will improve
the record transfer rate. However, spawning more child will consume additional
resource. So, this option needs to be used with proper resource analysis.
-
module-only: Specifies that the
transfer-mode is only applicable to the HDD module. This enables to support
individual record transfer-mode configuration for each module.
-
primary encrypted-url
encrypted_url: Specifies
the primary URL location in encrypted format to which the system pushes the
Diameter files.
encrypted_url must be the location in an
encrypted format, and must be an alphanumeric string of 1 through 1024
characters.
-
primary url
url: Specifies the
primary URL location to which the system pushes the Diameter files.
url must be the location, and must be an
alphanumeric string of 1 through 1024 characters in the
"//user:password@host:[port]/directory" format.
-
secondary encrypted-secondary-url
encrypted_secondary_url:
Specifies the secondary URL location in encrypted format to which the system
pushes the Diameter files when the primary location is unreachable or fails.
encrypted_secondary_url must be the
secondary location in an encrypted format, and must be an alphanumeric string
of 1 through 1024 characters in the
"//user:password@host:[port]/directory" format.
-
secondary secondary-url
secondary_url: Specifies
the secondary location to which the system pushes the Diameter files when the
primary location is unreachable or fails.
secondary_url must be the secondary
location, and must be an alphanumeric 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 Diameter records. The system pushes the Diameter
files via SPIO in the local context.
use-harddisk
Important:
The
use-harddisk keyword is available only on
the ASR 5000 and ASR 5500 chassis.
ASR 5000: Specifies that on the ASR 5000 chassis the hard disk
on the SMC be used to store Diameter files. On configuring to use the hard disk
for Diameter record storage, Diameter files are transferred from packet
processing cards to the hard disk on the SMC. Default: Disabled
ASR 5500: Specifies that on the ASR 5500 chassis the hard disk
the FSC hard disk array be used to store Diameter files. On configuring to use
the hard disk for Diameter record storage, Diameter files are transferred from
DPCs to the hard disk array. Default: Disabled
+
Indicates that multiple keywords can be specified in a single command
entry. When the “+” appears in the syntax, any of the keywords that appear
prior to the “+” can be entered in any order.
Usage Guidelines
Use this command to configure how the Diameter records are moved and
stored.
On the ASR 5000 or ASR 5500 chassis, you must run this command only
from the local context. If you run this command in any other context it will
fail and result in an error message.
If PUSH transfer mode is configured, the external server URL to which
the Diameter 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 the transfer-mode from pull to push, disable the PULL
from the external server 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 the "diameter"
directory created within it.
When changing the transfer mode from push to pull, after changing,
enable PULL on the external server. 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.
The
use-harddisk command is available only on the
ASR 5000 and ASR 5500 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."
The
use-harddisk command is configured to store
EDR/UDR/EVENT/DIAMETER files. Configuring in one of the modules will prevent
the configuration to be applied in the other module. Any change to this
configuration must be done in the module in which it was configured, the change
will be applied to all the record types.
The VPNMgr can send a maximum of 4000 files to the remote server per
iteration. However if the individual file size is big (say when compression is
not enabled), then while transferring 4000 files SFTP operation takes a lot of
time. To prevent this, the
transfer-mode push command can be configured
with the keyword
max-files, which allows operators to
configure the maximum number of files sent per iteration based on configured
file size.
Limitations:
- When an ICSR event occurs unexpectedly before the CCR-T message is
written, the CCR-T will not written to the HDD and hence the usage will be
lost.
- It is expected that the customers requiring this feature should
monitor the HDD and periodically pull and delete the files so that the
subsequent records can be buffered.
Examples
The following command retains a copy of the Diameter file after it has
been transferred to the storage location:
no diameter-event remove-file-after-transfer