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.sshScheme
Description:
Id:ethz.sshScheme
Category:accessor
Identifier Syntax

ethz.sshScheme is an accessor using a standard identifier grammar:

<grammar>
  <group>
    <group name="uri">ssh://
      <regex type="anything" />
    </group>
  </group>
</grammar>

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

ArgumentRulesTypingDescription
uriString (unknown)(no description available)
Request Verbs

The following verbs are supported:

Verbs
SOURCESINKEXISTSDELETE
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.sshScheme accessor you must import the module urn:org:netkernel:client:ssh:

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

The ssh:// scheme allows files on a remote SSH server to be treated as full ROC resources.

The scheme supports SOURCE, SINK, DELETE, EXISTS verbs.

Default Credentials

All ssh:// requests require credentials. The ssh:// scheme endpoint will always attempt to source its credentials from the resource

res:/etc/SSHCredentials

You must ensure this resource is resolvable when using the ssh:// scheme directly.

See credentials section for the form of this resource.

Examples

To SOURCE the file "/x/y/z/MyFile.txt" from the remote SSH server "server.com"

<request>
  <identifier>ssh://server.com/x/y/z/MyFile.txt</identifier>
  <verb>SOURCE</verb>
</request>

To DELETE the file "/x/y/z/MyFile.txt" from the remote SSH server "server.com"

<request>
  <identifier>ssh://server.com/x/y/z/MyFile.txt</identifier>
  <verb>DELETE</verb>
</request>