Specifies the options that the SshClient class supports.
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
The SshClient class uses the ClientOptions enumeration to specify one or more options to be used when establishing a connection with a remote host. Multiple options may be specified if necessary.
| Member Name | Description | Value |
|---|---|---|
| optionNone | No option specified. | 0 |
| optionDefault | The default connection option. This is the same as specifying optionNone. | 0 |
| optionKeepAlive | This option specifies that the library should attempt to maintain an idle client session for long periods of time. This option is only necessary if you expect that the connection will be held open for more than two hours. This option is the same as setting the KeepAlive property to a value of true. | 1 |
| optionNoPTY | This option specifies that a pseudoterminal (PTY) should not be created for the client session. This option is automatically set if the Command property specifies a command to be executed on the server. | 2 |
| optionNoShell | This option specifies that a command shell should not be used when executing a command on the remote host. | 4 |
| optionNoAuthRSA | This option specifies that RSA authentication should not be used with SSH-1 connections. This option is ignored with SSH-2 connections and should only be specified if required by the remote host. | 8 |
| optionNoPwdNul | This option specifies that the user password cannot be terminated with a null byte. This option is ignored with SSH-2 connections and should only be specified if required by the remote host. | 16 |
| optionNoRekey | This option specifies that the client should never attempt a repeat key exchange with the server. Some SSH servers do not support rekeying the session, and this can cause the client to become non-responsive or abort the connection after being connected for an hour. | 32 |
| optionCompatSID | This compatibility option changes how the session ID is handled during public key authentication with older SSH servers. This option should only be specified when connecting to servers that use OpenSSH 2.2.0 or earlier versions. | 64 |
| optionCompatHMAC | This compatibility option changes how the HMAC authentication codes are generated. This option should only be specified when connecting to servers that use OpenSSH 2.2.0 or earlier versions. | 128 |
| optionFreeThread | This option specifies that class methods may be called from any thread, and not only the thread that established the connection. Using this option disables certain internal safety checks that are made by the class and may result in unexpected behavior unless you ensure that access to the class instance is synchronized across multiple threads. | 524288 |
Namespace: SocketTools
Assembly: SocketTools.SshClient (in SocketTools.SshClient.dll)