pluginConfiguration - Web サーバー・プラグイン (pluginConfiguration)

Web サーバー・プラグイン構成ファイルを生成するときに使用されるプロパティー

NameTypeDefaultDescription
pluginInstallRootstring/opt/IBM/WebSphere/PluginsWeb サーバー・ホストのファイル・システム内の、Web サーバー・プラグインのインストール場所
webserverNamestringwebserver1この構成が使用される Web サーバーの名前。 ログ・ファイル名やディレクトリーによってプラグイン・ログ・ファイルの場所が明示的に指定されていない場合に、プラグイン・ログ・ファイルの場所を生成するために使用されます。
webserverPortint
Min: -1

Max: 65535
80Web サーバー HTTP ポート
webserverSecurePortint
Min: -1

Max: 65535
443Web サーバー HTTPS ポート
sslKeyringLocationstring${pluginInstallRoot}/config/${webserverName}/plugin-key.kdbWeb サーバー・ホスト上の SSL 鍵リング・ファイルの完全修飾パス
sslStashfileLocationstring${pluginInstallRoot}/config/${webserverName}/plugin-key.sthWeb サーバー・ホスト上の SSL stash ファイルの完全修飾パス
sslCertlabelstringWeb コンテナーがプラグインからクライアント証明書を要求したときにプラグインが使用することになる、鍵リング内の証明書のラベルを指定します。
ipv6Preferredbooleanfalse{null} または {0} のアプリケーション・サーバー・ホスト名を解決するとき、可能な場合に使用される優先のアドレス・タイプ
httpEndpointRef最上位の httpEndpoint エレメント (ストリング) の参照。defaultHttpEndpoint生成される plugin-cfg.xml ファイルに含める HTTP エンドポイントの ID を指定します。 このエンドポイントは、クラスター内のサーバーを定義します。 デフォルト値は、'defaultHttpEndpoint' です。
connectTimeout期間 (精度: 秒)5sアプリケーション・サーバーが Web サーバーとの接続を維持する最大時間を示します。. 正整数の後に時間単位 (時間 (h)、分 (m)、または秒 (s)) を付けて指定してください。 例えば、30 秒は 30s と指定します。 単一エントリーに複数の値を含めることができます。 例えば、90 秒の場合、1m30s とすることができます。
serverIOTimeout期間 (精度: 秒)900sWeb サーバー・プラグインがアプリケーション・サーバーへの要求の送信またはアプリケーション・サーバーからの応答の受信を待機する最大時間を示します。. 正整数の後に時間単位 (時間 (h)、分 (m)、または秒 (s)) を付けて指定してください。 例えば、30 秒は 30s と指定します。 単一エントリーに複数の値を含めることができます。 例えば、90 秒の場合、1m30s とすることができます。
wsServerIOTimeout期間 (精度: 秒)Web サーバー・プラグインがアプリケーション・サーバーへの要求の送信またはアプリケーション・サーバーからの WebSocket 応答の受信を待機する最大時間を示します。. 正整数の後に時間単位 (時間 (h)、分 (m)、または秒 (s)) を付けて指定してください。 例えば、30 秒は 30s と指定します。 単一エントリーに複数の値を含めることができます。 例えば、90 秒の場合、1m30s とすることができます。
wsServerIdleTimeout期間 (精度: 秒)Web サーバー・プラグインがアイドル状態の WebSocket 接続を強制終了するのを待機する最大時間を示します。. 正整数の後に時間単位 (時間 (h)、分 (m)、または秒 (s)) を付けて指定してください。 例えば、30 秒は 30s と指定します。 単一エントリーに複数の値を含めることができます。 例えば、90 秒の場合、1m30s とすることができます。
extendedHandshakebooleanfalsetrue の場合、Web サーバー・プラグインは、アプリケーション・サーバーが稼働中かどうかを判別するために拡張ハンドシェークを使用します。
waitForContinuebooleanfalsefalse (デフォルト値) の場合、Web サーバー・プラグインは、メッセージ本体のある HTTP 要求に「Expect: 100-continue」ヘッダーを付けて送信します。 true に設定されている場合、Web サーバー・プラグインは、すべての HTTP 要求に「Expect: 100-continue」ヘッダーを付けて送信します。 Web サーバーとアプリケーション・サーバーとの間にファイアウォールがあり、本体のない要求再試行に敏感な場合は、この値を true に設定することを検討してください。
logFileNameファイルのパスWeb サーバー・プラグイン・ログ・ファイルの完全修飾パス。 ディレクトリー・コンポーネントが存在している必要があります。 Apache ベースの Web サーバーでは、パイプ文字で始まるパスは外部パイプ・ロガーとして解釈されます。 指定した場合、パスは logDirLocation をオーバーライドします。
logDirLocationディレクトリーのパス${pluginInstallRoot}/logs/${webserverName}非推奨: http_plugin.log ファイルが置かれているディレクトリーを示します。 ログ・ファイル名を参照してください。
serverIOTimeoutRetryint
Min: -1

Max: 65535
-1読み取り/書き込みタイムアウト後の、要求の再試行回数を制限します。 デフォルト値は {-1} で、追加の制限は適用されません。つまり、再試行は、クラスター内の使用可能なサーバー数によって制限されます。 値 {0} は、再試行できないことを示します。 この値はサーバー・クラスターを対象としおり、HTTP プラグイン接続タイムアウトや Web ソケット・タイムアウトによる接続障害や接続タイムアウトには当てはまりません。
loadBalanceWeightint20この値は、ランタイム時に動的に変更されます。サーバーの重みは、要求がサーバーに割り当てられるたびに低くなります。すべてのサーバーのすべての重みが 0 以下の値になると、Web サーバー・プラグインはすべての重みを 0 より大きくなるように再調整します。
serverRole
  • BACKUP
  • PRIMARY
PRIMARYサーバー・ロールは、サーバーが 1 次であるかバックアップであるかを識別します。1 次サーバーが使用可能な場合、Web サーバー・プラグインは、ロード・バランスとフェイルオーバーに 1 次サーバーを使用します。ただし、使用可能な 1 次サーバーがない場合は、Web サーバー・プラグインは、ロード・バランスとフェイルオーバーにバックアップ・サーバーのみを使用します。
BACKUP
バックアップ
PRIMARY
1 次
ESIEnablebooleantrueESIEnable プロパティーは、応答をキャッシュに入れるための Edge Side Include 処理を使用可能にします。このプロパティーには、Web サーバー・プラグイン構成ファイルで ESI を無効にするオプションがあります。
ESIMaxCacheSizeint1024ESIMaxCacheSize はキャッシュの最大サイズで、デフォルトでは 1 MB に設定されています。このプロパティーには、Web サーバー・プラグイン構成ファイルの値をオーバーライドするオプションがあります。
ESIInvalidationMonitorbooleanfalseESIInvalidationMonitor は、ESI プロセッサーがアプリケーション・サーバーから無効化を受け取るかどうかを指定します。このプロパティーには、Web サーバー・プラグイン構成ファイルの値をオーバーライドするオプションがあります。
ESIEnableToPassCookiesbooleanfalseESIEnableToPassCookies は、WebSphere Application Server へのセッション Cookie の転送を許可します。このプロパティーには、Web サーバー・プラグイン構成ファイルの値をオーバーライドするオプションがあります。
trustedProxyEnableboolean信頼されたプロキシーの使用を有効にします。指定された場合、このプロパティーは、Web サーバー・プラグイン構成ファイルの値をオーバーライドします。
trustedProxyGroupstring信頼されたプロキシーのコンマ区切りリスト。指定された場合、このプロパティーは、Web サーバー・プラグイン構成ファイルの値をオーバーライドします。

httpEndpoint

生成される plugin-cfg.xml ファイルに含める HTTP エンドポイントの ID を指定します。 このエンドポイントは、クラスター内のサーバーを定義します。 デフォルト値は、'defaultHttpEndpoint' です。

NameTypeDefaultDescription
onError
  • IGNORE
  • WARN
  • FAIL
WARNエンドポイントの開始に失敗した後に実行されるアクション。
IGNORE
サーバーは、構成エラーが発生したときに、警告メッセージおよびエラー・メッセージを出しません。
WARN
サーバーは、構成エラーが発生すると、警告メッセージおよびエラー・メッセージを出します。
FAIL
サーバーは、最初のエラー発生時に警告メッセージまたはエラー・メッセージを出した後、サーバーを停止します。
enabledbooleantrueエンドポイントの使用可能/使用不可を切り替えます。 これが true のとき、このエンドポイントはディスパッチャーによって、HTTP 要求を処理するためにアクティブ化されます。
hoststringlocalhostクライアントがリソースを要求する際に使用する IP アドレス、ドメイン・ネーム接尾部付きのドメイン・ネーム・サーバー (DNS) ホスト名、または単なる DNS ホスト名。 使用可能なすべてのネットワーク・インターフェースの場合には「*」を使用します。
httpPortint
Min: -1

Max: 65535
クライアント HTTP 要求に使用されるポート。 このポートを使用不可にする場合は、-1 を使用します。
httpsPortint
Min: -1

Max: 65535
SSL (HTTPS) で保護されたクライアント HTTP 要求に使用されるポート。 このポートを使用不可にする場合は、-1 を使用します。
httpOptionsRef最上位の httpOptions エレメント (ストリング) の参照。defaultHttpOptionsエンドポイントの HTTP プロトコル・オプション。
sslOptionsRef最上位の sslOptions エレメント (ストリング) の参照。エンドポイントの SSL プロトコル・オプション。
tcpOptionsRef最上位の tcpOptions エレメント (ストリング) の参照。defaultTCPOptionsエンドポイントの TCP プロトコル・オプション。
accessLoggingRef最上位の httpAccessLogging エレメント (ストリング) の参照。エンドポイントの HTTP アクセス・ロギング構成。

httpEndpoint > httpOptions

エンドポイントの HTTP プロトコル・オプション。

NameTypeDefaultDescription
keepAliveEnabledbooleantrueパーシスタント接続 (HTTP キープアライブ) を有効にします。 true の場合、複数の順次的な要求および応答によって再使用できるように、接続がキープアライブ状態になります。 false の場合、応答の送信後に接続がクローズされます。
maxKeepAliveRequestsint
Min: -1
100パーシスタント接続が使用可能にされた場合に単一の HTTP 接続で許可されるパーシスタント要求の最大数。 値 -1 は無制限を意味します。
persistTimeout期間 (精度: 秒)30sソケットが要求間でアイドル状態を維持できる時間の長さ。 この設定は、パーシスタント接続が使用可能である場合にのみ適用されます。. 正整数の後に時間単位 (時間 (h)、分 (m)、または秒 (s)) を付けて指定してください。 例えば、30 秒は 30s と指定します。 単一エントリーに複数の値を含めることができます。 例えば、90 秒の場合、1m30s とすることができます。
readTimeout期間 (精度: 秒)60s最初の読み取りが発生した後、ソケットで読み取り要求が完了するのを待つ時間の長さ。. 正整数の後に時間単位 (時間 (h)、分 (m)、または秒 (s)) を付けて指定してください。 例えば、30 秒は 30s と指定します。 単一エントリーに複数の値を含めることができます。 例えば、90 秒の場合、1m30s とすることができます。
writeTimeout期間 (精度: 秒)60s応答データの各部分が送信されるのをソケットで待つ時間の長さ。. 正整数の後に時間単位 (時間 (h)、分 (m)、または秒 (s)) を付けて指定してください。 例えば、30 秒は 30s と指定します。 単一エントリーに複数の値を含めることができます。 例えば、90 秒の場合、1m30s とすることができます。
removeServerHeaderbooleanfalseHTTP ヘッダーからサーバー実装情報を削除し、デフォルトの Liberty プロファイル・ウェルカム・ページも使用不可にします。
NoCacheCookiesControlbooleantrueSet-Cookie ヘッダーが存在する場合に、一致する no-cache 値によって Cache-Control ヘッダーを更新する必要があるかどうかを、ユーザーが制御できるようにします。 これにより、Expires ヘッダーも追加されます。
AutoDecompressionbooleantrueHTTP チャネルが、着信要求の本体データを自動的に圧縮解除するかどうかを指定します。

httpEndpoint > sslOptions

エンドポイントの SSL プロトコル・オプション。

NameTypeDefaultDescription
sessionTimeout期間 (精度: 秒)1dソケットで読み取り要求または書き込み要求が完了するのを待機する時間です。 この値は、プロトコル固有のタイムアウトによってオーバーライドされます。. 正整数の後に時間単位 (時間 (h)、分 (m)、または秒 (s)) を付けて指定してください。 例えば、30 秒は 30s と指定します。 単一エントリーに複数の値を含めることができます。 例えば、90 秒の場合、1m30s とすることができます。
suppressHandshakeErrorsbooleanfalseSSL ハンドシェーク・エラーのロギングを無効にします。 通常操作時に SSL ハンドシェーク・エラーが発生することがありますが、SSL の動作が予期しないものになっている場合は、こうしたメッセージが役立ちます。
sslRef最上位の ssl エレメント (ストリング) の参照。デフォルト SSL 構成レパートリー。 デフォルト値は defaultSSLSettings です。
sslSessionTimeout期間 (精度: ミリ秒)8640msSSL チャネルによって確立される SSL セッションのタイムアウト制限。. 正整数の後に時間単位 (時間 (h)、分 (m)、秒 (s)、またはミリ秒 (ms)) を付けて指定してください。 例えば、500 ミリ秒は 500ms と指定します。 単一エントリーに複数の値を含めることができます。 例えば、1.5 秒の場合、1s500ms とすることができます。

httpEndpoint > tcpOptions

エンドポイントの TCP プロトコル・オプション。

NameTypeDefaultDescription
inactivityTimeout期間 (精度: ミリ秒)60sソケットで読み取り要求または書き込み要求が完了するのを待機する時間です。 この値は、プロトコル固有のタイムアウトによってオーバーライドされます。. 正整数の後に時間単位 (時間 (h)、分 (m)、秒 (s)、またはミリ秒 (ms)) を付けて指定してください。 例えば、500 ミリ秒は 500ms と指定します。 単一エントリーに複数の値を含めることができます。 例えば、1.5 秒の場合、1s500ms とすることができます。
soReuseAddrbooleantrueアクティブなリスナーのないポートへの即時再バインドを使用可能にします。
addressIncludeListstringこのエンドポイントでインバウンド接続を行うことを許可されるアドレスのコンマ区切りリスト。IPv4 または IPv6 のアドレスを指定できます。IPv4 または IPv6 アドレスのすべての値は、数字またはアスタリスク・ワイルドカード文字で表現する必要があります。
addressExcludeListstringこのエンドポイントでインバウンド接続を行うことを許可されないアドレスのコンマ区切りリスト。IPv4 または IPv6 のアドレスを指定できます。IPv4 または IPv6 アドレスのすべての値は、数字またはアスタリスク・ワイルドカード文字で表現する必要があります。
hostNameIncludeListstringこのエンドポイントでインバウンド接続を行うことを許可されるホスト名のコンマ区切りリスト。ホスト名は大/小文字を区別せず、先頭にアスタリスク (ワイルドカード文字として使用される) を使用できます。ただし、ホスト名内のそれ以外の場所にアスタリスクを使用することはできません。例えば、*.abc.com は有効ですが、*.abc.* は無効です。
hostNameExcludeListstringこのエンドポイントでインバウンド接続を行うことを許可されないホスト名のコンマ区切りリスト。ホスト名は大/小文字を区別せず、先頭にアスタリスク (ワイルドカード文字として使用される) を使用できます。ただし、ホスト名内のそれ以外の場所にアスタリスクを使用することはできません。例えば、*.abc.com は有効ですが、*.abc.* は無効です。

httpEndpoint > accessLogging

エンドポイントの HTTP アクセス・ロギング構成。

NameTypeDefaultDescription
enabledbooleantrueアクセス・ログを使用可能にします。
filePathファイルのパス${server.output.dir}/logs/http_access.logアクセス・ログ・ファイルのディレクトリー・パスと名前。 ディレクトリー・パスの指定では、標準の変数置換 (${server.output.dir} など) を使用できます。
logFormatstring%h %u %{t}W "%r" %s %bクライアント・アクセス情報のロギングに使用されるログ・フォーマットを指定します。
maxFileSizeint
Min: 0
20ログ・ファイルの最大サイズ (MB)。これを超えると繰り越されます。値 0 は無制限を表します。
maxFilesint
Min: 0
2保持されるログ・ファイルの最大数。これを超えると、一番古いファイルが除去されます。値 0 は無制限を表します。

extraConfigProperties

生成されたプラグイン構成ファイルで Config エレメントに追加されるプロパティー。IBM サポートが、Web サーバー・プラグインの動作を変更するためにこれらのプロパティーを指定できます。