Cisco IOS ネットワーク管理コンフィギュレーション ガイド
Syslog メッセージへの XML インターフェイ スの設定
Syslog メッセージへの XML インターフェイスの設定
発行日;2012/02/01 | 英語版ドキュメント(2011/04/25 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 6MB) | フィードバック

目次

Syslog メッセージへの XML インターフェイスの設定

この章の構成

Syslog メッセージへの XML インターフェイス機能について

Cisco IOS システム メッセージ ロギング

XML 形式のシステム メッセージ ロギング

システム ロギング メッセージの形式

syslog メッセージの XML 形式の設定方法

syslog メッセージの XML 形式の設定例

その他の参考資料

関連資料

規格

MIB

RFC

シスコのテクニカル サポート

コマンド リファレンス

用語集

Syslog メッセージへの XML インターフェイスの設定

Syslog メッセージへの XML インターフェイス機能には、Extensible Markup Language(XML)形式で送信する syslog メッセージを有効にするための Command-Line Interface(CLI; コマンドライン インターフェイス)コマンドがあります。標準化された XML 形式のログは、外部のカスタマイズされたモニタリング ツールでより簡単に使用できます。

Syslog メッセージへの XML インターフェイス機能の仕様

機能の履歴
リリース
変更点

12.2(15)T

この機能が導入されました。

サポートされているプラットフォーム1

標準のシステム メッセージ ロギングをサポートするすべてのプラットフォーム。詳細については、Cisco Feature Navigator を参照してください。

1.イメージとプラットフォームのサポートの詳細と更新については、Cisco Feature Navigator を参照してください。http://www.cisco.com/go/fn にある Cisco Feature Navigator にアクセスしてください。アクセスには、Cisco.com のアカウントが必要です。アカウントを持っていないか、ユーザ名またはパスワードが不明の場合は、ログイン ダイアログボックスの [Cancel] をクリックし、表示される指示に従ってください。

Syslog メッセージへの XML インターフェイス機能について

Syslog メッセージへの XML インターフェイス機能を設定するには、次の概念を理解する必要があります。

Cisco IOS システム メッセージ ロギング

XML 形式のシステム メッセージ ロギング

システム ロギング メッセージの形式

Cisco IOS システム メッセージ ロギング

Cisco IOS System Message Logging(syslog; システム メッセージ ロギング)プロセスを使用すると、ローカルまたはリモート ロギング サーバにシステムで重要なエラーと通知メッセージを報告し、保存できます。これらの syslog メッセージには、標準化された形式のメッセージ(システム エラー メッセージと呼ばれることもあります)と debug コマンドからの出力が含まれます。これらのメッセージは、ネットワーク動作の間に生成され、問題の種類と重大度を特定してユーザと Cisco TAC 技術者を支援したり、ルータ動作のモニタリングでユーザを援助します。syslog メッセージは、コンソール、モニタ(TTY および Telnet 接続)、システム バッファ、またはリモート ホストに送信できます。


) Cisco IOS ソフトウェアのシステム メッセージ ロギング プロセスは略して「syslog」と呼ばれます。このプロセスによって生成されたメッセージは、「syslog メッセージ」と呼ばれます。ただし、syslog メッセージは Cisco IOS のマニュアルでは「システム エラー メッセージ」または「SEM」と呼ばれることもあります。syslog メッセージは、エラー状態に限らず、単純に情報メッセージを反映する場合もあることに注意してください。


XML 形式のシステム メッセージ ロギング

SGML から派生した XML では、syslog メッセージにあるような一貫して形式化されたデータを構造化する表現方法が可能です。

Syslog メッセージへの XML インターフェイス機能には、XML 形式で送信する syslog メッセージを有効にするための CLI コマンドがあります。標準化された XML 形式のログは、外部のカスタマイズされたモニタリング ツールでより簡単に使用できます。Cisco IOS ソフトウェア内では、意味のある XML タグの閉集合が定義され、イネーブルにすると、コンソール、モニタ、バッファ、またはリモート ホストに送信される syslog メッセージに適用されます。

Cisco IOS ソフトウェアには、標準ロギング形式と XML ロギング形式の 2 つのシステム ロギング形式があります。これはつまり、あるリモート ホストに標準の syslog メッセージを送信するように指定し、別のホストには XML 形式の syslog メッセージを送信するように指定できます。同様に、ロギング メッセージがシステム バッファに送信されると、XML ロギング バッファは標準ロギング バッファとは区別され、標準ロギング バッファと XML ロギング バッファを同時に実行できます。

XML ロギング プロセスは標準ロギング プロセスに依存します。ほとんどの場合、標準ロギング プロセスの設定が XML ロギング プロセスにも適用されます。たとえば、 logging buffered xml コマンドの重大度は、標準 logging buffered コマンドに設定されたレベル(または設定されていない場合、標準バッファのデフォルトの重大度)によって決まります。同様に、XML ロギング バッファのデフォルト サイズは、標準ロギング バッファのデフォルトと同じです(デフォルトのバッファ サイズはプラットフォームによって異なります)。

システム ロギング メッセージの形式

システム ロギング メッセージは次の形式になります。

%<facility>-<severity>-<mnemonic>: <message-text>
 

例:

%LINK-5-CHANGED: Interface Serial3/3, changed state to administratively down
 

通常、これらのメッセージはタイムスタンプやメッセージ シーケンス番号などの追加のテキストの後に続きます。

<sequence-number>: <date or system-up-time> <time>:%<facility>-<severity>-<mnemonic>: <message-text>
 

例:

000013: Mar 18 14:52:10.039:%LINK-5-CHANGED: Interface Serial3/3, changed state to administratively down
 

) システム ロギング メッセージに使用されるタイムスタンプの形式は、service timestamps グローバル コンフィギュレーション モード コマンドによって決まります。service sequence-numbers グローバル コンフィギュレーション コマンドは、先行するシーケンス番号をイネーブルまたはディセーブルにします。時刻の前のアスタリスク(*)は、システム クロックが信頼できる時刻源と同期していないため、時刻が不正確である可能性があることを示しています。


表 1 は、syslog メッセージに適用される XML タグを示しています(XML 形式)。

表 1 syslog メッセージに使用される XML タグ フィールド

適用されるタグ
区切られる項目

<ios-log-msg></ios-log-message>

syslog メッセージ全体。

<facility></facility>

ファシリティ名。FACILITY は、複数の大文字で構成されたコードで、メッセージが言及しているファシリティを示します。ファシリティはハードウェア デバイス、プロトコル、またはシステム ソフトウェアのモジュールである可能性があります。

<severity></severity>

重大度値。SEVERITY は、状態の重大度を反映する 0 から 7 の 1 桁のコードです。数字が小さいほど状態は深刻です。

<msg-id></msg-id>

ニーモニック。MNEMONIC は、エラーまたはイベントの種類を特定するコード(通常は省略された説明)です。

<seq></seq>

エラー シーケンス番号。

<time></time>

日付と時刻を含むタイムスタンプまたはシステム アップタイム(最後のリブートからの時間)。

<args></args>

メッセージ テキスト内の変数。完全に「人間が読み取れる」テキストのメッセージは、XML では保持されません。変数のみが抽出され、形式化されます。

システム エラー メッセージ内の変数は、Cisco IOS マニュアル内でカッコで特定されます( [chars]、[hex]、[int] 、など)。

例:

%LINK-5-CHANGED: : Interface [chars], changed state to [chars]

syslog メッセージの完全なテキストについては、Cisco.com で入手できる『 Cisco IOS System Error Messages 』マニュアルを参照してください。

これらの XML タグはすべてメッセージに大きなオーバーヘッドを加えます。メッセージの長さが IOS メッセージ ロギングの制限を越えている場合、「<args>...</args>」部分は「<args-warning>*** LOG OVERRUN ***</args-warning>」に置き換えられます。

<arg id="x"></arg>

特定の引数。"x" はゼロから始まる連続した変数 ID 番号です。

次の例では、標準形式の syslog メッセージと XML 形式を適用した同じメッセージを示しています。

標準の syslog メッセージ形式

000013: *Oct 11 14:52:10.039: %SYS-5-CONFIG_I: Configured from console by vty0 (172.19.208.14)

XML の syslog メッセージ形式

<ios-log-msg><facility>SYS</facility><severity>5</severity><msg-id>CONFIG_I</msg-id><seq>000013</seq><time>*Oct 11 14:52:10.039</time><args><arg id=“0”>console</arg><arg id=“1”>vty0 (172.19.208.14)</arg></args></ios-log-msg>
 

) ルータでデバッグがイネーブルになっており、ロギングが重大度 7 のメッセージを記録するよう設定されている場合、システム ロギング メッセージにはデバッグ メッセージが含まれます。ただし、デバッグ メッセージはシステム ロギング メッセージ形式を使用しません。このため、XML 形式はこれらのメッセージには適用されません。


syslog メッセージの XML 形式の設定方法

XML 形式でロギングをイネーブルにするには、単純に syslog メッセージを送信する場所を示す適切なロギング コマンドを使用し、後に xml キーワードを続けます。標準のシステム メッセージ ロギングは、デフォルトでイネーブルになっていますが、これらのメッセージの XML 形式はデフォルトでディセーブルになっています。

前にも述べたように、XML 形式のロギング プロセスは標準のロギング プロセスとは区別されるため(ただし依存します)、宛先がリモート ホストやシステム バッファの場合、標準のロギングに加えて XML 形式のロギングも設定できます。

コマンドの概要

XML 形式の syslog メッセージをイネーブルにするには、グローバル コンフィギュレーション モードで次のいずれかのコマンドを使用します。

logging console xml

logging monitor xml

logging buffered xml

logging host { ip-address | host-name } xml

ロギングの状態と XML ロギングバッファの内容を表示するには、EXEC モードで show logging xml コマンドを使用します。XML ロギングバッファの内容をクリアするには、EXEC モードで clear logging xml コマンドを使用します。

コマンドの詳細

 

コマンドまたはアクション
目的

logging console xml [ severity-level ]

 

 

Router(config)#logging console xml informational

XML 形式でコンソール接続へのシステム メッセージ ロギングをイネーブルにします。

重大度がこれ以下のメッセージが記録されます。デフォルトの重大度はプラットフォームによって異なりますが、一般的にレベル 7(「デバッグ」)、つまり、すべての重大度(0 から 7)のメッセージが記録されます。

logging monitor xml [ severity-level ]

 

 

Router(config)#logging monitor xml 6

XML 形式でモニタ接続(使用可能なすべての TTY または Telnet 接続)へのシステム メッセージ ロギングをイネーブルにします。

重大度がこれ以下のメッセージが記録されます。デフォルトの重大度はプラットフォームによって異なりますが、一般的にレベル 7(「デバッグ」)、つまり、すべての重大度(0 から 7)のメッセージが記録されます。

ロギング メッセージの表示はデフォルトでディセーブルになっている場合があります。つまり、端末にログインしても terminal monitor EXEC モード コマンドを実行するまでメッセージは表示されません。

logging buffered xml [ xml-buffer-size ]

 

 

Router(config)#logging buffered xml 14336

XML 形式でシステム バッファへのシステム メッセージ ロギングをイネーブルにします。

記録されるメッセージの重大度は logging buffered コマンドの設定によって決まります。 logging buffered コマンドが使用されていない場合は、そのコマンドのデフォルトの重大度が使用されます。デフォルトの重大度はプラットフォームによって異なりますが、一般的にレベル 7(「デバッグ」)、つまり、すべての重大度(0 から 7)のメッセージが記録されます。重大度の詳細については、 logging buffered コマンドについての文書を参照してください。

デフォルトの XML ロギング バッファ サイズはプラットフォームによって異なります (XML ロギング バッファのサイズは、標準ロギング バッファのデフォルトと同じです)。XML バッファ サイズの有効な範囲は 4096 から 2147483647 バイト(4 キロバイトから 2 ギガバイト)です。

logging host { ip-address | host-name } xml

 

 

Router(config)#logging host 209.165.202.132 xml

Router(config)#logging host 209.165.201.20 xml

 

指定されたホストへの XML 形式のシステム メッセージ ロギングをイネーブルにします。

このコマンドを複数回実行すると、ロギング メッセージを受信する syslog サーバのリストが作成されます。

(標準)コマンドで異なる IP アドレス(またはホスト名)を指定する必要があります。

デフォルトの重大度はプラットフォームによって異なりますが、一般的にレベル 5(「通知」)、つまり、重大度 0 から 7 のメッセージが記録されます。すべてのリモート ホストへのロギングのための重大度を指定するには、 logging trap コマンドを使用します。

syslog メッセージの XML 形式の設定例

次の例では、ロギングがイネーブルにされた後、標準バッファと XML バッファへのロギングがイネーブルにされています。最後の 2 つの show logging コマンドは、標準 syslog バッファと XML syslog バッファの違いを比較します。

Router#show logging
Syslog logging: disabled (10 messages dropped, 5 messages rate-limited, 6 flush)
Console logging: disabled
Monitor logging: disabled
Buffer logging: disabled, xml disabled
Logging Exception size (8192 bytes)
Count and timestamp logging messages: disabled
Trap logging: level informational, 31 message lines logged
Router#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#logging on
Router(config)#logging buffered
Router(config)#end
Router#show logging
Syslog logging: enabled (10 messages dropped, 5 messages rate-limited, 6 flushed)
Console logging: disabled
Monitor logging: disabled
Buffer logging: level debugging, 1 messages logged, xml disabled
Logging Exception size (8192 bytes)
Count and timestamp logging messages: disabled
Trap logging: level informational, 32 message lines logged
Log Buffer (8192 bytes):
 
1w0d: %SYS-5-CONFIG_I: Configured from console by console
Router#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#logging buffered xml
Router(config)#end
Router#show logging
Syslog logging: enabled (10 messages dropped, 5 messages rate-limited, 6 flushes, 0 overruns, xml enabled)
Console logging: disabled
Monitor logging: disabled
Buffer logging: level debugging, 2 messages logged, xml enabled (1 messages logged)
Logging Exception size (8192 bytes)
Count and timestamp logging messages: disabled
Trap logging: level informational, 33 message lines logged
Log Buffer (8192 bytes):
 
1w0d: %SYS-5-CONFIG_I: Configured from console by console
1w0d: %SYS-5-CONFIG_I: Configured from console by console
Router#show logging xml
<syslog-logging status="enabled" msg-dropped="10" msg-rate-limited="5" flushes="6" overruns="0"><xml>enabled</xml></syslog-logging>
<console-logging>disabled</console-logging>
<monitor-logging>disabled</monitor-logging>
<buffer-logging level="debugging" messages-logged="2"><xml messages-logged="1">enabled</xml></buffer-logging>
<logging-exception size="8192 bytes"></logging-exception>
<count-and-timestamp-logging status="disabled"></count-and-timestamp-logging>
<trap-logging level="informational" messages-lines-logged="33"></trap-logging>
<log-xml-buffer size="8192 bytes"></log-xml-buffer>
 
<ios-log-msg><facility>SYS</facility><severity>5</severity><msg-id>CONFIG_I</msg-id><time>1w0d</time><args><arg id="0">console</arg><arg id="1">console</arg></args></ios-log-msg>

Router#

その他の参考資料

Syslog メッセージへの XML インターフェイス機能の詳細情報については、次の参考資料を参照してください。

関連資料

関連トピック
参照先

システム メッセージ ロギング

Troubleshooting and Fault Management 」の章

デバッグレベル システム メッセージ

『Cisco IOS Debug Command Reference』

規格

XML は現在インターネット標準ではありません。XML 1.0 推奨事項(『Extensible Markup Language(XML)1.0(第 2 版)』)は http://www.w3.org/TR/ で定義されています。RFC 3076 も参照してください。

MIB

この機能に関連する MIB はありません。

RFC

RFC2
タイトル

RFC 3470

『Guidelines for the Use of Extensible Markup Language (XML) within IETF Protocols』(Status: BEST CURRENT PRACTICE)

2.サポートされている RFC がすべて記載されているわけではありません。

シスコのテクニカル サポート

説明
リンク

Technical Assistance Center(TAC)

TAC のホームページには、3 万ページに及ぶ検索可能な技術情報があります。製品、テクノロジー、ソリューション、技術的なヒント、およびツールへのリンクもあります。Cisco.com に登録済みのユーザは、このページから詳細情報にアクセスできます。

http://www.cisco.com/public/support/tac/home.shtml

システム エラー メッセージ デコーダ ツール

Cisco IOS エラー メッセージの調査と解決のためには、Cisco IOS エラー メッセージ デコーダ ツールをお試しください。このツールは、登録された Cisco.com ユーザのために Cisco Technical Assistance Center(TAC)から入手できます。

http://www.cisco.com/cgi-bin/Support/Errordecoder/home.pl

コマンド リファレンス

この機能に関連して、次のコマンドが新しく追加または変更されています。これらのコマンドおよびこの機能に使用されているその他のコマンドのコマンド ページを参照するには、 http://www.cisco.com/en/US/docs/ios/mcl/124mainlinemcl/124_book.html にある『 Cisco IOS Master Commands List , Release 12.4』にアクセスしてください。

clear logging xml

logging buffered xml

logging console xml

logging host

logging monitor xml

show logging xml


logging host コマンドは、Release 12.2(15)T の logging コマンドに代わります。


用語集


) この用語集に記載されていない用語については、『Internetworking Terms and Acronyms』を参照してください。


SEM :システム エラー メッセージの略。「システム エラー メッセージ」という用語は、システムロギング(syslog)プロセスによって生成されるメッセージに対して使用されることがあります。syslog メッセージは標準化された形式を使用し、「緊急」(レベル 0)から「デバッグ」(レベル 7)まで 8 つの重大度があります。これらのメッセージには、「エラー」とはいえない(情報の通知など)ルータ動作の通知が含まれる場合もあるため、「システム エラー メッセージ」という用語は、実際に誤解を招くおそれがあります。

syslog :Cisco IOS ソフトウェアでのシステム メッセージ ロギング プロセスの略。「syslog メッセージ」などとして、生成されたメッセージを特定するためにも使用されます。専門的には、「syslog」という用語はリモート ホストへのメッセージのロギング プロセスのみを示しますが、一般的に Cisco IOS システム ロギング プロセスすべてを示すために使用されます。

コンソール :この機能のコンテキストでは、ルータのコンソール ポートへの接続(CTY または接続ライン)を示します。一般的にこれはコンソール ポートに直接接続された端末または端末エミュレーション プログラムを備えた PC です。 show terminal コマンドに対応します。

トラップ :エラー メッセージを送信するためのシステム ソフトウェアのトリガー。この機能のコンテキストでは、「トラップ ロギング」とは、リモート ホストへのメッセージのロギングを意味します。リモート ホストはトラップ メッセージを送信するデバイスから見ると実際には syslog ホストですが、受信デバイスは一般的に収集した syslog データを別のデバイスに提供するため、受信デバイスも「syslog サーバ」と呼ばれます。

モニタ :この機能のコンテキストでは、ライン ポートでの TTY(TeleTYpe)ライン接続を示します。つまり、「モニタ」キーワードは TTY ライン接続または Telnet(端末エミュレーション)接続に対応します。TTY ライン(ポートとも呼ばれます)は、端末、モデム、シリアル プリンタなどの周辺装置と通信します。TTY 接続の例は、ダイヤルアップ モデムを使用してデバイスに接続する端末エミュレーション プログラムを備えた PC です。

Copyright © 2009-2010. シスコシステムズ合同会社.