AddMonitor API――メール サーバー
このページでは、AddMonitor APIで、カテゴリ タイプ「メール サーバー」の監視を追加する方法を説明します。製品では次の監視をサポートします。
Exchange Server
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME] &host=[HOST]&username=[USER_NAME]&password=[PASS_WORD]&version=[VERSION]&ServerRole[2013/2010/2007]=[ServerRole]&UsePowershell=[USEPOWERSHELL]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するメール サーバーのタイプです。値は Exchange Serverにしてください。 |
| host | Exchange Serverを実行しているホストの名前を指します。 |
| username | Exchange Serverを実行しているシステムのユーザー名です。 |
| password | Exchange Serverを実行しているシステムのパスワードです。 |
| version | Exchange Serverのバージョンです。2003、2007、2010、2013、2016、2019をサポートします。 |
|
ServerRole2019 |
サポートする役割は、mbxserver2019とedgeserver2019です。 |
|
ServerRole2016 |
サポートする役割は、mbxserver2016とedgeserver2016です。 |
|
ServerRole2013 |
サポートする役割は、mbxserver2013、casserver2013、edgeserver2013です。 |
|
ServerRole2010 |
サポートする役割は、mbxserver2010、casserver2010、edgeserver2010、hubserver2010、umserver2010です。 |
|
ServerRole2007 |
サポートする役割は、 mbxserver2007、casserver2007、hubserver2007、edgeserver2007、umserver2007です。 |
| UsePowershell |
データ収集にPowerShellを使う場合は「Yes」、利用しない場合は「No」を指定します。この引数は必須項目です。 |
リクエスト サンプル
http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=2712f158d675135e9b3d81d9efd533c0&type=Exchange Server&displayname=apmexchange&host=emp-ex03&username=exchange\administrator&password=admin123&version=2013&ServerRole2013=mbxserver2013&UsePowershell=Yes
メール サーバー
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME] &host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&Version=[VERSION]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプです。値は メール サーバーにしてください。 |
| host | メール サーバーを実行しているホストの名前です。 |
| port | SMTPポート番号を指定します。 |
| emailid | メール サーバーに存在するメール アドレスです。 |
| timeout | タイムアウト値を指定します（秒）。 |
| mailMsg | メール件名の表示内容を指します。 |
| mailSubject | メールの件名に表示されます。 |
| smtpauth | trueでSSLが有効になります。 |
|
username password |
SMTPサーバーで認証が必要な場合、ユーザー名とパスワードを指定します。 |
| sslEnabled | trueでSSLが有効になります。 |
| tlsEnabled | trueの設定でTLS有効となり、データ送信がセキュアになります。 |
| popenabled |
POPでメール取得をする場合は、 trueをセットしてください。 |
| fetchEnabled | trueの指定で、POPやIMAPでメール取得が有効になります。 |
| popPort | POPやIMAPのサービスが別ホストにある場合、POPサービスを実行しているPOP/IMAPのポートを指定してください。 |
|
popUserName popPassword |
POPやIMAPのサービスが別ホストにある場合、POP用のユーザー名とパスワードを指定します。 |
| popSSLEnabled | trueの指定でSSLが有効となり、POP/IMAPのデータ転送がセキュアになります。 |
| popTLSEnabled | trueの指定でTLSが有効となり、POP/IMAPのデータ転送がセキュアになります。 |
| fetchType | メール取得サーバーを指定してください。POPとIMAPから選びます。 |
| fsHost | メール取得サーバーのPOP/IMAPホストです。 |
| fsport | メール取得サーバーのPOP/IMAPポートです。 |
| fsSSLEnabled | trueでSSLが有効になります。 |
| fsTLSEnabled | trueでTLSが有効になります。 |
リクエスト サンプル
http://prod-server5:9098/AppManager/xml/AddMonitor?apikey=4c362569ccc528be78fafdcc2317bc5c &type=Mail Server&host=smtp&displayname=apmmail&port=25&emailid=myesura@zohocorp.com&timeout=15&mailMsg=Testing mail server.