new-SSHSession -- 安全な SSH セッションの作成

リファレンスガイド › AutoShell › AutoShell コアリファレンス › AutoShell の一般コマンド › new-SSHSession コマンド -- 安全な SSH セッションの新規作成（Funclet）

new-SSHSession コマンド -- 安全な SSH セッションの新規作成（Funclet）

new-SSHSession コマンドは、SSH サーバ上でセッションを作成し、そのセッションを表す CASSHELL オブジェクトを返します。このセッション上でアクションを行うには、このオブジェクトを保存する必要があります。このコマンドは通常、run-SSHCommand または run-SSHShell コマンドと共に使用します。

コマンドの構文は、以下のとおりです。

new-SSHSession -host hostname [-user username] [-pass password] [-key key] 
[-prompt prompt][-port portnumber]

-host hostname

SSH サーバの名前です。

-user username

（オプション）リモートノードへのログインに使用するユーザ名を指定します。パスワードまたは公開鍵認証を使用する場合、ユーザ名は必須です。ユーザ名を指定しない場合、AutoShell へのログイン時に入力されたユーザ名が使用されます。引用符で囲まれていない引数トークンは自動的に文字列に変換されます。式のコードは丸かっこ内に配置して、式が自動的に引用符で囲まれないようにします。

デフォルト： $$User

-pass password

（オプション）リモートノードへのログインに使用するパスワードを指定します。パスワードを指定しない場合、AutoShell へのログイン時に入力されたパスワードが使用されます。このコマンドを発行した後に非表示でパスワードを入力するには、引数としてオプションのプロンプトと PW_GET() を指定します。引用符で囲まれていない引数トークンは自動的に文字列に変換されます。式のコードは丸かっこ内に配置して、式が自動的に引用符で囲まれないようにします。

デフォルト： $$Pass

-key key

（オプション）リモートノードへのログインに使用する、RSA の秘密鍵が保存されているファイルへの絶対パスまたは相対パスを指定します。秘密鍵とパスワードが指定された場合、AutoShell はまず公開鍵でログオンしようとします。公開鍵でのログオンに失敗した場合は、パスワードでログオンします。引用符で囲まれていない引数トークンは自動的に文字列に変換されます。式のコードは丸かっこ内に配置して、式が自動的に引用符で囲まれないようにします。このパラメータは、公開鍵認証を使用して、オンザフライで SSH セッションを作成する場合にのみ必要です。

デフォルト： ""

-prompt prompt

（オプション）入力できるようになったことを示すために SSH サーバが表示するプロンプト文字列の末尾の固定部分（例： AutoShell では「::->」）を指定します。この情報は、SSH セッションで実行されたコマンドの完了を判断するために必要です。できるだけ多くの固定文字を指定します。引用符で囲まれていない引数トークンは自動的に文字列に変換されます。式のコードは丸かっこ内に配置して、式が自動的に引用符で囲まれないようにします。

デフォルト： "::->"

-port portnumber

（オプション）ターゲットシステムに接続するポートです。

デフォルト： SSH の標準ポート 22。

戻り値

CASSHELL オブジェクトを返します。このオブジェクトを run-SSHCommand funclet に渡してコマンドを実行したり、run-SSHSession に渡して SSH サーバ上で対話型セッションを実行したりすることができます。

例

SSH セッションを作成します、サーバでは、指定したアカウントに対し、SSH シェルとして AutoShell を設定しているものとします。コマンドを実行し、切断します。

ssh=new-SSHSession -host client8 -user bob -pass xyz42 -prompt ::->
? run-SSHCommand -session ssh -command "! ver"
ssh.disconnect();