How to: Collect Logs For VIRL Troubleshooting

     

    What logs do I need to provide?

    Depending on the problem we may need you to provide a varied set of logs. For most problems encountered after initial VIRL installation, launching simulations, or problems with services running in your VIRL server, the following will always be a great start.

    1. Problem Report (VM Maestro)
      • Collect the Problem Report when you are having issues attempting to launch a simulation and you receive an error. The Problem Report is also useful when VM Maestro (VMM) is not behaving as expected or options that should be present are not. If you are not sure, collect the report and attach to your post.
    2. System Logs
      • System Logs are useful for just about any issue you may be experiencing. These logs will give us a basic understanding of your configuration and where a problem may be originating. While these logs have a large amount of information, they do not give us the level of detail we sometimes need. For those occasions we may request specific logs found elsewhere on your VIRL server.
    3. Other Logs
      • In some cases UWM may not be accessible due to incomplete configuration or failed system configuration changes. Collecting a summary of your server settings can be very helpful. Use the script VIRL Server Config Validation to gather key settings into a single text file. Don't forget to attach the file to your thread.
      • OpenStack logs may be required on special occasions. When requested, you will be able to find the logs by connecting to your VIRL server via System Console (VIRL 1.2 and later) or via SSH. If you use Windows, we recommend installing WinSCP client in order to copy the log files from your VIRL server to your local computer. If you use a Mac, Forklift or Cyberduck have an easy to use GUI if you prefer not to use CLI. On Mac, SCP is included in the OS and can usage details can be found on the internet.
      • OpenStack Logs and VIRL Configuration change logs can be found under /var/log
      • VIRL Services Logs can be found under /var/local/virl/logs

     

    Collecting Problem Report (VM Maestro)

    (Windows, Mac and Linux)

    1. Open VM Maestro
    2. Click on Help menu.
    3. Select Generate Problem Report
    4. In the Generate Problem Report dialog provide some detail of the problem you are experiencing. This is optional but can prove very useful in some cases.
      VMM_AddNote_ProbReport.png
    5. Add notes describing the problem (optional, but helpful)
    6. You may (optionally) expand the Detailed Contents of the Report to customize what is included in the project report or to preview the contents that will be packaged into the problem report.
      VMM_DetailsDialog_ProbReport.png
    7. Click on Generate
    8. Select the location where VM Maestro should save the problem report .zip file.
      VMM_SaveProbReport.png
    9. You may attach the .zip file to a post on the community forum. If you do not wish other users to be able to see the problem report contents, you may send it via e-mail to ciscovirl-files@cisco.com. If you send the problem report in e-mail, please include a link to associated community forum thread.


    System Logs (UWM)

     

    As of VIRL 1.1.1 the name of the panel was changed from System Status to System Tools to better describe the panel and tools available to the administrator. To view and collect VIRL server information pertaining health and other system services, expand VIRL Server and then select System Tools.

    1. Click on Download System Logs
    2. Select download location and accept

    2016-07-25 13_29_39-UWM __ System Tools.png

    Health Status

    (VIRL 1.1 and later)

    1. Open UWM and navigate to VIRL Server > System Tools
    2. Click Check Health Status and wait for page to refresh
    3. If errors are returned, you may choose to download the logs by clicking on Download button or view the raw report by clicking on Display RAW Report

     

    Other Logs

    Copying other logs from your VIRL server can typically be done using SCP (Secure Copy Protocol) or SFTP. By default your VIRL server will allow the connections using the following default credentials:

    User: virl

    Password: VIRL

     

    VIRL Logs Locations

    System EventPath to Log File(s)
    Fully Automated Upgrades (VIRL System Upgrade Feature), Cisco Image(s) upgrades / installation, Remote Server Launch, UWM, and STD (Simulation events)/var/local/virl/logs
    Various OS components, OS upgrades, Openstack components and rehost logs/var/log/


    Connecting from Windows computer

    The easiest way to copy files out of the VIRL Server is to use SCP protocol. The graphical Windows SCP client is called WinSCP and you can download it from WinSCP Official Site.

    1. Install or launch WinSCP (you may choose to use the portable version)
    2. Connect to VIRL VM
    3. Right pane: navigate to  /home/virl/Desktop
    4. Left pane: navigate to desired destination on your LOCAL machine
    5. Drag and drop files you want to transfer
    6. Repeat as needed
    7. Once you have collected the files you can just close the client. If you have several files to upload, select them > right click > send to > compressed (zipped) folder. Now you can just upload a single zip file.


    Connecting from Mac OSX / Linux

    From a Mac or Linux machine we will use SCP via command line. SCP client is almost always pre-packaged and is easy to use. The syntax is simple:

    ~# scp source destination (this is basic syntax)

    The command would look like this:

    ~# scp virl@<ip_address>:/var/log/<file_name> ~/Desktop

    What the command says is; use SCP protocol and connect with user VIRL to server with path to log file and copy the file to my desktop.
    Repeat for all the log files needed and then zip them up! Yep you can do that via CLI as well. And why not, you are already there. The command will look like this:

    ~# zip myzippedlog.zip <log.log> <log2.log> etc.

    The above command will collect all the specified log files and compress them into a single zip file called myzippedlog.zip.

     

     

    Attaching Logs To A Post

    If you need to attach a file to a post, make sure to click on the Use Advanced Editor located at the top right of the Quick Reply window.

     

    Step 1.
    Screen Shot 2017-01-03 at 5.21.51 PM.png

    Step 2.
    Screen Shot 2017-01-03 at 11.19.08 AM.png