SSH Settings

From VSI OpenVMS Wiki
Jump to: navigation, search

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running and debugging projects. Depending on the type of configuration, SSH connection settings can be edited either in the vmssoftware.ssh-helper-settings.json file located in /.vscode directory or via Visual Studio Code settings page.

SSH Settings Template

    "connection": {
        "host": "",
        "keyFile": "",
        "password": "",
        "port": 22,
        "username": ""
    "host-collection": {
        "hosts": []
    "timeouts": {
        "cmdTimeout": 0,
        "feedbackTimeout": 0,
        "welcomeTimeout": 0


Connection section sets the current connection details.

  • Host - IP-address or name of OpenVMS machine. It also can refer to the label of a connection specified in host-collection section - should be enclosed in angle brackets (<hostname>). In that

case, all other fields are ignored.

  • Port - The port number to use for SSH connection. Default is 22.
  • Username - User account that will be used for SSH connection.
  • Password - User password that will be used for SSH connection.. If it is omitted password input box will be shown on connection attempt.
  • Key File - Path to SSH private key file.

Host Collection

If you need to connect to different servers when working on your project, it makes sense to list all the required connections and then just pick the one that you need by using its label as the host name in the connection section.

NOTE: If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the settings.json file. Ssh collection hosts.png


Specifies SSH connection timesouts.

  • Cmd Timeout - Time out for command answer. If a command is sent to VMS and does not send response for the specified period of time, it will be considered as rejected.
  • Feedback Timeoutt - If SSH connection does not send feedback for this period, the specified password will be considered as invalid.
  • Welcome Timeout - If SSH shell prompt is not received for this period of time, the shell will be closed.
NOTE: Value "0" means, that timeout is not used. 
WARN: Do not change timeout settings.