PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of sshSession variables
  • Authentication mode
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
The sshSession type is used to define the characteristics of a connection to an SSH server. The characteristics of this connection are described by several WLanguage properties.
Note: See Declaring a variable for more details.
Example
cMySession is sshSession
cMySession..Address = "127.0.0.1"
cMySession..Port = 22
cMySession..User = "login"
cMySession..UserPassword = "pass"
Remarks

Properties specific to the description of sshSession variables

The following properties can be used to define a connection to an SSH server:
Property nameType usedEffect
AddressCharacter stringAddress of SSH server.
This address can be given in the following format:
  • IP address in XXX.XXX.XXX.XXX format (125.5.110.100 for example).
  • IP address containing the server name (SSHServer for example). This syntax is recommended.
PrivateKeyCharacter string or Certificate variableName of Certificate variable to use or key files in OpenSSH format (for a connection by private key).
If this property is specified, an authentication by key is performed: only ..User, ..PrivateKey and ..PrivateKeyPassword are taken into account.
PrivateKeyPasswordCharacter stringPassword of key file (for a connection by private key). ..PrivateKey corresponds to the private key to use.
UserPasswordCharacter stringUser password used for an authentication by password (..User corresponds to the user name).
PortIntegerConnection port (22 by default).
ConnectionTimeOutInteger ou DurationConnection time-out expressed in milliseconds (20 seconds by default, which means 20000 milliseconds). This property can correspond to:
  • an integer corresponding to the number of milliseconds,
  • a Duration variable,
  • Versions 23 and later
    the direct indication of duration (20 s or 20000 ms for example).
    New in version 23
    the direct indication of duration (20 s or 20000 ms for example).
    the direct indication of duration (20 s or 20000 ms for example).
UserCharacter stringName of user.


Note: These properties can be used via one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>

Authentication mode

The authentication by key has priority over the authentication by password.
The authentication by key is attempted if:
  • the server supports this authentication mode.
  • ..PrivateKey is filled.
The authentication by password is attempted if:
  • the server supports this authentication mode.
  • ..UserPassword is filled.
Minimum required version
  • Version 20
This page is also available for…
Comments
Click [Add] to post a comment