Hitachi

JP1 Version 12 JP1/Automatic Operation コマンド・API リファレンス 


1.6.10 setremoteconnection(エージェントレス接続先定義の追加・更新)

機能

エージェントレス接続先定義情報ファイル(CSV形式)を使用して,エージェントレス接続先定義を登録または更新します。

このコマンドを実行する前に,listremoteconnectionsコマンドを実行して,出力されたエージェントレス接続先定義情報ファイルを編集してください。

形式

setremoteconnection
    /file エージェントレス接続先定義情報ファイルのパス
    /user ユーザーID
     {/password パスワード | /passwordfile パスワードファイルパス}

引数

/file

エージェントレス接続先定義情報ファイルのパスを絶対パスまたは相対パスで指定します。指定したファイルが存在しない場合はエラーとなります。

/user

JP1/AOのユーザーIDを指定します。

指定できる文字数は,1~256文字です。

使用できる文字の種類は,半角英数字,「!」,「#」,「$」,「%」,「&」,「'」,「(」,「)」,「*」,「+」,「-」,「.」,「=」,「@」,「\」,「^」,「_」,「|」です。

大文字と小文字は区別しません。

/password

userオプションで指定した,ユーザーのパスワードを指定します。

このオプションまたはpasswordfileオプションのどちらかを指定する必要があります。両方のオプションが指定されている場合,およびどちらのオプションも指定されていない場合はエラーとなります。

指定できる文字数は,1~256文字です。

使用できる文字の種類は,userオプションと同じです。

/passwordfile

userオプションで指定したユーザーのパスワードファイルのパスを絶対パスまたは相対パスで指定します。パスワードファイルはencryptpasswordコマンドで作成します。

このオプションまたはpasswordオプションのどちらかを指定する必要があります。両方のオプションが指定されている場合,およびどちらのオプションも指定されていない場合はエラーとなります。

エージェントレス接続先定義情報ファイルの形式

エージェントレス接続先定義情報ファイルの形式を次の表に示します。

表1‒9 エージェントレス接続先定義情報ファイルの形式

項目

指定内容※1

Id

エージェントレス接続先定義を追加したい場合

空文字を指定します。

エージェントレス接続先定義を更新したい場合

情報を更新したいエージェントレス接続先定義のIDを指定します。

Method

接続先種別として次のどれかを指定します。大文字と小文字は区別しません。

  • IPv4

  • IPv6

  • HostName

IP Address/Host Name

接続先ホストのIPアドレスまたはホスト名を指定します。

Service Group

エージェントレス接続先定義に割り当てるサービスグループを指定します。

Authentication

認証情報を設定するかどうかを指定します。大文字と小文字は区別しません。

  • Enable

    認証情報を設定する。

  • Disable

    認証情報を設定しない。

Protocol※2

接続先ホストとの通信で使用する認証用プロトコルを指定します。大文字と小文字は区別しません。

  • Windows

  • SSH

  • Telnet

SSH Authentication Method※2

「Protocol」が「SSH」の場合に,接続先ホストとの通信で使用する認証方式を指定します。()内に示す文字列で指定することもできます。大文字と小文字は区別しません。

  • Password Authentication(PW)

    パスワード認証

  • Public Key Authentication(PK)

    公開鍵認証

  • Keyboard Interactive Authentication(KI)

    キーボードインタラクティブ認証

User ID※2

接続先ホストにログインするためのユーザーIDを指定します。「Protocol」が「Windows」または「SSH」の場合は必ず指定してください。

Password※2

接続先ホストにログインするためのパスワードを指定します。次の場合に,必ず指定してください。

  • 「Protocol」に「Windows」を指定している場合

  • 「SSH Authentication Method」に「Password Authentication」または「Keyboard Interactive Authentication」を指定している場合

また,「Id」に値が指定されているかどうかで,次のように動作します。

「Id」に値が指定されていない場合
  • 「Password」に「********」を指定するとエラーになります。

「Id」に値が指定されている場合
  • 「Password」に「********」を指定すると,パスワードは変更されません。

  • 「Password」に空文字を指定すると,パスワードが削除されます。

Super User's Password※2

接続先ホストのスーパーユーザーのパスワードを指定します。「Protocol」に「SSH」または「Telnet」を指定している場合に指定します。

また,「********」を指定すると,パスワードは変更されません。空文字を指定した場合は,パスワードが削除されます。

Connection Status

最後にホストに接続した時の状態を指定します。

  • Connection Successful

    接続成功

  • Error

    接続失敗

  • Unknown

    未接続

  • -

    対象外

Connected Time

最後にホストに接続した時刻を指定します。

注※1

値は「"」で囲まれていなくてもエラーになりません。ただし,値に「"」が含まれる場合は,直前に「"」を付加してエスケープしてください。

注※2

「Authentication」で「Disable」を指定している場合は,空文字を指定してください。

格納先

Windowsの場合

JP1/AOのインストール先フォルダ\bin

Linuxの場合

/opt/jp1ao/bin

実行権限

OSのAdministrators権限またはroot権限と,JP1/AOのAdminロールを持つユーザーで実行してください。Administrators権限またはroot権限がない場合は,権限昇格を求めるメッセージが表示されます。

戻り値

コマンドの戻り値を次の表に示します。

戻り値

説明

0

正常に終了しました。

1

引数が不正です。

2

コマンドの実行を中断しました。

3

サービスの状態が不正です。

4

ほかのコマンドを実行中です。

5

通信に失敗しました。

6

認証に失敗しました。

7

パスの指定が不正です。

9

指定したパスが存在しません。

10

指定したパスにアクセスできません。

14

コマンドの実行権限がありません。

230

エージェントレス接続先定義の指定内容が不正です。

231

一部のエージェントレス接続先定義の登録に失敗しました。

232

すべてのエージェントレス接続先定義の登録に失敗しました。

255

そのほかのエラーでコマンドの実行が中断しました。

使用例

Windowsで,list01.csvの内容に従ってエージェントレス接続先定義を追加・更新する場合のコマンドの使用例を示します。

setremoteconnection /file list01.csv /user user01 /password pass01