xymon - クラウドでオンライン

プログラム：

NAME

xymon - Xymon クライアント通信プログラム

SYNOPSIS

キシモン [オプション] レシピエント メッセージ

DESCRIPTION

キシモン(1) Xymon サーバーと通信するために使用されるクライアント プログラムです。 頻繁にあります
Xymon クライアント システムによって、ローカル テストのステータス メッセージとポケットベル アラートを送信するために使用されます。

Xymon では、xymon プログラムは、名前の変更や名前の変更などの管理目的にも使用されます。
ホストを削除するか、長時間停止しているホストを無効にします。

OPTIONS そして パラメーター

- デバッグ
デバッグを有効にします。 これにより、Xymon への接続方法に関する詳細が出力されます。
サーバーを確立中です。

--プロキシ=http://PROXYSERVER：プロキシポート/
HTTP 経由でステータス メッセージを送信する場合は、代わりにこのサーバーを HTTP プロキシとして使用します。
Xymon サーバーに直接接続する方法。

--タイムアウト=N
Xymon サーバーへの接続のタイムアウトを秒単位で指定します。 デフォルト
5秒です。

- 応答
xymon ユーティリティは通常、サーバーからの応答がいつ来るかを知っているため、これは
オプションは必要ありません。 ただし、サーバーからの応答はすべて次のようになります。
表示されます。

- マージ
コマンドラインのメッセージテキストと標準入力で提供されたデータをマージし、
結果を Xymon サーバーに送信します。 コマンドラインで提供されるメッセージテキスト
マージされたメッセージの最初の行になります。

レシピエント
　 レシピエント パラメータは、どのサーバーがメッセージを受信するかを定義します。 RECIPIENT が
「0.0.0.0」と指定すると、メッセージはリストされているすべてのサーバーに送信されます。
XYMSERVERS 環境変数。

通常、クライアントは「$XYMSRV」を使用します。 レシピエント パラメータ、このように
クライアント スクリプトに正しい値が自動的に含まれるように定義されます。

　 レシピエント パラメータは、xymoncgimsg.cgi を持つ Web サーバーの URL である場合があります。
または同様のスクリプトがインストールされています。 これにより、Xymon メッセージが Xymon サーバーにトンネリングされます。
標準の HTTP プロトコルを使用します。 の xymoncgimsg.cgi(8) CGI ツール (Xymon に含まれています)
HTTP トランスポートが機能するには、Web サーバーにインストールする必要があります。

MESSAGE
　 メッセージ パラメータは、Xymon サーバーに送信されるメッセージです。
メッセージは引用符で囲む必要がありますが、そうすることで複数行にまたがることができます。
メッセージの最大サイズは、メッセージの最大許容長によって定義されます。
シェルのコマンドラインであり、通常は 8 ～ 32 KB です。

より長いステータス メッセージを送信する必要がある場合は、メッセージとして「@」を指定できます。
次に、xymon は標準入力からステータス メッセージを読み取ります。

ザイモン MESSAGE 構文

このセクションでは、Xymon プロトコルで最も一般的に使用されるメッセージをリストします。

各メッセージは Xymon コマンドのいずれかで始まる必要があります。 HOSTNAME が指定されている場合、
Xymon FQDN 設定が有効な場合は、ホスト名のドットをカンマに変更する必要があります
(これがデフォルトです)。 たとえば、ホスト「www.foo.com」は次のように報告します。
「www、foo、com」。

ステータス[+LIFETIME][/group:GROUP] ホスト名.テスト名 色
これにより、単一ホスト上の単一のテスト (列) のステータス メッセージが送信されます。
TESTNAME は、このテストが表示される列の名前です。 どの名前でも有効です
ただし、テスト名にドットを使用すると機能しません。 COLOR は次のいずれかでなければなりません
有効な色: 「緑」、「黄」、「赤」、または「透明」。 カラーは「ブルー」と「パープル」
- 有効な色ですが、これらはステータス メッセージで送信されるべきではありません。
Xymon サーバーによって特別に処理されます。 特殊なケースとして（古いものをサポートするため）
client)、「client」を色の名前として使用できます。 これによりステータスが発生します
Xymon によって「クライアント」データ メッセージとして処理されるメッセージ、および TESTNAME
パラメータは「コレクターID」として使用されます。
「追加テキスト」には通常、ローカル タイムスタンプとテストの概要が含まれます。
最初の行に結果が表示されます。 最初の行に続く行は自由形式であり、
報告されている問題の診断に役立つ可能性のある情報を含めてください。
LIFETIME は、このステータスがシステムによって受信されてから有効な期間を定義します。
ザイモンサーバー。 デフォルトは 30 分ですが、任意の期間を設定できます。 例えば
60 時間に XNUMX 回実行するカスタム テストの場合は、これを少なくとも XNUMX に設定する必要があります。
分 - それ以外の場合、ステータスは 30 分後に紫色になります。 それは良いアイデアです
LIFETIME をテスト間の間隔よりわずかに長く設定するには、
テストが完了するまでにかかる時間は変動することを考慮してください。 ライフタイムはこれからです
分。ただし、直後に「h」（時間）、「d」（日）、または「w」（週）を追加します。
数値。たとえば、5 時間有効なステータスの場合は「status+5h」。
GROUP オプションは、ステータスから特定のグループにアラートを送信するために使用されます。 それ
現在、Xymon クライアントのデータから生成されたステータスに使用されています。たとえば、
正確にどのプロセスに応じて、さまざまな人に「procs」ステータスをアラートする
ダウンしています。

HOSTNAME.TESTNAME に通知する
これにより、アラートを受信した人に情報メッセージが送信されます。
この HOSTNAME+TESTNAME の組み合わせは、で定義されたルールに従っています。 アラート.cfg(5)
これはによって使用されます enadis.cgi(1) ホストが無効になっていることを人々に通知するツール
または有効になっていますが、サーバー管理者に通知する一般的な方法としても機能します。

データ ホスト名.データ名
「データ」メッセージを使用すると、ツールはホストに関するデータを、ホストとして表示されることなく送信できます。
Xymon Webページのコラム。 これは、たとえば統計をレポートするために使用されます。
ホストに関するもの (例: vmstat データ)。それ自体は何かを表しません。
赤、黄、緑のアイデンティティを持っています。 これは、RRD ボトムフィーダー モジュールによって使用されます。
その他。 Xymon では、データ メッセージはデフォルトで、 xymond_rrd(8)
モジュール。 外部アプリケーションを使用してデータメッセージを処理したい場合は、次のようにします。
を有効にしたい xymond_filestore(8) データメッセージ用モジュール、データを保存するためのモジュール
Big Brother デーモンの動作と互換性のある形式のメッセージ。

HOSTNAME.TESTNAME DURATION を無効にする
特定のテストを DURATION 分間無効にします。 これにより、この状態が発生します
テストは Xymon サーバー上で「青」としてリストされ、このホスト/テストに対するアラートはありません
が生成されます。 DURATION が数字で指定され、その後に s/m/h/d が続く場合、それは次のようになります。
それぞれ秒/分/時間/日単位として解釈されます。 を無効にするには
OKになるまでテストし、DURATIONとして「-1」を使用します。 すべてのテストを無効にするには、
ホストの場合は、TESTNAME にアスタリスク「*」を使用します。

HOSTNAME.TESTNAME を有効にする
無効になっていたテストを再度有効にします。

クエリ HOSTNAME.TESTNAME
この特定のテストに関して報告された最新のステータスについては、Xymon サーバーにクエリを実行します。 もし
ホスト/テストのステータスはわかっており、応答はステータス レポートの最初の行です
- 現在の色が行の最初の単語になります。 追加のテキスト行
ステータス メッセージに存在する可能性のあるメッセージは取得できません。
これにより、任意の Xymon クライアントが特定のテストのステータスを判断できるようになります。
これは、クライアントが実行されているホスト、他のホスト、または
おそらく、によって管理される複数のホストからの組み合わせテストの結果です。 コンボステータス(1)
これは通常、Xymon クライアント拡張スクリプトに役立ちます。
他のホストのステータスを確認します。たとえば、自動ホストかどうかを判断します。
回復措置を開始する必要があります。

設定ファイル名
Xymon 構成ファイルの XNUMX つをサーバーから取得します。 このコマンドにより、
クライアントがサーバー上の $XYMONHOME/etc/ ディレクトリからファイルをプルすることで、
クライアント設定の半自動更新用。 構成以来
ファイルは、すべてのホストの構成に共通のファイルを持つように設計されています。
システム - そして実際、これがクライアントを構成する推奨される方法です - これ
構成ファイルの同期を維持しやすくなります。

ホスト名を削除
ホスト HOSTNAME に関して保存されているすべてのデータを削除します。 あなたが持っていると仮定されます
ホストはすでに hosts.cfg 構成ファイルから削除されています。

ホスト名テスト名を削除
単一のテスト (列) に関するデータを削除します。

OLDHOSTNAME NEWHOSTNAME の名前を変更
名前が変更されたホストのすべてのデータの名前を変更します。 これは後で行うべきです
hosts.cfg 構成ファイル内のホスト名を変更します。

ホスト名 OLDTESTNAME NEWTESTNAME の名前を変更します
単一のテスト (列) に関するデータの名前を変更します。

xymondlog ホスト名.テスト名
単一のテストの Xymon ステータス ログを取得します。 応答の最初の行
パイプ記号で区切られた一連のフィールドが含まれます。

hostname ホストの名前

テスト名 テストの名前

カラー ステータスカラー（緑、黄、赤、青、クリア、紫）

テストフラグ ネットワーク テストの場合、テストの詳細を示すフラグ (
キシモンゲン）。

最終変更 ステータスの色が最後に変更されたときの Unix タイムスタンプ。

ログタイム ログ メッセージを受信したときの Unix タイムスタンプ。

有効時間 ログ メッセージが有効でなくなったときの Unix タイムスタンプ (次の時点で紫色になります)
この時）。

アクタイム アクティブな確認応答の有効期限が切れたときの -1 または Unix タイムスタンプ。

無効化時間 ステータスが無効でなくなったときの -1 または Unix タイムスタンプ。

トランスミッタ ステータスの受信元の IP アドレス。

クッキー -1 またはアラートの確認に使用される Cookie 値。

確認メッセージ 空、またはステータスが確認されたときに送信される確認メッセージ。
改行、パイプ記号、およびバックスラッシュは、C スタイルのバックスラッシュでエスケープされます。

メッセージを消す 空、またはステータスが無効になったときに送信されるメッセージ。 改行、パイプ記号
バックスラッシュは C スタイルのバックスラッシュでエスケープされます。

最初の行の後には、プレーン テキスト形式の完全なステータス ログが続きます。

xymondxlog ホスト名.テスト名
「xymondlog」コマンドと同様に、ステータス ログを含む XML 文字列を取得します。

xymondboard [基準] [フィールド=フィールドリスト]
Xymon デーモンで利用できるすべての既知のテストのステータスの概要を取得します。

デフォルトでは、CRITERIA が指定されていない場合、すべてのステータスに対して XNUMX 行が返されます。
Xymon にあるメッセージ。 特定の選択によって応答をフィルタリングできます
ページ、ホスト、テスト、カラー、またはその他のさまざまなフィールド。 ページパス、ネットワーク、ホスト名、
TESTNAME および *MSG パラメータは Perl 互換の正規表現として解釈されます。
COLOR パラメータはカンマで区切られた複数の色を受け入れます。 *TIME 値
UNIX エポック タイムスタンプを受け入れます。 で特定されるその他の変数 xymon-xmh(5) また、
利用される。

ホスト フィルタリングはテスト フィルタリングの前に実行されるため、より効率的です (
非常に大きなデータ セット)、PAGEPATH、HOSTNAME、NETWORK、およびその他の XMH_ フィルターを使用する
可能であれば、COLOR、*MSG、*TIME、または TESTNAME でグローバルにフィルタリングする前に。

たとえば、ホスト名とテスト名の両方でフィルタリングできます。

page=ページパス PAGEPATH ページで見つかったホストからのテストのみを含めます。
hosts.cfg ファイル。

ネット=ネットワーク この NET: タグを持つホストからのテストのみを含めます

ip=IPアドレス この IP アドレスを持つホストからのテストのみを含めます。 これは正規表現です。
CIDRではありません。

ホスト=ホスト名 ホスト HOSTNAME からのテストのみを含めます

テスト=テスト名 テスト名 TESTNAME のテストのみを含めます

color=色名 ステータスの色が COLORNAME であるテストのみを含めます

タグ=タグ名 で指定された特定のタグを持つホストのみを含めます。 ホスト.cfg(5)
ライン。 ここには、xymon コンポーネントに既知の項目のみが含まれていることに注意してください。 任意
テキストは含まれません

XMH_string=VALUE を持つホストのみを含めます xymon-xmh(5) これに一致する変数
値

高度なフィルタリング

msg=メッセージ MESSAGE と一致する完全なコンテンツを持つテストのみを含めます。 「\s」を使用して、
エスケープスペース (または他の PCRE 文字列)

ackmsg=メッセージ 確認応答メッセージのあるテストのみを含めます。 「\s」を使用して、
エスケープスペース (または他の PCRE 文字列)

dismsg=メッセージ 文字列が一致する無効化されたテストのみを含めます
メッセージ。 スペース (または他の PCRE 文字列) をエスケープするには、「\s」を使用します。 (それが最も効率的です
これを color=blue と組み合わせます。)

タイムスタンプフィルター

特定のフィールド (以下で説明) は、UNIX タイムスタンプと
次の不等式: >= > <= < = !=

これらのフィルタは次のとおりです: lastchange、logtime、validtime、acktime、disabletime

応答は、CRITERIA に一致するステータスごと、またはすべてのステータスに対して XNUMX 行です。
基準が指定されていない場合。 行は複数のフィールドで構成され、区切られています。
パイプサインで。 取得するフィールドを選択するには、
フィールドリスト。 次のフィールドが使用可能です。

hostname ホストの名前

テスト名 テストの名前

カラー ステータスカラー（緑、黄、赤、青、クリア、紫）

フラグ ネットワーク テストの場合、テストの詳細を示すフラグ (
キシモンゲン）。

最終変更 ステータスの色が最後に変更されたときの Unix タイムスタンプ。

ログタイム ログ メッセージを受信したときの Unix タイムスタンプ。

有効時間 ログ メッセージが有効でなくなったときの Unix タイムスタンプ (次の時点で紫色になります)
この時）。

アクタイム アクティブな確認応答の有効期限が切れたときの -1 または Unix タイムスタンプ。

無効化時間 ステータスが無効でなくなったときの -1 または Unix タイムスタンプ。

トランスミッタ ステータスの受信元の IP アドレス。

クッキー -1 またはアラートの確認に使用される Cookie 値。

line1 ステータスログの最初の行。

確認メッセージ 空 (アクティブな確認応答がない場合)、または確認応答のテキスト
メッセージ。

メッセージを消す 空 (ステータスが現在有効な場合)、または無効のテキスト
メッセージ。

MSG 現在のステータスメッセージの全文。

クライアント 利用可能なクライアント データがある場合は「Y」、ない場合は「N」を表示します。

clntstamp 最後のクライアント メッセージが受信されたときのタイムスタンプ (Unix では「エポック」)
形式でダウンロードすることができます。

確認リスト テストに対する現在の確認応答のリスト。 これは次のテキスト文字列です
コロン文字で区切られた複数のフィールド。 5 つのフィールドがあります。
ACK が生成されたときとその有効期限が切れたとき。 「ACK レベル」。 ユーザーは
ack を送信しました。 そして謝辞のテキスト。

フラップインフォ ステータスがフラッピングしているかどうかを示します。 「/」で区切られた 5 つのフィールド:
ステータスは羽ばたきしていません。羽ばたきしている場合は「1」です。 最新ステータス時のタイムスタンプ
変更が記録されたとき、および最初のステータス変更が記録されたとき。 そして二人
ステータスが点滅している色。

統計情報 xymond 以降にこのステータスに対して記録されたステータス変更の数
始められた。

修飾子 このステータスのアクティブな修飾子をすべてリストします (つまり、
「変更」コマンド）。

XMH_* XMH タグは Xymon を参照します。 ホスト.cfg(5) 構成設定。 いっぱい
これらのリストは、 xymon-xmh(5) マニュアルページ。

ackmsg、dismg、および msg フィールドには、特定の文字がエンコードされています: 改行は "\n"、
TAB は「\t」、キャリッジ リターンは「\r」、パイプ記号は「\p」、バックスラッシュは「\\」です。

「fields」パラメータが省略された場合、デフォルトのセット
ホスト名、テスト名、色、フラグ、最終変更、ログタイム、有効時間、ACK タイム、無効化時間、送信者、Cookie、line1
使用されている。

キシモンドxボード
すべてのステータス ログの概要を含む XML 文字列を取得します。
「xymondboard」コマンド。

ホスト情報 [基準]
ホストの現在の構成を取得します (つまり、 ホスト.cfg(5) 意味）。
CRITERIA は、レポートするホストを選択します。これは、
xymondboard コマンド。

応答は、基準に一致するホストごとに XNUMX 行で、条件に一致する場合はすべてのホストに対して返されます。
基準は指定されていません。 この行は、次のように区切られた複数のフィールドで構成されます。
パイプサイン。 最初の XNUMX つのフィールドは常にホスト名と IP アドレスになります。
残りのフィールド (存在する場合) は、順不同の hosts.cfg タグです。

ファイル名をダウンロード
Xymon サーバーのダウンロード ディレクトリからファイルをダウンロードします。

クライアント[/COLLECTORID] ホスト名.OSTYPE [ホストクラス]
「クライアント」メッセージを Xymon サーバーに送信するために使用されます。 クライアントメッセージが生成される
Xymon クライアントによる。 Xymon サーバーに送信されると、それらは
のルール 分析.cfg(5) 構成ファイル、ステータス メッセージが生成される
クライアント側のテスト用。 COLLECTORID は、クライアント データを送信するときに使用されます。
標準のクライアント データへの追加です。 データは次のように連結されます。
通常のクライアントデータ。

clientlog ホスト名 [セクション=セクション名[,セクション名...]]
HOSTNAME によって最後に送信された現在の生のクライアント メッセージを取得します。 オプションの
「セクション」フィルターは、クライアント データの特定のセクションを選択するために使用されます。

ping Xymon サーバーへの接続を試みます。 成功した場合、Xymon サーバーのバージョン ID は次のようになります。
報告した。

プルクライアント
このメッセージは、実装された「プル」メカニズムを介してクライアント データをフェッチするときに使用されます。
by キシモンフェッチ(8) & メッセージキャッシュ(8) に直接接続できないクライアントの場合、
ザイモンサーバー。

ゴーストリスト
のリストを報告する ゴースト Xymon サーバーから認識されるクライアント。 ゴーストは次のようなシステムです。
データを Xymon サーバーにレポートしますが、hosts.cfg ファイルにはリストされません。

スケジュール [タイムスタンプコマンド]
後で実行するために Xymon サーバーに送信されるコマンドをスケジュールします。 例えば
将来のいつかのホストまたはサービスの無効化をスケジュールするために使用されます。 指示
上記のような完全な Xymon コマンドです。 TIMESTAMP は Unix です
コマンドが実行されるエポック時間。
パラメーターが指定されていない場合、現在スケジュールされているタスクがリストされます。
応答。 応答はスケジュールされたコマンドごとに XNUMX 行で、ジョブ ID、
コマンドが実行される時刻、コマンドの送信元の IP アドレス、
および完全なコマンド文字列。
以前にスケジュールしたコマンドをキャンセルするには、 "スケジュール キャンセル ジョビッド」 に使える。
JOBID は、スケジュール リストの出力の最初の項目として提供される番号です。

メモ ファイル名
メッセージ テキストは $XYMONHOME/notes/FILENAME に保存され、次のように使用されます。
ホスト名または列名からのハイパーリンク。 これには、「storenotes」タスクが必要です
task.cfg で有効になります (デフォルトでは無効になっています)。 FILENAME には何も含めることはできません
ディレクトリ パス - これらは自動的に削除されます。

ユーザーメッセージ ID
これらのメッセージは、「ユーザー」チャネルでリッスンしているモジュールに直接中継されます。
Xymon デーモンの。 これは、クライアント側間のカスタム通信を目的としています。
モジュールと Xymon サーバー。

HOSTNAME.TESTNAME COLOR SOURCE 原因を変更します
完全なステータスを生成せずに、特定のステータスの色を変更する
メッセージ。 これは、
通常のフローの外で決定されたいくつかの基準に基づくステータスの色
状態。 たとえば、通常の「conn」ステータスは単にチェックしているだけなので緑色に見える場合があります。
ホストに ping を送信できるかどうか。 RRD ハンドラーは「変更」を使用できるようになります。
これをオーバーライドするコマンドは、実際の ping 応答時間が指定されたしきい値を超えていることを示します。
(「DS」構成設定を参照してください) 分析.cfg(5) これを行う方法については)。 ソース
「変更」メッセージを生成するモジュールの識別子です - 将来
変更には同じソースを使用する必要があります。 変更するソースがいくつかある可能性があります
同じステータス (最も深刻なステータスが実際の色になります)
状態）。 CAUSE は、オーバーライドする理由を説明する XNUMX 行のテキスト文字列です。
通常のステータスの色 - ステータス Web ページに表示されます。

実施例

TCP 上の標準 Xymon プロトコルを使用して、通常のステータス メッセージを Xymon サーバーに送信します。
ポート 1984:
$ $XYMON $XYMSRV "ステータス www,foo,com.http 緑色 `日付` Web OK"

同じステータス メッセージを送信しますが、Web サーバーの xymoncgimsg.cgi 経由で HTTP プロトコルを使用します。
スクリプト：
$$ザイモン http://bb.foo.com/cgi-bin/xymoncgimsg.cgi 「ステータス www,foo,com.http 緑色
「日付」Web OK」

「クエリ」メッセージを使用して「www」テストの色を決定し、そうであった場合は Apache を再起動します。
赤：

$ WWW=`$XYMON $XYMSRV "クエリ www,foo,com.www" | ああ、「{print $1}」
$ if [ "$WWW" = "赤" ]; 次に /etc/init.d/apache を再起動します。 フィ

「config」メッセージを使用して、ローカルの mytest.cfg ファイルを更新します (ただし、応答を受け取った場合に限ります)。

$ $XYMON $XYMSRV "config mytest.cfg" >/tmp/mytest.cfg.new
$ if [ -s /tmp/mytest.cfg.new ]; それから
mv /tmp/mytest.cfg.new $XYMONHOME/etc/mytest.cfg
fi

ファイル「statusmsg.txt」に組み込まれた非常に大きなステータス メッセージを送信します。 その代わり
コマンドラインで指定する場合は、stdin 経由で xymon コマンドに渡します。

$ cat statusmsg.txt | $XYMON $XYMSRV "@"

onworks.net サービスを使用してオンラインで xymon を使用する