Legacy API

WQL queries

WinRMWqlExecutor.executeWql(...)^[4]:

WinRMWqlExecutor result = WinRMWqlExecutor.executeWql(
    protocol,        // WinRMHttpProtocolEnum.HTTP or HTTPS (null → HTTP)
    hostname,        // mandatory
    port,            // Integer, null → 5985 (HTTP) / 5986 (HTTPS)
    username,        // "DOMAIN\\user" or "user", mandatory
    password,        // char[]
    namespace,       // null → ROOT\CIMV2
    wqlQuery,        // mandatory
    timeout,         // long, milliseconds, > 0
    ticketCache,     // java.nio.file.Path, Kerberos ticket cache; null → log in with the password
    authentications  // List<AuthenticationEnum>, null/empty → NTLM
);

result.getHeaders();        // List<String> — column names
result.getRows();           // List<List<String>> — values in header order
result.getExecutionTime();  // long, milliseconds

Declared exceptions: WinRMException^[5], WqlQuerySyntaxException^[6], java.util.concurrent.TimeoutException — all checked.

Remote commands

WinRMCommandExecutor.execute(...)^[7]:

WindowsRemoteCommandResult result = WinRMCommandExecutor.execute(
    command,              // mandatory
    protocol,             // null → HTTP
    hostname,             // mandatory
    port,                 // null → protocol default
    username,             // mandatory
    password,             // char[]
    workingDirectory,     // nullable; ignored when localFileToCopyList is not empty
    timeout,              // long, milliseconds, > 0
    localFileToCopyList,  // List<String> of local files to copy first, nullable
    ticketCache,          // nullable
    authentications       // null/empty → NTLM
);

result.getStdout();
result.getStderr();
result.getStatusCode();     // process exit code
result.getExecutionTime();  // float, seconds

Files listed in localFileToCopyList are copied to the host first, and each reference to them in command is rewritten to the remote copy — the same engine as the fluent upload(...); see File Transfers^[8].

Declared exceptions: java.io.IOException, java.util.concurrent.TimeoutException, WindowsRemoteException^[9] — all checked.

Behavior notes

• One connection per call: every invocation performs a full authentication handshake. Code that polls the same host repeatedly pays that cost on every call — the main reason to move to the reusable WinRMClient.
• Command output is decoded as UTF-8 (the remote shell runs under console code page 65001), as with the fluent client by default; see Character encoding^[10].
• The static helpers take no TLS settings: trust a certificate through the JVM trust store (-Djavax.net.ssl.trustStore=...), or, for testing only, disable validation with -Dorg.metricshub.winrm.tls.insecure=true (see TLS / HTTPS^[11]).
• Authentication schemes come from AuthenticationEnum^[12] (NTLM, KERBEROS, BASIC), with the same ordered-fallback semantics^[13] as the fluent AuthScheme^[14]: a list that contains KERBEROS requires HTTPS (over HTTP the call fails, even when NTLM comes first).
• For advanced use, the underlying reusable executor is also public: WinRMExecutorFactory.createInstance(...)^[15] returns a WindowsRemoteExecutor^[16] — but the fluent WinRMClient is the supported way to get connection reuse.