jimmail(Windows限定)
機能
指定したメールアドレスにメールを送信するコマンドです。
jimmailコマンドでメールを送信するには,メール環境定義ファイルの設定が必要です。
このコマンドは,JP1/IM - Managerサービスの起動状態に関係なく単体で実行できます。次に示すJP1/IM - Managerの機能でメール送信できます。
機能 |
説明 |
---|---|
自動アクション |
自動アクションでメール送信できる。 |
アクションの状態監視,遅延監視 |
アクションの異常を検知したときに通知コマンドでメール送信できる。 |
ヘルスチェック |
JP1/IM - Managerのプロセス異常を検知したとき,通知コマンドでメール送信できる。 |
コマンド実行(コマンドボタン) |
コマンドボタンでメール送信できる。 |
コマンドラインの最大長を超過した場合は,jimmailコマンドのコマンドライン長が制限内に収まるように,メールの内容を再定義してください。
形式
jimmail [-to 送信先メールアドレス[,送信先メールアドレス…]] [-s メールの主題] [-b メールの本文] [-rh 論理ホスト名]
実行権限
Administrators権限(WindowsのUAC機能が有効な場合は管理者コンソールから実行)
格納先ディレクトリ
Consoleパス\bin\
引数
- -to 送信先メールアドレス[,送信先メールアドレス…]
-
送信先メールアドレスを指定するオプションです。
指定できるメールアドレスは20件です。ただし,コマンドラインの最大長を超えて指定することはできません。複数のメールアドレスを指定する場合は,「,(コンマ)」でアドレスを区切って指定してください。メールアドレスと「,(コンマ)」の間の半角スペース,タブは無視されます。連続した「,(コンマ)」は一つの「,(コンマ)」と見なし,先頭と末尾の「,(コンマ)」は無視されます。同じメールアドレスを複数指定した場合,指定したアドレスにはメールを1件送信します。
指定したメールアドレスが最大件数を超過した場合,KAVB8725-Eを出力して異常終了します。
送信先メールアドレスに指定できる文字数は,1〜256バイトです。半角英数字,「@(アットマーク)」,「-(ハイフン)」,「_(アンダーバー)」,「.(ピリオド)」の文字で指定します。
このオプションは省略できます。省略した場合,メール環境定義ファイルのDefaultToパラメーター(デフォルトの送信先メールアドレス)に指定したメールアドレスを送信先として処理を継続します。送信処理する際,DefaultToパラメーターのメールアドレスに送信したメッセージは出力しません。
-toオプションを省略し,DefaultToパラメーターにメールアドレスの指定がない場合,jimmailコマンドはエラーメッセージを出力して異常終了します。
-toオプションとDefaultToパラメーターがどちらも設定されている場合,-toオプションが優先されます。
jimmailコマンドは,指定されたメールアドレスが有効なアドレスかをチェックしません。
- -s メールの主題
-
メールの主題を指定するオプションです。
指定できる文字数は,1〜512バイトです。文字数は,メール環境定義ファイルのCharsetパラメーターで指定したメールの文字コードに従ったバイト数でチェックします。イベントやアクションの情報を引き継ぐ場合は,「$変数名」を置換したあとの長さで最大長をチェックします。最大長を超えている場合,メールの主題を切り捨ててメール送信を継続するかを,メール環境定義ファイルのMailSubjectCuttingパラメーターで選択できます。
-
MailSubjectCuttingパラメーターの値が「OFF」の場合は,KAVB8708-Eメッセージを出力してコマンドは異常終了します。
-
MailSubjectCuttingパラメーターの値が「ON」の場合は,メールの主題をCharsetパラメーターで指定したメールの文字コードに従い512バイト以内になるように切り捨てて,メール送信を継続します。512バイトを超える場合は,512バイト以内になるように主題の文字列を切り捨てます。メールの主題を切り捨てて送信した場合,KAVB8729-I(メール送信成功メッセージ)の前に,KAVB8724-Wメッセージを表示します。
このオプションは省略できます。省略した場合,メールの主題は空文字("")になります。
メールの主題に空白文字を含む場合,メールの主題を「"」で囲んで指定します。
「\n」を指定しても,メールの主題は改行されません。「\n」を指定した場合,「\n」がそのまま表示されます。改行コード,制御文字の場合,半角スペースに変換されます。
-
- -b メールの本文
-
メールの本文を指定するオプションです。
メールの本文に指定できる文字数は,1〜4,096バイトです。文字数は,メール環境定義ファイルのCharsetパラメーターで指定したメールの文字コードに従ったバイト数でチェックします。イベントやアクションの情報を引き継ぐ場合は,「$変数名」を置換したあとの長さで最大長をチェックします。
1行に指定できる文字数は,改行文字を含め1〜512バイトです。512バイトを超えている場合,改行文字を含めて512バイト以内になるように改行コードを挿入します。その際,警告メッセージは出力しません。
このオプションは省略できます。省略した場合,メールの本文は空文字("")となります。
最終行の末尾に改行がない場合,改行コードが挿入されます。
メールの本文に空白文字を含む場合,メール本文を「"」で囲んで指定します。
メールの本文中に「\n」を指定した場合,メール環境定義ファイルのMailNewLineパラメーターに指定した改行コードで改行されます。「CRLF」,「CR」,「LF」を除く制御文字が指定されている場合は,半角スペースに変換されます。
「\n」を文字列として入力する場合は,「\\n」と指定します。
- -rh 論理ホスト名
-
-rhオプションは,クラスタでJP1/IM - Managerを運用している場合に,jimmailコマンドが物理ホスト上,または論理ホストの共有フォルダ上のどちらに格納されたメール環境定義ファイルを使用するか指定するオプションです。
このオプションを指定した場合,指定した論理ホスト名の共有フォルダ上のメール環境定義ファイルを読み込み,メールを送信します。
このオプションを省略した場合は,物理ホスト上のメール環境定義ファイルを読み込み,メールを送信します。
ただし,このオプションを省略した場合は,環境変数JP1_HOSTNAMEに指定した論理ホスト名が仮定されます。環境変数JP1_HOSTNAMEを指定していない場合,物理ホスト名が仮定されます。クラスタでJP1/IM - Managerを運用していない場合は指定する必要はありません。
注意事項
-
コマンドラインに指定したメールの主題,および本文は,メール環境定義ファイルに指定した文字コードの範囲で指定してください。メール環境定義ファイルの詳細については,「メール環境定義ファイル(jimmail.conf)」(2. 定義ファイル)を参照してください。
-
自動アクションやコマンド実行(コマンドボタン)でjimmailコマンドを実行する場合,イベント情報を引き継ぐ際にイベント情報に次に示す制御文字が含まれていると,その制御文字は半角スペース(0x20)に変換されて処理されます。
半角スペースに変換される制御文字:0x01〜0x1F(タブ(0x09)を除く),0x7F
例えば,$EVMSGの指定によって取得したメッセージの中に改行コード(0x0A)が含まれていた場合,改行コード(0x0A)は半角スペース(0x20)に変換されて処理されます。
戻り値
戻り値 |
説明 |
---|---|
0 |
正常終了 |
1 |
引数エラー |
2 |
送信先メールアドレスが指定されていない |
3 |
メール環境定義ファイルの読み込みエラー |
4 |
メール環境定義ファイルのフォーマットエラー (設定値不正,必須項目未指定,パラメーター不正) |
5 |
SMTPサーバへの接続でタイムアウトが発生した |
6 |
SMTPサーバがログインを拒否した |
7 |
SMTPサーバへの接続に失敗した |
8 |
POP3サーバへの接続でタイムアウトが発生した |
9 |
POP3サーバがログインを拒否した |
10 |
POP3サーバへの接続に失敗した |
11 |
メール送信処理に失敗した |
12 |
メモリー不足が発生した |
13 |
実行権限エラー |
255 |
その他のエラー |
使用例
自動アクションで,監視対象ホスト(gyoumu001)の障害をマネージャーホスト(jp1imhost001)からシステム管理者(user@hitachi.com)にメール通知する例と,送信されるメール内容の例を次に示します。
jimmail.exe -to user@hitachi.com -s "[重大度:$EVSEV] 障害発生通知" -b "業務サーバで障害が発生しました。\n---\nイベントDB内通し番号=$EVSEQNO\nイベント発生日時=$EVDATE $EVTIME\nイベントID=$EVIDBASE\n重大度=$EVSEV\nプロダクト名=$EV"PRODUCT_NAME"\nメッセージ=$EVMSG\n---\nFrom:IM-Mホスト($ACTHOST)"
[通知メール例]
送信元(From) |
admin@hitachi.com |
送信先(To) |
user@hitachi.com |
メールの主題 |
[重大度:Error]障害発生通知 |
メールの本文 |
業務サーバで障害が発生しました。 --- イベントDB内通し番号=1234567 イベント発生日時=2014/01/01 10:00:00 イベントID=000A 重大度=Error プロダクト名=/HITACHI/XXXXX/JP1 メッセージ=業務サーバでシステムエラーが発生しました --- From:IM-Mホスト(jp1imhost001) |