AddMonitor API――仮想化

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

VMware ESX/ESXi Server

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&addtoGroup=[ADDTO_GROUP]&groupID=[GROUP_ID]&monitorvms=[MONITOR_VMS]

リクエスト パラメーター

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

フィールド 説明
type 追加する監視のタイプです。値はVMware ESX/ESXiにしてください。
host VMware ESX/ESXi Serverを実行しているホストの名前を指します。
port VMware ESX/ESXi Serverが動作するポート番号です。
username VMware ESX/ESXi Serverのユーザー名です。
password VMware ESX/ESXi Serverのパスワードです。
addtoGroup 監視を監視グループに追加するか決定します。trueかfalseを指定してください。
groupID 監視グループIDを指定します。
monitorvms ESX Serverの仮想マシンを、どう監視するか指定します。設定ごとに次の挙動になります。
  • no：VMのディスカバリを行いません。
  • onlyavailability：VMをディスカバリしますが、メトリック監視は行いません（ライセンス消費なし）。
  • yes：VMのディスカバリと監視を行います。

リクエスト サンプル

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=e249ce592ad1052c4ea605bcf3125ad9&type=VMware ESX/ESXi&displayname=vnwgroup&host=esx-2&port=443&username=root&password=password&addToGroup=true&groupID=10000024&monitorvms=onlyavailability

VMware Horizon View接続ブローカー

VMware Horizon View接続ブローカー監視を追加するには、方法が2つあります。

  • VMware Horizon Viewを新規監視グループとして追加するには、新規監視グループ > VMware Horizon Viewと移動してください。Horizon Viewにある全コンポーネントを、View接続ブローカーも含めディスカバリします。

    構文

    http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=VMwareView&displayname=[DISPLAY_NAME]&host=[HOST]&username=[USER_NAME]&password=[PASS_WORD]&pollInterval=[POLL_INTERVAL]

    リクエスト サンプル

    http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=f6ad2a431bb2cd5aa85c195262daef7f&type=VMwareView&displayname=HorizonView&host=172.18.144.52&username=vmwarehzview\user-test&password=APM@13&pollInterval=5

     

  • VMware Horizon View接続ブローカーを新規監視として追加するには、(新規監視 > VMware Horizon View接続ブローカーと移動してください。View接続ブローカーのみがディスカバリの対象となります。

    構文

    http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=ViewConnectionBroker&displayname=[DISPLAY_NAME]&host=[HOST]&username=[USER_NAME]&password=[PASS_WORD]&pollInterval=[POLL_INTERVAL]&addtoGroup=[true/false]&groupID=[GROUP_ID]

    リクエスト サンプル

    http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=f6ad2a431bb2cd5aa85c195262daef7f&type=ViewConnectionBroker&displayname=ViewBroker&host=172.18.144.52&username=vmwarehzview\maran-test&password=Zoho@13&pollInterval=5&addtoGroup=true&groupID=10000028

リクエスト パラメーター

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

フィールド 説明
type 追加する監視のタイプです。値はVMwareViewかViewConnectionBrokerにしてください。
host VMware Horizon View serverを実行しているホストの名前を指します。
username VMware Serverのユーザー名です。
password VMware Serverのパスワードです。

Microsoft Hyper-V Server

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&host=[HOST]&displayname=[DISPLAY_NAME]&password=[PASS_WORD]&addvms=[ADDVMS]&username=[USER_NAME]&Version=[VERSION]

リクエスト パラメーター

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

フィールド 説明
type 追加する監視のタイプです。値はHyper-V Serverにしてください。
host Hyper-V Serverを実行しているホストの名前を指します。
password Hyper-V Serverのパスワードです。
addvms Hyper-V ServerのVM監視のしかたを決めます。次の値を指定できます。
  • no：VMのディスカバリを行いません。
  • onlyavailability：VMをディスカバリしますが、メトリック監視は行いません（ライセンス消費なし）。
  • yes：VMのディスカバリと監視を行います。
username Hyper-V Serverのユーザー名です。
Version Microsoft Hyper-V Serverのバージョンです。値は、2008、2012、2016、2019から選んでください。

リクエスト サンプル

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84&type=Hyper-V Server&host=amp-w2k8-64&displayname=apmhyperv&password=admin123app2&addvms=yes&username=administrator&Version=2008

Citrix XenServer

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE] &host=[HOST]&displayname=[DISPLAY_NAME]&username=[USER_NAME]&password=[PASS_WORD]&port=[PORT] &addvms=[ADDVMS]&addToGroup=[true/false]&groupID=[GROUP_ID]&monitorvms=[AVAILABILITY]

リクエスト パラメーター

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

フィールド 説明
type 追加する監視のタイプです。値はXenServerHostにしてください。
host XenServerホストを実行しているホストの名前を指します。
password XenServerHostのパスワードを指します。
addvms VMのパフォーマンス メトリックを収集するか指定します。yesかnoにしてください。
username XenServerHostのユーザー名を指します。
addToGroup 監視を監視グループに追加するかを決めます。trueかfalseを指定してください。
groupID 監視グループのIDです。
monitorvms 仮想マシンの監視のしかたを指定します。値は、no、yes、onlyavailabilityです。noを指定すると、VMのディスカバリを行いません。値yesの場合、VMをディスカバリして監視します。onlyavailabilityの場合、VMディスカバリは行いますが、メトリックは監視しません（ライセンス消費なし）。

リクエスト サンプル

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194 &type=XenServerHost&host=192.18.3.75&displayname=newxen&password=sankho &addvms=yes&username=root

Citrix XenApp

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE] &host=[HOST]&displayname=[DISPLAY_NAME]&UserName =[USERNAME]&password=[PASS_WORD]&Version=[VERSION]

リクエスト パラメーター

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

フィールド 説明
apikey 「管理」タブのAPIキーの作成で生成したキーを指定します。
type 追加する監視のタイプです。値はXenAppにしてください。
host XenAppサーバーを実行しているホストの名前を指します。
displayname 監視の表示名です。
username XenAppサーバー ホスト マシンのユーザー名を指定します。
password XenAppサーバー ホスト マシンのパスワードを指定します。
Version XenAppのバージョンです。

リクエスト サンプル

http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=XenApp&host=192.18.3.75&displayname=XenAppServer&UserName =administrator&Password=pass&Version=7.6

vCenter

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]
&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&addtoGroup=[ADDTO_GROUP]&groupID=[GROUP_ID]&monitorvms=[MONITOR_VMS]
http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=vCenter&displayname=vctest&vcHost=vcenter&vcPort=443&username=test&password=test&pollInterval=5&isHostDCViaVC=on

リクエスト パラメーター

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

フィールド 説明
type 追加する監視のタイプです。値はvCenterにしてください。
vcHost vCenterが稼働しているホストの名前を入力します。
vcPort vCenterが稼働しているポート番号を入力します。
username vCenter Serverのユーザー名を指定してください。
password vCenter Serverのパスワードを指定してください。
addtoGroup 監視を監視グループに追加するか決定します。trueかfalseを指定してください。
isHostDCViaVC データ収集をvCenterの認証情報で行うか指定します。onかoffにしてください（任意項目）。

リクエスト サンプル

http://[host]:[port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=vCenter&displayname=vctest&vcHost=vcenter&vcPort=443&username=test&password=test&pollInterval=5

Docker

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&sslenabled=[true/false]&isAllContainerEnabled=[true/false]&isCertificateEnabled=[true\false]&clientCertName=[CLIENT_CERTIFICATE_NNAME]&keystorePassword=[CLIENT_CERTIFICATE_PASSWORD]

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

フィールド 説明
type 追加する監視のタイプです。値はDockerにしてください。
host Dockerを実行中のホストの名前を指定します。
port Dockerを実行中のポート番号を指定します。
username Dockerサーバーのユーザー名を入力します。
password Dockerサーバーのパスワードを入力します。
sslenabled SSLを有効にするオプションです。値は、trueかfalseです。
isAllContainerEnabled Dockerサーバーに存在するすべてのコンテナーを検出・監視するか、選択します。値は、trueかfalseです。
isCertificateEnabled 監視するDockerサーバーでクライアント証明書認証を有効にするか、指定します。値は、trueかfalseです。
clientCertName クライアント証明書の名前です。
keystorePassword クライアント証明書で使うパスワードです。

リクエスト サンプル

証明書を利用しない場合

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=dd2e6f7ec54632b4493d0dc13829df39&type=Docker&displayname=docker&host=testing&port=4243&username=&password=&isSSLEnabled=false&isAllContainerEnabled=true&isCertificateEnabled=false

証明書を利用する場合

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=dd2e6f7ec54632b4493d0dc13829df39&type=Docker&displayname=docker&host=testing&port=4243&username=&password=&isSSLEnabled=true&isAllContainerEnabled=true&isCertificateEnabled=true&clientCertName=abcd&keystorePassword=abcd123

Kubernetes

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&mode=SSH&sshPKAuth=[true/false]&prompt=[PROMPT]&timeout=[TIMEOUT_IN_SECONDS]

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

フィールド 説明
type 追加する監視のタイプです。値はKubernetesにしてください。
host Kubernetesクラスターを実行しているホストの名前です。
port Kubernetesが動作するポート番号です。
username Kubernetesクラスターのユーザー名です。
password Kubernetesクラスターのパスワードです。
mode Kubernetesへのアクセス モードを指定します。
sshPKAuth 公開鍵認証（SSH 2のみ）と、SSH認証用のSSHキーを有効にします。
prompt コマンド プロンプトの最後の文字を指定します。デフォルトでは$となっており、>、#なども指定できます。
timeout タイムアウト値を指定します（秒）。

リクエスト サンプル

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=0b0e064274e52eead3d1cabdd5ceee04&type=Kubernetes&displayname=kubemaster&host=kubemaster&port=22&username=test&password=test&mode=SSH&sshPKAuth=false&prompt=$&timeout=40

Red Hat Virtualization (RHV)

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST_NAME]&port=[PORT]&username=[USERNAME]&password=[PASS_WORD]&pollInterval=[POLL_INTERVAL]&timeout=[TIME_OUT]&discoverVM=[DISCOVER_VM]

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

パラメーター 説明
type 追加する監視のタイプです。値はRHEVにしてください。
host RHV Serverを実行しているホストの名前を指します。
port RHV Serverが動作するポート番号です。
username RHV Serverのユーザー名です。
password RHV Serverのパスワードです。
discoverVM RHV Serverの仮想マシンを、どう監視するか指定します。設定ごとに次の挙動になります。
  • 1：検出した仮想マシンを管理対象外とし、VMのみ、ステータスと可用性の監視を行います。
  • 2：検出した仮想マシンを管理対象とし、定義済みメトリックのすべてを監視します。

リクエスト サンプル

http://localhost:8989/AppManager/xml/AddMonitor?apikey=47e71c777772a41d1482a394070aaae6&type=RHEV&displayname=rhevtest&host=apm-rhvm1.csez.zohocorpin.com&port=443&username=admin@internal&password=NewPassword&pollInterval=5&timeout=300&discoverVM=2

KVM（Kernel-based Virtual Machine：カーネル ベースの仮想マシン）

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&HostName=[HOST_NAME]&displayname=[DISPLAY_NAME]&mode=[MODE]&snmptelnetport=[PORT]&username=[USERNAME]&password=[PASS_WORD]&timeout=[TIME_OUT]&AddVMS=[DISCOVER_VMS]

認証情報マネージャーを利用する場合

Telnetモード

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&HostName=[HOST_NAME]&displayname=[DISPLAY_NAME]&mode=TELNET&snmptelnetport=[PORT]&credentialID=[CREDENTIAL_ID]&timeout=[TIME_OUT]&AddVMS=[DISCOVER_VMS]&TelnetCredentialDetails=cmTelnet

SSHモード

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&HostName=[HOST_NAME]&displayname=[DISPLAY_NAME]&mode=SSH&snmptelnetport=[PORT]&credentialID=[CREDENTIAL_ID]&timeout=[TIME_OUT]&AddVMS=[DISCOVER_VMS]&SSHCredentialDetails=cmSSH

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

パラメーター 説明
type 追加する監視のタイプです。値はKVMにしてください。
hostname KVMサーバーを実行しているホストの名前です。
mode KVMサーバーの監視モードを指定します。値は、SSHかTELNETです。
snmptelnetport KVMサーバーが動作するポート番号です。
username KVMサーバーのユーザー名です。
password KVMサーバーのパスワードです。
AddVMS KVMサーバーのVMの監視のしかたを決定します。次の値を指定できます。
  • 0：VMのディスカバリを行いません。
  • 1：VMをディスカバリしますが、メトリック監視は行いません（ライセンス消費なし）。
  • 2：VMのディスカバリと監視を行います。

リクエスト サンプル

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm-server&displayname=kvm&mode=TELNET&snmptelnetport=23&username=test&password=pwd&timeout=40&AddVMS=2

認証情報マネージャーを使う場合

Telnetモード

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm-server&displayname=kvm&mode=TELNET&snmptelnetport=23&credentialID=3&timeout=40&AddVMS=2&TelnetCredentialDetails=cmTelnet

SSHモード

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=25314fffa16c5975235d56564198e1ba&type=KVM&HostName=kvm-server&displayname=kvm&mode=SSH&snmptelnetport=23&credentialID=3&timeout=40&AddVMS=2&SSHCredentialDetails=cmSSH

OpenShift

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=OpenShift &displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&mode=SSH&sshPKAuth=[true/false]&prompt=[PROMPT]&OSUsername=[OPENSHIFT_USERNAME]&OSPassword=[OPENSHIFT_PASSWORD]&timeout=[TIMEOUT_IN_SEC]

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

パラメーター 説明
type 監視のタイプです。値はOpenShiftにしてください。
displayname 監視の表示名を表します。
host OpenShiftをホストしているマシンの名前です。
port OpenShiftが動作するポート番号です。
username ホスト サーバーのユーザー名です。
password ホスト サーバーのパスワードです。
mode 認証のモードです。値はSSHにしてください。
sshPKAuth SSH 2を有効にするか指定します。trueかfalseにしてください。
prompt コマンド プロンプトの最後の文字を指定します。
OSUsername OpenShiftサーバーのユーザー名です。
OSPassword OpenShiftサーバーのパスワードです。

リクエスト サンプル

http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=0b0e064274e52eead3d1cabdd5ceee04&type=OpenShift&displayname=openshift&host=openshift&port=22&username=test&password=test&mode=SSH&sshPKAuth=false&OSUsername=admin&OSPassword=admin&timeout=40

Rest-API with Password：
http://localhost:7700/AppManager/xml/AddMonitor?apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&port=22&username=openshift&password=Server@123&mode=SSH&sshPKAuth=false&prompt=$&OSUsername=admin&OSPassword=admin&timeout=40

認証情報を用いたREST APIサンプル：
http://localhost:7700/AppManager/xml/AddMonitor?apikey=6e793c8d4c9b811181258bcd3ce7dde6&type=OpenShift&displayname=openshift&host=openshift&port=22&mode=SSH&credentialID=1&OSUsername=admin&OSPassword=admin&timeout=40

Oracle VM (OVM)

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST_NAME]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&pollInterval=[POLL_INTERVAL]&discoverVM=[DISCOVER_VM]&credentialID=[CREDENTIAL_ID]&timeout=[TIME_OUT]

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

パラメーター 説明
type 追加する監視のタイプです。値はOVMにしてください。
host OVM Serverを実行しているホストの名前を指します。
port OVM Serverが動作するポート番号です。
username OVM Serverのユーザー名です。
password OVM Serverのパスワードです。
discoverVM OVM ServerのVM監視のしかたを決めます。次の値を指定できます。
  • 0：VMのディスカバリを行いません。
  • 1：VMをディスカバリしますが、メトリック監視は行いません（ライセンス消費なし）。
  • 2：VMのディスカバリと監視を行います。
timeout Oracle VM Manager（秒）のサーバー接続タイムアウト値です。

リクエスト サンプル

http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=f2fe671bf966e8607382fe9af59e9136&type=OVM&displayname=ovmmanager&host=172.24.158.227&port=7002&username=admin&password=Oracle2019&pollInterval=2&discoverVM=2&timeout=300
http://ProductionServer:6060/AppManager/xml/AddMonitor?apikey=f2fe671bf966e8607382fe9af59e9136&type=OVM&displayname=ovmmanager&host=172.24.158.227&port=7002&pollInterval=2&discoverVM=2&timeout=300&credentialID=1