Collect Logs (Bolt)

When the Bolt user is experiencing issues, they can collect logs for issue diagnosis and/or send the logs to TAC.

There are two options available for the user to collect logs.

• Save logs to a local destination via SFTP.
• Push logs to a remote location via a URL.

Video

Collect Logs Command Structure

• Command Path – tolt>system>logging>
• Module – tolt
• Container – system
• Action – logging
• Types – 
  • collect-logs – Action to collect all the log files, and automatically create a tgz file of the logs and make them available to users.
  • filename – The filename to give the log file.  Do not include an extension, it will be added by the collect-log command.

    • string

  • remote-url – If using sftp to push logs to a remote site, specify the sftp url in a format acceptable to url.

    •  string

  • username – The username to use when authenticating to an sftp server for log push. 

    •  string

  • password – The password to use when authenticating to a sftp server for log push.

    •  string

System Logging Action Local File Example 

The following example will show how to create an archive of the logs in a local SFTP directory on the BOLT. 

1. From the MDS1-ESUA# command line, input tolt system logging collect-logs filename local-test and press Enter. 
2. Output similar to the following is displayed:
    

   MDS1-ESUA# tolt system logging collect-logs filename local-test <enter> action-success true MDS1-ESUA# _

When the logs have been collected, they will be automatically saved to the OLT and added to the /usr/lbob/diagnostic folder with the extension of .tgz.

1. To access the file, open up a SFTP window to the OLT.
   
2. Select the diagnostic folder and do a refresh to display the log file.
   
3. Select the log and drag over to a user' local file directory.
   
   

System Logging Action Remote SFTP Example 

The following example will show how to perform a remote push of the logs to a SFTP server.  Note that typically an explicit file path is required, and the URL needs to terminate with a slash.   

1. From the MDS1-ESUA# command line, input tolt system logging collect-logs filename local-test remote-url sftp://172.28.152.30/home_dir/lbob/ username test-user password ************, and press Enter. 
2. Output similar to the following is displayed:
    

   MDS1-ESUA# tolt system logging collect-logs filename local-test remote-url sftp://172.28.152.30/home_dir/usern/ username test-user password ************ <enter> action-success true MDS1-ESUA# _

A copy of the log file is now available at the remote URL.