AddMonitor API――エンド ユーザー監視

このページでは、AddMonitor APIでエンド ユーザー監視（EUM）を追加する方法を説明します。サポート対象は次の監視です。

以下のパラメーターはEUMのAPIリクエストで共通です。

フィールド 説明
eumAgents EUMエージェントの表示名です。カンマ区切りで複数指定も可能です。
eumAgentsId 設定したEUMエージェントの一意のIDです。カンマ区切りで指定できます。
runOnServer 監視を、Applications Managerに作成するかを、指定します。値は、「True」か「False」です。

メモ：
1：「eumAgents」と「eumAgentsId」の双方を、同じAPリクエストで使う必要はありません。どちらかを指定してください。
2：runOnServerパラメーターは、リアル ブラウザー監視（RBM）には適用できません。

ping

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&timeout=[TIME_OUT]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。

フィールド 説明
type 追加するサービスのタイプです。値は「Ping Monitor」にしてください。
host 監視が稼働しているホストを指します。
timeout タイムアウト値を指定します（秒）。

リクエスト サンプル

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=Ping Monitor&displayname=apmping&host=smrithil&timeout=5&eumAgents=eumflorida&runOnServer=True

DNS

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&timeout=[TIME_OUT]&SearchField=[SEARCH_FIELD]&TargetAddress=[TARGETADDRESS]&LookupAddress=[LOOKU_PADDRESS]&RecordType=[RECOR_DTYPE]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。

フィールド 説明
type 追加するサービスのタイプです。値は「DNSMonitor」にしてください。
displayname 監視が稼働しているホストの表示名を指します。
timeout タイムアウト値を指定します（秒）。
SearchField 検索フィールドの値です。Record Name、Address、Additional Name、Target, Admin、Host、Alias、Port、Priorityから指定できます。-none-を指定すると、検索を行いません。
TargetAddress サービス接続用のホスト名かIPアドレスです。
LookupAddress DNSサーバーで確認するアドレスを指定します。
RecordType ルックアップ アドレスに対して期待する戻りレコードのタイプを指します。A、AAAA、CNAME、MX、NS、PTR、SOA、SPF、SRV、TXTから選択できます。-none-を指定すると、検索を行いません。

リクエスト サンプル

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=DNSMonitor&displayname=dnstttttt&timeout=15&SearchField=Record Name&TargetAddress=192.168.4.121&LookupAddress=appmanager.com&RecordType=A&eumAgents=eumbe1&runOnServer=True

LDAPサーバー

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&username=[USER_NAME]&timeout=[TIME_OUT]&LDAPServer=[LDAP_SERVER]&LDAPServerPort=[LDAP_SERVER_PORT]&MatchingAttribute=[MATCHING_ATTRIBUTE]&FilterCondition=[FILTER_CONDITION]&IsSecured=[ISSECURED]&SearchFilter=[SEARCH_FILTER]&SearchResult=[SEARCH_RESULT]&SearchBase=[SEARCH_BASE]&password=[PASS_WORD]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。

フィールド 説明
type 追加するサービスのタイプです。値は「LDAP Server」にしてください。
username LDAPサーバーのユーザー名です。
timeout タイムアウト値を指定します（秒）。
LDAPServer LDAPサーバーの名前です。
LDAPServerPort LDAPサーバーが動作するポートを指します。
MatchingAttribute マッチさせる属性を指定します。cn、uid、sn、displayname、givenname、objectclass、dc、ou名から選んでください。
FilterCondition フィルター条件の値です。equals、contains、notequalsがあります。
IsSecured 接続がセキュアか明記してください。値はyesかnoです。
SearchFilter 検索フィルターの値です。こちらは任意項目です。
Search結果 検索結果にマッチさせる文字列です。
SearchBase 検索ベースの値です。LDAP監視の追加時は必須です。
password LDAPサーバーのパスワードです。

リクエスト サンプル

http://operations-server9:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=LDAP Server&displayname=ldap_serverqqqq&username=cn=administrator,cn=users,dc=pmp,dc=com&timeout=10&LDAPServer=pmp-2k8s&LDAPServerPort=389&MatchingAttribute=cn&FilterCondition=equals&IsSecured=no&SearchFilter=&SearchResult=&SearchBase=&Password=admin123123&eumAgents=eumbe1&runOnServer=True

メール サーバー

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&host=[HOST]&port=[PORT]&displayname=[DISPLAY_NAME]&emailid=[EMAILID]&timeout=[TIME_OUT]&authRequired=[AUTHREQUIRED]&sslEnabled=[SSLENABLED]&username=[USER_NAME]&password=[PASS_WORD]&tlsEnabled=[TLSENABLED]&pollInterval=[POLL_INTERVAL]&mailsubject=[MAILSUBJECT]&fetchEnabled=[FETCHENABLED]&fetchType=[FETCHTYPE]&fsHost=[FSHOST]&fsport=[FSPORT]&fsSSLEnabled=[FSSSLENABLED]&fsTLSEnabled=[FSTLSENABLED]&fsUserName=[FSUSERNAME]&fsPassword=[FSPASSWORD]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]&runOnServer=[RUNONSERVER]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。

フィールド 説明
type 追加するサービスのタイプです。値は「Mail Server」にしてください。
host SMTPホスト名
port SMTPが動作するポートを指します。
emailid 送信先メール アドレスを指定します。
timeout タイムアウト値を指定します（秒）。
authRequired SNMPで認証を要するかを示します。「Yes」か「No」にしてください。
sslEnabled SNMPホストをSSLで利用するか示します。「Yes」か「No」にしてください。
username SNMPホストのユーザー名です。
password SNMPホストのパスワードです。
tlsEnabled SMTPでTLSを使うか否かを表します。
pollinterval 監視のポーリング間隔です（秒）。
mailSubject メール件名の表示内容を指します。
fetchEnabled POP/IMAPサーバーを監視するか否かを示します。「Yes」か「No」にしてください。
fetchType 監視対象のサービスを示します。POPの場合は1、IMAPの場合は2にしてください。
fsHost POP/IMAPサーバーのホスト名です。
fsport POP/IMAPサーバーが動作するポートを指します。
fsSSLEnabled POP/IMAPサーバーがSSL有効か否かを示します。「Yes」か「No」にしてください。
fsTLSEnabled POP/IMAPでTLSを使うか指定します。「Yes」か「No」にしてください。
fsUserName POP/IMAPサーバーのユーザー名です。
fsPassword POP/IMAPサーバーのパスワードです。

リクエスト サンプル

http://operations-server9:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=Mail Server&host=smtp1&port=23&displayname=apmsmtp&emailid=admin@yourdomain.com&timeout=5&authRequired=Yes&sslEnabled=Yes&username=guest&password=guest&tlsEnabled=Yes&pollinterval=60&mailsubject=Testing Mail Server&fetchEnabled=Yes&fetchType=1&fsHost=POP1&fsport=110&fsSSLEnabled=Yes&fsTLSEnabled=Yes&fsusername=admin&fsPassword=admin123123&eumAgents=eum1&runOnServer=True

リアル ブラウザー監視

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&scriptname=[SCRIPT_NAME]&pollInterval=[POLL_INTERVAL]&timeout=[TIME_OUT]&eumAgents=[EUMAGENTS]&eumAgentsId=[EUMAGENTID]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。AddMonitor APIに共通のリクエスト パラメーターも参照ください。

フィールド 説明
type 追加する監視のタイプです。値は「RBM」にしてください。
scriptname RBMのスクリプト名です。
pollinterval 管理のポーリング間隔を指定します（秒）。
timeout タイムアウト値を指定します（秒）。

リクエスト サンプル

http://operations-server9:9090/AppManager/xml/AddMonitor?apikey=40648ef160f4786b20ed89ea51aa3f98&type=RBM&displayname=rbm1&scriptname=script1&pollinterval=60&timeout=30&eumAgents=eum1