Difference between revisions of "SSH Settings"

From VSI OpenVMS Wiki
Jump to: navigation, search
m (Host Collection)
m
Line 23: Line 23:
  
 
=Connection=
 
=Connection=
Connection section sets the current connection details.
+
The connection section sets the current connection details.
 
* <code>'''Host'''</code> - 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  <code>(<hostname>)</code>. In that
 
* <code>'''Host'''</code> - 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  <code>(<hostname>)</code>. In that
 
case, all other fields are ignored.  
 
case, all other fields are ignored.  
* <code>'''Port'''</code> - The port number to use for SSH connection. Default is 22.
+
* <code>'''Port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''Username'''</code> - User account that will be used for SSH connection.
+
* <code>'''Username'''</code> - User account that will be used for the SSH connection.
* <code>'''Password'''</code> - User password that will be used for SSH connection.. If it is omitted password input box will be shown on connection attempt.
+
* <code>'''Password'''</code> - User password that will be used for the SSH connection.. If it is omitted a password input box will be shown on connection attempt.
 
* <code>'''Key File'''</code> - Path to SSH private key file.  
 
* <code>'''Key File'''</code> - Path to SSH private key file.  
  
Line 39: Line 39:
 
=Timeouts=
 
=Timeouts=
 
Specifies SSH connection timesouts.
 
Specifies SSH connection timesouts.
* <code>'''Cmd Timeout'''</code> - 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.
+
* <code>'''Cmd Timeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''Feedback Timeoutt'''</code> - If SSH connection does not send feedback for this period, the specified password will be considered as invalid.
+
* <code>'''Feedback Timeout'''</code> - If the SSH connection does not send feedback for this period, the specified password will be considered as invalid.
* <code>'''Welcome Timeout'''</code> - If SSH shell prompt is not received for this period of time, the shell will be closed.
+
* <code>'''Welcome Timeout'''</code> - If the SSH shell prompt is not received within this period of time, the shell will be closed.
  
 
  '''NOTE''': Value "0" means, that timeout is not used.  
 
  '''NOTE''': Value "0" means, that timeout is not used.  
  
  '''WARN''': Do not change timeout settings.
+
  '''WARN''': Do not change timeout settings unless necessary.
  
  
 
[[Category:VMS IDE]]
 
[[Category:VMS IDE]]

Revision as of 06:07, 7 May 2019

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

The 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 the SSH connection. Default is 22.
  • Username - User account that will be used for the SSH connection.
  • Password - User password that will be used for the SSH connection.. If it is omitted a 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

Timeouts

Specifies SSH connection timesouts.

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