Skip to main content

Create connection

Creates a new SSH session

Function CreateConnection(Val SSHSettings, Val Proxy = "", Val Logging = Undefined) Export

ParameterCLI optionTypeRequiredDescription
SSHSettings-Structure Of KeyAndValue✔Connection settings structure
Proxy-Structure Of KeyAndValue✖Proxy settings structure, if necessary
Logging-Structure Of KeyAndValue✖Logging settings. See GetLoggingSettings
Returns

Arbitrary, Map of KeyAndValue - Create connection

tip

Get the connection configuration using the functions GetSettingsLoginPassword, GetSettingsPrivateKey, GetSettingsViaAgent

Caution

NOCLI: this method is not available in CLI version

1C:Enterprise/OneScript code example
    Host = "172.33.0.13";
    Port = "2222";

    UseProxy          = True;
    ProxySettings     = Undefined;
    AuthorizationType = "By login and password";

    If AuthorizationType = "By login and password" Then

        Login    = "bayselonarrend";
        Password = "12we...";

        SSHSettings = OPI_SSH.GetSettingsLoginPassword(Host, Port, Login, Password);

    ElsIf AuthorizationType = "By key" Then

        Login      = "bayselonarrend";
        PrivateKey = "./ssh_key";
        PublicKey  = "./ssh_key.pub";

        SSHSettings = OPI_SSH.GetSettingsPrivateKey(Host, Port, Login, PrivateKey, PublicKey);

    ElsIf AuthorizationType = "Keyboard interactive" Then

        Login    = "bayselonarrend";
        Password = "12we...";

        AnswersArray = New Array;
        AnswersArray.Add(Password);

        SSHSettings = OPI_SSH.GetSettingsKI(Host, Port, Login, AnswersArray);

    Else

        Login       = "bayselonarrend";
        SSHSettings = OPI_SSH.GetSettingsViaAgent(Host, Port, Login);

    EndIf;

    If UseProxy Then

        ProxyType = "http"; // http, socks5, socks4

        ProxyAddress  = "127.0.0.1";
        ProxyPort     = "8071";
        ProxyLogin    = "proxyuser";
        ProxyPassword = "12we...";

        ProxySettings = OPI_SSH.GetProxySettings(ProxyAddress, ProxyPort, ProxyType, ProxyLogin, ProxyPassword);

    EndIf;

    Result = OPI_SSH.CreateConnection(SSHSettings, ProxySettings);
Result
"AddIn.OPI_SSH.Main"