| Parameter |
Description |
Default Value |
|
|
ESS Installation Directory
|
Type the directory path
where you want the ESS to be installed. The default is the current
directory.
|
Current directory from where
the ESS installation script is executed.
|
IP Address for ESS installation
|
Type the IP address
of the local machine where the ESS application is installed.
IMPORTANT:
This IP address will
be used to lock a socket to avoid starting of similar ESS instances.
In case of stand alone installation this should be machine's IP
address and in case of cluster based installation this should be
Logical Host's IP address. Default is current machine's IP address.
|
IP address of the local machine where ESS
is installed
|
Base Directory Path for
Fetched Data
|
Type the base directory
path for the fetched data.
|
<less_install_dir>/ess/fetched_data
|
|
|
Type the directory path
for the log files.
|
Stand-alone mode: <less_install_dir>/ess/log
Cluster mode: When the ESS installation
is in shared path, the log files will be available at <shared_path>/LESS/log.
When the ESS installation
is in local path and the data files are on shared path, the log
files will be available at <shared_path>/LESS/lesslog_hostname.
|
Install init scripts [for standalone]
|
Use this option to
install init scripts for a standalone ESS installation. These scripts
are required if you want to start the ESS application after a system reboot.
Type (Y)es to create
the init script named less in
the /etc/init.d/ location.
|
|
|
|
|
|
If you want Process
Monitor (PSMON) alert messages automatically e-mailed to a specific
person, type the host name or IP address of a valid SMTP server.
Press ENTER for no
SMTP server and e-mail recipient.
|
|
|
|
Type the e-mail address
of the person who should receive the alert messages.
|
|
Miscellaneous Configuration
|
|
|
Type the maximum lifetime,
in days, after which the EDR/NBR/UDR files should
be deleted from the ESS base directory or local destinations. The
value must be an integer from 0 through 30.
When the parameter is
set to 0, the ESS will not delete any files.The ESS deletes the
file from base directory after it is pushed to all required destinations.
If the data record file is not pushed to a destination, it will
be kept in the base directory.
Also if files are not
getting deleted from local destination paths by the application
that is using them, files will keep on accumulating on these paths causing
unnecessary disk space utilization.
You can control lifetime
of the data records with the cleanup script. You must start the
cleanup script by providing path of ESS base directory. Refer to
the Using the Cleanup
Script section for more details.
IMPORTANT:
If you are configuring
the destination for a mediation device you may want to enable File expiry duration parameter
so that the files are deleted periodically to maintain the disk space.
On the other hand, if it is any other application (e.g. R-ESS) that takes
care of deleting the files after processing, it is advised that
the File expiry duration parameter
is not configured (leave its value as 0 i.e. default).
|
|
|
|
Type the value, in hours,
at which the ESS cleanup script should start deleting the older
files. This can be adjusted so that cleanup script does not cause
slowing down of ESS.The value must be an integer from 0 through
23.
IMPORTANT:
This parameter can be
configured only when the File expiry
duration parameter is set to a non-zero value.
|
|
The above mentioned
parameters are stored in a configuration file, generic_ess_config,
located at <less_install_dir>ess/template directory.
The ess process when started by PSMON will take the configuration
from this file. If you would like to change any of the existing
configuration, or set additional parameters, see the ESS Server Configuration section
in this guide.
|
ESS Installation Confirmation
|
|
|
Type (Y)es if you want
to make any modifications to the existing configuration.
|
|
Proceed with installation
|
Type (Y)es to proceed
with ESS installation.
|
|
The following prompt
appears when you proceed with the ESS installation:
[1]
Modify Common Configurations For Source/Destination
[2]
Add Source
[3]
Modify Source
[4]
Remove Source
[5]
Enable Source
[6]
Disable Source
[7]
Add Destination
[8]
Modify Destination
[9]
Remove Destination
[10] Enable
Destination
[11] Disable
Destination
[12] Miscelleneous
Configurations
[13] Show
All Config
[e]
Exit
Enter your choice according
to the configurations needed.
|
Common Config Parameters
for Source/Destination
|
Directory poll interval for source
|
Type the pull poll interval,
in seconds, for pulling the record files from chassis or host.
The value must be an
integer from 10 through 3600.
|
|
File name format for source
|
Select from the currently
available file formats for xDR files.
-
[1] FIELDSEP(_)_STR_RULEBASENAME_TIMESTAMP_RSTIND_SEQUENCENO(0,999999999)
-
[2] FIELDSEP(_)_STR_RULEBASENAME_TIMESTAMP_RSTIND_SEQUENCENO(0,999999999)_PSCNO
-
[3] FIELDSEP(_)_STR_RULEBASENAME_TIMESTAMP_SEQUENCENO(0,999999999)
-
[4] FIELDSEP(_)_STR-RULEBASENAME_STR_TIMESTAMP
-
[5] FIELDSEP(_)_STR_TIMESTAMP(MM_DD_YYYY+HH:MM:SS)_STR_STR(file)SEQUENCENO(1,4294967295).EXT
-
[6] FIELDSEP(_)_STR_TIMESTAMP(MM_DD_YYYY+HH:MM:SS)_STR_STR(file)SEQUENCENO(1,4294967295)
-
[7] FIELDSEP(_)_STR_TIMESTAMP(MM_DD_YYYY+HH:MM:SS)_STR_STR(file)SEQUENCENO(1,999999).EXT
-
[8] FIELDSEP(_)_STR_STR_TIMESTAMP(YYYYMMDDHHMMSS).EXT
In ESS 14.0 and later
releases:
In ESS 9.0 and earlier
releases:
IMPORTANT:
Modification in file
format requires restart of ESS.
You can also customize
your own format according to the file naming convention. |
|
|
|
Type (Y)es to
delete record files from source directory after fetching.
|
|
Report missed files from
remote source
|
Type (Y)es to activate
alarm when files are found missing while pulling them from chassis.
IMPORTANT:
This feature is to be
set to (Y)es only if file naming format contains sequence
number.
IMPORTANT:
Please
set this configuration to (N)o if cdr-multi-mode is
enabled at ASR5x00 as L-ESS might fail to uniquely identify sequence
of files and may not report the missing files appropriately.
IMPORTANT:
This particular alarm
generation can be enabled only if the deletion of EDR or UDR files
from remote host is enabled and the SNMP support is enabled.
|
|
Transient file prefix
for source
|
Type the transient file
prefix for source files. This is a customer specific unique text
prefix to distinguish the incomplete files from final files.
|
|
Transfer file prefix
for destination
|
Type the transfer file
prefix for destination files. This is a customer specific unique
text prefix to distinguish the incomplete files from final files.
|
|
|
|
If SNMP feature is enabled
and the number of total files to be fetched from source directory
is larger than this threshold number then alarm "starLESSThreshPendingFiles"
will be raised.
Alarms will be raised
even if the files to be pushed to destination directory is exceeding
the configured limit.
Clear alarm "starLESSThreshClearPendingFiles"
will be raised when number of total files to be fetched falls below
this threshold. The threshold value, 0 indicates do not enable this
threshold. Maximum value for this threshold is 1000 files.
|
|
Half cooked file detection threshold
|
Type the threshold value,
in hours, to avoid the unnecessary half cooked files being stored
under chassis’ base directory. If incomplete file older
than this threshold is found, then ESS removes the file.The value
must be an integer from 1 through 24.
|
|
|
|
Type the port number
used to create SFTP connection to remote host.
|
|
|
|
This value is used to
decide number of times ESS can try to set up connection to remote
host in case of connection failure.
|
|
Connection Retry Frequency
|
This is the time interval
after which ESS should reconsider connecting to remote host in case
connection creation has failed earlier even after retrying configured
number of times.
|
|
|
|
Use this parameter to
set the socket timeout value. This socket timeout is set for a socket
connection that is opened for SFTP between ESS and configured host or
remote destination. This is like a normal socket timeout which means
maximum time for which socket can remain idle. The default value
is 10 seconds.
|
|
Compressed/Decompressed required
|
This value indicates
if compression or decompression is required at the destination end
while sending the files. Possible values are c and d.
If it is c, it means
that every file received will be compressed before sending to destination,
unless it is already compressed. If the value is d, it means that
every file received will be decompressed before sending to destination
unless it is already decompressed.
|
|
|
|
Specify the number of
processes to be spawned for each source/destination.
|
|
Create hostname directory
|
Type (y)es to create
a directory with hostname while pushing the files to destination.
To have this feature enabled it is necessary that HostName parameter
has some value for given source.
|
|
|
|
|
|
Select (L)ocal or (R)emote
depending on the location of source.
|
|
|
|
Type the path for xDR
base directory on chassis or on local source. This is the base directory
on chassis from which ESS will pull xDR files.
|
|
Hostname for subdirectory
|
Type the host name of
subdirectory created at source side. This configuration is applicable
only for local source. In case of remote source, remote host name
is used to create directory.
|
|
|
|
Type the unique string
that is used to identify the xDR files to be included or excluded
based on filter list. If the filter string is provided, ESS will
pull/push files only with matching filter string.
For example, the include
filter list can be [MIP,OCS] and the exclude filter
list can be ![ACR,NBR].
|
|
Add destination for current source
|
Select this option if
you want to add destination to the currently configured source.
|
|
Detach destination for current source
|
Select this option if
you want to remove destination from the currently configured source.
|
|
Destination Configuration
|
|
|
Select (L)ocal or (R)emote
depending on the location of destination.
|
|
|
|
Type the destination
directory path at the destination side where xDR files are to be
stored. In cluster mode installation, this path should be shared
path.
|
|
Create subdirectory with hostname
|
Type (Y)es if you want
to create subdirectory with host name under destination base path.
|
|
Create subdir under hostname dir
|
Type (Y)es if you want
to create subdirectory under the host name directory if it exists.
|
|
|
|
Type the name of the
subdirectory being created.
|
|
How should files be sent
to destination? Compressed/Decompressed
|
Type (Y)es if file is
required in compressed format at the destination side.
If you type (Y)es, the file
will be compressed (if it is not previously compressed) and then
forwarded. If you type (N)o,
the file will be uncompressed (if previously compressed) and then
forwarded to destination.
|
|
|
|
Type the unique string
that is used to identify the xDR files to be included or excluded
based on filter list. If the filter string is provided, ESS will
pull/push files only with matching filter string.
For example, the include
filter list can be [MIP,OCS] and the exclude filter
list can be ![ACR,NBR].
|
|
File prefix while transfer
|
Type the file prefix
to be used while transferring the xDR files to the destination.
|
|
Miscellaneous Configuration
|
Start disk clean up based
on threshold
|
To enable the disk cleanup
based on the disk utilization threshold level, type (Y)es. This causes
the deletion of older files on disk crossing the threshold of the
Disk threshold 2 parameter until disk utilization drops below Disk threshold
1.
|
|
|
|
Type the first level
threshold value, in percentage, for monitoring disk usage. If disk
utilization goes beyond this threshold an alarm is raised indicating
that the disk is overutilized. The value must be an integer from
1 through 100.
|
|
|
|
Type the second level
threshold value, in percentage, for monitoring disk usage. If disk
utilization goes beyond this threshold an alarm is raised indicating that
the disk utilization has crossed the configured second level threshold.
This threshold is specifically to notify that disk is now critically
low. The value must be an integer from 1 through 100.
|
|
|
|
Type (Y)es to enable
the SNMP trap notifications.
|
|
|
|
Type the SNMP version
of the traps that should be generated by ESS. The currently supported
SNMP versions are v1 and v2c.
|
|
|
|
Type (Y)es to send alarms
to the primary SNMP host only.
When this option is
set to (Y)es, alarms
will be sent only to the SNMP host that is set as primary. When
this option is set to (N)o,
alarms will be sent to all the hosts even if a host is configured
as the primary SNMP host.
|
|
|
|
Type (Y)es to add another
SNMP Manager host.
IMPORTANT:
The maximum number of
SNMP Manager hosts that are allowed to be configured is four.
IMPORTANT:
The default values for
all the parameters except SNMP Manager Host Name will be taken from
previous host configuration for the new host.
|
|
|
|
Type (Y)es to remove
the currently configured SNMP Manager host.
|
|
|
|
This value specifies
the severity of log messages. The values can be one of the following:
|
|
|
|
|
|
Type the hostname or
IP address where the SNMP Manager resides.
|
|
|
|
Type the SNMP Manager
port number.
|
|
|
|
Type the community string
that should be used while sending the SNMP traps.
|
|
|
|
Type (Y)es to set the
current SNMP Manager host as the primary SNMP host.
IMPORTANT:
Only one SNMP host
can be set as the primary SNMP host.
|
|
Remote Host Configuration
|
Host Name or IP Address
of Starent Platform
|
To establish an SFTP
connection, type the hostname or IP address of the chassis.
IMPORTANT:
This parameter is
applicable only if the source or destination is at remote location.
|
|
|
|
Type the user name used
to log on to chassis.
IMPORTANT:
This parameter is
applicable only if the source or destination is at remote location.
|
|
|
|
Type the password used
to log on to chassis.
IMPORTANT:
This parameter is
applicable only if the source or destination is at remote location.
|
|