ESS Installation and Configuration

This chapter describes how to install and configure the ESS application on the ESS Server.

It consists of the following topics:

ESS Installation Modes

This section provides information on the different modes available for the installation of ESS application.

The ESS application can be installed in one of the following modes:
  • Stand-alone mode
  • Cluster mode

In the cluster mode, ESS provides high availability and critical redundancy support to retrieve xDRs in case of failure of any one of the systems. An ESS Veritas cluster comprises of two ESS systems, or nodes, that work together as a single, continuously available system to provide applications, system resources, and data to the ESS users. Each ESS node on the Veritas cluster is a fully functional, stand-alone system. However, in a Veritas clustered environment, the ESS nodes are connected by an interconnected network and work together as a single entity to provide increased data availability.

For more information on the Veritas cluster, refer to the Veritas Cluster Installation and Management chapter.

For stand-alone installation of ESS application, refer to the Installing ESS Application in Standalone Mode section. For cluster-based installation of ESS application, refer to the Installing ESS Application in Cluster Mode section.

Installing ESS Application in Stand-alone Mode

IMPORTANT:

The ESS application cannot be upgraded currently. Only complete re-installation is supported.

To install and configure the ESS application:

  1. Obtain the software archive file as directed by your designated sales or service contact.

    IMPORTANT:

    ESS supports both Solaris-Sparc and Solaris-x86 platforms. The installable tar file names help in identifying the platform. For example, L_ess_n_n_nn_solaris_sparc.zip indicates that this file is for Solaris-Sparc platform. L_ess_n_n_nn_solaris_x86.zip indicates that this file is for Solaris-x86 platform.

  2. Create a directory named ess on the system on which you want to run the ESS application.
  3. Change to the /ess directory and then enter the following command to unzip the software archive file:
    unzip L_ess_n_n_nn_solaris_n.zip
    
    The following files are extracted in the current working directory:
    • README: A text file that gives additional information on installation and configuration procedures for ESS and PSMON.
    • l_ess.tar: A tar archive that the installation script uses.
    • install_ess: A shell script that performs the ESS installation.
    • platform: A file that provides information on the platforms currently supported for ESS.
    • StarentLESS.tar: A tar file that contains the ESS cluster agent package.
    • less_pool.cfg: A configuration file to create ESS resource pool.
    • ess_sourcedest_config.cfg: A file to configure the source and destination parameters.
    • workload_division_T5220.sh: A shell script utility to allocate the CPU resource pools for workload division.
  4. Start the installation by entering the following command:
    ./install_ess [Option] [Config File Path]
    
    If no option is provided, the install script will proceed with the installation of ESS application without loading the source/destination config file, ess_sourcedest_config.cfg, present in the path where the tar ball is untarred. The option is -l used to validate and load the config file. If the validation is successful, the script will cause loading of config file parameters into a database. If it fails, the installation will proceed without loading the config file. If you want to load the source/destination configuration file after the installation is complete, use the lessConfigUtility.sh script. For more information on how to use this script, refer to the Source and Destination Configuration section in Configuring the ESS Server chapter.
  5. Follow the on-screen prompts to progress through the various installation dialogs and configure the parameters as required. Refer to the following table for descriptions of the configurable parameters on each of the installation dialogs.
    Parameter Description Default Value
    Primary Configuration
    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
    Log Directory Path
    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.
    n
    SMTP Configuration
    SMTP Server Name
    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.
    Null
    Email-ID [To ]
    Type the e-mail address of the person who should receive the alert messages.
    Null
    Miscellaneous Configuration
    File expiry duration
    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).

    0
    Local file deletion time
    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.

    0
    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
    Modify configuration
    Type (Y)es if you want to make any modifications to the existing configuration.
    No
    Proceed with installation
    Type (Y)es to proceed with ESS installation.
    Yes
    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.
    30
    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:
    • [9] STR
    • [10] ACR_FILEFORMAT
    In ESS 9.0 and earlier releases:
    • [9] ACR_FILEFORMAT

    IMPORTANT:

    Modification in file format requires restart of ESS.

    You can also customize your own format according to the file naming convention.
    1
    Delete files from source
    Type (Y)es to delete record files from source directory after fetching.
    y
    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.

    y
    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.
    curr_
    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.
    Null
    Pending file threshold
    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.
    0
    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.
    1
    Port
    Type the port number used to create SFTP connection to remote host.
    22
    Connection retry count
    This value is used to decide number of times ESS can try to set up connection to remote host in case of connection failure.
    3
    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.
    60
    Socket timeout value
    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.
    10
    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.
    c
    Process count
    Specify the number of processes to be spawned for each source/destination.
    1
    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.
    y
    Source Configuration
    Source Location
    Select (L)ocal or (R)emote depending on the location of source.
    Local
    Source directory
    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.
    Null
    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.
    Null
    Filter
    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].
    Null
    Add destination for current source
    Select this option if you want to add destination to the currently configured source.
    Null
    Detach destination for current source
    Select this option if you want to remove destination from the currently configured source.
    Null
    Destination Configuration
    Destination Location
    Select (L)ocal or (R)emote depending on the location of destination.
    Local
    Destination directory
    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.
    Null
    Create subdirectory with hostname
    Type (Y)es if you want to create subdirectory with host name under destination base path.
    y
    Create subdir under hostname dir
    Type (Y)es if you want to create subdirectory under the host name directory if it exists.
    y
    Subdirectory name
    Type the name of the subdirectory being created.
    data
    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.
    c
    Filter string
    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].
    Null
    File prefix while transfer
    Type the file prefix to be used while transferring the xDR files to the destination.
    Null
    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.
    y
    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.
    80
    Disk threshold 2
    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.
    98
    Enable SNMP
    Type (Y)es to enable the SNMP trap notifications.
    Yes
    SNMP Version
    Type the SNMP version of the traps that should be generated by ESS. The currently supported SNMP versions are v1 and v2c.
    v1
    Enable primary SNMP mode
    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.
    No
    Add 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.

    No
    Remove SNMP host
    Type (Y)es to remove the currently configured SNMP Manager host.
    No
    Log level
    This value specifies the severity of log messages. The values can be one of the following:
    • 0 - Disable all logs
    • 1 - Debug Level logs
    • 2 - Info Level logs
    • 3 - Warning Level logs
    • 4 - Error Level logs
    • 5 - Critical Level logs
    4
    SNMP Host Configuration
    SNMP host name
    Type the hostname or IP address where the SNMP Manager resides.
    Null
    SNMP port
    Type the SNMP Manager port number.
    162
    SNMP community string
    Type the community string that should be used while sending the SNMP traps.
    public
    Primary SNMP host
    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.

    No
    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.

    Null
    SFTP User Name
    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.

    Null
    SFTP Password
    Type the password used to log on to chassis.

    IMPORTANT:

    This parameter is applicable only if the source or destination is at remote location.

    Null


    The above mentioned parameters are stored in a database. These parameters can be added, removed or modified through the config utility, lessConfigUtility.sh, present in the /<less_install_dir>/ess directory. If you would like to change any of the existing configuration, or set additional parameters, see the ESS Server Configuration section in this guide. After providing the inputs for the parameters, the script extracts the l_ess.tar file and then installs the ESS application.

Installing ESS Application in Cluster Mode

This section describes the procedure for installing the ESS application on Sun/Veritas cluster node. For complete installation of the ESS application, you need to perform the installation process on both primary and secondary ESS nodes of the cluster.

To install and configure the ESS application in cluster mode:

IMPORTANT:

The ESS application cannot be upgraded currently. Only complete re-installation is supported.

  1. Obtain the software archive file as directed by your designated sales or service contact.
  2. Create a directory named ess on the system on which you want to run the ESS.
  3. Change to the /ess directory and then enter the following command to unzip the software archive file:
    unzip L_ess_n_n_nn_solaris_n.zip
    
    The following files are created in the current working directory:
    • README: A text file that gives additional information on installation and configuration procedures for ESS and PSMON.
    • l_ess.tar: A tar archive that the installation script uses.
    • install_ess: A shell script that performs the ESS installation.
    • platform: A file that provides information on the platforms currently supported for ESS.
    • ReleaseNotes: A file that summarizes the changes made specific to each version of the ESS application.
    • StarentLESS.tar: A tar file that contains the ESS cluster agent package.
  4. Start the installation on ESS node1 by entering the following command:
    ./install_ess [Option] [Config File Path]
    
    If no option is provided, the install script will proceed with the installation of ESS application without loading the source/destination config file, ess_sourcedest_config.cfg, present in the path where the tar ball is untarred. The option is -l used to validate and load the config file. If the validation is successful, the script will cause loading of config file parameters into a database. If it fails, the installation will proceed without loading the config file. If you want to load the source/destination configuration file after the installation is complete, use the lessConfigUtility.sh script. For more information on how to use this script, refer to the Source and Destination Configuration section in Configuring the ESS Server chapter.
  5. Follow the on-screen prompts to progress through the various installation dialogs and configure the parameters as required. Refer to the following table for descriptions of the configurable parameters on each of the installation dialogs.
    Parameter Description Default Value
    Cluster Mode Installation
    Cluster Mode Installation in cluster environment
    Type (Y)es to install the ESS application in cluster mode.

    IMPORTANT:

    The ESS application can be installed in cluster mode only when the script is used in cluster environment. The prompt message varies according to the cluster in which the ESS application is installed.

    Yes
    Shared directory for ESS data and log files
    Type the shared directory path where the ESS stores the fetched data and log files.
    /sharedless/less
    Primary Configuration
    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.
    Virtual IP address
    Type the required Virtual IP address for the ESS cluster.
    Null
    Logical host name
    Type the logical host name.

    IMPORTANT:

    This input is specific to Veritas cluster.

    Null
    SMTP Configuration
    SMTP Server Name
    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.
    Null
    Email-ID [To ]
    Type the e-mail address of the person who should receive the alert messages.
    Null
    Miscellaneous Configuration
    File expiry duration
    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 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).

    0
    Local file deletion time
    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.

    0
    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
    Modify configuration
    Type (Y)es if you want to make any modifications to the existing configuration.
    No
    Proceed with installation
    Type (Y)esto proceed with ESS installation.
    Yes
    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.
    30
    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:
    • [9] STR
    • [10] ACR_FILEFORMAT
    In ESS 9.0 and earlier releases:
    • [9] ACR_FILEFORMAT

    IMPORTANT:

    Modification in file format requires restart of ESS.

    You can also customize your own format according to the file naming convention.
    1
    Delete files from source
    Type (Y)es to delete record files from source directory after fetching.
    y
    Report missed files from remote source
    Type (Y)es to activate alarm when files are found missing while pulling them from the chassis.

    IMPORTANT:

    This feature is allowed only if file naming format contains sequence number.

    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.

    y
    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.
    curr_
    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.
    curr_
    Pending file threshold
    If number of total files to be fetched from source directory is larger than this threshold number then alarm "starLESSThreshPendingFiles" will be raised if SNMP feature is enabled.
    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.
    0
    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.
    1
    Port
    Type the port number used to create SFTP connection to remote host.
    22
    Connection retry count
    This value is used to decide number of times ESS can try to set up connection to remote host in case of connection failure.
    3
    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.
    60
    Socket timeout value
    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.
    10
    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.
    c
    Process count
    Specify the number of processes to be spawned for each source/destination.
    1
    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.
    y
    Source Configuration
    Source Location
    Select (L)ocal or (R)emote depending on the location of source.
    Local
    Source directory
    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.
    Null
    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.
    Null
    Filter
    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].
    Null
    Add destination for current source
    Select this option if you want to add destination to the currently configured source.
    Null
    Detach destination for current source
    Select this option if you want to remove destination from the currently configured source.
    Null
    Destination Configuration
    Destination Location
    Select (L)ocal or (R)emote depending on the location of destination.
    Local
    Destination directory
    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.
    Null
    Create subdirectory with hostname
    Type (Y)es if you want to create subdirectory with host name under destination base path.
    y
    Create subdir under hostname dir
    Type (Y)es if you want to create subdirectory under the host name directory if it exists.
    y
    Subdirectory name
    Type the name of the subdirectory being created.
    data
    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.
    c
    Filter string
    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].
    Null
    File prefix while transfer
    Type the file prefix to be used while transferring the xDR files to the destination.
    Null
    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.
    y
    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.
    80
    Disk threshold 2
    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.
    98
    Enable SNMP
    Type (Y)es to enable the SNMP trap notifications.
    Yes
    SNMP Version
    Type the SNMP version of the traps that should be generated by ESS. The currently supported SNMP versions are v1 and v2c.
    v1
    Enable primary SNMP mode
    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.
    No
    Add SNMP host
    Use this option to add SNMP Manager hosts.

    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.

    Null
    Remove SNMP host
    Use this option to remove the currently configured SNMP Manager hosts.

    IMPORTANT:

    This option will be available only if at least one SNMP Manager host is configured.

    Null
    Log level
    This value specifies the severity of log messages. The values can be one of the following:
    • 0 - Disable all logs
    • 1 - Debug Level logs
    • 2 - Info Level logs
    • 3 - Warning Level logs
    • 4 - Error Level logs
    • 5 - Critical Level logs
    4
    SNMP Host Configuration
    SNMP host name
    Type the hostname or IP address where the SNMP Manager resides.
    Null
    SNMP port
    Type the SNMP Manager port number.
    162
    SNMP community string
    Type the community string that should be used while sending the SNMP traps.
    public
    Primary SNMP host
    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.

    No
    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.

    Null
    SFTP User Name
    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.

    Null
    SFTP Password
    Type the password used to log on to chassis.

    IMPORTANT:

    This parameter is applicable only if the source or destination is at remote location.

    Null
    The above mentioned parameters are stored in a database. These parameters can be added, removed or modified through the config utility. If you would like to change any of the existing configuration, or set additional parameters, see the ESS Server Configuration section in this guide.


    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.
  6. After completion of ESS installation on node1, please perform switchover and then execute the ESS installation script on node2.
  7. Type (y)es to continue the installation. The script displays the configuration settings for node1. If you want to make changes to the existing configuration, modify the configuration as needed.
  8. If you do not want to make any changes to the configurations, type (y)es to continue the installation. After successful installation of ESS, verify the status of the ESS cluster resource group by entering the following command: For Veritas cluster:
    hastatus
    
    The system displays the status of various cluster nodes, elements and resources. The status of the nodes must be online as displayed below:
    ---------------- Cluster
    Nodes ----------------
    
    Node name          
                 Status
    
    ---------          
                 -------
    
    Cluster node: clustems2
             Online
    
    Cluster node: clustems1
             Online
    
    ---------------------------------------------------
    
    --------- Cluster Transport
    Paths --------- 
    
         Endpoint      
                                        Endpoint Status
    
    -----------------  
                                      ------------------
    
    Transport path: clustems2:bge3
    clustems1:bge3 Path         online
    
    Transport path: clustems2:bge2
    clustems1:bge2 Path         online
    
    ------------------------------------------------------------------
    
    -- Quorum Summary --
    
      Quorum votes possible:
         3
    
      Quorum votes needed:
           2
    
      Quorum votes present:
          3 
    
    -- Quorum Votes by Node
    --
    
    Node Name          
         Present  Possible   Status
    
    ------------       
         -------  --------   -------
    
    Node votes: clustems2
          1        1       Online
    
    Node votes: clustems1
          1        1       Online
    
    -- Quorum Votes by Device
    --
    
    Device Name        
                     Present  Possible   Status
    
    -----------        
                     -------  --------   -------
    
    Device votes: /dev/did/rdsk/d2s2
          1         1       Online
    
    ------------------------------------------------------------------
    
    -- Device Group Servers
    --
    
    Device Group       
    Primary             Secondary
    
    ------------       
    -------             ---------
    
     
    
    -- Device Group Status
    --
    
    Device Group       
    Status
    
    ------------       
    ------ 
    
    -- Multi-owner Device
    Groups --
    
    Device Group       
    Online Status
    
    ------------       
    -------------
    
    ------------------------------------------------------------------ 
    
    -- Resource Groups and
    Resources --
    
    Group Name         
             Resources
    
    ----------         
             ---------
    
    Resources: LESS-harg
         lessserver LESS-hars
    
     
    
    -- Resource Groups -- 
    
    Group Name         
     Node Name          State        Suspended
    
    ----------         
    ---------           -----        ---------
    
    Group: LESS-harg   
    clustems2           Offline        No
    
    Group: LESS-harg   
    clustems1           Online         No
    
     
    
    -- Resources --
    
    Resource Name      
        Node Name     State         Status Message
    
    --------------     
        ---------     -------       --------------
    
    Resource: LESS-hars
        clustems2     Offline        Offline
    
    Resource: LESS-hars
        clustems1     Online         Online
    
    ------------------------------------------------------------------
    

Uninstalling ESS Application

This section provides instructions on how to uninstall the ESS application.

IMPORTANT:

It is recommended that you manually perform a backup of all critical and historical data files before proceeding with this procedure. Uninstallation removes the directories, files and database. If backup is not taken, restoring the files would be an issue.

The following steps describe how to uninstall the ESS application:

  1. Change to the directory in which the ESS application is installed and execute the uninstall script by entering the following command:
    ./LessUninstall.sh
    

    IMPORTANT:

    Please note that the uninstall script gets created in the ESS installation directory upon installation of the ESS application.

  2. Type (y)es to continue the uninstall. The script stops the ESS server, Process Monitor application, and the ESS processes. When uninstallation is finished, the system displays a message to indicate successful uninstallation and removal of the directories.
  3. Remove shared directories/process manually if not removed during uninstallation.

Configuring PSMON Threshold (Optional)

PSMON is a Perl script that runs as a stand-alone program or as a fully functional background daemon. PSMON is capable of logging to a syslog and a log file with customizable e-mail notification facilities. You can define a set of rules in the psmon.cfg file. These rules describe what processes must always be running on the system. PSMON scans the UNIX process table and uses the set of rules to restart any dead processes.

The following are the files/package used by PSMON:
  • psmon: A perl script that handles monitoring processes and restarts them.
  • ess/template/psmon.cfg: A configuration file for PSMON. Contains process information and other information like e-mail id, smtp server, poll interval (or Frequency) and threshold parameters [MemoryUsed and SwapUsed, FinalDirPath and FinalDirThreshold].
  • ess/3rdparty/perl/linux/perl5.8.7.tar: Perl 5.8.7 used by PSMON for LINUX.
  • ess/3rdparty/perl/solaris/perl5.8.5.tar: Perl 5.8.5 used by PSMON for SOLARIS.
The PSMON utility monitors the following thresholds for the ESS application:
  • The percentage of total memory used (Default: 50%)
  • The percentage of swap space used (Default 50%)
  • The final directory size in percentage of the file system used (Default 10%)
  • The percentage of memory (Default: 10 %)
  • The percentage of CPU resources used. (Default: 10%)

When these thresholds are crossed, an alert message is sent to the administrator/user at E-mail ID specified during installation of ESS application. This alert message is also written to a log file, watchdog.log located in the <less_install_dir>/ess/log directory.

IMPORTANT:

The watchdog.log file will be generated by PSMON.

To edit the PSMON configuration file for changing the threshold monitoring values of PSMON:

  1. Change to the directory where the psmon.cfg is present by entering the following command:
    cd <less_install_dir>/ess/template
    
  2. Open the psmon.cfg in a standard text editor.
  3. Find the following lines:
    #THRESHOLDS
    for total memory used and total swap used in percentage (%).
    
    Default is 50 %
    
    MemoryUsed 50
    
    SwapUsed 50
    
  4. Change the values for MemoryUsed and SwapUsed to the desired percentages.

    IMPORTANT:

    The users are advised NOT to modify any parameters other than MemoryUsed and SwapUsed.

  5. Save and close the file.
  6. Stop and restart the PSMON process to implement these changes by using the procedures in Starting and Stopping ESS and Using the Maintenance Utility sections.