Secure Shell (SSH) コネクタのメソッド
Secure Shell (SSH) コネクタのメソッドを使用して、SSH 接続の確立、確立された接続を介したコマンドの実行、セッションの切断を行うことができます。
コネクト
SSH 接続を確立します。リモートマシンへの接続に必要な情報を指定します。
設定アイコン (
) を選択して、認証タイプを選択します。
サポートされている認証タイプは、Password、KeyboardInteractive、および KeyFileAuthentication です。
パスワードはデフォルトの認証タイプです。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| HostName | リモートサーバーのホスト名または IP アドレス。 | データ入力 | 文字列 |
| Username | SSH アカウントのユーザー名。 | データ入力 | 文字列 |
| Password |
パスワードの安全な文字列表現。SSH アカウントのパスワード。 次の例に示すように、SecureStringEncode コンポーネントを使用して、安全な文字列パスワードをエンコードできます。詳細については、「SecureStringEncode コンポーネントの使用」を参照してください。
このタスクを実行した後、リモートサーバーに接続できます。 |
データ入力 | SecureString |
| Port | オプション。SSH 接続のポート番号です。デフォルト値は 22 です。 | データ入力 | 整数 |
| CreateShell | オプション。True の場合、接続成功時にシェルストリームが作成されます。この接続で実行されているコマンドはすべてシェルを使用します。 False の場合、この接続で実行されているコマンドはシェルを使用しません。 デフォルト値は true です。 |
データ入力 | ブーリアン |
| KeyboardInteractiveAuth | チャレンジとしてのパスワード。 True の場合、サーバーはユーザーの ID を確認するためにクライアントにパスワードの入力を求めます。password パラメーターに指定された値は、クライアントからの応答として共有されます。 このパラメーターは、KeyboardInteractive が [認証] タイプに選択されている場合にのみ表示されます。 |
データ入力 | ブーリアン |
| KeyFilepath | 秘密鍵のパス。 このパラメーターは、KeyFileAuthentication が [認証] タイプに選択されている場合にのみ表示されます。 |
データ入力 | 文字列 |
| Passphrase | オプション。秘密鍵が Passphrase を使用して暗号化されている場合は、秘密鍵を使用するために Passphrase パラメータ内に同じ値が指定されます。 このパラメーターは、KeyFileAuthentication が [認証] タイプに選択されている場合にのみ表示されます。 |
データ入力 | 文字列 |
RunCommand
SSH 接続を確立した後、RunCommand メソッドを使用して、確立された接続を介してコマンドを実行します。
| パラメーター | 説明 | データポートタイプ | データタイプ |
|---|---|---|---|
| Command | messages や scripts など、リモート SSH サーバー上で実行する必要があるコマンドには、有効なシェルコマンド、あるいはリモートサーバーが理解できる実行可能コマンドを使用できます。 以下の例では、echo hello です。 |
データ入力 | 文字列 |
| Timeout | オプション。インタラクティブシェルの使用時に SSH サーバーからのコマンドの出力を待機する最大時間 (秒) を指定するパラメーター。 デフォルト値は 30 です。 |
データ入力 | 整数 |
| Return | 実行されたコマンドの結果。 たとえば、自動化を実行した後、Return パラメーターの [データプレビュー] で「hello」と表示されます。 |
データ出力 | 文字列 |
Disconnect
コマンドを実行した後、Disconnect メソッドを使用して、確立された接続を切断します。
次の例は、Disconnect メソッドを追加した後の自動化全体を示しています。