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