Configuring NE Log Collection

Use this procedure to configure network element log collection.

The PSM server can retrieve NE logs on a collection schedule as well as on demand. To retrieve logs, PSM logs in to the NE or router and transfers the specified log file from the NE or router to the PSM server machine using FTP. PSM then parses and stores the logs into its database and makes the logs available for the user to query. Once the logs are in the database, the retrieved log file is no longer needed and is removed automatically. For information on how to view NE logs, see the proNX Service Manager User Guide.

1. Log in to the PSM server machine and open the /var/local/ems9001/conf/override-common.properties file. Note

   The /var/local/ems9001/conf/override-common.properties file contains many settings that affect the behavior of the PSM server. Only those attributes explicitly described in this guide should be changed. Changing any other attributes may have unintended consequences and must only be performed under the guidance of Juniper Networks Support.

2. Configure log collection parameters.

   PSM logs in to the network element or router and transfers the specified log files to the PSM server machine using FTP.

   Note

   <ne> is 7800 for BTI7800 Series network elements and junos for supported Juniper Networks routers.

   • To set the FTP username, set logCollection.<ne>.ftp.username=<username>, where <username> is the username of the FTP user configured on the PSM server machine. If you leave this blank, the default FTP user is used. The default FTP user is set up as part of PSM server software installation.

   • To set the FTP password, set logCollection.<ne>.ftp.password=<password>, where <password> is the FTP password for the specified username. If you leave this blank, the default FTP password is used.

   • To set the destination file path where the log file is to be transferred, set logCollection.<ne>.ftp.absolutePath=<filepath>, where <filepath> is the absolute path of the directory where you want to place the log file. If you leave this blank, the log files are placed in /home/ftpadmin.

   • To specify the log file(s) that you want to retrieve, set logCollection.<ne>.ftp.fileList=<files>, where <files> is a comma-separated list of log files you want to retrieve. If you leave this blank, the system.log file is retrieved for BTI7800 Series network elements and the messages file is retrieved for supported Juniper Networks routers.

   • To specify the FTP timeout value, set logCollection.<ne>.ftp.readTimeout=<timeout>, where <timeout> is the number of milliseconds to wait for FTP to complete. If the timeout expires, PSM assumes the FTP has failed.

   • To specify the (source) directory on supported Juniper Networks routers, set logCollection.junos.ftp.directory=<directory>, where <directory> is the directory where the log files are stored on the router.

3. If you want PSM to collect logs automatically, set the collection schedule by changing the schedule.logCollection.cron setting.

   For information on how to set this value, see Example: Scheduling Using Quartz CronTrigger Format.

   Note

   Different network elements might support different strategies for log rotation. Log rotation refers to closing and saving the current log file and creating a new log file for subsequent logs. In order to minimize the risk of PSM missing a log file, ensure that the log rotation frequency on the network element or router aligns with the log collection frequency on PSM.

4. Save and close the /var/local/ems9001/conf/override-common.properties file.
5. Track changes to the /var/local/ems9001/conf/override-common.properties file with Git by committing this update to the Git repository.

   For example:

   This update can now be seen in the Git log. For more information on Git, see Using Git to Track override-common.properties.

6. To activate changes made to the override-common.properties file, restart the PSM server.

   The restart command successfully completes when the 'Ems-' processes all change to 'running' state. Type <ctrl> c to exit the Linux watch command window.