3.5.1 接続設定ファイル
接続設定ファイルの記述形式や設定項目の詳細について説明します。
- メモ
-
接続設定ファイルはサービス連携ジョブを実行するホストに格納します。
(1) ファイルの格納場所
ファイル名およびファイルを格納するフォルダまたはディレクトリとも任意です。ただし,ファイル名を含む絶対パスが255バイト以内となるようなフォルダまたはディレクトリに格納してください。
接続設定ファイルのサンプルファイルの格納場所を次に示します。
- Windowsの場合
JP1/AJS3 - ManagerまたはJP1/AJS3 - Agentのインストールフォルダ\conf\ajscsajob_network.conf.model
- Linuxの場合
/etc/opt/jp1ajs2/conf/ajscsajob_network.conf.model
(2) ファイルの編集手順
既存の接続設定ファイルを任意の場所にコピーしてバックアップを取得してから,テキストエディターで編集します。必要に応じて接続設定ファイルのサンプルファイルを格納場所からコピーして編集してください。
(3) 設定が有効になるタイミング
次回のサービス連携ジョブ実行時
(4) 記述形式
接続設定ファイルの記述形式を次に示します。
CSAServerName=JP1/AJS3 for Cloud Service Applicationsサーバのホスト名 CSAConnectProtocol=JP1/AJS3 for Cloud Service Applicationsサーバと接続するためのプロトコル CSAConnectPortNumber=JP1/AJS3 for Cloud Service Applicationsサーバと接続するためのポート番号 ConnectTimeout=JP1/AJS3 for Cloud Service Applicationsサーバとの接続タイムアウト時間 ProxyAddr=JP1/AJS3 for Cloud Service Applicationsサーバと接続するためのプロキシの指定 CAFile=JP1/AJS3 for Cloud Service ApplicationsサーバとSSL通信するためのサーバ証明書ファイル名 Timeout=JP1/AJS3 for Cloud Service Applicationsサーバとの接続1回の全体の処理時間の上限 CSAConnectRetryCount=JP1/AJS3 for Cloud Service Applicationsサーバとの接続エラーのリトライ回数 CSAConnectRetryInterval=JP1/AJS3 for Cloud Service Applicationsサーバとの接続エラーのリトライ間隔
なお,「#」から始まる行はコメント行です。
(5) 設定項目
設定項目について説明します。
(a) CSAServerName
サービス連携ジョブがJP1/AJS3 for Cloud Service Applicationsサーバと接続するため,JP1/AJS3 for Cloud Service Applicationsサーバのホスト名を指定します。
サービス連携ジョブの実行ホストから名前解決できる値を指定してください。名前解決は,jp1hosts情報またはjp1hosts2情報も有効になります。jp1hostsまたはjp1hosts2の詳細については,マニュアル「JP1/Base 運用ガイド」を参照してください。
- 重要
-
この設定項目はJP1/AJS3 for Cloud Service ApplicationsサーバのIPアドレスで指定できません。
- 指定できる文字数
-
1〜255(単位:バイト)
この設定項目は省略できません。省略した場合,サービス連携ジョブ用コマンドは0以外の戻り値で終了します。
(b) CSAConnectProtocol
サービス連携ジョブがJP1/AJS3 for Cloud Service Applicationsサーバと接続するためのプロトコルを指定します。
- 指定できる値
-
-
http
JP1/AJS3 for Cloud Service Applicationsサーバと非SSLで通信します。
-
https
JP1/AJS3 for Cloud Service ApplicationsサーバとSSLで通信します。
-
- デフォルト値
-
http
「CSAConnectProtocol=」の設定行を省略した場合はデフォルト値が設定されたとみなします。
(c) CSAConnectPortNumber
サービス連携ジョブがJP1/AJS3 for Cloud Service Applicationsサーバと接続するためのポート番号を指定します。
- 指定できる値
-
0〜65535(単位:ポート番号)
- デフォルト値
-
22265
(d) ConnectTimeout
JP1/AJS3 for Cloud Service Applicationsサーバとの接続先ホストへの接続タイムアウト時間を指定します。
ここで指定した時間を待っても接続先ホストとの通信が確立しない場合は,CSAConnectRetryCountで設定したリトライ回数およびCSAConnectRetryIntervalで設定したリトライ間隔で接続をリトライします。
- 指定できる値
-
1〜600(単位:秒)
- デフォルト値
-
10(単位:秒)
「ConnectTimeout=」の設定行を省略した場合はデフォルト値が設定されたとみなします。
なお,サービス連携ジョブが動作するOSの設定,およびシステムのネットワーク設定によっては,接続タイムアウト時間の設定値より短い時間でタイムアウトが発生し接続エラーとなる場合があります。
OSの設定についてはOSのマニュアルを参照してください。
(e) ProxyAddr
JP1/AJS3 for Cloud Service Applicationsとの通信でプロキシを利用する場合に,利用するプロキシを指定します。
「ProxyAddr=」の設定行を省略した場合はプロキシを利用しません(http_proxyなどの環境変数は有効になりません)。
- 指定できる形式
プロトコル://ユーザー:パスワード@プロキシサーバのホスト名:ポート番号
プロトコルは「http://」または「https://」で始まる必要があります。大文字と小文字の区別はしません。
ポート番号を省略した場合は「1080」を仮定します。
不正なデータを指定した場合の動作は保証しません。
- 重要
-
「プロキシサーバのホスト名」にはサービス連携ジョブの実行ホストから名前解決できる値を指定してください。jp1hosts情報またはjp1hosts2情報でのプロキシサーバの名前解決はできません。
- 指定できる文字数
-
-
「http://」で始まる場合は8〜2,083(単位:バイト)
-
「https://」で始まる場合は9〜2,083(単位:バイト)
-
(f) CAFile
JP1/AJS3 for Cloud Service ApplicationsサーバとSSL通信するためにサーバ証明書を検証する場合,サーバ証明書のファイル名を指定します。
指定できるサーバ証明書の形式はPEM形式だけです。DER形式のサーバ証明書を指定した場合,エラーとなります。
「CAFile=」の設定行を省略した場合はサーバ証明書の検証をしません。
- 指定できる文字数
-
1〜511(単位:バイト)
(g) Timeout
JP1/AJS3 for Cloud Service Applicationsサーバとの1回の接続で処理する時間の上限を指定します。
ここで指定した時間を待っても処理が終了しない場合は,CSAConnectRetryCountで設定したリトライ回数およびCSAConnectRetryIntervalで設定したリトライ間隔で処理をリトライします。
- 指定できる値
-
1〜86,400(単位:秒)
- デフォルト値
-
600
「Timeout=」の設定行を省略した場合はデフォルト値が設定されたとみなします。
(h) CSAConnectRetryCount
JP1/AJS3 for Cloud Service Applicationsサーバとの接続ができない場合,またはTimeoutで設定した処理時間の上限を超えた場合のリトライ回数を指定します。
ここで指定した回数分リトライしてもJP1/AJS3 for Cloud Service Applicationsサーバと接続ができなかったり,処理時間の上限を超えたりする場合は,サービス連携ジョブ用コマンドは0以外の戻り値で終了します。
- 指定できる値
-
0〜100(単位:回)
「0」を指定した場合はリトライせず,サービス連携ジョブ用コマンドは0以外の戻り値で終了します。
- デフォルト値
-
2
「CSAConnectRetryCount=」の設定行を省略した場合はデフォルト値が設定されたとみなします。
(6) 注意事項
-
0バイトの行,および空白だけの行は無視されます。
-
各行の先頭に空白やタブが存在する場合,および終端に空白やタブが存在する場合は,空白やタブを取り除いた値を有効な値とみなします。
-
値の中に空白が含まれる場合は,空白も含めて値とみなします。ただし,値にタブが含まれる場合は,サービス連携ジョブ用コマンドは0以外の戻り値で終了します。
- 例1
-
「CAFile=C:\AAA△BBB\CAFile△」の場合,指定値を「CAFile=C:\AAA△BBB\CAFile」とみなします。
(凡例)△:空白
- 例2
-
「CAFile=C:\AAA<\t>BBB\CAFile△」の場合,エラーとなります。
(凡例)<\t>:タブ,△:空白
-
同一の設定項目が複数行に定義されている場合,最後に記載されている行が有効になります。
-
不明なキーワードが存在する場合,サービス連携ジョブ用コマンドは0以外の戻り値で終了します。
-
項目には必ず値を指定してください。値が指定されていない場合,サービス連携ジョブ用コマンドは0以外の戻り値で終了します。
-
1行あたり改行コードを含み4,096バイト以内となるように指定してください。4,096バイトを超える行を指定した場合,サービス連携ジョブ用コマンドは0以外の戻り値で終了します。