tSSH Properties - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Component family

System

 

Function

Returns data from a remote computer, based on the secure shell command defined.

Purpose

Allows to establish a communication with distant server and return securely sensible information.

Basic settings

Schema and Edit Schema

A schema is a row description, it defines the number of fields to be processed and passed on to the next component. The schema is either Built-in or stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this option to view the schema only.

  • Change to built-in property: choose this option to change the schema to Built-in for local changes.

  • Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the [Repository Content] window.

Click Sync columns to retrieve the schema from the preceding component in the Job.

 

 

Built-in: You create and store the schema locally for this component only. Related topic: see Talend Studio User Guide.

 

 

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and job flowcharts. Related topic: see Talend Studio User Guide

 

Host

IP address

 

Port

Listening port number

 

User

User authentication information

Authentication method

Public Key/Key Passphrase/Private Key

Select the relevant option.

In case of Public Key, type in the passphrase, if required, in the Key Passphrase field and then in the Private key field, type in the private key or click the three dot button next to the Private key field to browse to it.

To enter the passphrase, click the [...] button next to the passphrase field, and then in the pop-up dialog box enter the passphrase between double quotes and click OK to save the settings.

Authentication method

Password/Password

Select the relevant option.

In case of Password,type in the required password in the Password field.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

Authentication method

Keyboard Interactive/Password

Select the relevant option.

In case of Keyboard Interactive, type in the required password in the Password field.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

 

Pseudo terminal

Select this check box to call the interactive shell that performs the terminal operations.

 

Command separator

Type in the command separator required. Once the Pseudo terminal check box is selected, this field becomes unavailable.

 

Commands

Type in the command for the relevant information to be returned from the remote computer. When you select the Pseudo terminal check box, this table becomes a terminal emulator and each row in this table is a single command.

 

Use timeout/timeout in seconds

Define the timeout time period. A timeout message will be generated if the actual response time exceeds this expected processing time.

 

Standard Output

Select the destination to which the standard output is returned. The output may be returned to:

- to console: the output is displayed in the console of the Run view.

- to global variable: the output is indicated by the corresponding global variable.

- both to console and global variable: the output is indicated both of the two means.

- normal: the output is a standard ssh output.

 

Error Output

Select the destination to which the error output is returned. The output may be returned to:

- to console: the output is displayed in the console of the Run view.

- to global variable: the output is indicated by the corresponding global variable.

- both to console and global variable: the output is indicated both of the two means.

- normal: the output is a standard ssh output.

Advanced settings

tStatCatcher Statistics

Select this check box to gather the processing metadata at the Job level as well as at each component level.

Connections

Outgoing links (from this component to another):

Row: Main

Trigger: Run if; On Component Ok; On Component Error; On Subjob Ok; On Subjob Error.

Incoming links (from one component to this one):

Row: Main; Iterate

Trigger: Run if; On Component Ok; On Component Error; On Subjob Ok; On Subjob Error.

For further information regarding connections, see Talend Studio User Guide.

Global Variables

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

STDOUT: the standard execution output of the remote command. This is an After variable and it returns a string.

STDERR: the error execution output of the remote command. This is an After variable and it returns a string.

EXIT_CODE: the exit code of the remote command. This is an After variable and it returns an integer.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

This component can be used as standalone component.

Note that for some sensitive information such as password and username, you can define the context variables in the Contexts tab and press Ctrl + Space to access them.

Log4j

If you are using a subscription-based version of the Studio, the activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

The component use is optimized for Unix-like systems.