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

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

Base
active:sshPut

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

ArgumentRulesTypingDescription
local
Mandatory
Representation (java.lang.Object)The resource to upload
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
java.lang.Void

This accessor throws no documented exceptions.

Import Requirements

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

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

active:sshPut transfers a local resource to a file located on a remote SSH server.

local

The local resource to be transfered to the remote file. This resource must be transreptable to IReadableBinaryStream.

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 transfer res:/mylocalresource to the file "/x/y/z/MyFile.txt" on the remote SSH server "server.com"

<request>
  <identifier>active:sshPut</identifier>
  <argument name="local">res:/mylocalresource</argument>
  <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>