CGI設定ファイルのオプション
目次
- 1 注釈
- 2 サンプル設定
- 3 設定ファイルの場所
- 4 設定ファイルの主な変数
- 4.1 メイン設定ファイルの場所
- 4.2 物理的なHTMLパス
- 4.3 HTMLファイルへのURLパス
- 4.4 認証の使用方法
- 4.5 デフォルトユーザ名
- 4.6 システム/プロセス情報へのアクセス
- 4.7 システム/プロセスコマンドへのアクセス
- 4.8 設定情報へのアクセス
- 4.9 グローバルホスト情報へのアクセス
- 4.10 グローバルホストコマンドへのアクセス
- 4.11 グローバルサービス情報へのアクセス
- 4.12 グローバルサービスコマンドへのアクセス
- 4.13 読み取り専用ユーザ
- 4.14 登録者名変更の制限
- 4.15 CGIステータスマップの背景画像
- 4.16 ステータスマップCGIの透過
- 4.17 ステータスマップのデフォルトレイアウト方法
- 4.18 3DステータスマップCGI
- 4.19 3Dステータスマップのデフォルトレイアウト方法
- 4.20 CGIのリロード間隔
- 4.21 警告音
- 4.22 Pingの構文
- 4.23 HTMLタグの回避オプション
- 4.24 表示URLターゲット
- 4.25 動作URLターゲット
- 4.26 Splunk統合オプション
- 4.27 SplunkのURL
注釈
設定ファイルを作成および編集するときは、以下のことに注意してください:
- '#'で始まる行はコメントとみなされ、実際には処理されません。
- 変数名は行の先頭から始めてください - スペースが先頭に入っていはいけません。
- 変数名は大文字/小文字を区別します。
サンプル設定
Tip前提:以下のサンプルでは、CGI設定ファイル(/usr/local/nagios/etc/cgi.cfg)はクイックスタートガイドに従ってインストールされているものとします。
設定ファイルの場所
デフォルトでは、NagiosはCGI設定ファイルがcgi.cfgという名前でメイン設定ファイルと同じディレクトリにあると考えます。ファイル名やディレクトリパスを変更したい場合は、ApacheにNAGIOS_CGI_CONFIGという環境変数 (cgiへの正しいパスを指す為のもの)を設定してください。設定方法についてはApacheのドキュメントを参照してください。
設定ファイルの主な変数
以下にNagiosのメイン設定ファイルのオプションを示します...
メイン設定ファイルの場所
- 書式
- main_config_file=<file_name>
- 例
- main_config_file=/usr/local/nagios/etc/nagios.cfg
この変数はメイン設定ファイルの場所を指定します。CGIは、設定情報や現在のホストとサービスのステータスを知る為にこのファイルの場所を知る必要があります。
物理的なHTMLパス
- 書式
- physical_html_path=<path>
- 例
- physical_html_path=/usr/local/nagios/share
この変数はNagiosのあるサーバのHTMLファイルの物理的な場所を指定します。Nagiosは、ドキュメントとイメージファイル(CGIによって用いられるもの)が、それぞれdocs/、images/というサブディレクトリにあると仮定します。
HTMLファイルへのURLパス
- 書式
- url_html_path=<path>
- 例
- url_html_path=/nagios
ウェブブラウザを経由してNagiosへアクセスする場合、/nagiosサブディレクトリを指す次のような形式のURL http://www.myhost.com/nagios が必要です。基本的に、このURLはNagiosのHTMLページへのアクセスパスの一部です。
認証の使用方法
- 書式
- use_authentication=<0/1>
- 例
- use_authentication=1
このオプションでは、各ユーザがどのような情報にアクセスできるか決定する際に、CGIが認証と許可機能を利用するかどうかを制御します。この項目については有効にすることを強く推奨します。もし認証機能を利用しない場合は、未許可のユーザがNagiosへコマンドを発行できないように、コマンドCGIを削除しておいてください。認証機能を無効にした場合はCGIはNagiosへコマンドを発行しませんが、より安全にサーバを利用するために無効化は避けるべきでしょう。詳しい設定方法やCGIの認証と許可についてはこちらです。
- 0 = Don't use authentication functionality
- 0 = 認証機能を無効にします
- 1 = Use authentication and authorization functionality (default)
- 1 = 認証機能を有効にします(デフォルト)
デフォルトユーザ名
- 書式
- default_user_name=<username>
- 例
- default_user_name=guest
この変数は、CGIにアクセスするデフォルトのユーザ名を設定します。これを設定することにより、セキュアな環境(ファイアウォールの配下など)からは認証なしにCGIへアクセスできるようになります。BASIC認証はパスワードをインターネット上にクリアテキストで送信するので、それを避けるためにこの機能を利用するのもよいかもしれません。
重要:サーバがセキュアな環境にあり、CGIへアクセスするユーザは全て何らかの形で認証されていることが確認できるまでは、デフォルトユーザ名を定義しないでください。確認が取れないまま定義すると、認証されていないユーザが、デフォルトユーザに対して与えられている全ての権限を受け継いでしまう可能性があります!
システム/プロセス情報へのアクセス
- 書式
- authorized_for_system_information=<user1>,<user2>,<user3>,...<usern>
- 例
- authorized_for_system_information=nagiosadmin,theboss
これは追加情報CGIからシステム/プロセス情報を閲覧できる認証ユーザのカンマ区切りのリストです。このリストのユーザは、自動的にシステム/プロセスコマンド発行権限を与えられるわけではありません。もしシステム/プロセスコマンド発行権限が必要なら、authorized_for_system_commands変数に設定する必要があります。詳しい設定方法やCGIの認証と許可についてはこちらです。
システム/プロセスコマンドへのアクセス
- 書式
- authorized_for_system_commands=<user1>,<user2>,<user3>,...<usern>
- 例
- authorized_for_system_commands=nagiosadmin
これはコマンドCGIからシステム/プロセスコマンドを発行できる認証ユーザのカンマ区切りのリストです。このリストのユーザは、自動的にシステム/プロセス情報閲覧権限を与えられるわけではありません。もしシステム/プロセス情報閲覧権限が必要なら、authorized_for_system_information変数に設定する必要があります。詳しい設定方法やCGIの認証と許可についてはこちらです。
設定情報へのアクセス
- 書式
- authorized_for_configuration_information=<user1>,<user2>,<user3>,...<usern>
- 例
- authorized_for_configuration_information=nagiosadmin
これはCGI設定から設定情報を閲覧できる認証ユーザのカンマ区切りのリストです。このリストのユーザは、ホスト、ホストグループ、サービス、通知先、通知先グループ、時間帯とコマンドの全情報を閲覧することができます。詳しい設定方法やCGIの認証と許可についてはこちらです。
グローバルホスト情報へのアクセス
- 書式
- authorized_for_all_hosts=<user1>,<user2>,<user3>,...<usern>
- 例
- authorized_for_all_hosts=nagiosadmin,theboss
これは、全ホストのステータスと設定情報を閲覧できる認証ユーザのカンマ区切りのリストです。このリストのユーザは、自動的に全サービス情報も閲覧できますが、全ホストやサービスに対してコマンドを発行できるようにはなりません。もし全ホストやサービスに対するコマンド発行権限が必要なら、authorized_for_all_host_commands変数に設定する必要があります。詳しい設定方法やCGIの認証と許可についてはこちらです。
グローバルホストコマンドへのアクセス
- 書式
- authorized_for_all_host_commands=<user1>,<user2>,<user3>,...<usern>
- 例
- authorized_for_all_host_commands=nagiosadmin
これはコマンドCGIから全ホストへのコマンド発行権限を持つ認証ユーザのカンマ区切りのリストです。このリストのユーザは、自動的に全サービスに対してもコマンドを発行できますが、全ホストやサービスの設定情報を閲覧できるようにはなりません。もし全ホストやサービスの設定情報閲覧権限が必要なら、authorized_for_all_hosts変数に設定する必要があります。詳しい設定方法やCGIの認証と許可についてはこちらです。
グローバルサービス情報へのアクセス
- 書式
- authorized_for_all_services=<user1>,<user2>,<user3>,...<usern>
- 例
- authorized_for_all_services=nagiosadmin,theboss
これは全サービスのステータスと設定情報を閲覧できる認証ユーザのカンマ区切りのリストです。このリストのユーザは、自動的に全ホストの設定情報を閲覧できるわけではありませんし、自動的に全サービスへコマンドを発行できるようにはなりません。もし全サービスに対するコマンド発行権限が必要なら、authorized_for_all_service_commands変数に設定する必要があります。詳しい設定方法やCGIの認証と許可についてはこちらです。
グローバルサービスコマンドへのアクセス
- 書式
- authorized_for_all_service_commands=<user1>,<user2>,<user3>,...<usern>
- 例
- authorized_for_all_service_commands=nagiosadmin
これはコマンドCGIから全サービスへのコマンド発行権限を持つ認証ユーザのカンマ区切りのリストです。このリストのユーザは、自動的に全ホストへのコマンド発行権限を与えられるわけではありませんし、自動的に全ホストの設定情報を閲覧できるようにはなりません。もし全サービスの設定情報閲覧権限が必要なら、authorized_for_all_services変数に設定する必要があります。詳しい設定方法やCGIの認証と許可についてはこちらです。
読み取り専用ユーザ
- 書式
- authorized_for_read_only=<user1>,<user2>,<user3>,...<usern>
- 例
- authorized_for_read_only=john,mark
CGIに対して読み取り権限のみを持つユーザのカンマ区切りのリストです。このリストのユーザは、全サービス又はホストへのコマンド発行をブロックされます。コメントも、読み取り専用ユーザには表示されません。
登録者名変更の制限
- 書式
- lock_author_names=[0/1]
- 例
- lock_author_names=1
Webインタフェースからコメント、認知済み、計画されたダウンタイムを登録する場合に、このオプションで登録者名の変更を制限することができます。このオプションが有効な場合、ユーザは関連するコマンドを登録したユーザ名を変更することができません。
- 0 = Allow users to change author names when submitting commands
- 0 = コマンド登録者名を変更できます
- 1 = Prevent users from changing author names (default)
- 1 = コマンド登録者名を変更できません(デフォルト)
CGIステータスマップの背景画像
- 書式
- statusmap_background_image=<image_file>
- 例
- statusmap_background_image=smbackground.gd2
このオプションで、ステータスマップCGIの背景画像を指定できます。背景画像は、どのレイアウト方法でも利用できます。画像は、HTMLイメージパス(つまり /usr/local/nagios/share/images)にあると仮定されます。このパスは、自動的にphysical_html_pathで指定したパスに"/images"を追加したものになります。 注釈: 画像ファイルは GIF、JPEG、PNG、GD2 が使えますが、CPU負荷が低いGD2(圧縮されていないものがより望ましい)を推奨します。
ステータスマップCGIの透過
- 書式
- color_transparency_index_r=<0-255>
- color_transparency_index_g=<0-255>
- color_transparency_index_b=<0-255>
- 例
- color_transparency_index_r=255
- color_transparency_index_g=255
- color_transparency_index_b=255
このオプションで、ステータスマップCGIの背景色の赤、緑、青の値を設定することができます。これによって透過PNGに対応していないブラウザでも表示できるようにします。デフォルトは白色で、値は次のようになっています:(R,G,B) = (255,255,255)
ステータスマップのデフォルトレイアウト方法
- 書式
- default_statusmap_layout=<layout_number>
- 例
- default_statusmap_layout=4
このオプションで、ステータスマップCGIのデフォルトのレイアウト方法を決定できます。オプションは以下の通り:
| 設定値 | レイアウト方法 |
|---|---|
| 0 | ユーザ定義の座標 |
| 1 | 階層構造 |
| 2 | 非バランス木 |
| 3 | バランス木 |
| 4 | 円 |
| 5 | 円(マークアップ) |
| 6 | 円(バルーン) |
3DステータスマップCGI
- 書式
- statuswrl_include=<vrml_file>
- 例
- statuswrl_include=myworld.wrl
このオプションによって、3Dオブジェクトの指定が可能となります。これはphysical_html_pathで指定したパスに属するとみなされます。注:ここで指定されるのはVRMLファイルである必要があります(例えばVRMLブラウザで見ることができる、等)。
3Dステータスマップのデフォルトレイアウト方法
- 書式
- default_statuswrl_layout=<layout_number>
- 例
- default_statuswrl_layout=4
このオプションで、3DステータスマップCGIのデフォルトのレイアウト方法を決定できます。オプションは以下の通り:
| 設定値 | レイアウト方法 |
|---|---|
| 0 | ユーザ定義の座標 |
| 2 | 非バランス木 |
| 3 | バランス木 |
| 4 | 円 |
CGIのリロード間隔
- 書式
- refresh_rate=<rate_in_seconds>
- 例
- refresh_rate=90
このオプションで、ステータスCGI、ステータスマップCGI、追加情報CGIのリロード間隔を秒単位に設定できます。
警告音
- 書式
- host_unreachable_sound=<sound_file>
- host_down_sound=<sound_file>
- service_critical_sound=<sound_file>
- service_warning_sound=<sound_file>
- service_unknown_sound=<sound_file>
- 例
- host_unreachable_sound=hostu.wav
- host_down_sound=hostd.wav
- service_critical_sound=critical.wav
- service_warning_sound=warning.wav
- service_unknown_sound=unknown.wav
このオプションで、ステータスCGIを見ている時に問題が発生した場合に再生される音声ファイルを指定します。問題の深刻度に合わせて違うファイルを指定できます。最も深刻な問題はホスト未到達、最も軽微な問題はサービス状態不明です(上記の例を参照してください)。音声ファイルは、HTMLディレクトリのmedia/サブディレクトリにあるとみなされます(例: /usr/local/nagios/share/media)。
Pingの構文
- 書式
- ping_syntax=<command>
- 例
- ping_syntax=/bin/ping -n -U -c 5 $HOSTADDRESS$
このオプションは、WAPインタフェースから(statuswmlCGIを利用して)疎通確認をする場合のpingの構文を指定します。pingバイナリを必要なオプションと共にフルパスで指定してやる必要があります。$HOSTADDRESS$ マクロは、コマンドが実行される前にホスト名に置き換えられます。
HTMLタグの回避オプション
- 書式
- escape_html_tags=[0/1]
- 例
- escape_html_tags=1
このオプションでは、ホストやサービス(プラグイン)の出力に含まれるHTMLタグを回避するかどうかを決定します。このオプションを有効にした場合、プラグイン出力にはHTMLハイパーリンクを含められません。
表示URLターゲット
- 書式
- notes_url_target=[target]
- 例
- notes_url_target=_blank
このオプションでは、URLを表示するフレーム名を決定します。有効な名前は_blank、_self、_top、_parentなどです。
動作URLターゲット
- 書式
- action_url_target=[target]
- 例
- action_url_target=_blank
このオプションでは、動作URLが表示されるフレーム名を決定します。有効な名前は_blank、_self、_top、_parentなどです。
Splunk統合オプション
- 書式
- enable_splunk_integration=[0/1]
- 例
- enable_splunk_integration=1
このオプションでは、Splunkの統合機能をウェブインタフェース上で有効にするかどうかを決定します。このオプションを有効にすると、"Splunk It"というリンクがログファイル、警告履歴、ホスト/サービスの詳細などに表示され、それはある種の問題が発生した場合にその原因を探るのに役立ちます。より詳しい情報はこちらです http://www.splunk.com/ 。
SplunkのURL
- 書式
- splunk_url=<path>
- 例
- splunk_url=http://127.0.0.1:8000/
このオプションでは、SplunkインタフェースのベースURLを指定します。 このURLは、enable_splunk_integrationオプションが有効な場合にCGIに利用されます。
