AddMonitor API――サーバー

このページでは、AddMonitor APIで、カテゴリ タイプ サーバーの監視を追加する方法を説明します。次のサーバーをサポートしています。

AIX

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&os=[OS]&username=[USER_NAME]&mode=[MODE]&snmptelnetport=[SNMPTELNETPORT]&password=[PASS_WORD]&prompt=[PROMPT]&timeout=[TIME_OUT]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
host AIXサーバーを実行しているホストの名前を指します。
os サーバーのOSです。「AIX」を指定してください。
username AIXサーバーのユーザー名です。
mode 監視のモードAIXサーバー。値はTELNETかSSHにしてください。
snmptelnetport Telnetサービスが稼働しているポート番号。デフォルト値は23です。
password AIXサーバーのパスワードです。
timeout タイムアウト値を指定します（秒）。
prompt コマンド プロンプト値を指定します。「$」を入力してください。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。

リクエスト サンプル：

http://prod-server1:9098/AppManager/xml/AddMonitor?apikey=624436f73f9fda2109cc916c8c8be5c1&type=servers&displayname=apmaix&host=adventaix&os=AIX&username=root&mode=TELNET&snmptelnetport=23&password=sankho&prompt=#&timeout=2

AS/400

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&subnet=[SUBNET]&pollInterval=[POLL_INTERVAL]&os=[OS]&username=[USER_NAME]&password=[PASS_WORD]&timeout=[TIME_OUT]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
host AS/400サーバーを実行しているホストの名前を指します。
subnet サブネット マスク値
pollInterval 監視のポーリング間隔です。
os サーバーのOSです。「AS400/iSeries」を指定してください。
username AS/400・iSeriesサーバーのユーザー名です。
timeout タイムアウト値を指定します（秒）。
password AS/400（iSeries）サーバーのパスワードです。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。

リクエスト サンプル：

http://prod-server2:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmas400&host=pub1.rzkh.de&subnet=255.255.255.0&pollInterval=5&os=AS400/iSeries&username=nimda&password=admin&timeout=3

FreeBSD

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&subnet=[SUBNET]&pollInterval=[POLL_INTERVAL]&os=[OS]&username=[USER_NAME]&password=[PASS_WORD]&mode=[MODE]&snmptelnetport=[SNMPTELNETPORT]&prompt=[PROMPT]&timeout=[TIME_OUT]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
host FreeBSDサーバーを実行しているホストの名前を指します。
subnet サブネット マスク値
pollInterval 監視のポーリング間隔です。
os サーバーのOSです。「FreeBSD」を指定してください。
username FreeBSDサーバーのユーザー名です。
password FreeBSDサーバーのパスワードです。
mode 監視のモード。SNMP、TELNET、SSHから選んでください。
snmptelnetport Telnetサービスを実行するポートを指定します。デフォルト値は23です。
timeout タイムアウト値を指定します（秒）。
prompt コマンド プロンプト値を指定します。値は$になっています。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。

リクエスト サンプル：

http://prod-server4:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmfreebsd&host=cm-bsd&subnet=255.255.255.0&pollInterval=5&os=FreeBSD&username=test&password=test&mode=TELNET&snmptelnetport=23&prompt=$&timeout=4

HP-UX/Tru64

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&username=[USER_NAME]&password=[PASS_WORD]&os=[OS]&mode=[MODE]&snmptelnetport=[SNMPTELNETPORT]&host=[HOST]&timeout=[TIME_OUT]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
username HP-UXサーバーのユーザー名です。
password HP-UXサーバーのパスワードです。
os サーバーのOSです。「HP-UX」を指定してください。
mode 監視のモードです。SSHかTELNETにしてください。
snmptelnetport SSHやTelnetを実行しているポートを指定します。デフォルトではTelnetは23、SSHは22です。
timeout タイムアウト値を指定します（秒）。
host HP-UXサーバーを実行しているホストの名前を指します。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。

リクエスト サンプル：

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmhpux&username=test&password=test&os=HP-UX&mode=SSH&snmptelnetport=22&host=hpuxtests&timeout=5

Linux

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&timeout=[TIME_OUT]&username=test&password=Zoho123

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
host Linuxサーバーを実行しているホストの名前です。
snmptelnetport SSH、Telnet、SNMPの実行ポートを指定します。デフォルトでは、Telnetが23、SSHは22、SNMPが161です。
os サーバーのOSです。「Linux」を指定してください。
timeout タイムアウト値を指定します（秒）。
mode 監視のモードを指します。SNMP、SSH、TELNETから選択してください。SNMPモードでは、コミュニティ文字列をAPIリクエストのパラメーターに追加してください。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。
username Telnet/SSHでの監視に使うユーザー名です。
password Telnet/SSHでの監視に使うパスワードです。

リクエスト サンプル：

SSHモード

http://prod-server:9090/AppManager/xml/AddMonitor?apikey=cfb48066f523d94c18fd0a99bc4faa10&type=servers&displayname=APILINUX &host=app-centos32-1&snmptelnetport=22&os=Linux&mode=SSH&timeout=10&username=test&password=Zoho123

SNMPモード

http://prod-server:9090/AppManager/xml/AddMonitor?apikey=cfb48066f5fdvgf94c18fd0a99bc4faa10&type=servers&displayname=APILINUX &host=app-centos32-1&snmptelnetport=161&os=Linux&mode=SNMP&timeout=10&username=test&password=Zoho123&SNMPCommunityString=Public

サンプルResponse：

<?xml version="1.0" encoding="UTF-8"?>
<AppManager-response uri="/AppManager/xml/AddMonitor">
<result>
<response resourceid="10005717" response-code="4000">
<message>Monitor added successfully.</message>
</response>
</result></AppManager-response>

Mac OS

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username=[USER_NAME]&password=[PASS_WORD]&timeout=[TIME_OUT]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
host Mac OSを実行しているホストの名前を指します。
snmptelnetport SSH、Telnet、SNMPの実行ポートを指定します。デフォルトでは、Telnetが23、SSHは22、SNMPが161です。
os サーバーのOSです。「Mac OS」を指定してください。
mode 監視のモードを指します。SNMP、SSH、TELNETから選択してください
username Mac OSサーバーのユーザー名です。
timeout タイムアウト値を指定します（秒）。
password Mac OSサーバーのパスワードです。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。

リクエスト サンプル：

http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmmac&host=apptest-mac&snmptelnetport=23&os=Mac OS&mode=TELNET&username=administrator&password=admin123&timeout=2

Novell

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&timeout=[TIME_OUT]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
host Novellサーバーを実行しているホストの名前を指します。
snmptelnetport ポートwhere SNMPが稼働しているデフォルト値は161です。
os サーバーのOSです。「Novell」を指定してください。
timeout タイムアウト値を指定します（秒）。
mode サーバーで指定する監視モードです。「SNMP」を指定してください。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。

リクエスト サンプル：

http://production-server2:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmnovell&host=smrithil&snmptelnetport=161&os=Novell&mode=SNMP&timeout=2

Sun Solaris

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username=[USER_NAME]&password=[PASS_WORD]&timeout=[TIME_OUT]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
host Sun Solarisサーバーを実行しているホストの名前を指します。
snmptelnetport SSH、Telnet、SNMPの実行ポートを指定します。デフォルトでは、Telnetが23、SSHは22、SNMPが161です。
os サーバーのOSです。「SUN」を指定してください。
mode サーバーの指定監視モードです。SNMP、TELNET、SSHから選んでください。
username Sun Solarisサーバーのユーザー名です。
timeout タイムアウト値を指定します（秒）。
password Sun Solarisサーバーのパスワードです。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。

リクエスト サンプル：

http://prod-server7:9090/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmsolaris&host=cagent-solaris2&snmptelnetport=23&os=SUN&mode=TELNET&username=guest&password=guest&timeout=3

Windows

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&snmptelnetport=[SNMPTELNETPORT]&os=[OS]&mode=[MODE]&username=[USER_NAME]&password=[PASS_WORD]&timeout=[TIME_OUT]&kerberos_status=[ KERBEROS STATUS ]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。値は「servers」にしてください。
host Windows Serverを実行しているホストの名前を指します。
snmptelnetport ポートwhere SNMPが稼働しているデフォルト値は161です。
os サーバーのOSです。Windows 2008、Windows 2012、Windows 2016、Windows 2019から指定してください。
mode サーバーの指定監視モードです。値はSNMPかWMIにしてください。
username Windows Serverのユーザー名です。
password Windows Serverのパスワードです。
timeout タイムアウト値を指定します（秒）。
eventlog_status イベント ログ監視を有効にするか示します。パラメーター値はtrueかfalseです。
snmpCommunityString サーバーのSNMPデータへの読み込み専用アクセスに必要なSNMPコミュニティ文字列を指定します。SNMPでの監視には必須です。デフォルトでは「public」になっています。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。
kerberos_status Kerberos認証が有効かを示します。値は、trueかfalseにします。

リクエスト サンプル：

Windows ServerをSNMPモードで追加するには

http://prod-server6:8080/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5 &type=servers&displayname=apmwindows&host=app-xp5&os=Windows XP&mode=SNMP&snmptelnetport=161&snmpCommunityString=public&timeout=2&timeout=2

Windows ServerをWMIモードで追加するには

http://prod-server6:8080/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=servers&displayname=apmwindows&host=app-xp5&os=Windows XP&mode=WMI&username=administrator&password=pass&timeout=300&kerberos_status=true

Windowsクラスター

構文：

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST_NAME]&Version=[VERSION_NO]&username=[USER_NAME]&password=[PASS_WORD]&DiscoverNodes=[NO OF NODES]&EventLog=[YES/NO]&pollinterval=[INTERVAL]

リクエスト パラメーター：

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

フィールド 説明
type 追加する監視のカテゴリ タイプです。Windows Clusterを指定してください。
host Windows Serverクラスターが稼働しているホストの名前です。
version Windows Serverクラスターのバージョンです。次の値を指定できます。
  • 2008 (Default)
  • 2008 R2
DiscoverNodes ノードもディスカバリするかを指定します。次の値から選択ください。
  • 0：No（デフォルト）
  • 1：Yes
EventLog イベント ログを取得するか指定します。次の値から選択ください。
  • Yes
  • No（デフォルト）
pollInterval サーバーへのポーリング間隔を指定します。この変数は任意項目です。指定がなければ、デフォルトの5分を採用します。
forceadd Applications Managerで可用性チェックや認証関連チェックを迂回し、強制的に監視を追加する時に使うパラメーターです。次の値を指定できます。
  • true：監視を強制追加します。
  • false：強制追加をしません。
addgivenname リソースのホスト名をAPIで設定するホスト名に使うか指定します。
passphrase 秘密鍵をSSH認証で保護する場合のパスフレーズを指定します。

リクエスト サンプル：

https://prod-server6:8080/AppManager/xml/AddMonitor?apikey=5bc6a8e9a30d5bf894586d4db90282f5&type=Windows Cluster&displayname=clusterApi&host=apmcluster&Version=2008 R2&username=apmcluster2012\administrator&password=12345&DiscoverNodes=1&EventLog=No&pollinterval=5