PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
This content has been translated automatically. Click here to view the French version.
  • Properties specific to the description of sshSession variables
  • Authentication mode
  • Using sshSession variables
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.
Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.
Example
cMySession is sshSession
cMaSession.Address = "127.0.0.1"
cMaSession.Port = 22
cMaSession.user = "login"
cMaSession.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 the properties User, PrivateKey and PrivateKeyPassword are taken into account..
PrivateKeyPasswordCharacter stringPassword of key file (for a connection by private key). The Property PrivateKey is the private key to use.
UserPasswordCharacter stringUser password used for password authentication (the Property User corresponds to the name of the user).
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
    direct indication of the time (e.g. 20 s or 20000 ms).
    New in version 23
    direct indication of the time (e.g. 20 s or 20000 ms).
    direct indication of the time (e.g. 20 s or 20000 ms).
UserCharacter stringUser 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.
  • the Property PrivateKey is filled in.
The authentication by password is attempted if:
  • the server supports this authentication mode.
  • the Property UserPassword is filled in.

Using sshSession variables

sshSession variables can be used in WLanguage functions:
Minimum version required
  • Version 20
This page is also available for…
Comments
Click [Add] to post a comment