1.2.144 opfmt(メッセージ出力コマンド)

Systemwalker Centric Manager リファレンスマニュアル - UNIX共通 -

目次索引

第1章コマンドリファレンス 1.2 コマンド

1.2.144 opfmt(メッセージ出力コマンド)

■機能説明

本コマンドは、“ラベル: エラー種別: メッセージテキスト”の形式でメッセージを作成し、そのメッセージを標準エラー出力へ表示するとともに、システム監視エージェントへメッセージを通知します。

システム監視エージェント未起動時は、メッセージ一時保存ファイルに保存され、システム監視エージェント起動時に読み込まれます。

■記述形式

opfmt

[-c] [-f flags] [-l label] [-s errclass] [-g catalog:msgnum] format [args]

■オプション

-c:

このオプションは無視されます。

-f flags:

このオプションは無視されます。ただし、指定した場合は引数を指定しなければなりません。

-l label:

作成されるメッセージのラベル文字列を指定します。labelは25バイト以内の文字列を指定してください。接尾辞のコロン“:”は自動的に付加されます。

labelが指定されない場合のメッセージ形式は、“エラー種別：メッセージテキスト”です。

-s errclass:

作成されるメッセージのエラー種別文字列を指定します。errclassは以下の文字列のうち、どちらかが指定されなければなりません。接尾辞のコロン(:)は自動的に付加されます。指定されない場合は、エラーが使用されます。

エラー種別	指定する文字列
停止	HALT または halt
エラー	ERROR または error
警告	WARNING または warn
情報	INFO または info

-g catalog:msgnum:

作成されるメッセージのテキスト文字列をメッセージカタログで指定します。catalogにはメッセージカタログ名を、msgnumには取り出したいメッセージテキスト番号を指定し、コロンでつないだ一つの文字列とします。catalogは14バイト以内の文字列を指定してください。これらの文字列には、NULL“\0”、スラッシュ“/”およびコロン“:”は使用できません。

環境変数LC_MESSAGESまたはLANGに設定されたロケールに、catalogで指定したメッセージカタログが存在しない場合、または、msgnumが範囲外の場合、opfmtはCロケールからテキストを取り出そうとします。これに失敗すると、opfmthコマンド行から渡されたままのformat文字列をメッセージテキストとして使用します。メッセージカタログについての詳細は、システムが提供しているgettxt(3c)mkmsgs(1)のマニュアルページを参照してください。

format[args]:

formatには、システムが提供しているprintfコマンドと同じ形式のメッセージテキストを指定します。argsには、formatに必要な引数を指定します。formatの指定に対してargsの数が多い場合は、余分なargsは無視されます。formatの指定に対してargsの数が少ない場合は、その結果は不定です。

指定できる書式は文字列“％ｓ”だけです。また、“％”をメッセージテキストとして使用する場合は、2つ連続させて(“％％”)記述します。

システムが提供しているprintfコマンドについての詳細は、printf(1)のマニュアルページを参照してください。

■復帰値

0：: 正常終了
1：: 異常終了

■参照

表:イベント監視用コマンド

■コマンド格納場所

Solaris OE
HP-UX
AIX
Linux

/opt/systemwalker/bin

■実行に必要な権限/実行環境

一般ユーザの権限で実行できます。
運用管理サーバ/部門管理サーバ/業務サーバで実行可能です。
運用管理クライアント/クライアントでは、イベント監視を選択インストールしたとき実行可能です。

■注意事項

運用管理サーバでクラスタ待機系の監視を行なっている場合、待機系のシステムからopfmtコマンドを実行しても運用系システムでのメッセージ監視はできません。
なお、待機系時で実行したopfmtの結果は、コマンドを実行したシステムが運用系になったときにメッセージが通知されます。

使用できるメッセージカタログの形式は、mkmsgsコマンドでフォーマットされたメッセージカタログです。メッセージカタログの作成方法の詳細については、gettxt(3C)、mkmsgs(1)のマニュアルページを参照してください。
コマンドを実行する環境のLANGとシステムのコード系を同一のものにしてください。

■使用例1

opfmt -l LABEL -s INFO "test message"

■使用例2

opfmt "test message"

■実行結果/出力形式

実行した結果は以下の形式で監視イベント一覧に表示されます。

ラベル: エラー種別: メッセージテキスト

注意: ラベルとエラー種別、エラー種別とメッセージテキストの間は“: "(コロンと空白)で区切られます。

ラベル: -lオプションで指定した文字列

エラー種別: -sオプションで指定した文字列に対応するエラー種別

メッセージテキスト: formatで指定した文字列実行環境による差異はなし

[上記使用例1を実行した場合]

LABEL: INFO: test message

[上記使用例2を実行した場合]

ERROR: test message

目次索引