9.2 isapi_redirect.confMicrosoft IIS用リダイレクタ動作定義ファイル

<この節の構成>
(1) 形式
(2) ファイルの格納先
(3) 機能
(4) 指定できるキー
(5) 記述例
(6) 注意事項

(1) 形式

次のようにキーを指定します。

<キー名称> = <値>

指定方法
  • 改行までが値になります。
  • #で始まる行はコメントとみなされます。
  • 値が存在しない行を定義した場合,その行は無視されます。キー名称として定義されていないパラメタを定義しても無視されます。
  • 「キー名称=値」として1023文字までが有効となります。超えた部分は切り捨てられます。

(2) ファイルの格納先

<Cosminexusのインストールディレクトリ>¥CC¥web¥redirector¥isapi_redirect.conf

(3) 機能

Microsoft IIS用リダイレクタの動作パラメタを定義します。

(4) 指定できるキー

指定できるキーとデフォルト値を次に示します。このキーに不正な値を指定した場合,動作は保証されません。

キー名称内容デフォルト値
connection_sharingワーカ間でコネクションを共有するかどうかを指定します。
trueを指定した場合:
同一ホスト,同一ポートへ接続するワーカは,ワーカ定義が異なってもコネクションを共有します。
falseを指定した場合:
ワーカ定義が異なるワーカ間のコネクションは共有しません。
true
connect_timeoutリクエスト送信時のWebコンテナに対するコネクション確立のタイムアウト値を0~3600の整数(単位:秒)で指定します。
数値以外の文字列や範囲外の数値を指定した場合は,メッセージを出力し,デフォルト値を使用します。
タイムアウト値に0,またはTCPの持つデータ送信の再送タイマより長い時間を設定した場合,TCPの持つタイムアウト値になります。その場合,不正なタイムアウト値が指定されたことを示すメッセージは出力されません。
30
filter_priorityリダイレクタをISAPIフィルタとして登録する際の,優先順序を指定します。
指定できる文字列を次に示します。
  • hight(優先順序を「高」にする)
  • medium(優先順序を「中」にする)
  • low(優先順序を「低」にする)
high
gateway_hostゲートウェイのホスト名またはIPアドレスを指定します。
Hostヘッダのないリクエストをwelcomeファイルなどにリダイレクトする場合,Locationヘッダに指定するURLのホスト名部分が指定値になります。
なし
gateway_https_schemeクライアントからのリクエストのスキームがhttpsであり,かつSSLアクセラレータなどを介すことでWebサーバへのスキームがhttpとなる場合に,trueを指定します。
trueを指定した場合,Webサーバへのリクエストのスキームがhttpsであるとみなされます。falseを指定した場合は,何も実行されません。
false
gateway_portゲートウェイのポート番号を指定します。Hostヘッダのないリクエストに対して,welcomeファイルなどにリダイレクトするとき,Locationヘッダに指定するURLのポート番号部分が指定値になります。このパラメタを指定した場合は,gateway_hostも必ず指定してください。
gateway_hostを指定してこのパラメタを省略した場合,httpによるアクセスの場合は80,httpsによるアクセスの場合は443が使用されます。
なし
log_file_dirログファイルの出力先ディレクトリを指定します。
相対パスで指定した場合:
<Cosminexusのインストールディレクトリ>¥CC¥web¥redirector以下のディレクトリ名を指します。
絶対パスで指定した場合:
記述されたディレクトリ名を指します。
なお,出力先として指定したディレクトリのアクセス権にUsersグループに対する書き込み権限を設定する必要があります。アクセス権を設定していない場合,ログファイルが出力されません。
log_file_prefixとtrace_log_file_prefixに同じ値を指定した場合は,このキーにtrace_log_file_dirとは異なる値を指定する必要があります。同じ値が指定された場合,リダイレクタは動作しません。
logs
log_file_numリダイレクタ用ログファイルの最大数を指定します。この数を超えると古いログファイルは上書きされます。
1~64の整数値を指定します。
5
log_file_prefixログファイル名のプリフィックスです。実際のログファイル名は,このキーの指定値に<通番>.logが付けられたものになります。
log_file_dirとtrace_log_file_dirに同じ値を指定した場合は,このキーにtrace_log_file_prefixとは異なる値を指定する必要があります。同じ値が指定された場合,リダイレクタは動作しません。
isapi_redirect
log_file_sizeリダイレクタ用ログファイルの一つ当たりのサイズをバイト単位で指定します。
4096~16777216の整数値を指定します。
4194304
log_levelリダイレクタ用ログファイルの出力レベルを指定します。指定するログレベルを一つだけ指定します。
debug,info,errorを指定できます。
error
prf_idPRFデーモン起動時にPRF識別子に指定した文字列を指定します。なし
receive_client_timeoutクライアントからPOSTデータを受信するときのタイムアウト時間を秒単位で指定します。
60~3600の整数値を60(秒)の倍数で指定します。
指定された値が60の倍数になっていない場合は,60の倍数に切り上げた値がタイムアウト時間になります。
300
request_retry_countリクエスト送信時のWebコンテナに対するコネクション確立,およびリクエスト送信のリトライ回数を,1~16の整数(単位:回)で指定します。
リトライ回数には,初回のコネクション確立およびリクエスト送信処理も含まれます。
タイムアウトが発生した場合,リトライするケースは次のとおりです。
  • コネクション確立時にタイムアウトした場合
  • リクエストヘッダ送信時にタイムアウトした場合
上記処理以降の,リクエストボディの送信時にタイムアウトが発生した場合は,リトライは行いません。
リトライ回数に,範囲外の値や,整数値でない値などの異常値を設定した場合,デフォルト値が設定されます。
3
send_timeoutリクエスト送信のタイムアウト値を0~3600の整数(単位:秒)で指定します。
数値以外の文字列や範囲外の数値を指定した場合は,メッセージを出力し,デフォルト値を使用します。
タイムアウト値に0,またはTCPの持つデータ送信の再送タイマより長い時間を設定した場合,TCPの持つタイムアウト値になります。その場合,不正なタイムアウト値が指定されたことを示すメッセージは出力されません。
100
trace_logリダイレクタの保守用トレースログを出力するかどうかを指定します。出力する場合はtrueを,出力しない場合はfalseを指定します。true
trace_log_file_dir保守用トレースログファイルの出力先ディレクトリを指定します。
相対パスで記述した場合:
<Cosminexusのインストールディレクトリ>¥CC¥web¥redirector以下のディレクトリ名を指します。
絶対パスで記述した場合:
記述されたディレクトリ名を指します。
なお,出力先として指定したディレクトリのアクセス権にUsersグループに対する書き込み権限を設定する必要があります。アクセス権を設定していない場合,ログファイルが出力されません。
log_file_prefixとtrace_log_file_prefixに同じ値を指定した場合は,このキーにlog_file_dirとは異なる値を指定する必要があります。同じ値が指定された場合,リダイレクタは動作しません。
logs
trace_log_file_num保守用トレースログファイルの最大数を指定します。この数を超えると古いログファイルは上書きされます。
1~64の整数値を指定します。
4
trace_log_file_prefix保守用トレースログファイル名のプリフィックスを指定します。実際のログファイル名は,このキーの指定値に<通番>.logが付加されたものになります。
log_file_dirとtrace_log_file_dirに同じ値を指定した場合は,このキーにlog_file_prefixとは異なる値を指定する必要があります。同じ値が指定された場合,リダイレクタは動作しません。
iis_rd_trace
trace_log_file_size保守用トレースログファイルの一つ当たりのサイズをバイト単位で指定します。
4096~16777216の整数値を指定します。
16777216
worker_fileワーカ定義ファイルの位置とファイル名を指定します。
相対パスで指定した場合:
<Cosminexusのインストールディレクトリ>¥CC¥web¥redirector以下のファイル名を指します。
絶対パスで指定した場合:
記述されたファイル名を指します。
workers.properties
worker_mount_fileマッピング定義ファイルの位置とファイル名を指定します。
相対パスで指定した場合:
<Cosminexusのインストールディレクトリ>¥CC¥web¥redirector以下のファイル名を指します。
絶対パスで指定した場合:
記述されたファイル名を指します。
uriworkermap.properties
注※ IIS6.0と連携する場合
新規インストール時には,デフォルトのログ出力先ディレクトリは存在しません。ディレクトリを作成してアクセス権を設定するか,一つ上のディレクトリredirectorへアクセス権を設定してください。
また,リダイレクタのログ出力先ディレクトリを変更し,そのパスが途中までしか存在しない場合,存在する最下層のディレクトリに対してアクセス権を設定するか,指定したパスをすべて作成し,アクセス権を設定してください。

(5) 記述例

gateway_host=hostA
gateway_https_scheme=true
gateway_port=443

log_level=error
log_file_size=4194304
log_file_num=5
log_file_dir=logs
log_file_prefix=isapi_redirect
prf_id=prfid
trace_log=true
trace_log_file_size=16777216
trace_log_file_num=4
trace_log_file_dir=logs
trace_log_file_prefix=iis_rd_trace
receive_client_timeout=300
worker_file=workers.properties
worker_mount_file=uriworkermap.properties

(6) 注意事項