This is an old revision of the document!

SessionOptions Class

Defines information to allow an automatic connection and authentication of the session. Is used with Session.Open method.

Syntax

public sealed class SessionOptions

Advertisement

Constructors

Name Description
SessionOptions() Default constructor.

Properties

Name Description
SessionProtocols Protocol Protocol to use for the session. Possible values are SessionProtocols.Sftp, SessionProtocols.Scp and SessionProtocols.Ftp. Defaults to SessionProtocols.Sftp.
string HostName Name of the host to connect to. Mandatory property.
uint PortNumber Port number to connect to. Keep default 0 to use the default port for the protocol.
string UserName Username for authentication. Mandatory property.
string Password Password for authentication.
string HostKey Host key of the SSH server. Mandatory for SFTP/SCP protocol.

Remarks

You need to fill in all properties required to connect and authenticate your session automatically.

Advertisement

You always need to fill in Protocol, HostName and UserName1.

In most cases you need to fill in Password. Exceptions are:

  • The server does not require password;
  • You use different authentication method than a password authentication, such public key authetication (with passphrase-less private key or with use of Pageant) for SSH session.

For SSH (SFTP/SCP) session you need to fill in the HostKey.

  1. Except for very rare occasions that the server does not require username.Back

Last modified: by martin