# tSSH

遠隔サーバーとの通信を確立し、安全に機密情報を返します。

定義したセキュアなシェルコマンドに基づいて、リモートコンピューターからデータを返します。

## tSSHの標準プロパティ

これらのプロパティは、標準ジョブのフレームワークで実行されているtSSHを設定するために使われます。

標準のtSSHコンポーネントは、システムファミリーに属しています。

このフレームワーク内のコンポーネントは、すべてのTalend製品で利用できます。

## 基本設定

| プロパティ | 説明 |
| --- | --- |
| [Schema] (スキーマ)と[Edit Schema] (スキーマを編集) | スキーマとは行の説明で、処理された後に次のコンポーネントに渡されるフィールドの数を定義するものです。スキーマは[Built-in] (組み込み)か、[Repository] (リポジトリー)にリモートで保存されます。<br><br><ul> <li> <span>[Built-in] (組み込み)</span>: そのコンポーネントに対してのみスキーマを作成し、ローカルに保管します。<span>[Basic settings] (基本設定)</span>タブにあるコンポーネントスキーマの詳細は、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/basic-settings-tab" target="_blank">[Basic settings] (基本設定)</a>をご覧ください。</li> <li> <span>[Repository] (リポジトリー)</span>: スキーマは作成済みで、リポジトリーに保管されています。さまざまなプロジェクトやジョブフローチャートで再利用できます。<span>[Basic settings] (基本設定)</span>タブにあるコンポーネントスキーマの詳細は、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/basic-settings-tab" target="_blank">[Basic settings] (基本設定)</a>をご覧ください。</li> </ul><br><br>スキーマを変更するには[Edit schema] (スキーマを編集)をクリックします。現在のスキーマがリポジトリータイプの場合は、3つのオプションを利用できます。<br><br><ul> <li> <p> <span>[View schema] (スキーマを表示)</span>: スキーマのみを表示する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Change to built-in property] (組み込みのプロパティに変更)</span>: ローカルで変更を行うためにスキーマを<span>組み込み</span>に変更する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Update repository connection] (リポジトリー接続をアップデート)</span>: リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。</p> <p>変更を現在のジョブにのみ反映する場合は、変更後、<span>[No] (いいえ)</span>を選択し、<span>[Repository Content] (リポジトリーコンテンツ)</span>ウィンドウで再びこのスキーマのメタデータを選択します。</p> </li> </ul> |
| [Host] (ホスト) | SSHサーバーのIPアドレスを入力します。 |
| [Port] (ポート) | SSHサーバーのリスニングポート番号を入力します。 |
| [User] (ユーザー) | SSHサーバーへの認証に使用するユーザー名を入力します。 |
| [Authentication method] (認証方式) | 使用する認証方法として、[Public key] (パブリックキー)、[Password] (パスワード)、または[Keyboard Interactive] (キーボードインタラクティブ)のいずれかを選択します。<br><br><ul> <li> <p> <span>[Public key] (パブリックキー)</span>: パブリックキーへのパスとそのキーのパスフレーズを、<span>[Private key] (プライベートキー)</span>フィールドと<span>[Key Passphrase] (キーパスフレーズ)</span>フィールドにそれぞれ入力します。パスフレーズを入力するためには、<span>[Key Passphrase] (キーパスフレーズ)</span>フィールドの横にある<span>[...]</span>ボタンをクリックし、ポップアップダイアログボックスにパスフレーズを二重引用符で囲んで入力し、<span>[OK]</span>をクリックして設定を保存します。</p> </li> <li> <p> <span>[Password] (パスワード)</span>: 要求されたパスワードを入力します。パスワードを入力するためには、<span>[Password] (パスワード)</span>フィールドの横にある<span>[...]</span>ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符で囲んで入力して<span>[OK]</span>をクリックし、設定を保存します。</p> </li> <li> <span>[Keyboard Interactive] (キーボードインタラクティブ)</span>: <span>[Password] (パスワード)</span>フィールドに必要なパスワードを入力します。パスワードを入力するためには、<span>[Password] (パスワード)</span>フィールドの横にある<span>[...]</span>ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符で囲んで入力して<span>[OK]</span>をクリックし、設定を保存します。</li> </ul> |
| [Pseudo terminal] (擬似端末) | このチェックボックスをオンにすると、端末操作を実行する対話式シェルが呼び出されます。 |
| [Command separator] (コマンドセパレーター) | 必要なコマンドセパレーターを入力します。[Pseudo terminal] (擬似端末)チェックボックスをオンにすると、このフィールドは使用できなくなります。 |
| [Commands] (コマンド) | リモートコンピューターから返される関連情報のコマンドを入力します。[Pseudo terminal] (擬似端末)チェックボックスをオンにすると、このテーブルは端末エミュレーターになり、このテーブルの各行が1つのコマンドになります。 |
| [Use timeout/timeout in seconds] (タイムアウトを秒単位で使用) | タイムアウト時間を定義します。実際の応答時間がこの予想される処理時間を超えると、タイムアウトメッセージが生成されます。 |
| [Standard Output] (標準出力) | 標準出力が返される送信先を選択します。出力は以下のように返されます:<br><br>- to console: 出力は[Run] (実行)ビューのコンソールに表示されます。<br><br>- to global variable:出力は対応するグローバル変数に示されます。<br><br>- both to console and global variable: 出力はコンソールおよびグローバル変数の両方に示されます。<br><br>- normal: 出力は、標準のssh出力になります。 |
| [Error Output] (エラー出力) | エラー出力が返される送信先を選択します。出力は以下のように返されます:<br><br>- to console: 出力は[Run] (実行)ビューのコンソールに表示されます。<br><br>- to global variable:出力は対応するグローバル変数に示されます。<br><br>- both to console and global variable: 出力はコンソールおよびグローバル変数の両方に示されます。<br><br>- normal: 出力は、標準のssh出力になります。 |

## 詳細設定

| プロパティ | 説明 |
| --- | --- |
| [Use session heartbeat] (セッションハートビートを使用) | このオプションを有効にすると、SSH セッション中に一定間隔でハートビートメッセージ(具体的には'SSH\_MSG\_IGNORE')が送信されるようにんなります。これによってタイムアウトが防止され、セッションをアクティブに保つことができます。**[Heartbeat interval] (ハートビート間隔)**フィールドに、間隔を秒単位で指定してください。デフォルト値は**1800秒**(30分)です。 |
| [tStatCatcher Statistics] (tStatCatcher統計) | このチェックボックスを選択すると、ジョブレベルおよび各コンポーネントレベルで処理メタデータが収集されます。 |

## グローバル変数

| 変数 | 説明 |
| --- | --- |
| グローバル変数 | ERROR\_MESSAGE: エラーが発生した時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。この変数はコンポーネントにこのチェックボックスが存在し、[Die on error] (エラー発生時に強制終了)がオフになっている場合のみ機能します。<br><br>STDOUT: リモートコマンドの標準実行の出力。これはAfter変数で、文字列を返します。<br><br>STDERR: リモートコマンドのエラー実行の出力。これはAfter変数で、文字列を返します。<br><br>EXIT\_CODE: リモートコマンドの終了コード。これはAfter変数で、整数を返します。<br><br>Flow変数はのコンポーネントの実行中に機能し、After変数はコンポーネントの実行後に機能します。<br><br>フィールドまたは式に変数を入力する場合は、Ctrl + スペースを押して変数リストにアクセスし、使用する変数を選択します。<br><br>変数の詳細は、[コンテキストと変数を使用](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/contexts-and-variables)をご覧ください。 |

## 使用方法

| 使用方法のガイダンス | 説明 |
| --- | --- |
| **使用ルール** | このコンポーネントはスタンドアロンコンポーネントとして使用できます。<br><br>パスワードやユーザー名などの機密情報については、[Context] (コンテキスト)タブでコンテクスト変数を定義し、Ctrl + スペースを押してアクセスできます。<br><br>情報メモ注: このコンポーネントによって返されるデータのサイズが大きい場合があります。ジョブの完了に非常に長い時間がかかる場合は、より多くのメモリスペースを割り当てます。Run (実行)タブの [Advanced settings] (詳細設定)ビューで、ジョブのメモリスペースを設定できます。 |
| [Connections] (接続) | 外部リンク(このコンポーネントから別のコンポーネントへのリンク):<br><br>[Row] (行): Main<br><br>[Trigger] (トリガー): Run if; On Component Ok; On Component Error; On Subjob Ok; On Subjob Error<br><br>受信リンク (あるコンポーネントからこのコンポーネントへのリンク):<br><br>[Row] (行): Main; Iterate<br><br>[Trigger] (トリガー): Run if; On Component Ok; On Component Error; On Subjob Ok; On Subjob Error<br><br>接続の詳細は、[ジョブにおける接続の使い方](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/using-connections-in-job)をご覧ください。 |
| 制限事項 | コンポーネントの使用は、Unixライクシステム向けに最適化されています。 |

**関連概念**

[SSHによるリモートシステム情報の表示](https://help.qlik.com/talend/ja-JP/components/8.0/system/tssh-displaying-remote-system-information-via-ssh-standard-component "以下のユースケースでは、SSHコマンドを使用して、接続されている遠隔サーバーのホスト名と、このリモートシステムの現在の日付を表示する基本的なジョブについて説明しています。")