WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:ethz.sshGet
Description:
Id:ethz.sshGet
Category:accessor
Identifier Syntax

ethz.sshGet is an accessor using Active URI syntax with the following base identifiers:

Base
active:sshGet

and the following arguments: (for more details on argument passing details see here)

ArgumentRulesTypingDescription
remote
Mandatory
Representation (java.lang.Object)ssh: URI of the remote file
credentials
Mandatory
Representation (java.lang.Object)The ssh credentials
Request Verbs

The following verb is supported:

Verb
SOURCE
Response

The following response representations can be returned for SOURCE requests:

SOURCE Representations
Readable Binary Stream

This accessor throws no documented exceptions.

Import Requirements

To use ethz.sshGet accessor you must import the module urn:org:netkernel:client:ssh:

<import>
  <uri>urn:org:netkernel:client:ssh</uri>
</import>

active:sshGet sources a file located on a remote SSH server and makes it available to the ROC domain as an IReadableBinaryStream representation.

remote

The remote argument must be an ssh: URI including the hostname and path to the remote file. For example:

ssh://remote.server.com/path/path/the-file

credentials

The credentials argument are the ssh credentials required to connect to the remote host. See credentials section for details.

Example

The following request would source the file "/x/y/z/MyFile.txt" from the remote SSH server "server.com"

<request>
  <identifier>active:sshGet</identifier>
  <argument name="remote">ssh://server.com/x/y/z/MyFile.txt</argument>
  <argument name="credentials">res:/resources/my-ssh-credentials-for-server.com</argument>
</request>