Systemwalker Centric Manager APIガイド - UNIX共通 -
|
目次
索引

|
第3章 APIリファレンス
3.28 Mp_ReadMsgLog()関数
◆機能説明
Mp_OpenMsgLog()関数発行後、Mp_ReadMsgLog()関数を発行することによりロギングされたメッセージを、1メッセージずつ読み出します。
◆呼び出し形式
#include <mp_opagt_api.h>
int Mp_ReadMsgLog( fp, hostxflg, level, time1, node, NodeID,
DatabaseID, time2, category, msgtext, blkno,
msgtype, ostype, submsgnum, voicenum, msgcolor,
backcolor, domtype, domnum, replyid, systype,ext );
int fp; /* Mp_OpenMsgLog()で獲得したファイ */
/* ル記述子を指定する */
unsigned char *hostxflg; /* 強制表示フラグの格納領域のアドレ */
/* スを指定する */
short *level; /* メッセージの重要度格納領域のアド */
/* レスを指定する */
time_t *time1; /* メッセージが自システムに通知され */
/* た日時格納領域のアドレスを指定 */
/* する */
char *node; /* メッセージが出力されたシステム名 */
/* 格納領域のアドレスを指定する */
unsigned long *NodeID; /* リザーブ領域 */
unsigned long *DatabaseID; /* リザーブ領域 */
time_t *time2; /* メッセージが出力された日時格納領 */
/* 域のアドレスを指定する */
char *category; /* メッセージの種別格納領域のアドレ */
/* スを指定する */
char *msgtext; /* メッセージ格納領域のアドレスを指 */
/* 定する */
unsigned short *blkno; /* メッセージのブロック番号格納領域 */
/* のアドレスを指定する */
unsigned short *msgtype; /* メッセージ種別格納領域のアドレス */
/* を指定する */
unsigned short *ostype; /* OS種別格納領域のアドレスを指定す */
/* る */
unsigned short *submsgnum; /* 補助説明文番号格納領域のアドレス */
/* を指定する */
unsigned short *voicenum; /* 音声番号格納領域のアドレスを指定 */
/* する */
unsigned char *msgcolor; /* 文字色格納領域のアドレスを指定す */
/* る */
unsigned char *backcolor; /* 背景色格納領域のアドレスを指定す */
/* る */
unsigned short *domtype; /* DOM種別格納領域のアドレスを指定 */
/* する */
long *domnum; /* DOM番号格納領域のアドレスを指定 */
/* る */
char *replyid; /* 返答識別子格納領域のアドレスを指 */
/* 定する */
unsigned char *systype; /* 系区別格納領域のアドレスを指定す */
/* る */
EXTENDDATA *ext; /* 拡張データ格納領域のアドレスを指 */
/* 定する */
◆パラメタ
- fp:
- Mp_OpenMsgLog()で獲得したファイル識別子を指定します。
- hostxflg:
- リザーブ領域。
charの領域を確保し、そのアドレスを指定してください。
- level:
- 発生したメッセージの重要度レベルが格納されます。
- MPOP_RE_SPEMG :
- 最重要
- MPOP_RE_EMG :
- 重要
- MPOP_RE_WARN :
- 警告
- MPOP_RE_MSG :
- 一般
- time1:
- システム監視エージェントサービスが、メッセージログファイルに格納した日時が格納されます。
ただし、日時が正しく獲得できなかった時は、0x00FFFFFFが設定されます。
- node:
- メッセージが発生したシステムのノード名が格納されます。
MPOP_NODENAMELENバイト分呼び出し元で準備します。
- time2:
- nodeで示されたシステムでメッセージが出力された日時が格納されます。
ただし、日時が正しく獲得できなかった場合、以下のように値が設定されます。
- 日付、時刻とも獲得できない場合:
- 0x00FFFFFF
- 日付だけ獲得できない場合:
- 0x00hhmmss
- hh:
- 時(0x00 〜0x17)
- mm:
- 分(0x00 〜0x3B)
- ss:
- 秒(0x00 〜0x3B)
- category:
- 発生したメッセージの監視イベント種別が格納されます。
MPOP_CATEGORYLENバイト分呼び出し元で準備します。
- msgtext:
- 発生したメッセージテキストが格納されます。
2048バイト分呼び出し元で準備します。
メッセージ長が2047バイトを超える場合は、2047バイト以降は破棄されます。
- blkno:
- マルチラインメッセージのように、複数のメッセージで意味をもつ場合に、複数メッセージをブロック化するための番号が格納されます。
単一メッセージの場合は、OP_ONLYBLK(0x0000)が格納され、マルチラインメッセージの場合は、0x0001〜0xFFFFが格納されます。
ブロックの最後のメッセージには、必ずOP_MLTBLK_END(0xFFFF)が格納されます。
- msgtype:
- 発生したメッセージのメッセージ種別が格納されます。
メッセージ種別を以下に示します。
- OP_APIMSGTYPENORM:
- 通常メッセージ
- OP_APIMSGTYPEREP:
- 返答要求メッセージ
- OP_APIMSGTYPEHB:
- 高輝度メッセージ
- OP_APIMSGTYPEDEL:
- メッセージ削除データ(以下、DOMデータという)
- OP_APIMSGTYPESTAT:
- システム監視エージェントサービス起動メッセージ
- OP_APIMSGTYPESTOP:
- システム監視エージェントサービス停止メッセージ
- OP_APIMSGTYPECHNG:
- システム状態変更メッセージ
- ostype:
- 発生したメッセージのOS種別が格納されます。
OS種別を以下に示します。
- OP_UXPDS:
- UXP/DS
- OP_SOLARIS1:
- Solaris1.xOE系
- OP_SOLARIS2:
- Solaris2.xOE系
- OP_HPUX10:
- HP−UX
- OP_AIX:
- AIX
- OP_MVS:
- MVS
- OP_LINUX:
- Linux
- OP_UXPM:
- UXP/M
- OP_UXPVPP:
- UXP/VPP
- OP_WINDOWS2000:
- Windows(R) 2000
- OP_WINDOWSNT:
- Windows NT(R)
- OP_WINNTSERVER:
- Windows NT(R) Server
- OP_WINNTWS:
- Windows NT(R) Workstation
- OP_WINDOWS31 :
- Windows(R) 3.1, Windows(R) 3.11, Windows(R) 3.11 WorkGroup
- OP_WINDOWS95:
- Windows(R) 95
- OP_WINDOWS98:
- Windows(R) 98
- OP_WINDOWSXP:
- Windows(R) XP
- OP_WINDOWSXPPRO:
- Windows(R) XP Professional
- OP_ WINDOWSXPHOME:
- Windows(R) XP Home Edition
- OP_SXO:
- SXO
- OP_SYMFOWAREPS:
- Symfoware Parallel Server
- OP_RAID:
- RAID
- OP_MSPE20:
- MSP E20
- OP_MSPAF2:
- MSP AFII
- OP_XSPAF2:
- XSP AFII
- OP_AVMEX:
- AVM/EX
- OP_FTOPS2:
- FTOPS−II
- OP_MVSG:
- MVS 系(IBM、および他社互換機)
- OP_MSERV:
- ホスト連携オプション
- OP_ASP:
- ASP
- OP_WINDOWSSV2003 :
- Windows Server(TM) 2003
- OP_WINDOWSSV2003STD :
- Windows Server(TM) 2003,Standard Edition
- OP_WINDOWSSV2003ENT :
- Windows Server(TM) 2003,Enterprise Edition
- OP_WINDOWSSV2003DATA :
- Windows Server(TM) 2003,Datacenter Edition
- OP_WINDOWSSV2003WEB :
- Windows Server(TM) 2003,Web Edition
- OP_OS_UNKNOWN:
- 不明
- submsgnum:
- UNIX版集中監視マネージャのGS連携オプションが使用する、メッセージの補助説明文の番号が格納されます。
この値は、GS連携オプション以外では使用しません(Windowsでは無効)。
- voicenum:
- UNIX版集中監視マネージャで音声を出力する場合の、音声に対する番号が格納されます。
音声出力機能は未サポートです(Windowsでは無効)。
- msgcolor:
- Systemwalkerコンソールの監視イベント一覧に表示する、メッセージの文字の色が格納されます。
文字色の種類を以下に示します。
- OP_COLOR_BLACK:
- 黒色
- OP_COLOR_WHITE:
- 白色
- OP_COLOR_RED:
- 赤色
- OP_COLOR_GREEN:
- 緑色
- OP_COLOR_BLUE:
- 青色
- OP_COLOR_YELLOW:
- 黄色
- OP_COLOR_LIGHTBLUE:
- 明青色
- OP_COLOR_PURPLE:
- 紫色
- OP_COLOR_DARKGRAY:
- 濃い灰色
- OP_COLOR_ORANGE:
- 黄緑色
- OP_COLOR_SKYBLUE:
- 空色
- OP_COLOR_PINK:
- 桃色
- OP_COLOR_PALEGREEN:
- 青緑色
- OP_COLOR_BROWN:
- 茶色
- OP_COLOR_GRAY:
- 淡い灰色
- OP_COLOR_CREAM:
- 黄土色
- OP_COLOR_DEF:
- メッセージ属性に応じたデフォルト色
- backcolor:
- Systemwalkerコンソールの監視イベント一覧に表示する、メッセージの背景色が格納されます。
文字色の種類はmsgcolorと同じです。
- domtype:
- 返答要求メッセージ、および高輝度メッセージの種類が格納されます。
DOM種別を以下に示します。
- OP_NORMDOM:
- 返答要求メッセージ、および高輝度メッセージ以外です。
- OP_NIPDOM:
- NIPDOMです。MSPのNIP時のメッセージ、およびDOMデータです(Windowsでは無効)。
- OP_MSPDOM:
- MSPDOMです。MSPの通常時のメッセージ、およびDOMデータです(Windowsでは無効)。
- OP_XSPDOM:
- XSPのNIP時以外の返答要求メッセージ、高輝度メッセージ、およびDOMデータです。
- OP_WORKITDOM:
- WORKITDOMです。BS*NET/WORKITが通知する返答要求メッセージ、およびDOMデータです。
- OP_ASPDOM:
- ASPが通知する返答要求メッセージ、高輝度メッセージ、およびDOM データです。
- OP_APLDOM:
- Systemwalker Centric Managerアプリケーションが通知するDOM対応メッセージ、およびDOMデータです。
- domnum:
- 返答要求メッセージ、および高輝度メッセージの場合に、メッセージとDOMデータとの対応をとるための番号が格納されます。
この番号は、メッセージ発生システム内でDOM種別ごとに一意です。
- replyid:
- 返答要求メッセージに対してコマンドで返答するときの、メッセージを識別するための文字列が格納されます。
9バイト分呼び出し元で準備します。
- systype:
- ホットスタンバイシステムの場合に、メッセージが発生した時点での運用系、待機系の区別が格納されます。
系区別を以下に示します。
- OP_SYSTYPE_NORM :
- ホットスタンバイシステムではない。または、ホットスタンバイシステムですが、運用系、待機系がまだ決定していません。
- OP_SYSTYPE_MAIN :
- ホットスタンバイシステムの運用系です。
- OP_SYSTYPE_SUB :
- ホットスタンバイシステムの待機系です。
- OP_SYSTYPE_WP :
- Windows NT(R)のマイクロソフトクラスタシステムの運用です。
- ext:
- 発生したメッセージの拡張データが格納されます。
◆構造体の形式
拡張データ(EXTENDDATA)の形式
/*
* EXTEND DATA
*/
typedef struct _EXTENDDATA {
unsigned short protype;
unsigned char conntype;
char rsv1[1];
char jobnum[MPOP_JOBNUMLEN];
char rsv2[3];
char runtype[MPOP_RUNTYPELEN];
char rsv3[3];
unsigned char mailmsgflg;
char rsv4[3];
char domkey[MPOP_DOMKEYLEN];
chark rsv5[3];
unsigned int IPaddr;
unsigned int DMInstallType;
unsigned int JMInstallType;
unsigned int MW_DM_vl;
char MW_DM_suffix[MPOP_SUFFIXLEN];
char MW_DM_updatenum[MPOP_UPDATENUMLEN];
char rsv6[2];
DWORD MW_JM_vl;
char MW_JM_suffix[MPOP_SUFFIXLEN];
char MW_JM_updatenum[MPOP_UPDATENUMLEN];
unsigned char auttrbtkt;
char rsv7[1];
} EXTENDDATA;
- protype:
- リザーブ
- conntype:
- リザーブ
- jobnum:
- リザーブ
- runtype:
- メッセージが発生したシステムの運用形態名が格納されます。
- mailmsgflg:
- 発生したメッセージのメール連携フラグが格納されます。
- domkey:
- DOM拡張キーが格納されます。
DOM拡張キーがない場合は、NULLが格納されます。
- IPaddr:
- メッセージが発生したシステムのIPアドレスが格納されます。アドレスがない場合は、0が格納されます。
- DMInstallType:
- メッセージが発生したシステムのSystemwalker Centric Managerのインストールタイプが格納されます。
- JMInstallType:
- メッセージが発生したシステムのSystemwalker Operation Managerのインストールタイプが格納されます。
- MW_DM_vl:
- メッセージが発生したシステムのSystemwalker Centric Managerのメジャーバージョン、マイナーバージョン、メジャーレベルが格納されます。
0x00000000 a) メジャーバージョン
←→←→←→ b) マイナーバージョン
a) b) c) c) メジャーレベル
- MW_DM_suffix:
- メッセージが発生したシステムのSystemwalker Centric Managerのサフィックスが格納されます。
- MW_DM_updatenum:
- メッセージが発生したシステムのSystemwalker Centric Managerのアップデートパック修正番号が格納されます。
- MW_JM_vl:
- メッセージが発生したシステムのSystemwalker Operation Managerのメジャーバージョン、マイナーバージョン、メジャーレベルが格納されます。形式は、MW_DM_vlと同様です。
- MW_JM_suffix:
- メッセージが発生したシステムのSystemwalker Operation Managerのサフィックスが格納されます。
- MW_JM_updatenum:
- メッセージが発生したシステムのSystemwalker Operation Managerのアップデートパック修正番号が格納されます。
- Auttrbtkt:
- 発生したメッセージの障害票自動発行フラグが格納されます。
◆参照
Mp_OpenMsgLog(),Mp_CloseMsgLog()
◆復帰値
- 1:
- 正常終了。メッセージを正常に獲得。
- 0:
- 正常終了。メッセージをすべて獲得。
- −1:
- 異常終了。
◆備考
異常終了した場合の詳細なエラーコードは、errnoに設定されます。
errnoには、システムのエラーコード(/usr/include/sys/errno.hに定義)、または/opt/systemwalker/include/mp_operr_api.hに定義されている値が設定されます。
◆API格納場所
/usr/lib
◆注意事項
拡張データの各メンバの値は、SystemWalker/CentricMGR V4.0L10以前のシステムで発生したメッセージには設定されません。
◆動作環境による差異
運用管理サーバ
部門管理サーバ
業務サーバ
運用管理クライアント : Windows(R) 2000/ Windows NT(R)/ Windows(R) XP(*1)
クライアント : Windows(R) 2000/ Windows NT(R)/ Windows(R) XP(*1)
(*1)システム監視エージェントインストール選択時
All Rights Reserved, Copyright(C) 富士通株式会社 1995-2003