Tuning Manager - Agents

7.1.2 アラート機能使用時のemail送信の設定

この項の構成

(1) プロパティファイルの設定

(2) テストメールの送信

アラート機能を使用してしきい値を超えた際にemailを送信して問題発生を通知する場合，エージェントホストごとに，プロパティファイル（alertglobalconfig.ini）でemailの送信情報を設定する必要があります。

プロパティファイルの格納先を次に示します。

Windowsの場合：

インストール先フォルダ\htnm\agent\config

Linuxの場合：

インストール先ディレクトリ/htnm/agent/config

Tuning Manager Agent REST APIコンポーネントのサービスを停止します。
エージェントをインストールしているホストで次のコマンドを実行してください。

Windowsの場合：
インストール先フォルダ\htnm\bin\htmsrv stop -webservice

Linuxの場合：
インストール先ディレクトリ/htnm/bin/htmsrv stop -webservice

プロパティファイル（alertglobalconfig.ini）を編集^※１します。
alertglobalconfig.iniファイルをUTFで保存する場合は，BOM（byte order mark）が付与されないように保存してください。
各プロパティに設定する値については，次の表を参照してください。
表7-1 プロパティファイル（alertglobalconfig.ini）のプロパティ一覧

プロパティ説明入力できる値デフォルト値省略時の動作

Notice メール送信機能の有効無効 YesまたはNo No デフォルト値が設定されます。

From Address 送信元メールアドレス 0 - 256 byte^※2 TuningManagerAgent デフォルト値が設定されます。

SMTP Host SMTPサーバのホスト名，またはIPアドレス 0 - 256 byte^※2 －メールで通知されません。

SMTP Port SMTPサーバのポート番号 0 - 65535 25 デフォルト値が設定されます。

SMTP Auth SMTP認証の有無 YesまたはNo No デフォルト値が設定されます。

SMTP Error To メール送信失敗時の通知先メールアドレス 0 - 256 byte^※2 －メールの送信失敗時に，失敗が通知されません。

SMTP Auth User Id SMTP認証時のユーザID ユーザID －

SMTP認証する場合

メールで通知されません。

SMTP認証しない場合

メールで通知されます。

SMTP Auth Password SMTP認証時のパスワード（平文，またはエンコードしたパスワード^※3）パスワード－

SMTP認証する場合

メールで通知されません。

SMTP認証しない場合

メールで通知されます。

SMTP Auth Password Encoding SMTP Auth Passwordに指定したパスワードがエンコードされたものか否か YesまたはNo No デフォルト値が設定されます。

（凡例）

－：デフォルト値なし

注※1

プロパティファイル（alertglobalconfig.ini）を編集する場合の注意事項を次に示します。

・各プロパティは[[Email Notice]]サブセクションに記載してください。

・「プロパティ=値」のフォーマットで記載してください。

・「#」（シャープ）で始める行はコメントとして扱います。

プロパティファイルは，次の書式で定義してください。

[Alert Setting]
[[Email Notice]]
Notice=メール送信機能の有効無効
From Address=送信元メールアドレス
SMTP Host=SMTPサーバのホスト名またはIP アドレス
SMTP Port=SMTPサーバのポート番号
SMTP Auth=SMTP認証の有無
SMTP Error To=メール送信失敗時の通知先メールアドレス
SMTP Auth User Id=SMTP認証時のユーザID
SMTP Auth Password=SMTP認証時のパスワード
SMTP Auth Password Encoding=指定したパスワードがエンコードされたものか否か

注※2

ASCIIコードで指定してください。大文字と小文字は区別されます。

注※3

パスワードをエンコードすると，システム上の他のユーザからパスワードを隠すことができます。エンコードしたパスワードはhtmpwencoderコマンドを使用して取得してください。htmpwencoderコマンドの詳細については，「18.2.8 htmpwencoder」を参照してください。

Tuning Manager Agent REST APIコンポーネントのサービスを起動します。
エージェントをインストールしているホストで次のコマンドを実行してください。

Windowsの場合：
インストール先フォルダ\htnm\bin\htmsrv start -webservice

Linuxの場合：
インストール先ディレクトリ/htnm/bin/htmsrv start -webservice

プロパティ	説明	入力できる値	デフォルト値	省略時の動作
Notice	メール送信機能の有効無効	YesまたはNo	No	デフォルト値が設定されます。
From Address	送信元メールアドレス	0 - 256 byte^※2	TuningManagerAgent	デフォルト値が設定されます。
SMTP Host	SMTPサーバのホスト名，またはIPアドレス	0 - 256 byte^※2	－	メールで通知されません。
SMTP Port	SMTPサーバのポート番号	0 - 65535	25	デフォルト値が設定されます。
SMTP Auth	SMTP認証の有無	YesまたはNo	No	デフォルト値が設定されます。
SMTP Error To	メール送信失敗時の通知先メールアドレス	0 - 256 byte^※2	－	メールの送信失敗時に，失敗が通知されません。
SMTP Auth User Id	SMTP認証時のユーザID	ユーザID	－	SMTP認証する場合メールで通知されません。 SMTP認証しない場合メールで通知されます。
SMTP Auth Password	SMTP認証時のパスワード（平文，またはエンコードしたパスワード^※3）	パスワード	－	SMTP認証する場合メールで通知されません。 SMTP認証しない場合メールで通知されます。
SMTP Auth Password Encoding	`SMTP Auth Password`に指定したパスワードがエンコードされたものか否か	YesまたはNo	No	デフォルト値が設定されます。

(2) テストメールの送信

プロパティファイルの設定が完了したら，テストメール用のアラート定義情報を設定してemail送信が正しく動作するか確認します。emailの送信情報を設定または変更した場合，メール通知エラーを防止するために必ず動作確認することを推奨します。

注意

ここで説明する手順で検証できる範囲は，Agentホスト上のemail送信のSMTPサーバ設定までです。実際の業務で利用するアラート定義情報の正当性を検証することはできません。

前提条件

HTM - Agent for RAIDをインストールしているホストでアラート発行時のemailの送信情報の設定が完了していること。

Device Manager，Tuning Manager serverおよびHTM - Agent for RAIDのサービスが起動していること。

テストメールの送信手順を，次に示します。

なお，ここでは，Windows環境でhtmrestコマンドを使用した例をあげて説明します。

補足

htmrestコマンド実行に必要な設定や前提条件，およびコマンドの詳細については，マニュアル「Hitachi Command Suite Tuning Manager APIリファレンスガイド」を参照してください。

Device Manager，Tuning Manager serverおよびHTM - Agent for RAIDの設定をデフォルトから変更している場合やWindows環境以外の場合は，環境に合わせて読み替えてください。

手順の中でリクエスト時に使用するファイルの保存先は，任意です。例と異なる保存先の場合は，そのファイルのパスに読み替えてください。

出力例は，見やすくするために改行を入れています。
Device Managerをインストールしているホスト上で，コマンドプロンプトを開きます。
手順2以降は，このコマンドプロンプト上で実行します。
次のコマンドを実行して，使用するJREを設定します。
この手順は，htmrestコマンドの実行に必要な設定が完了している場合は，不要です。
set HTMREST_CLI_JRE_PATH=C:\Program Files\HiCommand\Base64\uCPSB\jdk\jre\bin
次のコマンドを実行して，カレントディレクトリをTuning Manager APIを実行するコマンドの格納ディレクトリに変更します。
cd /d C:\Program Files\HiCommand\DeviceManager\HiCommandServer\tools\htmrest
次のコマンドを実行して，HTM - Agents情報を更新します。
htmrest PUT http://localhost:22015/DeviceManagerWebService/analytics/v1/services/agent-manager/actions/refresh/invoke -u system -p manager -b C:\tmp\testTargetAgent.txt
リクエスト時に読み込ませたファイルの内容：（testTargetAgent.txt）
{
     "agentType" : "all"
}
HTM - Agents情報の更新が成功した場合の出力例
200
{
  "state":"Succeeded"
}
次のコマンドを実行して，HTM - Agents情報を取得します。
アラート定義情報を配布する対象のエージェントが表示されることを確認してください。
htmrest PUT http://localhost:22015/DeviceManagerWebService/analytics/v1/services/agent-manager/actions/list/invoke -u system -p manager -b C:\tmp\getAgentListAll.txt
リクエスト時に読み込ませたファイルの内容：（getAgentListAll.txt）
{
     "agentType" : "all"
}
HTM - Agents情報の取得に成功した場合の出力例
200
{
  "data":
  [
    {
      "agentType":"RAID",
      "hostName":"myhost1",
      "instanceName":"inst001",
      "model":"VSP G1000",
      "serialNumber":"12345",
      "lastMonitoredTime":"2016-06-23T12:48:29Z",
      "formatVersion":"1.0"
    }
  ]  
}
次のコマンドを実行して，テストメール用のアラート定義情報（AlertDefForTestMail）を追加します。
htmrest POST http://localhost:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs -u system -p manager -b C:\tmp\testAlartDef.txt
リクエスト時に読み込ませたファイルの内容：（testAlartDef.txt）

「テストメール用のアラート定義情報（AlertDefForTestMail）」を参考にしてアラート定義情報を設定してください。

アラート定義情報の追加が成功した場合の出力例
201
{
  "state":"Succeeded",
  "affectedResources":
    [
    "http://localhost:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs/AlertDefForTestMail"
    ],
  "result":
    [
      {
        "distributionResult":"Succeeded",
        "agent":
          {
            "agentType":"RAID",
            "hostName":"myhost1",
            "instanceName":"inst001",
            "model":"VSP G1000",
            "serialNumber":"12345"
          }
      }
    ],
  "resultType":"AlertDefDistributionResult"
}
次のコマンドを実行して，追加したアラート定義情報が参照できることを確認します。
htmrest GET http://localhost:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs -u system -p manager
追加したアラート定義情報が参照できた場合の出力例
200
{
  "data":
    [
      {
        "alertDefName":"AlertDefForTestMail"
      }
   ]
}
次のコマンドを実行して，Device ManagerホストとHTM - Agentsホストのアラート定義情報を同期します。
Device Managerが管理しているアラート定義情報とemailの送信情報を設定したAgentホストのアラート定義情報が同期できたことを確認してください。
htmrest PUT http://localhost:22015/DeviceManagerWebService/analytics/v1/services/alert-def-manager/actions/sync/invoke -u system -p manager -b  C:\tmp\syncAgentAll.txt
リクエスト時に読み込ませたファイルの内容：（syncAgentAll.txt）
{
     "agentType" : "all"
}
アラート定義情報の同期が成功した場合の出力例
200
{
  "state":"Succeeded",
  "result":
    [
      {
        "syncResult":"Succeeded",
        "agent":
        {
          "agentType":"RAID",
          "hostName":"myhost1",
          "instanceName":"inst001",
          "model":"VSP G1000",
          "serialNumber":"12345"
        },
        "syncedAlertDef":[]
      }
    ],
  "resultType":"AlertDefSyncResult"
}
アラート定義情報に指定したメールアドレスにテストメールが届いているか確認します。
email送信は，手順6または手順8の操作でアラートを同期したのち，アラート定義情報で設定した監視対象のレコードの収集後1分程度かかります。テストメール用のアラート定義情報の設定例では，PIレコードをアラートの発行条件に指定しています。PIレコードの収集はデフォルトで1分間隔のため，テストメール用のアラート定義情報を追加または同期してからemail送信まで2分程度待つ必要があります。
テストメールの受信例
メールタイトル： Test mail for Tuning Manager Alert
メール本文の例：
recordTime=2016/06/24/13:08
evaluateTime=2016/06/24/13:08
alertDefName=AlertDefForTestMail
agentType=RAID
instance=inst100
agentHost=myhost1
triggerID=
noticeID=TestMailNoticeID


Alert issue: key=<N/A>, status=CAUTION
This is test mail for Tuning Manager Alert.
注意

テストメール用のアラート定義情報で指定したtargetDefに該当するAgentのインスタンスが複数ある場合，該当するAgentインスタンスそれぞれからアラート定義情報のテストメールが送信されます。emailの設定情報はホスト単位で設定するため，複数のAgentホストがある場合，期待したAgentホストからのテストメールが届いているか，メール本文中に出力されるagentHostで確認してください。

テストメールを発行時のemail送信が失敗した場合，email送信失敗のメッセージをhtmRestDbEngineMessage#.logに出力します。
htmRestDbEngineMessage#.logについては，「20.3.3 Tuning Manager API使用時のログ情報」を，出力されるメッセージについては「19.3 HTM - Agents共通のメッセージ」を参照してください。
テストメール用のアラート定義情報（AlertDefForTestMail）を削除します。
テストメールの送信が成功したことを確認した後，不要なテストメールが送信されないようにするため，次のコマンドでテストメール用のアラート定義情報（AlertDefForTestMail）を削除してください。
htmrest DELETE http://localhost:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs/AlertDefForTestMail -u system -p manager
テストメール用のアラート定義情報（AlertDefForTestMail）の削除に成功した場合の出力例
200
{
  "state":"Succeeded",
  "result":
  [
    {
      "deleteResult":"Succeeded",
      "agent":
      {
        "agentType":"RAID",
        "hostName":"myhost1",
        "instanceName":"inst001",
        "model":"VSP G1000",
        "serialNumber":“12345"
      }
    }
  ],
  "resultType":"AlertDefDeleteResult"
}
テストメール用のアラート定義情報（AlertDefForTestMail）

ここで説明するテストメール用のアラート定義情報（AlertDefForTestMail）は，VSP G1000を監視しているHTM - Agent for RAIDのインスタンスが稼働しているホストから，PIレコードを初回収集したときにだけアラート発行する条件を指定しています。

注意

監視対象のストレージシステムの機種名，送信先メールアドレスをご使用の環境に合わせて変更し，必ずアラートが発行される条件にしてください。

TCP/IP接続だけを使用してパフォーマンスデータを収集している場合は，PIレコードでなく別のレコードを指定してください。
{
    "alertDefName": "AlertDefForTestMail",
    "targets": [
        {
            "targetID": "TestMailTargetID",
            "targetDef": [
                {
                    "type": "model",
                    "key": {
                        "model": "VSP G1000"
                    }
                }
            ]
        }
    ],
    "notices": [
        {
            "noticeID": "TestMailNoticeID",
            "emails": [
                {
                    "addresses": [
                        "test@example.com"
                    ],
                    "subject": "Test mail for Tuning Manager Alert",
                    "body": "This is a test mail for Tuning Manager Alert."
                }
            ]
        }
    ],
    "triggers": [
        {
            "triggerID": "TestMailTriggerID",
            "condition": {
                "warning": "%PI.CACHE_MEMORY_USAGE% >= '0'",
                "caution": "%PI.CACHE_MEMORY_USAGE% >= '0'"
            }
        }
    ],
    "definitions": [
        {
            "targetIDs":["TestMailTargetID"],
            "noticeIDs":["TestMailNoticeID"],
            "triggerIDs":["TestMailTriggerID"]
        }
    ]
}

[目次] [前へ] [次へ]

[マニュアル発行元]