cancel
Showing results for 
Search instead for 
Did you mean: 
Create Post

SolarWinds Solar-PuTTY Quick Reference Guide

SolarWinds® Solar-PuTTY is a terminal emulation client with a browser-based user interface. Built on top of PuTTY, this free tool includes a browser-based interface with tabs that allow you to open multiple client sessions.

Solar-PuTTY extends the functionality of PuTTY, allowing you to connect to a resource using the following protocols:

  • Secure Shell (SSH)
  • Telnet
  • File Transfer Protocol (FTP)
  • SSH File Transfer Protocol (SFTP)
  • Secure Copy Protocol (SCP)

Installation requirements

Component

Requirements

Operating System

Windows® 7

Windows 8

Windows 8.1

Windows 10

Windows Server® 2012

Windows Server 2012 R2

Windows Server 2016

Microsoft®.NET

.NET 4.6.1

Download and run the tool for the first time

  1. Download the free tool here:
    https://www.solarwinds.com/solar-putty
  2. Unzip the tool.
  3. Double-click Solar-PuTTY.exe.
  4. Accept the terms of the license agreement.

Overview screen

When you launch Solar-PuTTY for the first time, the Overview screen is displayed. Here, you can enter the IP address of your remote server, or select ‘Create new session’ for additional options. See Create a new session later in this guide for details.

pastedImage_2.png

The Overview screen provides quick access to your saved sessions. Each session includes a screen with clickable options. These options are ordered by frequency, so the connections used the most often are always at hand.

pastedImage_3.png

The Overview screen includes a search bar to search for a saved session, filtering out any session that doesn’t meet your search criteria. You can also use the search bar to define a new session.

pastedImage_4.png

All running sessions are organized in tabs. We tried to make this behavior as browser-like as possible. You can create a new tab by clicking the + icon or CTLR+T.  You can also move the tab to a separate window by right-clicking the tab and selecting Detach. To reorder the tabs, press CTRL and the left or right arrow keys.

Create a session

You can create a new session using the Search bar, the “Create new session” form, or the Sessions tab.

Create session using the Search bar

To create a new session using the Search bar, enter the IP address or hostname and press Enter. You can also define the SSH or Telnet protocol, username, and port.

For example:

  • 192.168.1.5 – Connects to the default port using SSHv2
  • Mycoolserver.company.local – Connects to the default port using SSHv2
  • telnet:192.168.1.5 –  Connects to the default port using Telnet
  • admin@mycoolserver.company.local:8888 –  Connects to port 8888 as an admin using SSHv2

Create a session using a form

Click “Create new session” to bring up a form. Complete the form and click Create to connect to the targeted resource and save the session

Create a session using the Settings tab

Press CTRL + S to open the Settings tab and create a new session

Discover saved PuTTY sessions

Solar-PuTTY can read registry entries and locate already existing PuTTY sessions. These sessions are automatically added to Solar-PuTTY.

Import and export sessions

To export a session, click Export Sessions under the vertical ellipsis menu. The application prompts you to set a password, which is used to encrypt the exported data file. This file contains the sessions, keys, scripts, tags, and relationships associated with these entities.

The exported data file and the application are portable. This allows you to import your saved sessions to Solar-Putty running on a different PC. During the import, the application prompts you for a password to protected data file.

Settings

You can access settings by pressing CTRL+S or clicking the vertical ellipsis menu button in the user interface.

Sessions

Click the Sessions tab to define a new session or delete an existing session. You can link your existing sessions to credentials, tags or scripts.

Credentials

Use the Credential Manager to automatically authenticate to a targeted resource using a password and keys.

Tags

Tags enhance your search options by adding labels to your saved sessions. Using the Address bar on the Overview screen, you can search these tags and automatically filter sessions to meet your search criteria.

Scripts

After you connect to a machine, use scripts in an SSH connection to send post-authentication commands to the machine.

Solar-PuTTY does not include a script editor. During a session, the tool links an existing script saved on your computer. When you create a session and authenticate, Solar-PuTTY sends the script content to the remote machine. Most servers will close the session after executing the command.

Logs

When you enable logging in your session configuration, the application logs all data sent by the server in your terminal session. When you create a new folder in the Logs tab, the application saves your log files to the folder.

Windows integration

Solar-PuTTY creates a Windows shortcut for each saved session. This allows you to search and launch a saved session using a Windows search.

You can also create a shortcut to a specific server, which you can save on your desktop or pin to your taskbar or Start menu. When you right-click the Solar-PuTTY icon on the Windows taskbar, the application provides a list of the 10 most frequent sessions.

Generate certificate

You can use the PuTTY key generator to generate your own keys. To access this feature, click the top left vertical ellipsis menu and select “Generate certificate”. See the PuTTY User Manual for details.

File Transfer protocols

You can extend Solar-PuTTY to support FTP, SFTP and SCP protocols. To configure a protocol to your session, click the Type of connection drop-down menu on the new session form and select a protocol.

The menu includes the SCP/SFTP/FTP option, which is grayed out. To add support for these protocols, click Download. The application downloads the WinSCP libraries from a third-party location and restart. When the download is completed, you can use the selected protocols in your sessions.

Solar-PuTTY keyboard shortcuts

Solar-PuTTY supports following keyboard shortcuts by default. This functionality can be turned off in application settings in case it conflicts with your remote server keyboard shortcuts.

Shortcut

Action

CTRL+T

Opens a new tab

CTRL+N

Opens a new window

CTRL+E

Opens the Create new session form

CTRL+S

Opens the Settings tab

CTRL+R

CTRL+F5

Reconnects to the targeted machine

CTRL+W

Closes the current tab

CTRL+SHIFT+T

Opens the previously-closed tab

CTRL+TAB

Switches between tabs (left to right)

CTRL+SHIFT+TAB

Switches between tabs (right to left)

CTRL+1-8

Switches to the specified tab

CTRL+9

Switches to the last tab

CTRL + ←

Move tab to the left

CTRL + →Move tab to the right
ALT+F4Closes the current window

Solar-PuTTY CLI arguments

Argument

Action

-a, --passphrase      

Passphrase used for authentication

-b, --ftp

Starts an FTP session

-c, --scp

Starts an SCP session

-d, --dark

Switches to Dark mode [beta]

-e, --remote

SCP/SFTP/FTP remote directory

-f, --sftp

Starts an SFTP session

-h, --hostname

Hostname used in the connection

-i, --sessionid

Session ID to be opened

-k, --key

Path to a key file used for authentication

-l, --log

Enables session logging to the logging folder

-o, --port

Connection port number

-p, --password

Password used for authentication

-r, --script

Patch to a script file that runs after the authentication

-s, --ssh

Starts an SSHv2 session

-t, --telnet

Starts a Telnet session

-u, --username

Username used to authenticate to the machine

-v, --ssh1

Starts an SSHv1 session

--help

Displays the online help

--version

Displays the current version

-n, --nameSession name to be opened
Comments

Both Putty and Kitty let me change the font, but not this one.  That's a deal-breaker.

Too bad you can not change the text color

This tools keyboard shortcuts conflict with bash keyboard shortcuts.

Bash keyboard shortcuts · GitHub

It doesn't allow change the font? I'd definitely use if it let me change the font !!

Does solarwinds-putty support X11 redirect as traditional putty? why not?

Cool features.  Inability to change font and font size is a deal breaker.  Can change both in Putty.  Nobody wants to look at tiny text in a terminal.

Is there a way to tie this into Orion Linux / Net-snmp nodes?

Is it possible to export managed nodes from NCM and import them into Putty?  Seems like all the information is already there (ie, Name, tags, IP) and would certainly make this tool more helpful if it tied in.  It would make the difference in me using this over SecureCRT or other tools.

If you want to change the appearance of the Putty sessions the tool launches, I've found that launching putty.exe in C:\Users\<username>\AppData\Roaming\Solar-PuTTY and modifying the settings of the Default Settings sessions works a treat

I concur with everyone else. I like the layout, but not being able to change the font size is a big issue

I had high hopes but I have 100s of entries in Putty Connection Manager and I'm not going to rekey them all into Solar-Putty. If you could import an XML file I'd give it a shot or even provide a format that I could massage my data into so that it could be imported.

Big oversight not to allow manipulation of that from the Solar-Putty shell. I'm staying with Putty Connection Manager for now, despite its shortcomings that I'm able to live with.

As a workaround you can run putty.exe from c:\Users\<username>\AppData\Roaming\Solar-PuTTY\putty.exe, set the font size, colors and other appearance you want to use and save it to 'Default Settings'. Solar-PuTTY then loads the Putty’s setting as a default setting for all sessions.

Changed font and color.png

balasarius As a workaround you can run putty.exe from c:\Users\<username>\AppData\Roaming\Solar-PuTTY\putty.exe, set the font size, colors and other appearance you want to use and save it to 'Default Settings'. Solar-PuTTY then loads the Putty’s setting as a default setting for all sessions.

sholtman​, as a workaround you can run putty.exe from c:\Users\<username>\AppData\Roaming\Solar-PuTTY\putty.exe, set the font size, colors and other appearance you want to use and save it to 'Default Settings'. Solar-PuTTY then loads the Putty’s setting as a default setting for all sessions.

mdangol​, as a workaround you can run putty.exe from c:\Users\<username>\AppData\Roaming\Solar-PuTTY\putty.exe, set the font size, colors and other appearance you want to use and save it to 'Default Settings'. Solar-PuTTY then loads the Putty’s setting as a default setting for all sessions.

nunezno, some PuTTY features are not available via Solar-PuTTY and X11 is one of them. We focused on SSH/Telnet and automatic authentication together with browser like multi-tabbed environment. We're now collecting feedback and will consider adding more to Solar-PuTTY later.

jschaffer​, as a workaround you can run putty.exe from c:\Users\<username>\AppData\Roaming\Solar-PuTTY\putty.exe, set the font size, colors and other appearance you want to use and save it to 'Default Settings'. Solar-PuTTY then loads the Putty’s setting as a default setting for all sessions.

Hey allen​, currently no, but send me an email to milan.hulik@solarwinds.com

I'd like to know more about how you would like to use it.

jknueppel​, that's definitely an interesting idea, that I already have in my backlog. v1 of Solar-PuTTY is oriented towards general usage. We'll consider Orion integration later.

knucklebusted​, so the Putty Connection Manager does not store all connections in the Windows registry just like PuTTY does? Solar-PuTTY is able to read all your saved PuTTY sessions from registry and automatically adds them to the list.

I would like to see the ability to run commands in all of the open sessions at one time like SuperPutty.

No, putty connection manager stores them in a database. I could upload a sample if helpful.

Hi, can you add ping option to Solar-PuTTY?

It's useful to check why i can't connect.

Example:

Ping IP-Address

pastedImage_0.png

or click on element and ping to check status.

go ahead and send me the sample to my mailbox: milan.hulik@solarwinds.com

I would at least hope for a facility to import a list of Session names/IP addresses so that I don't have to do one at a time - but if this could ultimately tie in with the nodes in our NPM environment, that would be ideal

Just sent it to you.

Thanks for taking a look.

From first run, any time I open a session, it opens in a new windows and not in a tab.  Windows 10 x64.  Any suggestions?

Okay, found that I need to right click and run as administrator to use the tabbed interface.

Another deal breaker.  Check out ExtraPuTTY's ability to send commands.  You can send a single command or a sequence.  I use this constantly and would not dream of using another PuTTY version without it. 

After install it seems Solar-Putty has only discovered 1/4 of my saved sessions. I can export them all using regedit but it wants to give me a .reg or .txt file. Solar-Putty only wants .dat files for session import. What's the best pathway forward here?

Solar-PuTTY imports the PuTTY sessions (telnet and ssh only; no raw, rlogin, serial) directly from Windows registry. There is no other way of importing the PuTTY sessions to Solar-PuTTY. What kind of PuTTY sessions are those which were not imported?

The only way in Solar-PuTTY is using the post-authenticate functionality to push commands to terminal.

All un-discovered sessions are SSH or telnet sessions. I have a lot of them - 180+. Solar-Putty seems to have discovered 40 of them, in alphabetical order. Is there a limit to the number of saved sessions?

Sullivro, there is no limit to the number of saved sessions. We've tested the auto-import with around 400 sessions. Solar-PuTTY uses following registry key 'HKEY_CURRENT_USER\Software\Simontatham\PuTTY\Sessions' for importing the sessions.

Could you please provide us Solar-PuTTY logs from c:\ProgramData\Solarwinds\Logs\Solar-PuTTY\ and - if possible - your exported Putty sessions from Windows registry?

You can contact me via richard.john@solarwinds.com.

Thank you,

Richard

As I am just starting as a Network Admin at a new company, I am setting up SolarPutty fresh with all new connections. I like it so far. One thing I might suggest is a way to sort the Overview list other than frequency. A sort option by name, IP address, type, etc would be great.

EDIT: Creating groups in the overview list would also be a welcome addition

You can use Tags as a replacement for groups and perform search based on the tag name on Overview page or Settings->Sessions page.

Like a few other people, my sessions are not in the registry. I use KiTTY with the portable setting so I can carry it around on a thumbdrive.

http://www.9bis.net/kitty/?page=Portability&zone=en

How do add my saved sessions? I can send a copy of the file that contains the Default Settings.

it's currently not possible currently to migrate saved sessions from KiTTY to Solar-PuTTY.

Needs an option to change the view in the "Overview" to list instead of blocks (icons). It does struggle to deal with the saved sessions especially when you have more than 100.

ehh, no local com port support, and with that comes no Xmodem.
Being an integrated part of the node management in SolarWinds is nice however, especially if I have no route to the device, but the server does.

I have the same issue. What was the resolution?

Hi Todd, no resolution so far. I am tracking it as a feature request for one of the future updates of Solar-PuTTY.

I've been trying to download the add-ins for SFTP, but I am behind a proxy that won't ever let it connect.

Is there a manual way to install these pieces?

How about creating an actual installer for this so it is 100% feature complete out of the box? It's weird how this is not just part of the program.

Hi Trey, the SFTP libraries we're downloading belong to a 3rd party and have a restrictive license. We cannot ship it as a part of SolarWinds product. But we can give you option to download it yourself and install it. So we have created the logic, which does it automatically and you're 1st one reporting issue with it.

You can download the package yourself from here: Downloading WinSCP-5.13.3-Automation.zip :: WinSCP

Then extract the WinSCPnet.dll and WinSCP.exe to C:\Users\User.Name\AppData\Roaming and to C:\Users\User.Name\AppData\Roaming\Solar-PuTTY

Then edit the Solar-PuTTY.exe.config file located in C:\Users\User.Name\AppData\Roaming\Solar-PuTTY and add these lines under startup section:

<runtime>

    <bypassTrustedAppStrongNames enabled="true" />

    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">

      <dependentAssembly>

        <assemblyIdentity name="WinSCPnet" publicKeyToken="2271ec4a3c56d0bf" culture="neutral" />

        <bindingRedirect oldVersion="0.0.0.0-65535.65535.65535.65535" newVersion="1.5.5.8565" />

      </dependentAssembly>

    </assemblyBinding>

  </runtime>

Launch Solar-PuTTY and it should work.

You need to make sure, that the newVersion value in the config file matched the version of dll downloaded from 3rd party site. Currently it is 1.5.5.8565, but that will change soon.

milan.hulik​ - So I followed those above steps, and I now see the options in the drop down. I created a new Session for the SFTP connection. When I try to connect, it just has the spinning "Connecting...".

Solar-Putty.png

Is there a place to look at logs, or some debug mode to see what's happening?

I can use WinSCP and connect to this same system without issue.

Trey, THWACK has not shown my previous comment fully. Apologies for that. Have a look at my previous comment again and specifically the section about config file.

Milan

Is there a way to clear out a stale fingerprint from the database?  I get a "something bad happened"

This tools shortcuts conflict with nano. There should be a way to disable sw putty keyboard shortcuts.

graham,

we have recently released updated version of Solar-PuTTY, in Settings->General you can find checkbox 'Disable keyboard shortcuts'.

pastedImage_0.png

Richard

Any word on when the ability to import sessions from a PuttyCM database file will be available?  This is the only thing stopping me from being able to see if i can completely switch over.  i have way too many connections saved to move to something else without an automated way to import those connections.

Also, could you add a check for update menu option into the app somewhere.  It doesn't have to auto update or anything, i'd just like to know with a quick click if i can go and get an updated version or not.

Thanks.

Version history
Revision #:
1 of 1
Last update:
‎05-30-2018 02:51 AM
Updated by: