2.6 接続先プロパティファイル(接続先名.properties)
次の部品を実行する際に,操作対象の機器との接続に使用する情報を設定するための定義ファイルです。
汎用コマンド実行部品
ファイル転送部品
ターミナル接続部品
コンテンツ部品
形式
指定キー名=設定値
格納先フォルダ
- 非クラスタシステムの場合
JP1/AOのインストール先フォルダ\conf\plugin\destinationsまたは/opt/jp1ao/conf/plugin/destinations
- クラスタシステムの場合
共有フォルダ名\jp1ao\conf\plugin\destinationsまたは共有フォルダ名/jp1ao/conf/plugin/destinations
定義の反映契機
接続先プロパティファイルを参照する部品の実行時
記述内容
指定キー名と設定値を1行に1つずつ指定します。接続先プロパティファイルを記述するときは,次の点に注意してください。
「#」で始まる行はコメント行として扱われます。
空白行は無視されます。
エンコーディングはISO8859-1です。
大文字と小文字は区別されます。
指定する文字列内に「\」が含まれる場合は,「\\」と記述する必要があります。
この場合,「\\」で1バイトとしてサイズを計算してください。
同一の指定キーをファイル内に複数指定した場合は,あとに指定したものが有効となります。
接続先プロパティファイルに不正な設定値が設定された場合,接続先プロパティファイルを参照する部品は,実行エラーとなります。
ファイル名は,ホスト名.properties,またはIPアドレス.propertiesの形式で指定します。ただし,IPv6アドレスの場合,「:」はファイル名に使用できないため,「-」に置き変えて指定してください。例えば,IPv6アドレスが「2001::234:abcd」の場合は「2001--234-abcd.properties」と指定します。
設定項目
キー名 |
設定項目 |
設定できる値 |
---|---|---|
terminal.charset |
通信で使用する文字セットを指定する。 |
|
telnet.port |
ターミナル接続部品を使用して,Telnet接続する際のポート番号を指定する。ユーザー設定プロパティファイル(config_user.properties)のtelnet.port.numberより優先される。 |
0~65535 |
ssh.port |
次の部品を使用して,SSH接続する際のポート番号を指定する。
ユーザー設定プロパティファイル(config_user.properties)のssh.port.numberより優先される。 |
0~65535 |
telnet.prompt.account |
ターミナル接続部品で接続先の機器に接続する場合,ユーザーIDの入力を求める際に出力される文字列を検出するための正規表現パターンを1~1,024文字で指定する。例えば,「Username:」など。 |
正規表現パターンで使用できる文字列 |
telnet.prompt.password |
ターミナル接続部品で接続先の機器に接続する場合,パスワードの入力を求める際に出力される文字列を検出するための正規表現パターンを1~1,024文字で指定する。例えば,「Password:」など。 |
正規表現パターンで使用できる文字列 |
telnet.noStdout.port.list |
ターミナル接続部品で接続したあと,標準出力を返さないサービスのポート番号を1~1,024文字で指定する。ポート番号を複数列挙する場合は「,」で区切って指定する。 |
0~65535および「,」 |
wmi.workDirectory.sharedPath |
汎用コマンド実行部品,ファイル転送部品,およびコンテンツ部品を実行する場合,コマンドの実行時に転送されるファイルが格納される共有フォルダの絶対パスを指定する。絶対パスは0~80文字で指定する。 「このプロパティで指定した値\Hitachi\CMALib\JP1AO」フォルダが作成され,その配下に「home」と「launcher」フォルダが作成される。 このプロパティは,次の場合に指定する必要がある。
このプロパティを指定する場合,wmi.workDirectory.sharedNameも指定する必要がある。またwmi.workDirectory.sharedNameで指定したフォルダ名と一致させる必要がある。 指定を省略した場合,次のフォルダが作成される。
|
半角英数字,「\」,「:」,「-」,「_」,「.」 |
wmi.workDirectory.sharedName |
汎用コマンド実行部品,ファイル転送部品,およびコンテンツ部品を実行する場合,コマンドの実行時に転送されるファイルが格納される共有フォルダの名称(共有名)を指定する。共有フォルダの名称は0~80文字で指定する。 「このプロパティで指定した値\Hitachi\CMALib\JP1AO」フォルダが作成され,その配下に「home」と「launcher」フォルダが作成される。 このプロパティは,次の場合に指定する必要がある。
このプロパティは,wmi.workDirectory.sharedPathを指定した場合に指定する。指定例を次に示す。 wmi.workDirectory.sharedPath = F:\\work wmi.workDirectory.sharedName = work |
半角英数字,「-」,「_」,「.」 |
wmi.adapter.id |
Windows環境で複数のJP1/AOから,汎用コマンド実行部品,ファイル転送部品,またはコンテンツ部品を実行する場合に指定する。システム上に存在するほかのJP1/AOとは異なる値を指定する必要がある。なお,Windows環境に同時に接続できるJP1/AOは2台までである。 また,Windows環境で同一ホスト上の物理ホストと論理ホストに存在する操作対象の機器に対して,汎用コマンド実行部品,ファイル転送部品,またはコンテンツ部品を同時に実行したい場合に指定する。このプロパティは,各論理ホストの接続先プロパティファイルで,論理ホストごとに異なる値を指定する。 プロパティの値は1~2文字で指定する。 なお,プロパティの値に「2」(一文字)を指定してはいけない。 このプロパティで指定した値は,接続先Windows上のサービス名や,共有フォルダ配下に作成するフォルダ名の一部に使用される。 「wmi.workDirectory.sharedPathで指定したプロパティ\Hitachi\CMALib\JP1AO_このプロパティで指定した値」フォルダが作成され,その配下に「home」と「launcher」フォルダが作成される。 ローカル実行機能が有効で,操作対象の機器がローカルホストの場合は,本プロパティの指定は無効となります。 |
半角英数字 |
wmi.win32.UACAdministratorsExec | 操作対象の機器のOSがWindowsで,UACが有効な場合にSystemアカウント以外のユーザーで部品を実行するための設定を有効にするかどうかを指定する。ユーザー設定プロパティファイル(config_user.properties)のplugin.wmi.win32.UACAdministratorsExecより優先される。 |
|
wmi.win32.CreationFlags.CREATE_NO_WINDOW | 操作対象の機器のOSがWindowsの場合,Systemアカウント以外のユーザーでプログレスバーを表示するようなコマンドを実行すると,正しく動作コマンドを実行すると,正しく動作しない場合があるときに有効にする。ユーザー設定プロパティファイル(config_user.properties)のplugin.wmi.win32.CreationFlags.CREATE_NO_WINDOWより優先される。 |
|
ssh.workDirectory |
OSがUNIXの操作対象の機器に対して,ファイル転送部品およびコンテンツ部品を実行する場合の作業用フォルダのパスを絶対パスで指定する。※1絶対パスは0~128文字で指定する。 フォルダまたはシンボリックリンクを指定する。また,パスにシンボリックリンクを含めることができる。指定した値が不正の場合,ファイル転送部品およびコンテンツ部品は異常終了となる。 このプロパティで指定したパスや,親フォルダに対してファイル転送部品を実行した場合は,製品サポートの対象外である。 作業用フォルダには,接続ユーザーに対して,読み込み権限,書き込み権限および実行権限が必要である。 ファイル転送部品やコンテンツ部品を実行したときに,このプロパティで指定したパスが存在しない場合は,部品実行時にフォルダを作成する。フォルダが作成できなかった場合は,部品は異常終了となる。フォルダを新規作成するかどうかに関わらず,作業用フォルダのパーミッションを777に変更すること。 |
半角英数字,「/」,「-」,「_」,「.」 |
common.executionDirectory |
|
0~128文字の文字列 |
- 注※1
-
作業用ディレクトリは次の優先順位で決定します。
優先順位
設定値
1
ssh.workDirectoryで指定した値
2
ユーザー設定プロパティファイル(config_user.properties)のplugin.remoteCommand.workDirectory.sshで設定した値
3
/tmp/Hitachi_AO
- 注※2
実行ディレクトリは次の優先順位で決定します。
優先順位
設定値
1
部品に定義された実行ディレクトリの値
2
common.executionDirectoryで指定した値
3
ユーザー設定プロパティファイル(config_user.properties)のplugin.remoteCommand.executionDirectory.wmiで指定した値
4
操作対象の機器の接続先のWindowsの環境変数%TEMP%の値
- 注※3
実行ディレクトリは次の優先順位で決定します。
優先順位
設定値
1
部品に定義された実行ディレクトリの値
2
common.executionDirectoryで指定した値
3
ユーザー設定プロパティファイル(config_user.properties)のplugin.remoteCommand.executionDirectory.sshで指定した値
4
/tmp
定義例
terminal.charset=UTF-8 telnet.port=23 ssh.port=22 telnet.prompt.account=login telnet.prompt.password=password telnet.noStdout.port.list=25,80,110