Cisco Service Control Management Suite Collection Manager ユーザ ガイド
コンフィギュレーション ファイルの説明
コンフィギュレーション ファイルの説明
発行日;2012/02/03 | 英語版ドキュメント(2011/02/23 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 2MB) | フィードバック

目次

コンフィギュレーション ファイルの説明

一般的なコンフィギュレーション ファイル

CM コンフィギュレーション

[adapter] セクション

[adapter_mem] セクション

[adapter_start_timeout] セクション

[buffer] セクション

[queue] セクション

[categorizer] セクション

[server] セクション

[collector] セクション

[csv_adapter] セクション

キュー コンフィギュレーション

アダプタ コンフィギュレーション ファイル

Topper/Aggregator アダプタ

[config] セクション

[rdr] セクション

[csv] セクション

[state save] セクション

[db] セクション

[app] セクション

CSV アダプタ

[csvadapter] セクション

JDBC アダプタ

[bench] セクション

[db] セクション

[app] セクション

RAG アダプタ

[config] セクション

[housekeeper] セクション

[db] セクション

[app] セクション

コンフィギュレーション ファイルの説明

この章では、Collection Manager(CM)が使用するコンフィギュレーション ファイルと各ファイルのコンフィギュレーション パラメータについて説明します。

各コンフィギュレーション ファイルは、複数のセクションに分割されています。各セクションは、 [config] などのヘディング部で特定できます。

現在の構成では必要のないパラメータの行の先頭に # を付けると、コメント化できます。

コンフィギュレーション ファイルの変更後は、CM を再起動して、CM 動作に変更を適用する必要があります。


) CM ソフトウェア インストールで提供されているコンフィギュレーション ファイルには、テスト済みの有効な設定が含まれています。通常、ユーザがこの設定を変更することはありません。構成設定を変更する必要がある場合は、細心の注意を払って変更を行ってください。


一般的なコンフィギュレーション ファイル

このセクションでは、 cm.conf および queue.conf コンフィギュレーション ファイルについて説明しています。

「CM コンフィギュレーション」

「キュー コンフィギュレーション」

CM コンフィギュレーション

このセクションでは CM コンフィギュレーション ファイルの cm.conf について説明しています。

「[adapter] セクション」

「[adapter_mem] セクション」

「[adapter_start_timeout] セクション」

「[buffer] セクション」

「[queue] セクション」

「[categorizer] セクション」

「[server] セクション」

「[collector] セクション」

「[csv_adapter] セクション」

[adapter] セクション

[adapter] セクションには次のパラメータが含まれます。

automatic_start

CM の起動またはリセット時にアダプタを自動起動するかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は true です。

port

アダプタ マネージャ サーバのポート番号を定義します。このパラメータに設定可能な値は 1024 ~ 65535 の範囲の値です。デフォルト値は 33001 です。

timeout

クライアント アダプタのタイムアウト値を秒単位で定義します。このパラメータを 0 に設定すると、タイムアウトがディセーブルになります。

connections

アダプタ毎のクライアント接続最大数を定義します。

このパラメータに設定可能な値は 2 ~ 100 の範囲の値です。デフォルト値は 20 です。

directory

バッファに格納された Raw Data Record(RDR)データを保存する場所を定義します。このパラメータの接頭辞として ~/ を使用できます。デフォルト値は ~/cm/adapters です。

adapter.<number>

アダプタの完全クラス名を定義します。ここでは、 <number> は一意の ID 番号です。アダプタ定義は、キュー コンフィギュレーション ファイルで定義されたキューの adapter_id パラメータと一致していなければなりません。「キュー コンフィギュレーション」を参照してください。

parestart_start

アダプタの定期的な再起動を実行する時間を 24 時間形式で定義します。このパラメータの値の例は 23:30 です。デフォルト値は 03:45 です。

parestart_interval

アダプタの定期的な再起動インターバルを分単位で定義します。このパラメータに設定可能な値は 0 ~ 2147483647(0 ~ 2 31 ~ 1)の範囲の値です。ここで 0 を設定すると、この機能がディセーブルになります。このパラメータのデフォルト値は 10080 分(18 時間)です。

[adapter_mem] セクション

[adapter_mem] セクションには次のパラメータが含まれます。

<Adapter class name>

アダプタに割り当てられた最大ヒープ サイズを定義します。次はこのパラメータの設定例です。

com.cisco.scmscm.adapters.topper.TAAdapter=-Xmx512M

) Solaris JRE 64 ビット上で実行している場合は、-d64 フラグを設定する必要があります。


com.cisco.scmscm.adapters.topper.TAAdapter= -d64 -Xmx4096M

必要なヒープ サイズが JVM のデフォルト最大ヒープ サイズと異なる場合は、アダプタに割り当てられたメモリの定義を含める必要があります。


) Linux プラットフォーム上にインストールされている場合は、このパラメータの最大値は 2 GB です。Solaris プラットフォーム上にインストールされている場合は、3.5 GB です。
Solaris JRE 64 ビット上で実行している場合は、このパラメータにこれよりも大きい値を設定できます。


[adapter_start_timeout] セクション

[adapter_start_timeout] セクションには次のパラメータが含まれます。

<Adapter class name>

特定のアダプタが起動するまで CM が待機する時間を秒単位で定義します。デフォルト値は 200 秒です。次はこのパラメータの設定例です。

com.cisco.scmscm.adapters.topper.TAAdapter=600

[buffer] セクション

[buffer] セクションには次のパラメータが含まれます。

size

バッファ デキューの前にキューに蓄積できる最小バイト数を定義します。

このパラメータに設定可能な値は 1 ~ 262144 の範囲の値です。デフォルト値は 128000 です。

time

バッファ デキューの最小時間間隔をミリ秒単位で定義します。

このパラメータに設定可能な値は 0 ~ 10000 の範囲の値です。デフォルト値は 1050 です。

file_limit

各アダプタのキューに格納されるファイルの最大数を定義します。

このパラメータに設定可能な値は 1 ~ 10000 の範囲の値です。デフォルト値は 10000 です。

[queue] セクション

[queue] セクションには次のパラメータが含まれます。

upper_hysteresis

上限ヒステリシス レベルを合計キュー サイズの割合として定義します。

このパラメータに設定可能な値は 0 ~1 の範囲の値です。デフォルト値は 0.11 です。

lower_hysteresis

下限ヒステリシス レベルを合計キュー サイズの割合として定義します。

このパラメータに設定可能な値は 0 ~1 の範囲の値です。デフォルト値は 0.12 です。

config

キュー コンフィギュレーション ファイルを定義します。このパラメータで定義されるファイル名は、「キュー コンフィギュレーション」で説明されているキュー コンフィギュレーション ファイル名です。デフォルト値は queue.conf です。

[categorizer] セクション

[categorizer] セクションには次のパラメータが含まれます。

use_table

RDR をテーブルを使用して分類するか、タグ ビットをデコードして分類するかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は true です。

rate_period_msec

着信 RDR レート計算の更新間隔時間をミリ秒単位で定義します。

このパラメータに設定可能な値は 5000 ~ 30000 の範囲の値です。デフォルト値は 5000 です。

[server] セクション

[server] セクションには次のパラメータが含まれます。

port

RDR サーバのポート番号を定義します。

このパラメータに設定可能な値は 1024 ~ 65535 の範囲の値です。デフォルト値は 33000 です。

connections

クライアント接続最大数を定義します。

このパラメータに設定可能な値は 1 ~ 50 の範囲の値です。デフォルト値は 50 です。

timeout

クライアント タイムアウト時間を秒単位で定義します。デフォルト値は 600 です。

allow_multi

同じ IP からの同時接続を許可するかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は false です。

[collector] セクション

[collector] セクションには次のパラメータが含まれます。

notification_level

連続する UM 通知の間隔をミリ秒単位で定義します。

このパラメータに設定可能な値は 0 ~ 60000 の範囲の値です。デフォルト値は 10 です。

log_directory

ログ ファイルを格納するディレクトリを定義します。このパラメータの接頭辞として ~/ を使用できます。デフォルト値は ~/cm/logs です。

[csv_adapter] セクション

[csv_adapter] セクションには次のパラメータが含まれます。

csvdir

CSV ファイルの親ディレクトリを定義します。このパラメータのデフォルト値は ~scmscm/cm/adapters/CSVAdapter/csvfiles です。

キュー コンフィギュレーション

このセクションではキュー コンフィギュレーション ファイルについて説明します。キュー コンフィギュレーション ファイル名は cm.conf コンフィギュレーション ファイルの[queue] セクションで定義されます。

キュー コンフィギュレーション ファイルの各セクションでは、キューを定義します。セクション名、キュー名はすべてユーザ定義項目です。各キュー セクションには次のパラメータが含まれます。

adapter_id

一意のアダプタ ID 番号を定義します。ID 番号は cm.conf コンフィギュレーション ファイルの [adapter] セクションの adapter.<number> パラメータで定義されているアダプタと一致していなければなりません。「[adapter] セクション」を参照してください。

priority

キューのプライオリティ レベルを定義します。このパラメータに設定可能な値は 1 ~ 3 の範囲の値です。このパラメータは廃止予定であるため、変更できません。

warning_size

警告が送信される前にキューに表示できる RDR 数を定義します。

maximum_size

キューの最大サイズを定義します。

tags

カテゴライザによってこのキューに送信される RDR タグ数のリストを定義します。同じタグを複数のキューに送信できます。

次の例では、キュー コンフィギュレーション ファイルで定義されたキューを示しています。

# Topper/Aggregator Adapter
[topper-hi]
adapter_id=3
priority=3
warning_size=40000
maximum_size=50000
tags=4042321920

アダプタ コンフィギュレーション ファイル

このセクションでは、すべての可能なアダプタのコンフィギュレーション ファイルについて説明しています。

「Topper/Aggregator アダプタ」

「CSV アダプタ」

「JDBC アダプタ」

「RAG アダプタ」

Topper/Aggregator アダプタ

このセクションでは TA アダプタ コンフィギュレーション ファイルである taadapter.conf について説明しています。

「[config] セクション」

「[rdr] セクション」

「[csv] セクション」

「[state save] セクション」

「[db] セクション」

「[app] セクション」

[config] セクション

[config] セクションには次のパラメータが含まれます。

num_top_entries

報告される上位エントリ数を定義します。デフォルト値は 50 です。

num_services

認識されるサービス(サービス 0 を含む)の最大数を定義します。デフォルト値は 32 です。

all_services_index

データベース/CSV ファイルの「すべての加入者」エントリをマークするインデックスを提供します。デフォルト値は -1 です。このパラメータの変更は推奨されません。

agg_lengths

各集約サイクル長を分単位で定義します。各サイクルは先行するサイクルで割り切れる数でなければなりません。そうでない場合は、起動時に四捨五入されます。

time_base

集約サイクルのフェーズ(タイム スキュー)を定義します。デフォルト値は 00:00 です。

[rdr] セクション

[rdr] セクションには次のパラメータが含まれます。

divide_1024

すべての消費を 1024 で除算するかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は false です。

table_name

NUR テーブルの論理名を tables.xml に記述されているとおりに指定します。デフォルト値は NUR です。

field_subs

subscriber-id フィールド名を tables.xml に記述されているとおりに定義します。デフォルト値は SUBSCRIBER_ID です。

field_svc

service counter id フィールド名を tables.xml に記述されているとおりに定義します。デフォルト値は SERVICE_ID,SUBS_USG_CNT_ID です。

field_up

upstream volume フィールド名を tables.xml に記述されているとおりに定義します。デフォルト値は UPSTREAM_VOLUME です。

field_down

downstream volume フィールド名を tables.xml に記述されているとおりに定義します。デフォルト値は DOWNSTREAM_VOLUME です。

field_sess

sessions フィールド名を tables.xml に記述されているとおりに定義します。デフォルト値は SESSIONS です。

field_sec

seconds フィールド名を tables.xml に記述されているとおりに定義します。デフォルト値は SECONDS です。

[csv] セクション

[csv] セクションには次のパラメータが含まれます。

active

CSV ファイル作成をアクティブにするかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は true です。

file_name_format

CSV ファイル名の形式を定義します。デフォルト値は yyyy-mm-dd_hh-mm-ss'.csv' です。

dir_name

CSV ファイルの格納場所を定義します。デフォルト値は ~/cm/adapters/TAAdapter/csvfiles です。

write_headers

各 CSV ファイルの上部に説明用ヘッダーを書き込むかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は false です。

metric_separator

CSV ファイルのメトリックを区切る文字を定義します。デフォルト値は「,」です。

service_separator

CSV ファイルのサービスを区切る文字を定義します。デフォルト値は「,」です。

[state save] セクション

[state save] セクションには次のパラメータが含まれます。

active

保存またはロード状態をアクティブにするかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は true です。

file_name

保存またはロードに使用されるステータス ファイル名を定義します。デフォルト値は taadapter.sav です。

[db] セクション

[db] セクションには次のパラメータが含まれます。

name_of_total_subs

データベースの「すべての加入者」の指定を定義します。

db_template_dir

メイン データベース コンフィギュレーション テンプレートの場所を、CM コンフィギュレーション ディレクトリの相対パスとして定義します。コンフィギュレーション ファイルには、3 つの構成可能なデータベースのデフォルト値が含まれます。ただし、一度に構成できるデータベースは 1 つだけです。設定可能な値は次のとおりです。

Oracle: dbpacks/oracle/9204e

Sybase: dbpacks/sybase/ase12.5.1

MySQL: dbpacks/mysql/4.0.20

デフォルト値は dbpacks/sybase/ase12.5.1 です。

db_template_file

メイン データベース コンフィギュレーション テンプレート名を定義します。デフォルト値は main.vm です。このパラメータの変更は推奨されません。

operations_timeout

接続、挿入などのデータベース操作の完了にかかる最大許容時間数を秒単位で定義します。デフォルト値は 60 です。

blocking_connects

データベースへの接続の試みをブロックするかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は false です。

connection_timeout

データベースへの接続の試みを許可する秒数を定義します。デフォルト値は 900 です。

blocking_connects true に設定されている場合は、このパラメータは無視されます。

connection_wait_period

次の接続の試みを実行するまで待機する時間を秒単位で定義します。デフォルト値は 10 です。

[app] セクション

[app] セクションには次のパラメータが含まれます。

app_conf_file

アプリケーション コンフィギュレーション XML ファイル名を定義します。デフォルト値は dbtables.xml です。

app_dtd_file

アプリケーション コンフィギュレーション DTD ファイル名を定義します。デフォルト値は dbtables.dtd です。

app_conf_dir

アプリケーション コンフィギュレーション XML ファイルと DTD ファイルの場所を、CM コンフィギュレーション ディレクトリからの相対パスとして定義します。デフォルト値は apps/scasbb/3.5.0 です。

CSV アダプタ

このセクションでは CSV アダプタ コンフィギュレーション ファイルである csvadapter.conf について説明しています。

[csvadapter] セクション

[csvadapter] セクションには次のパラメータが含まれます。

maxCSVFiles

CSV ファイルの最大エントリ数を定義します。この数に達すると、カウント数が 1 に戻ります。

このパラメータに設定可能な値は 1 ~ 9999 の範囲の値です。デフォルト値は 9999 です。

rdrLimit

1 つのファイルに書き込み可能な最大 RDR 数を定義します。

このパラメータに設定可能な値は 1 ~ 1000 の範囲の値です。デフォルト値は 1000 です。

backupPreviousFiles

既存の CSV ファイルを上書きする前にバックアップするかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は false です。

includeRecordSource

各 RDR 行のレコード送信元(SCE IP)を含めるかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は false です。

escapeNonPrintables

プリント不可能文字をエスケープするかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は false です。


escapeNonPrintables true に設定すると、アダプタ パフォーマンスに悪影響を及ぼす可能性があります。


JDBC アダプタ

このセクションでは JDBC アダプタ コンフィギュレーション ファイルである jdbcadapter.conf について説明しています。

「[bench] セクション」

「[db] セクション」

「[app] セクション」

[bench] セクション

[bench] セクションには次のパラメータが含まれます。

rate_period_msec

挿入レート更新時間間隔をミリ秒単位で定義します。デフォルト値は 5000 です。

このパラメータを 0 に設定すると、挿入をディセーブルにします。

[db] セクション

[db] セクションには次のパラメータが含まれます。

db_template_dir

メイン データベース コンフィギュレーション テンプレートの場所を、CM コンフィギュレーション ディレクトリの相対パスとして定義します。コンフィギュレーション ファイルには、3 つの構成可能なデータベースのデフォルト値が含まれます。ただし、一度に構成できるデータベースは 1 つだけです。設定可能な値は次のとおりです。

Oracle: dbpacks/oracle/9204e

Sybase: dbpacks/sybase/ase12.5.1

MySQL: dbpacks/mysql/4.0.20

デフォルト値は dbpacks/sybase/ase12.5.1 です。

db_template_file

メイン データベース コンフィギュレーション テンプレート名を定義します。デフォルト値は main.vm です。このパラメータの変更は推奨されません。

batch_size

1 つのバッチで実行可能な挿入数を定義します。デフォルト値は 10 です。

transaction_size

1 つのトランザクションで実行可能なバッチ数を定義します。デフォルト値は 15 です。

commit_interval

データベース コミットの最大時間間隔を秒単位で定義します。デフォルト値は 6 です。

operations_timeout

接続、挿入などのデータベース操作の完了にかかる最大許容時間数を秒単位で定義します。デフォルト値は 60 です。

blocking_connects

データベースへの接続の試みをブロックするかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は true です。

[app] セクション

[app] セクションには次のパラメータが含まれます。

app_conf_file

アプリケーション コンフィギュレーション XML ファイル名を定義します。デフォルト値は dbtables.xml です。

app_dtd_file

アプリケーション コンフィギュレーション DTD ファイル名を定義します。デフォルト値は dbtables.dtd です。

app_conf_dir

アプリケーション コンフィギュレーション XML ファイルと DTD ファイルの場所を、CM コンフィギュレーション ディレクトリからの相対パスとして定義します。デフォルト値は apps/scasbb/3.5.0 です。

RAG アダプタ

このセクションでは RAG アダプタ コンフィギュレーション ファイルである ragadapter.conf について説明しています。

「[config] セクション」

「[housekeeper] セクション」

「[db] セクション」

「[app] セクション」

[config] セクション

[config] セクションには次のパラメータが含まれます。

xml_filename

RAG アダプタが実行するリアルタイム集約を定義するアプリケーション コンフィギュレーション XML および DTD ファイルの場所を定義します。デフォルト値は ~/cm/config/ragadapter.xml です。

[housekeeper] セクション

[housekeeper] セクションには次のパラメータが含まれます。

interval_sec

集約およびシンク操作を実行するスケジュールされたタスクの実行インターバルを定義します。デフォルト値は 10 です。

[db] セクション

[db] セクションには次のパラメータが含まれます。

db_template_dir

メイン データベース コンフィギュレーション テンプレートの場所を、CM コンフィギュレーション ディレクトリの相対パスとして定義します。コンフィギュレーション ファイルには、3 つの構成可能なデータベースのデフォルト値が含まれます。ただし、一度に構成できるデータベースは 1 つだけです。設定可能な値は次のとおりです。

Oracle: dbpacks/oracle/9204e

Sybase: dbpacks/sybase/ase12.5.1

MySQL: dbpacks/mysql/4.0.20

デフォルト値は dbpacks/sybase/ase12.5.1 です。

db_template_file

メイン データベース コンフィギュレーション テンプレート名を定義します。デフォルト値は main.vm です。このパラメータの変更は推奨されません。

batch_size

1 つのバッチで実行可能な挿入数を定義します。デフォルト値は 10 です。

transaction_size

1 つのトランザクションで実行可能なバッチ数を定義します。デフォルト値は 15 です。

commit_interval

データベース コミットの最大時間間隔を定義します。デフォルト値は 6 です。

operations_timeout

接続、挿入などのデータベース操作の完了にかかる最大許容時間を定義します。デフォルト値は 60 です。

blocking_connects

データベースへの接続の試みをブロックするかどうかを定義します。

このパラメータに設定可能な値は true および false です。デフォルト値は true です。

[app] セクション

[app] セクションには次のパラメータが含まれます。

app_conf_file

アプリケーション コンフィギュレーション XML ファイル名を定義します。デフォルト値は dbtables.xml です。

app_dtd_file

アプリケーション コンフィギュレーション DTD ファイル名を定義します。デフォルト値は dbtables.dtd です。

app_conf_dir

アプリケーション コンフィギュレーション XML ファイルと DTD ファイルの場所を、CM コンフィギュレーション ディレクトリからの相対パスとして定義します。デフォルト値は apps/scasbb/3.5.0 です。