Retrieving VM Access Proxy Logs

The Commander VM Access Proxy is a solution deployed to allow users outside your firewall to connect to VMs inside the firewall from Commander or the Service Portal. Prior to VM Access Proxy version 3.4, the solution was delivered as an appliance deployed onto your local infrastructure. As of VM Access Proxy version 3.4 and later, the solution is delivered via Docker pulling down the required images from the Snow repository. 

Snow recommends that you keep your VM Access Proxy updated and current. Version 3.7 corrects significant security issues so any versions prior to this should be replaced. 

Retrieving Logs from Versions 3.4 and Later
Retrieving Logs from Versions 3.3 and Earlier
 

Retrieving Logs from Versions 3.4 and Later

• Remote Access Proxy 3.4 and later is installed via Docker on Ubuntu 20.4
• During the OS install, enable SSH for secure access
• On the Ubuntu server, the logs are created here: /var/data/logs
• The most commonly useful log file is named remoteAccess.log

While logged on to the Ubuntu server, you can view the live logs by executing the following commands:
 

docker logs remoteaccess

docker logs guacd

You can also pipe the contents to a text file in your home directory to download or export it. Otherwise, if you would like to use a client to download the logs, follow one of the procedures below.

Use Filezilla
Use WinSCP
 

Filezilla

Filezilla is a free, open source FTP client that also supports secure copy.

Download and install Filezilla and complete the steps below to retrieve the log files.

1. Under the File menu, choose Site Manager.
2. Click New Site and name it VM Access Proxy.
3. Enter the hostname or IP address of the console proxy in the Host field.
4. Choose SFTP SSH File Transfer Protocol from the Protocol menu.
5. Choose Normal as the Logon Type.
6. Enter the Username and Password of an account on the server with sufficient rights to access and download the files. 
7. Click Connect. Filezilla may prompt you to choose whether or not to save passwords. 
8. Enter /var/data/logs in the Remote site pane.

9. Double-click remoteAccess.log or select all and download to your local computer, in the location shown in the Local site pane.

 

WinSCP

WinSCP is a free, open source secure copy client for Windows.

Download and install WinSCP and complete the steps below to retrieve the log files.

1. Click New Session. 
2. Choose SFTP  as the File protocol.
3. Enter the hostname or IP address of the console proxy in the Hostname field.
4. Enter the Username and Password of an account on the server with sufficient rights to access and download the files.
5. Click Login.
6. Enter /var/data/logs in the Address field and hit enter.
   
7. Right-click remoteAccess.log and choose Download. 
8. Select a path to which the file will be downloaded on your local computer and click OK.

Retrieving Logs from Versions 3.3 and Earlier

• You must set logging to "all" to capture the events in the log file. Follow this process to enable the logging. 
• On the appliance, the logs are created here: /var/log/tomcat7
• The most commonly useful log file is named remoteAccess.log

You must first enable SSH, by following the procedure below:

1. Login to the VM Access Proxy using a console connection.
   
   username: vcommander
   password: gRHrB211
    
2. Execute the command sudo service ssh start. You will be prompted to enter the password again.
   

If you would like to use a client to download the logs, follow one of the procedures below.

Use Filezilla
Use WinSCP

Filezilla

Filezilla is a free, open source FTP client that also supports secure copy.

Download and install Filezilla and complete the steps below to retrieve the log files.

1. Under the File menu, choose Site Manager.
2. Click New Siteand name it VM Access Proxy.
3. Enter the hostname or IP address of the console proxy in the Hostfield.
4. Choose SFTP  SSH File Transfer Protocol?from the Protocolmenu.
5. Choose Normalas the Logon Type.
6. Enter the Username(vcommander), and Password (gRHrB211).
7. Click Connect.
8. If you are using the self-signed certificate, you will receive a warning that the connection is untrusted. Check Always trust this host, add this key to the cache and click OK.
   
   
9. Enter /var/log/tomcat7 in the Remote site pane for versions prior to 3.2 or /var/log/tomcat8 for Access Proxy 3.2 and 3.3.
   
10. Double-click remoteAccess.log to download it onto your local computer, in the location shown in the Local site pane.

WinSCP

WinSCP is a free, open source secure copy client for Windows.

Download and install WinSCP and complete the steps below to retrieve the log files.

1. Choose SFTP  as the File protocol.
2. Enter the hostname or IP address of the console proxy in the Hostname field.
3. Enter the Username (vcommander), and Password (gRHrB211).
4. Click Login.
5. When presented with the authentication banner, click Continue.
   
6. Enter /var/log/tomcat7 in the Address field and hit enter. /var/log/tomcat8 for Access Proxy 3.2 and above.
   
7. Right-click remoteAccess.log and choose Download.
8. Select a path to which the file will be downloaded on your local computer and click OK.

See Also

• Deploying the Commander VM Access Proxy
• Enabling Debug Logging for the VM Access Proxy