Package org.opennms.features.deviceconfig.sshscripting

Interface SshScriptingService

All Known Implementing Classes:

SshScriptingServiceImpl

public interface SshScriptingService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SshScriptingService.Result

Method Summary

Modifier and Type	Method	Description
SshScriptingService.Result	execute(String script, String user, String password, SocketAddress target, String hostKeyFingerprint, Map<String,String> vars, java.time.Duration timeout)	Executes the given script and optionally returns a failure.

Method Detail

execute

SshScriptingService.Result execute(String script,
                                   String user,
                                   String password,
                                   SocketAddress target,
                                   String hostKeyFingerprint,
                                   Map<String,String> vars,
                                   java.time.Duration timeout)

Executes the given script and optionally returns a failure.

Parameters:

script - contains statements separated by new lines

user - the ssh user

password - the ssh user's password

target - the ssh target to connect to

hostKeyFingerprint - host key fingerprint to accept from the target system

vars - variables that can be referenced in the script; variables are referenced by "${varname}" expressions

timeout - used when establishing the ssh interaction and for await statements

Returns: