Options Property  
 

Gets and sets the options that are used in establishing a connection.

Syntax

object.Options [= value ]

Remarks

The Options property is an integer value which specifies one or more options. The value specified for this property will be used as the default options when connecting to the server. The property value is created by using a bitwise operator with one or more of the following values:

Value Constant Description
0 sshOptionNone No options specified. A standard terminal session will be established with the default terminal type.
1 sshOptionKeepAlive This option specifies 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.
2 sshOptionNoPTY 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.
4 sshOptionNoShell This option specifies that a command shell should not be used when executing a command on the server.
8 sshOptionNoAuthRSA 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 server.
16 sshOptionNoPwdNul This option specifies the user password cannot be terminated with a null character. This option is ignored with SSH-2 connections and should only be specified if required by the server.
32 sshOptionNoRekey This option specifies 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.
64 sshOptionCompatSID 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.
128 sshOptionCompatHMAC 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.
&H40000 sshOptionPreferIPv6 This option specifies the client should prefer the use of IPv6 if the server hostname can be resolved to both an IPv6 and IPv4 address. This option is ignored if the local system does not have IPv6 enabled, or when the hostname can only be resolved to an IPv4 address. If the server hostname can only be resolved to an IPv6 address, the client will attempt to establish a connection using IPv6 regardless if this option has been specified.

Data Type

Integer (Int32)

See Also

Secure Property, Connect Method