Skip to main content

Get log

Retrieves connection log data (when in-memory logging is enabled)

Function GetLog(Val Connection, Val AsString = False, Val EventCount = 100) Export

ParameterCLI optionTypeRequiredDescription
Connection-Arbitrary✔AddIn object with open connection
AsString-Boolean✖True > returns log as a single string, False > as an array
EventCount-Number✖Number of recent events to retrieve. 0 > no limits
Returns

String, Map Of KeyAndValue - Log as a string or a map with the full execution result

Caution

NOCLI: this method is not available in CLI version

1C:Enterprise/OneScript code example
    LogFile         = GetTempFileName("txt");
    LoggingSettings = OPI_SSH.GetLoggingSettings(True, 100, LogFile);

    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 = "https://hut.openintegrations.d...";
        PublicKey  = "https://hut.openintegrations.dev/test_data/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);

        Port = "2223";

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

    Else

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

    EndIf;

    If UseProxy Then

        ProxyType = "http";

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

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

    EndIf;

    Connection = OPI_SSH.CreateConnection(SSHSettings, ProxySettings, LoggingSettings);

    If Not OPI_SSH.IsConnector(Connection) Then
        Raise OPI_Tools.JSONString(Connection);
    EndIf;

    Result = OPI_SSH.ExecuteCommand(Connection, "whoami");

    Result = OPI_SSH.GetLog(Connection);
Result
{
 "logs": [
  "[2026-05-26 13:43:42.298] Connecting to SSH server",
  "[2026-05-26 13:43:42.390] Connected to SSH server"
 ],
 "result": true,
 "returned": 2,
 "total": 2
}