サーバー・プロパティー・ファイルには、サーバーのさまざまな設定 (例えば、トレース設定、ロギング、およびセキュリティー構成など) を定義する複数のプロパティーが含まれます。
サーバー・プロパティー・ファイルは、スタンドアロン・サーバーと WebSphere® Application Server でホスティングされるサーバーの両方において、カタログ・サービス・サーバーおよびコンテナー・サーバーの両方によって使用されます。
サンプル・サーバー・プロパティー・ファイル
wxs_home/properties ディレクトリーにある sampleServer.properties ファイルを使用して、プロパティー・ファイルを作成できます。
サーバー・プロパティー・ファイルの指定
このリスト内の項目のいずれかを使用して後で設定を指定すると、前の設定はオーバーライドされます。
例えば、サーバー・プロパティー・ファイルのシステム・プロパティー値を指定すると、
そのファイルのプロパティーにより、クラスパスにある objectGridServer.properties ファイルの値が指定変更されます。
サーバー・プロパティー
- 一般プロパティー
- enableMBeans
- ObjectGrid
コンテナーの Managed Beans (MBean) を使用可能にします。このプロパティーは、コンテナー・サーバーとカタログ・サービスの両方に適用されます。
デフォルト: true
- haManagerPort
- HA マネージャーが使用するポート番号を指定します。
このプロパティーが設定されていない場合、空きポートが選択されます。
このプロパティーは、WebSphere Application Server 環境では無視されます。
- JMXConnectorPort
- Java Management
Extensions (JMX) サービスのバインド先の Secure Sockets Layer (SSL) ポートを定義します。
- JMXServicePort
- MBean サーバーが Java Management Extensions (JMX) との通信を listen するポート番号を指定します。JMXServicePort プロパティーは、JMX 用の非 SSL ポートを指定します。
構成の中の各 JVM に対して、異なるポート番号を使用しなければなりません。JMX/RMI を使用する場合は、たとえデフォルトのポート値を使用する場合であっても、JMXServicePort とポート番号を明示的に指定してください。このプロパティーは、コンテナー・サーバーとカタログ・サービスの両方に適用されます。
(スタンドアロン環境の場合のみ必須。)
デフォルト: カタログ・サーバーの場合は 1099
- jvmStatsFileName
- JVM の CSV 統計ファイルのファイル名を指定します。
デフォルト: jvmstats
- jvmStatsLoggingEnabled
- true に設定すると、JVM のログ・データを CSV ファイルに書き込むことができます。
デフォルト: true
- jvmStatsWriteRate
- JVM の CSV 統計ファイルの書き込み速度を、1 秒当たりの書き込み回数で指定します。
デフォルト: 10
- listenerHost
Internet Inter-ORB Protocol (IIOP) との通信用に、オブジェクト・リクエスト・ブローカー (ORB) がバインドする先のホスト名を指定します。この値は、完全修飾ドメイン名または IP アドレスである必要があります。ご使用の構成に複数のネットワーク・カードが含まれている場合は、リスナー・ホストとリスナー・ポートを設定し、バインドする IP アドレスを JVM 内のオブジェクト・リクエスト・ブローカーに通知します。使用する IP アドレスを指定しなければ、接続タイムアウトや異常な API 障害、クライアントがハングしたように見える状態などの症状が現れることがあります。
- listenerPort
- オブジェクト・リクエスト・ブローカー (ORB) がバインドする先のポート番号を指定します。この設定は、コンテナーおよびクライアントが ORB を介してカタログ・サービスと通信するように構成します。WebSphere Application Server では、listenerPort は BOOTSTRAP_ADDRESS ポート構成によって継承されます。このプロパティーは、コンテナー・サーバーとカタログ・サービスの両方に適用されます。
デフォルト: 2809
- mapStatsFileName
- マップの CSV 統計ファイルのファイル名を指定します。
デフォルト: mapstats
- mapStatsLoggingEnabled
- true に設定すると、サーバー上のマップのログ・データを CSV ファイルに書き込むことができます。
デフォルト: true
- mapStatsWriteRate
- マップの CSV 統計ファイルの書き込み速度を、1 秒当たりの書き込み回数で指定します。
デフォルト: 10
- maxJVMStatsFiles
- JVM について生成される CSV 統計ファイルの最大数を指定します。
デフォルト: 5
- maxJVMStatsFileSize
- JVM の CSV 統計ファイルの最大ファイル・サイズを、メガバイト単位で指定します。
デフォルト: 100
- maxMapStatsFileSize
- マップの CSV 統計ファイルの最大ファイル・サイズを、メガバイト単位で指定します。
デフォルト: 100
- maxOGStatsFiles
- ObjectGrid インスタンスについて生成される CSV 統計ファイルの最大数を指定します。
デフォルト: 5
- maxOGStatsFileSize
- ObjectGrid インスタンスの CSV 統計ファイルの最大ファイル・サイズを、メガバイト単位で指定します。
デフォルト: 100
- maxMapStatsFiles
- マップについて生成される CSV 統計ファイルの最大数を指定します。
デフォルト: 5
- maxThreads
- 組み込み evictor および DataGrid の操作で、実行時に内部スレッド・プールによって使用されるスレッドの最大数。
デフォルト:50
- minThreads
- 組み込み evictor および DataGrid の操作で、実行時に内部スレッド・プールによって使用されるスレッドの最小数。
デフォルト: 10
- ogStatsFileName
- ObjectGrid インスタンスの CSV 統計ファイルのファイル名を指定します。
デフォルト: ogstats
- ogStatsLoggingEnabled
- true に設定すると、サーバー上の ObjectGrid インスタンスのログ・データを CSV ファイルに書き込むことができます。
デフォルト: false
- ogStatsWriteRate
- ObjectGrid インスタンスの CSV 統計ファイルの書き込み速度を、1 秒当たりの書き込み回数で指定します。
デフォルト: 10
- serverName
- サーバーを識別するために使用されるサーバーの名前を指定します。このプロパティーは、コンテナー・サーバーとカタログ・サービスの両方に適用されます。
- systemStreamToFileEnabled
- コンテナーから、ファイルに SystemOut、SystemErr、およびトレース出力を書き込めるように設定します。
このプロパティーが false に設定されていると、出力はファイルに書き込まれず、代わりにコンソールに書き込まれます。
デフォルト: true
- traceFile
トレース情報を書き込むファイル名を指定します。このプロパティーは、コンテナー・サーバーとカタログ・サービスの両方に適用されます。
例: ../logs/c4Trace.log
制約事項: traceFile プロパティーは Liberty プロファイルではサポートされません。
- traceSpec
コンテナー・サーバーのトレースおよびトレース仕様ストリングを使用可能にします。
トレースは、デフォルトで使用不可に設定されています。このプロパティーは、コンテナー・サーバーとカタログ・サービスの両方に適用されます。
例:
- ObjectGrid=all=enabled
- ObjectGrid*=all=enabled
制約事項: traceSpec プロパティーは Liberty プロファイルではサポートされません。
- workingDirectory
- コンテナー・サーバー出力が書き込まれるロケーションを指定します。
この値が指定されない場合、出力は、現行ディレクトリー内の log ディレクトリーに書き込まれます。
このプロパティーは、コンテナー・サーバーとカタログ・サービスの両方に適用されます。
デフォルト: 値なし
- zoneName
- サーバーが含まれるゾーンの名前を設定します。このプロパティーは、コンテナー・サーバーとカタログ・サービスの両方に適用されます。
- コンテナー・サーバー・プロパティー
- catalogServiceEndPoints
- カタログ・サービス・ドメインに接続するエンドポイントを指定します。この値は、host:port,host:port という形式でなければなりません。
ホスト値は、listenerHost 値で、ポート値は、カタログ・サーバーの listenerPort 値です。このプロパティーは、コンテナー・サーバーにのみ適用されます。
- enableXM
- true に設定すると、サーバー上の IBM® eXtremeMemory を使用可能にし、同期および非同期のレプリカ生成用に IBM eXtremeIO を使用するようにサーバーを構成します。キャッシュ・エントリーは、Java ヒープではなく、ネイティブ・メモリーに保管されます。
データ・グリッドのすべてのコンテナー・サーバーは、enableXM プロパティーに同じ値を使用しなければなりません。
デフォルト: false
- maxXIONetworkThreads
- eXtremeIO トランスポート・ネットワーク・スレッド・プールに割り振るスレッドの最大数を設定します。
デフォルト:50
- maxXIOWorkerThreads
- eXtremeIO トランスポート要求処理スレッド・プールに割り振るスレッドの最大数を設定します。
デフォルト:128
- maxXMSize
- eXtremeMemory ストレージ用にサーバーが使用するメモリーの最大量を、メガバイト単位で設定します。
デフォルト: システム上の合計メモリーの 25%
- memoryThresholdPercentage
- メモリー・ベース除去のメモリーしきい値を設定します。
このパーセンテージは、Java 仮想マシン (JVM) で使用される最大ヒープを指定し、これを超えると除去が行われます。
デフォルト値は -1 で、メモリーしきい値が設定されていないことを示します。
memoryThresholdPercentage プロパティーが設定されていると、MemoryPoolMXBean 値は指定された値に設定されます。
詳しくは、Java API 仕様の MemoryPoolMXBean インターフェースを参照してください。
ただし、除去は Evictor で使用可能に設定されている場合にのみ行われます。
メモリー・ベースの除去を使用可能にするには、キャッシュ・オブジェクトの除去のためのプラグインを参照してください。
このプロパティーは、コンテナー・サーバーにのみ適用されます。
デフォルト:-1
- minXIONetworkThreads
- eXtremeIO トランスポート・ネットワーク・スレッド・プールに割り振るスレッドの最小数を設定します。
デフォルト:50
- minXIOWorkerThreads
- eXtremeIO トランスポート要求処理スレッド・プールに割り振るスレッドの最小数を設定します。
デフォルト:128
- statsSpec
- コンテナー・サーバーの統計仕様を指定します。
例:
all=disabled :
すべての統計を使用不可にします。
all=enabled :
すべての統計を使用可能にします。
統計の使用可能化について詳しくは、統計の使用可能化 を参照してください。
- xioChannel.xioContainerTCPNonSecure.Port
- サーバー上の eXtremeIO の非セキュア・リスナー・ポート番号を指定します。値を設定しなければ、一時ポートが使用されます。transportType プロパティーが TCP/IP に設定されている場合のみこのプロパティーが使用されます。
制約事項: xioChannel.xioContainerTCPNonSecure.Port プロパティーは Liberty プロファイルではサポートされません。
- xioChannel.xioContainerTCPSecure.Port
- サーバー上の eXtremeIO の SSL ポート番号を指定します。transportType プロパティーが SSL-Supported または SSL-Required に設定されている場合のみこのプロパティーが使用されます。
- カタログ・サービス・プロパティー
- catalogClusterEndPoints
- カタログ・サービスのカタログ・サービス・ドメイン・エンドポイントを指定します。このプロパティーで、カタログ・サービス・エンドポイントを指定して、カタログ・サービス・ドメインを開始します。以下のフォーマット設定を使用します。
serverName:hostName:clientPort:peerPort<serverName:hostName:clientPort:peerPort>
このプロパティーは、カタログ・サービスにのみ適用されます。
- domainName
- 複数ドメインに経路指定する際にクライアントに対してこのカタログ・サービス・ドメインを固有に識別するために使用するドメイン・ネームを指定します。このプロパティーは、カタログ・サービスにのみ適用されます。
- enableQuorum
カタログ・サービスのクォーラムを使用可能にします。
使用可能なコンテナー・サーバー上の区画を移動する前に、クォーラムを使用して、大半のカタログ・サービス・ドメインを確実に使用可能にします。クォーラムを使用可能にするには、この値を true または enabled に設定します。
デフォルト値は disabled です。このプロパティーは、カタログ・サービスにのみ適用されます。詳しくは、カタログ・サーバー・クォーラムを参照してください。
- <foreignDomain>.endpoints
- 外部ドメイン (ドメイン B など) のカタログ・サーバーの接続情報を指定します。
以下に例を示します。
B.endPoints=hostB1:2809, hostB2:2809
外部ドメインに複数のカタログ・サーバーがある場合には、すべてを指定します。
- foreignDomains
- マルチマスター・レプリカ生成トポロジー内のリンク先のカタログ・サービス・ドメインの名前を指定します。このプロパティーは、カタログ・サービスにのみ適用されます。
制約事項: foreignDomains プロパティーは Liberty プロファイルではサポートされません。
- heartBeatFrequencyLevel
サーバー・フェイルオーバーの検出頻度を指定します。
高速のハートビート間隔は、プロセスおよびネットワークが安定している場合に役立ちます。ネットワークまたはプロセスが最適に構成されていないと、ハートビートを見逃す可能性があり、そうなった場合は誤って障害検出が示されることがあります。
ハートビートの頻度レベルは、リソースの使用量と障害発見時間のトレードオフです。
頻繁にハートビートが発生するほど、より多くのリソースが使用されますが、より迅速に障害は発見されます。
このプロパティーは、カタログ・サービスにのみ適用されます。
表 1. ハートビートの有効な値値 |
アクション |
説明 |
0 |
標準 (デフォルト) |
標準的な速度でのハートビート・レベルを指定します。
この値を使用すると、リソースを過剰使用することなく適正な速度でフェイルオーバーの検出が行われます。
通常、30 秒以内にフェイルオーバーが検出されます。 |
-1 |
高速 |
積極的なハートビート・レベルを指定します。この値を指定すると、障害はより迅速に検出されますが、プロセッサーおよびネットワークのリソースもより多く使用します。
このレベルは、サーバーが混んでいる場合に、欠落ハートビートの検出精度が高くなります。
通常、5 秒以内にフェイルオーバーが検出されます。 |
1 |
低速 |
緩やかなハートビート・レベルを指定します。この値を使用すると、ハートビート頻度の減少により障害を検出するまでの時間は増加しますが、プロセッサーおよびネットワークの使用も減少します。
通常、180 秒以内にフェイルオーバーが検出されます。 |
- isCatalog
- true に設定すると、サーバー・プロセスはカタログ・サービスを自動的に開始します。
- デフォルト: false
- placementDeferralInterval
- 作業項目のバランシングおよびコンテナー・サーバーへの配置を延期する時間間隔を、ミリ秒単位で指定します。
延期間隔を長くすると、プロセッサー使用率は下がりますが、作業項目の配置は時間をかけて完了します。
延期間隔を短くすると、短期間のプロセッサー使用率は上がりますが、作業項目の配置は即時かつ迅速に行われます。
デフォルト: 15000 ミリ秒
セキュリティー・サーバー・プロパティー
サーバー・プロパティー・ファイルは、
eXtreme Scale サーバー・セキュリティーの構成にも使用されます。
1 つのサーバー・プロパティー・ファイルを使用して、基本プロパティーとセキュリティー・プロパティーの両方を指定します。
- 一般セキュリティー・プロパティー
- credentialAuthentication
- このサーバーが、資格情報認証をサポートするかどうかを示します。
次のいずれかの値を選択します。
- Never: サーバーは、資格情報認証をサポートしません。
- Supported: クライアントが資格情報認証をサポートする場合に、このサーバーも資格情報認証をサポートします。
- Required: クライアントは資格情報認証を必要とします。
資格情報認証に関して詳しくは、アプリケーション・クライアントの認証を参照してください。
- securityEnabled
- true に設定すると、コンテナー・サーバー・セキュリティーが使用可能になります。
デフォルト値は false です。このプロパティーは、カタログ・サーバーに提供される objectGridSecurity.xml ファイルに指定されている securityEnabled property と一致する必要があります。
- Transport Layer Security の設定
- transportType
- サーバーのトランスポート・タイプを指定します。
以下のいずれかの値を使用します。
- TCP/IP: サーバーが、TCP/IP 接続のみをサポートすることを示します。
- SSL-Supported: サーバーが TCP/IP 接続と Secure Sockets Layer (SSL) 接続の両方をサポートすることを示します。
(デフォルト)
- SSL-Required: サーバーが SSL 接続を必要とすることを示します。
- SSL 構成プロパティー
- 別名 (alias)
- 鍵ストア内の別名を指定します。鍵ストアに複数の鍵ペア証明書があり、いずれか
1 つの証明書を選択したい場合は、このプロパティーを使用します。
デフォルト: 値なし
- clientAuthentication
- このプロパティーを true に設定した場合は、SSL クライアントを認証する必要があります。SSL クライアントの認証は、クライアント証明書の認証とは異なります。クライアント証明書の認証とは、証明書チェーンに基づくユーザー・レジストリーと照合してクライアントを認証することです。このプロパティーは、サーバーが正しいクライアントに接続していることを保証します。
- contextProvider
- トラスト・サービスのコンテキスト・プロバイダーの名前を指定します。
有効でない値を指定すると、コンテキスト・プロバイダー・タイプが正しくないことを示すセキュリティー例外が発生します。
有効値: IBMJSSE2、IBMJSSE、IBMJSSEFIPS など。
- customSecureTokenManagerProps
- カスタム SecureTokenManager 実装クラス・プロパティーを指定します。
このプロパティーは、secureTokenManagerType 値が custom の場合にのみ使用されます。
この値は、setProperties(String) メソッドを使用して SecureTokenManager オブジェクトに設定されます。
- customTokenManagerClass
- SecureTokenManagerType プロパティー値を custom と指定した場合に、SecureTokenManager 実装クラスの名前を指定します。
この実装クラスでは、デフォルトのコンストラクターがインスタンス化される必要があります。
- keyStore
- 鍵ストア・ファイルへの完全修飾パスを指定します。
例: etc/test/security/client.private
- keyStorePassword
- 鍵ストアのストリング・パスワードを指定します。この値はエンコードすることも、実際の値を使用することもできます。
- keyStoreType
- 鍵ストアのタイプを示します。有効でない値を指定すると、ランタイム・セキュリティー例外が発生します。
有効値: JKS、JCEK、PKCS12 など。
- プロトコル
- クライアントに使用するセキュリティー・プロトコルのタイプを指定します。
このプロトコルの値は、使用する Java Secure
Socket Extension (JSSE) プロバイダーに基づいて設定します。有効でない値を指定すると、プロトコル値が正しくないことを示すセキュリティー例外が発生します。
有効値: SSL、SSLv2、SSLv3、TLS、TLSv1 など。
- SecureTokenManager
- SecureTokenManager の設定は、サーバー相互認証の秘密ストリングの保護とシングル・サインオン・トークンの保護に使用されます。
を参照してください。
- secureTokenManagerType
- SecureTokenManager 設定のタイプを指定します。次の設定のいずれかを使用できます。
- none: セキュア・トークン・マネージャーが使用されないことを示します。
- default: WebSphere eXtreme
Scale 製品で提供されるトークン・マネージャーが使用されることを示します。
SecureToken 鍵ストア構成を指定する必要があります。
- custom: SecureTokenManager
実装クラスを使用して指定した独自のトークン・マネージャーがあることを示しています。
- trustStore
- トラストストア・ファイルへの完全修飾パスを指定します。
例:
etc/test/security/server.public
- trustStorePassword
- トラストストアのストリング・パスワードを指定します。この値はエンコードすることも、実際の値を使用することもできます。
- trustStoreType
- トラストストアのタイプを示します。有効でない値を指定すると、ランタイム・セキュリティー例外が発生します。
有効値: JKS、JCEK、PKCS12 など。
- セキュア・トークンの鍵ストア構成
- secureTokenKeyStore
- 公開鍵と秘密鍵のペアおよび秘密鍵が保管されている鍵ストアのファイル・パス名を指定します。
- secureTokenKeyStoreType
- 鍵ストアのタイプ (例、JCKES など) を指定します。この値は、使用している Java Secure
Socket Extension (JSSE) プロバイダーに基づいて設定します。
ただし、鍵ストアが秘密鍵をサポートしている必要があります。
- secureTokenKeyPairAlias
- 署名および検証に使用される公開鍵と秘密鍵のペアの別名を指定します。
- secureTokenKeyPairPassword
- 署名および検証に使用される鍵ペアの別名を保護するパスワードを指定します。
- secureTokenSecretKeyAlias
- 暗号化に使用される秘密鍵の別名を指定します。
- secureTokenSecretKeyPassword
- 秘密鍵を保護するパスワードを指定します。
- secureTokenCipherAlgorithm
- 暗号の指定に使用されるアルゴリズムを指定します。この値は、使用している Java Secure
Socket Extension (JSSE) プロバイダーに基づいて設定します。
- secureTokenSignAlgorithm
- オブジェクトの署名に使用されるアルゴリズムを指定します。この値は、使用される JSSE プロバイダーに基づいて設定します。
- 認証ストリング
- authenticationSecret
- サーバーのチャレンジに使用される秘密ストリングを指定します。サーバーは始動すると、このストリングをプレジデント・サーバーあるいはカタログ・サーバーに提示する必要があります。
秘密ストリングが、プレジデント・サーバーにあるものと一致した場合に、このサーバーは参加できます。