Configuring the ESS Server

This chapter includes the following topics:

ESS Server Configuration

This section provides information about the ESS configuration file parameters. ESS server configuration file, generic_ess_config, can be modified to fine-tune the operation of the application. This file is located in the <less_install_dir>/ess/template directory by default.

There are a few parameters that the installation script does not prompt for. These are available in the generic_ess_config file. The following table lists the ESS server configuration parameters and the corresponding descriptions.

IMPORTANT:

Any change in the generic_ess_config file requires ESS server restart.


Table 1. ESS Server Configuration Parameters
Parameter Description Default Value

ASR 5x00 Parameters

essdellocalrecordsexpirytime

This specifies the time period (in days) for which files can be stored locally in ESS.

0

essdellocalrecordsstarttime

This specifies the time period (in hours) at which ESS should start deleting local files stored in final directory depending on the expiry time configured. This value must be an integer from 0 through 23.

0

essbasedirectorypath

This specifies the ESS specific base directory path.

<less_install_dir>/ess/fetched_data

Miscellaneous Parameters

logPath

This specifies the directory path where ESS stores the ESS logs.

<less_install_dir>/ess/log

resetfilecontent

If this flag is enabled, ESS pull instance on start/restart empties the file containing the entry of the last xDR file fetched from the chassis.

The ESS assumes that this is a fresh start and will refetch all the files from chassis if ESS is configured not to delete files from chassis. This parameter is also used to reset the information maintained for identifying missing files.

If this flag is set, each time when ESS instance restarts ESS will also ignore the past information about missing file identification and the file contents will be reset.

No

maxinfotimestampdiff

ESS uses this configurable to test whether ESS on startup is referring to old information about missing files. The configured value indicates the maximum allowed difference between the current time stamp and the timestamp at which information for identifying missing files was written.

If the difference exceeds, ESS will assume fresh restart and will restart identifying missing files ignoring previous information.

Minimum value allowed is 30 minutes and maximum allowed is 1440 minutes (24 hours). Default is 60 minutes.

60

ServerIpAddress

This specifies the IP address that is used by ESS to create TCP socket. In case of stand alone installation this should be the 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.

N/A

ServerPort

This port is used when creating TCP sockets to avoid starting of similar ESS instances on the same ESS machine. The default value for this parameter is 22222. The limit is within 1025 to 65535.

IMPORTANT:

Do not change this port unless it is absolutely required.

22222



Source and Destination Configuration

This section provides information about the source and destination configuration file parameters. The source and destination configuration file, ess_sourcedest_config, is located in the directory where the installable tar file is extracted.

This config file can be loaded to a database using a config utility called lessConfigUtility.sh. This script can also be used to add/remove/modify the configuration for particular source/destination, and other miscellaneous configurations like changing config parameters and adding/removing/modifying SNMP host.

The config file based configuration is provided to load source/destination config in bulk. Please note the following points:
  • Common configuration parameters will be applied to all source/destination configured through the config file.
  • If any parameter is changed from particular source/destination configuration block then changed value will be applied to source/destination instead of the value from common config.
  • Destination can be configured from "common local destination block" / "common remote destination block" / "destination block per source".
  • If the source block is having corresponding destination configuration then same configuration will be used for destination.
  • If the source does not have corresponding destination configuration then configuration from “common local destination block"/ "common remote destination block" will be used depending on the location (R - Remote / L - Local) value.
  • Source-Destination mapping
    • Source Path1,Filter1 mapped to Destination Path1,subdirectory1,Filter1
    • Source Path2,Filter2 mapped to Destination Path2,subdirectory2,Filter2
    • Source Path5,Filter5 mapped to Destination Path5,subdirectory5,Filter5
To load the source/destination config file after the ESS installation is complete:
  1. Modify the source/destination config file template as per the requirements.
  2. Use the config utility present in the <less_install_dir>/ess directory to validate and load the config file.
    ./lessConfigUtility.sh [Options] [Config File Path]
    The [Config File Path] is the path where the config file is present.

Options

Description

-l

Load the config file.

-v

Validate the config file.

-c

Clean all configurations.

-p

Print all configurations.

-h

Display help.




Table 2. Source and Destination Configuration Parameters
Parameter Description Default Value

Common Parameters

DirectoryPollInterval

This specifies the poll interval in seconds for pulling the xDR records from ASR 5x00 platform. The value must be an integer from 30 through 3600.

30

fileformat

This specifies the file format for xDR file naming convention.
  • [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

DeleteFilesFromSource

If this flag is enabled this will cause deleting data records from the source directory after fetching. The possible values are:
  • y – enable
  • n – disable

y

ReportMissedFiles

If this flag is enabled, SNMP notification will be sent when files are found missing while pulling them from the chassis. The possible values are:
  • y – enable
  • n – disable

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 xDR files from remote host is enabled and the SNMP support is enabled.

y

TransientPrefix

This specifies the transient File Prefix for source files. This is a customer specific unique text prefix to distinguish the incomplete files from final files.

curr_

TransferPrefix

This specifies the transient File Prefix for destination files. This is a customer specific unique text prefix to distinguish the incomplete files from final files.

curr_

PendingFileThreshold

If the 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.

Clear alarm "starLESSThreshClearPendingFiles" will be raised when the 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

HalfCookedDetectionThreshold

Type the threshold value, in hours, to avoid the unnecessary half cooked files being stored under the 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

SFTPPort

Type the port number used to create SFTP connection to remote host.

22

ConnectionRetryCount

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

ConnectionRetryFrequency

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

SocketTimeout

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

CompressionDecompressionAtDestination

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

ProcessCount

Specify the number of processes to be spawned for each source/destination.

1

CreateHostNameDir

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

Common Local Destination Parameters

Path

Type the path for xDR base directory on chassis or on local source. This is the base directory on the chassis from which ESS will pull xDR files.

Null

Subdirectory

Type the name of the subdirectory being created under destination base path.

Filter

Type the unique string that is used to identify the xDR files. If filter string is provided, ESS will pull files only with matching filter string.

Filter is the string based on which the files are to be moved to appropriate directory. If a filter is specified for certain type of record, it is must to specify for other types of records as well. Otherwise, files for that record type will not be moved to any destination.

Null

Common Remote Destination Parameters

HostName

Type the host name for the remote destination.

Null

RemoteHostUserName

Type the host user name for the remote destination.

Null

RemoteHostPassword

Type the password used for the remote destination.

Null

Path

Type the path for xDR base directory on chassis or on local source. This is the base directory on the chassis from which ESS will pull xDR files.

Null

Subdirectory

Type the name of the subdirectory being created under destination base path.

Filter

Type the unique string that is used to identify the xDR files. If the filter string is provided, ESS will pull files only with matching filter string.

Filter is the string based on which the files are to be moved to appropriate directory. If a filter is specified for certain type of record, it is must to specify for other types of records as well. Otherwise, files for that record type will not be moved to any destination.

Null

Source Parameters

Location - This can be L or R i.e. Local or Remote respectively. Rest of the parameters are common to Common Parameters list.

Destination Parameters

These are similar to the source parameters and the above list of common parameters.



Starting and Stopping ESS

To start the ESS Server, enter the following command from <less_install_dir>/ess directory:

./serv start

IMPORTANT:

After ESS is started, only the user who started ESS can restart, stop, or check the status of active ESS using serv script. Even a superuser is not permitted to stop the ESS although it is started by non-superuser.

To stop the ESS Server enter the following command from <less_install_dir>/ess directory:

./serv stop

For additional information on the serv commands, refer to the Using the Maintenance Utility section in the ESS Maintenance and Troubleshooting chapter.

Restarting LESS

L-ESS can be restarted using any of the following procedures:

Using Veritas Cluster Server

The following procedure is the preferred way of restarting the L-ESS when it is installed with Veritas:

  1. Find the Veritas Group configured for LESS. If L-ESS installation guide is followed, the configured Veritas Group should be less-ha. Otherwise, use the following command:
    root@pnclustless1 # hagrp
    -list
    
    less-ha            pnclustless1
    
    less-ha            pnclustless2
    
  2. Find the resource configured for L-ESS Application. Usually, it is configured to be less-app. It can be confirmed using the following command:
    root@pnclustless1 # hagrp
    -resources less-ha
    
    less-apps-dg
    
    less-apps-vol
    
    less-apps-mnt
    
    less-app
    
    less-nic
    
    less-ip
    
  3. Check the current status of Veritas.
    root@pnclustless1 # hastatus
    
    attempting to connect
    ....
    
    attempting to connect
    ....connected
    
        group           resource             system               message             
    
        ---------------
    -------------------- -------------------- --------------------
    
                                             pnclustless1         RUNNING             
    
                                             pnclustless2         RUNNING             
    
        less-ha                              pnclustless1         OFFLINE             
    
        less-ha                              pnclustless2        ONLINE              
    
        -------------------------------------------------------------------------
    
                        less-apps-dg         pnclustless1         OFFLINE             
    
                        less-apps-dg         pnclustless2        ONLINE              
    
                        less-apps-vol        pnclustless1         OFFLINE             
    
                        less-apps-vol        pnclustless2        ONLINE              
    
                        less-apps-mnt        pnclustless1         OFFLINE             
    
        -------------------------------------------------------------------------
    
                        less-apps-mnt        pnclustless2        ONLINE              
    
                        less-app             pnclustless1         OFFLINE             
    
                        less-app             pnclustless2        ONLINE              
    
                        less-nic             pnclustless1        ONLINE              
    
                        less-nic             pnclustless2        ONLINE              
    
        -------------------------------------------------------------------------
    
                        less-ip              pnclustless1         OFFLINE             
    
                        less-ip              pnclustless2        ONLINE    
    
    Currently, less-app is online on pnclustless2
  4. Bring this resource, less-app, offline by using the following command:
    root@pnclustless1 # hares
    -offline less-app -sys pnclustless2
    
    Now, the status of Veritas will change. The less-app will be offline on both the nodes.
    root@pnclustless1 # hastatus
    
    attempting to connect....
    
    attempting to connect....connected
    
        group           resource             system               message             
    
        ---------------
    -------------------- -------------------- --------------------
    
                                             pnclustless1         RUNNING             
    
                                             pnclustless2         RUNNING             
    
        less-ha                              pnclustless1         OFFLINE             
    
      less-ha                              pnclustless2        PARTIAL              
    
        -------------------------------------------------------------------------
    
                        less-apps-dg         pnclustless1         OFFLINE             
    
                        less-apps-dg         pnclustless2        ONLINE              
    
                        less-apps-vol        pnclustless1         OFFLINE             
    
                        less-apps-vol        pnclustless2        ONLINE              
    
                        less-apps-mnt        pnclustless1         OFFLINE             
    
        -------------------------------------------------------------------------
    
                        less-apps-mnt        pnclustless2        ONLINE              
    
                        less-app             pnclustless1         OFFLINE             
    
                        less-app             pnclustless2         OFFLINE             
    
                        less-nic             pnclustless1        ONLINE              
    
                        less-nic             pnclustless2        ONLINE              
    
        -------------------------------------------------------------------------
    
                        less-ip              pnclustless1         OFFLINE             
    
                        less-ip              pnclustless2        ONLINE    
    
    This can be confirmed by checking the status of L-ESS:
    root@pnclustless2# <less_install_dir>/ess/serv status
    
    PID    Process                                         
      Status
    
    ----------------------------------------------------------------
    
        -  PS
    Monitor Application                  Not running
    
        -  Local
    External Storage Server           Not running
    
  5. Now bring the resource online using the following command. Status of less-app will change to online.
    root@pnclustless1 # hares
    -online less-app -sys pnclustless2
    
  6. Confirm it using hastatus and see if less-ha and less-app are online on pnclustless2.
    root@pnclustless1 # hastatus
    
    attempting to connect
    ....
    
    attempting to connect
    ....connected
    
        group           resource             system               message             
    
        ---------------
    -------------------- -------------------- --------------------
    
                                             pnclustless1         RUNNING             
    
                                             pnclustless2         RUNNING             
    
        less-ha                              pnclustless1         OFFLINE             
    
        less-ha                              pnclustless2        ONLINE              
    
        -------------------------------------------------------------------------
    
                        less-apps-dg         pnclustless1         OFFLINE             
    
                        less-apps-dg         pnclustless2        ONLINE              
    
                        less-apps-vol        pnclustless1         OFFLINE             
    
                        less-apps-vol        pnclustless2        ONLINE              
    
                        less-apps-mnt        pnclustless1         OFFLINE             
    
        -------------------------------------------------------------------------
    
                        less-apps-mnt        pnclustless2        ONLINE              
    
                        less-app             pnclustless1         OFFLINE             
    
                        less-app             pnclustless2        ONLINE              
    
                        less-nic             pnclustless1        ONLINE              
    
                        less-nic             pnclustless2        ONLINE              
    
        -------------------------------------------------------------------------
    
                        less-ip              pnclustless1         OFFLINE             
    
                        less-ip              pnclustless2        ONLINE    
    
  7. Re-confirm it using:
    root@pnclustless2# <less_install_dir>/ess/serv status
    
    PID    Process                                         
      Status
    
    ----------------------------------------------------------------
    
    17151  PS
    Monitor Application                 Running
    
    17187  Local
    External Storage Server          Running
    

Using serv script

Another way for restarting L-ESS is to use “serv” script bundled with L-ESS. This is not the recommended way of restarting L-ESS on a Veritas Cluster.

IMPORTANT:

It should only be used in a single node installation. Using this on a cluster installation may lead to node switchover and may show a node to be faulted. However, it will not cause any loss of billing files.

Enter the following commands from <less_install_dir>/ess directory:

  1. Check the current status of L-ESS.
    root@pnclustless2# ./serv
    status
    
    PID    Process                                         
      Status
    
    ----------------------------------------------------------------
    
    17780  PS
    Monitor Application                 Running
    
    17812  Local
    External Storage Server          Running
    
  2. Stop L-ESS.
    root@pnclustless2# ./serv
    stop
    
    Stopping L-ESS. Please
    wait...
    
    Stopping PS Monitor
    Application...
    
    Stopping Local External
    Storage Server...
    
    Checking if all L-ESS
    processes have been stopped...
    
    Some L-ESS processes
    are still running.
    
    Checking if all L-ESS
    processes have been stopped...
    
    Some L-ESS processes
    are still running.
    
    Checking if all L-ESS
    processes have been stopped...
    
    Some L-ESS processes
    are still running.
    
    Checking if all L-ESS
    processes have been stopped...
    
    Local External Storage
    Server is stopped.
    
  3. Start L-ESS
    root@pnclustless2# ./serv
    start
    
    
    
    
    Please Wait ...
    
    Starting L-ESS. Please
    wait...
    
    checking if L-ESS is
    started succesfully...
    
    checking if L-ESS is
    started succesfully...
    
    Local ESS Storage Server
    started.
    
    
    
    
    Capturing status, please
    wait for a while...
    
    
    
    
    =============================================================
    
        0
    18345 12:32:23  TS  59      00:01 /export/home/LESS-HJ/less/less/ess/3rdparty/python/solaris//bin/python /export/      1
    
        0
    18359 12:32:23  TS  59      00:00 /export/home/LESS-HJ/less/less/ess/3rdparty/python/solaris//bin/python /export/  18345
    
        0
    18338 12:32:20  TS  59      00:00 /export/home/LESS-HJ/less/less/ess/3rdparty/perl/solaris//bin/perl
    -w /export/h      1
    
    =============================================================
    
  4. If there is a problem in stopping, use the following command to restart the server.
    root@pnclustless2# ./serv forcestart
    
    Restarting L-ESS. Please
    wait...
    
    Trying to stop already
    running L-ESS...
    
    Stopping PS Monitor
    Application...
    
    Stopping Local External
    Storage Server...
    
    Checking if all L-ESS
    processes have been stopped...
    
    Some L-ESS processes
    are still running.
    
    Checking if all L-ESS
    processes have been stopped...
    
    Some L-ESS processes
    are still running.
    
    Checking if all L-ESS
    processes have been stopped...
    
    Some L-ESS processes
    are still running.
    
    Checking if all L-ESS
    processes have been stopped...
    
    Some L-ESS processes
    are still running.
    
    Checking if all L-ESS
    processes have been stopped...
    
    Some L-ESS processes
    are still running.
    
    Checking if all L-ESS
    processes have been stopped...
    
    Local External Storage
    Server is stopped.
    
    Starting L-ESS...
    
    checking if L-ESS is
    started succesfully...
    
    checking if L-ESS is
    started succesfully...
    
    Local ESS Storage Server
    started.
    
    
    
    
    Capturing status, please
    wait for a while...
    
    
    
    
    =============================================================
    
        0
    18657 12:33:01  TS  59      00:00 /export/home/LESS-HJ/less/less/ess/3rdparty/python/solaris//bin/python /export/  18656
    
        0
    18636 12:32:58  TS  59      00:00 /export/home/LESS-HJ/less/less/ess/3rdparty/perl/solaris//bin/perl
    -w /export/h      1
    
        0
    18656 12:33:01  TS  59      00:01 /export/home/LESS-HJ/less/less/ess/3rdparty/python/solaris//bin/python /export       1
    
    =============================================================