Add an SSH Server with Username/Password Auth
Last modified on September 13, 2024
Overview
An SSH server is a combination of a specific SSH destination and the credentials to access it. This guide describes how to set up an SSH (Password) server in the Admin UI. This server type may be added to StrongDM to allow users to connect to resources (such as network devices) that require a username and password for authentication.
Prerequisites
Before you begin, ensure that the server you are attempting to add is accessible from your StrongDM gateways or relays. You must have a properly functioning gateway(s) (and optionally a relay(s) if you intend to use them to connect to this resource) up and running, and these nodes must be able to reach the target server before you can proceed. To verify, go to the gateway or relay server and from a command prompt, type ping <YOUR_HOSTNAME>. If your gateway or relay can connect to this hostname, you can continue. For more information see nodes.
In addition, you need to know the username and password of the resource to be added to StrongDM.
Add an SSH (Password) Server in the Admin UI
To add your new SSH (Password) server as a StrongDM resource, use the following steps.
- Log in to the Admin UI and go to Infrastructure > Servers.
- Click Add server.
- Select SSH (Password) as the Server Type and set other resource properties to configure how the StrongDM relay connects to the server via SSH.
- Click create to save the resource.
- Click the resource name to view status, diagnostic information, and setting details. After the server is created, the Admin UI displays that resource as unhealthy until the health checks run successfully. When the resource is ready, the Health icon indicates a positive, green status.
Resource properties
Configuration properties are visible when you add an SSH (Password) server or when you click to view the server’s settings. The following table describes the settings available for your SSH (Password) server.
| Property | Requirement | Description |
|---|---|---|
| Display Name | Required | Meaningful name to display the resource throughout StrongDM; exclude special characters like quotes (") or angle brackets (< or >) |
| Server Type | Required | Select SSH (Password) |
| Hostname | Required | Hostname or IP address to which you are connecting, such as testserver-01.example.org; relay server should be able to connect to your target server or hostname |
| Port | Required | Port to connect to the resource; default port value 22 |
| Port Override | Read only | Automatically generated with a value between 1024 to 64999 as long as that port is not used by another resource; preferred port can be modified later under Settings > Port Overrides |
| Secret Store | Optional | Credential store location; defaults to Strong Vault; to learn more, see Secret Store options |
| Username | Required | Enter the username the node should utilize to connect to the server via SSH (for example, bob.belcher) |
| Password | Required | Enter the password the node should utilize to connect to the server via SSH |
| Resource Tags | Optional | Resource tags consisting of key-value pairs <KEY>=<VALUE> (for example, env=dev) |
Secret Store options
By default, server credentials are stored in StrongDM. However, these credentials can also be saved in a secrets management tool.
Non-StrongDM options appear in the Secret Store dropdown if they are created under Network > Secret Stores. When you select another Secret Store type, its unique properties display. For more details, see Configure Secret Store Integrations.