添加监视器 API - 虚拟化

---

本节说明如何使用添加监视器API添加类别类型Virtualization的监视器。支持以下监视器：

• VMware ESX/ESXi Server
• VMware Horizon View Connection Broker
• Microsoft Hyper-V Server
• Citrix Hypervisor (XenServer)
• Citrix Virtual Apps (XenApp)
• vCenter
• Docker
• Kubernetes
• Red Hat Virtualization (RHV)
• Kernel-based Virtual Machine (KVM)
• OpenShift
• Oracle VM (OVM)

VMware ESX/ESXi Server

语法

请求参数

API请求中涉及的参数如下所述。另外，请参阅公共请求参数列表。

字段	描述
type	要添加的监视器的类型。值应为VMware ESX / ESXi。
host	运行VMWare ESX / ESXi服务器的主机的名称。
port	运行VMware ESX / ESXi服务器的端口号。
username	VMware ESX / ESXi服务器的用户名。
password	VMware ESX / ESXi服务器的密码。
addtoGroup	表示是否应将监视器添加到业务组。值是yes还是no
groupID	业务组ID
monitorvms	指示如何监控ESX Server虚拟机的方式。可能的值为： 否-将不会发现VM。 仅可用性-将发现VM，但将不监控指标。（将不计入许可） 是-将发现并监控VM。

示例请求

VMware Horizo​​n View连接代理

您可以通过以下两种方式添加VMware Horizo​​n View Connection Broker监视器：

• 将VMware Horizo​​n View添加为新的业务组（新建业务组-> VMware Horizo​​n View），这将发现Horizo​​n View设置中的所有组件，包括View Connection Broker。

  语法

  http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=VMwareView&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&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 Horizo​​n View Connection Broker添加为新监视器（新建监视器-> VMware Horizo​​n View Connection Broker）。这将单独发现View连接代理。

  语法

  http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=ViewConnectionBroker&displayname=[DISPLAYNAME]&host=[HOST]&username=[USERNAME]&password=[PASSWORD]&pollInterval=[POLL INTERVAL]&addtoGroup=[TRUE/FALSE]&groupID=[GROUPID]

  示例请求

  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请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段	描述
type	要添加的监视器的类型。值应为VMwareView或ViewConnectionBroker。
host	运行VMware Horizo​​n View服务器的主机的名称。
username	VMware服务器的用户名。
password	您的VMware服务器的密码。

Microsoft Hyper-V Server

语法

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段	描述
type	要添加的监视器的类型。值应为Hyper-V服务器。
host	Hyper-V服务器运行所在的主机的名称。
password	Hyper-V服务器的密码。
addvms	指示如何监控Hyper-V服务器的虚拟机（VM）。可能的值为： 否-将不会发现VM。 onlyavailability-将发现VM，但将不监控指标。（将不计入许可） 是-将发现并监控VM。
username	Hyper-V服务器的用户名。
Version	Microsoft Hyper-V服务器的版本。可能的值为2008、2012、2016或2019。

示例请求

Citrix Hypervisor (XenServer)

语法

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段	描述
type	要添加的监视器的类型。值应为XenServerHost。
host	XenServerHost运行所在的主机的名称。
password	XenServerHost的密码
addvms	表示是否应该收集VM的性能指标。值是yes或no
username	XenServerHost的用户名
addToGroup	表示是否应将监视器添加到业务组。值是yes还是no
groupID	业务组ID
monitorvms	指示监控虚拟机的方式。可能的值为no，yes和onlyavailability。值no表示将不会发现VM。值是表示将发现并监控VM。值onlyavailability表示将发现VM，但不监控指标（不计入许可）。

示例请求

Citrix Virtual Apps (XenApp)

语法

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段	描述
key	通过管理标签中的生成API密钥选项生成的密钥。
type	您要添加的监视器的类型。该值应为XenApp。
host	XenApp服务器运行所在的主机的名称。
displayname	监视器的显示名称。
username	XenApp服务器主机的用户名。
password	XenApp服务器主机的密码。
Version	XenApp的版本。

示例请求

vCenter

语法

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表.

字段	描述
type	要添加的监视器的类型。值应为vCenter。
vcHost	正在运行vCenter的主机的名称。
vcPort	vCenter运行所在的端口号。
username	vCenterServer的用户名。
password	vCenterServer的密码。
addtoGroup	表示是否应将监视器添加到业务组。值是yes还是no
isHostDCViaVC	指定是否应该使用vCenter凭证进行数据收集。值可以on或off。（可选参数）。
discoverVM	指示如何监控vCenter的虚拟机（VM）的方式。可能的值为： 0-将不会发现VM。 1-将发现VM，但将不监控指标。（不会算作许可） 2-将发现和监控VM。
sslVersion	指定为vCenter配置的SSL版本。这些值可以是以下值之一：SSLv3，TLSv1，TLSv1.1或TLSv1.2。默认值为TLSv1.2。

示例请求

Docker

语法

请求参数

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段	描述
type	要添加的监视器的类型。值应为 Docker.
host	Docker运行所在的主机的名称。
port	Docker运行的端口号。
username	Docker服务器的用户名。
password	Docker服务器的密码。
sslenabled	启用S​​SL的选项。可能的值为true或false。
isAllContainerEnabled	用于发现和监控Docker服务器下可用的所有容器的选项。可能的值为true或false。
isCertificateEnabled	为要监控的Docker服务器启用客户端证书身份验证的选项。可能的值为true或false。
clientCertName	客户证书名称。
keystorePassword	客户端证书使用的密码。

示例请求

没有证书:

有证书:

Kubernetes

语法

API请求中涉及的参数如下所述。另外，请参阅 常见的请求参数列表.

字段	描述
type	要添加的监视器的类型。值应为Kubernetes.
host	Kubernetes集群运行所在的主机的名称。
port	Kubernetes运行所在的端口号。
username	Kubernetes集群的用户名。
password	Kubernetes集群的密码。
mode	Kubernetes的访问方式。
sshPKAuth	启用公共密钥身份验证（仅支持SSH2），即用于SSH身份验证的SSH密钥。
prompt	指定命令提示符值，该值是命令提示符中的最后一个字符。默认值为$，可能的值为>，＃等。
timeout	超时值（以秒为单位）。

示例请求

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=[ PASSWORD ]&pollInterval=[ POLL INTERVAL ]&timeout=[ TIMEOUT ]&discoverVM=[ DISCOVER VM ]

请求参数

API请求中涉及的参数如下所述。另外，请参见公共请求参数列表。

参数	描述
type	您要添加的监视器的类型。该值应为RHEV。
host	运行RHV服务器的主机的名称。
port	RHV服务器运行的端口号。
username	RHV服务器的用户名。
password	RHV服务器的密码。
discoverVM	指示如何监控RHV服务器的虚拟机。可能的值为： 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

Kernel-based Virtual Machine (KVM)

语法:

包括凭证管理

Telnet 模式:

SSH 模式:

API请求中涉及的参数如下所述。另外，请参见公共请求参数列表。

参数	描述
type	您要添加的监视器的类型。该值应为KVM。
Hostname	KVM服务器运行所在的主机的名称。
mode	KVM服务器的监控模式。可能的值为SSH和TELNET。
snmptelnetport	KVM服务器运行的端口号。
username	KVM服务器的用户名。
password	KVM服务器的密码。
AddVM	指示如何监控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 模式:

SSH 模式:

OpenShift

语法

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OpenShift &displayname=[DISPLAYNAME]&host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&mode=SSH&sshPKAuth=[true/false]&prompt=[Prompt]&OSUsername=[OpenShift Username]&OSPassword=[OpenShiftPassword]&timeout=[Timeout in Sec]&apiMode=[true/false]&OSPort=[OS Port]&OSToken=[Service Account Token]

API请求中涉及的参数如下所述。另外，请参见公共请求参数列表。

参数	描述
type	监视器类型。值应为OpenShift。
displayname	监视器的显示名称
host	托管计算机的名称。
port	OpenShift运行所在的端口号。
username	主机服务器的用户名。
password	主机服务器的密码。
mode	认证方式。值应为SSH。
sshPKAuth	是否启用SSH2。值应为true或false。
prompt	指定命令提示符值，该值是命令提示符中的最后一个字符。
OSUsername	OpenShift服务器的用户名。
OSPassword	OpenShift服务器的密码。
apiMode	选择通过REST API收集Openshift环境的主要指标。可能的值为true或false。
OSPort	OpenShift服务器的端口。
OSToken	OpenShift服务器管理员用户的服务帐户令牌。

示例请求

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

使用凭证ID:

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

通过REST API收集主要指标:

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&apiMode=true&OSPort=8443&OSToken=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9

Oracle VM (OVM)

语法

API请求中涉及的参数如下所述。另外，请参见公共请求参数列表。

参数	描述
type	您要添加的监视器的类型。该值应为OVM。
host	OVM服务器运行所在的主机的名称。
port	OVM服务器运行的端口号。
username	OVM服务器的用户名。
password	OVM服务器的密码。
discoverVM	指示如何监控OVM服务器的虚拟机（VM）。可能的值为： 0-将不会发现VM。 1-将发现VM，但将不监控指标。（不会算作许可） 2-将发现和监控VM。
Timeout	Oracle VM Manager的服务器连接超时值（以秒为单位）。

示例请求