sshLocalTunnel (Local SSH Tunnel)

A local SSH tunnel stateful behaviour provides a bi-directional TCP connection running through the encrypted channel of SSH which begins at a port number locally (in this context, 'local' is the Flow server) and ends at a port number on the remote server.

This is useful to effectively 'proxy' through (usually over multiple hops) to some secure resource which the remote host does not want accessible by any other means.

The local port, password, remote host, remote port, host, port and username are mandatory fields.

class names

scala: code.model.flows.processors.ssh.LocalSshTunnelProviderFactory
javascript: code_model_flows_processors_ssh_LocalSshTunnelProviderFactory

aliases

localSshTunnel sshLocal localSsh

start type

end type

config

{"categories":[{"defaultCollapsed":true,"fields":["isRunning","runOnlyOnHosts","runOnlyOnRanks","runOnlyOnRoles","deepDiagnostics"],"name":"Advanced Run Configuration"}],"fieldName":"sshLocalTunnel","fields":[{"default":[],"fieldName":"sshLocalTunnel.runOnlyOnRanks","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"sshLocalTunnel.runOnlyOnRanks","hidden":false,"hideLabel":false,"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"I","validators":[]},"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"A"},{"default":null,"fieldName":"sshLocalTunnel.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"sshLocalTunnel","fieldName":"sshLocalTunnel.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.bundle","hidden":false,"hideLabel":false,"name":"bundle","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":false,"fieldName":"sshLocalTunnel.deepDiagnostics","hidden":false,"hideLabel":false,"name":"deepDiagnostics","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":[],"fieldName":"sshLocalTunnel.runOnlyOnRoles","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"sshLocalTunnel.runOnlyOnRoles","hidden":false,"hideLabel":false,"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["frontend","backend","viewer"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"A"},{"default":"","fieldName":"sshLocalTunnel.description","hidden":false,"hideLabel":false,"name":"description","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"T1726099537103_F99803548791Y0OX2I","fieldName":"sshLocalTunnel.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"categories":[{"defaultCollapsed":true,"fields":["throttleRpm","mutualThrottlingKey","delayBetweenThrottlingChecks","throttleCheckRetryLimit"],"name":"Quality of Service (QOS)"},{"defaultCollapsed":true,"fields":["testData","testDataTransformFunc","assertionFunc"],"name":"Testing"}],"fieldName":"sshLocalTunnel.tunnel","fields":[{"default":-1,"fieldName":"sshLocalTunnel.tunnel.throttleCheckRetryLimit","hidden":false,"hideLabel":false,"name":"throttleCheckRetryLimit","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"localSshTunnel","fieldName":"sshLocalTunnel.tunnel.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"categories":[],"fieldName":"sshLocalTunnel.tunnel.server","fields":[{"default":5000,"fieldName":"sshLocalTunnel.tunnel.server.keepaliveTimeout","hidden":false,"hideLabel":false,"name":"keepaliveTimeout","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.server.username","hidden":false,"hideLabel":false,"name":"username","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.server.host","hidden":false,"hideLabel":false,"name":"host","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.server.port","hidden":false,"hideLabel":false,"name":"port","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.server.knownHosts","hidden":false,"hideLabel":false,"name":"knownHosts","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"name":"server","readonly":false,"renderStrategies":[],"type":"O"},{"default":-1,"fieldName":"sshLocalTunnel.tunnel.throttleRpm","hidden":false,"hideLabel":false,"name":"throttleRpm","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"categories":[],"fieldName":"sshLocalTunnel.tunnel.passwordAuthenticator","fields":[{"default":null,"fieldName":"sshLocalTunnel.tunnel.passwordAuthenticator.password","hidden":false,"hideLabel":false,"name":"password","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"name":"passwordAuthenticator","readonly":false,"renderStrategies":[],"type":"O"},{"default":"","fieldName":"sshLocalTunnel.tunnel.mutualThrottlingKey","hidden":false,"hideLabel":false,"name":"mutualThrottlingKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"categories":[],"fieldName":"sshLocalTunnel.tunnel.publicKeyAuthenticator","fields":[{"default":null,"fieldName":"sshLocalTunnel.tunnel.publicKeyAuthenticator.privKey","hidden":false,"hideLabel":false,"name":"privKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.publicKeyAuthenticator.pubKey","hidden":false,"hideLabel":false,"name":"pubKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.publicKeyAuthenticator.passPhrase","hidden":false,"hideLabel":false,"name":"passPhrase","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"name":"publicKeyAuthenticator","readonly":false,"renderStrategies":[],"type":"O"},{"default":10000,"fieldName":"sshLocalTunnel.tunnel.heartbeatFrequency","hidden":false,"hideLabel":false,"name":"heartbeatFrequency","readonly":false,"renderStrategies":[],"type":"L","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.testDataTransformFunc","hidden":false,"hideLabel":false,"name":"testDataTransformFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"default":"T1726099537103_F99803548769CA4X0Y","fieldName":"sshLocalTunnel.tunnel.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.testData","hidden":false,"hideLabel":false,"name":"testData","readonly":false,"renderStrategies":[],"type":"Jv","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.assertionFunc","hidden":false,"hideLabel":false,"name":"assertionFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.localPort","hidden":false,"hideLabel":false,"name":"localPort","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":-1,"fieldName":"sshLocalTunnel.tunnel.delayBetweenThrottlingChecks","hidden":false,"hideLabel":false,"name":"delayBetweenThrottlingChecks","readonly":false,"renderStrategies":[],"type":"L","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.remotePort","hidden":false,"hideLabel":false,"name":"remotePort","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":null,"fieldName":"sshLocalTunnel.tunnel.remoteHost","hidden":false,"hideLabel":false,"name":"remoteHost","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Connector Configuration","name":"tunnel","readonly":false,"renderStrategies":[],"type":"O"},{"default":[],"fieldName":"sshLocalTunnel.runOnlyOnHosts","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"sshLocalTunnel.runOnlyOnHosts","hidden":false,"hideLabel":false,"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"sshLocalTunnel.isRunning","hidden":false,"hideLabel":false,"name":"isRunning","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":"statefulBehaviour","fieldName":"sshLocalTunnel.type","hidden":false,"hideLabel":false,"name":"type","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Stateful Behaviour Configuration","name":"sshLocalTunnel","readonly":false,"renderStrategies":[],"type":"O"}