本节说明如何使用添加监视器API添加邮件服务器类别类型的监视器。支持以下监视器:
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &host=[HOST]&username=[USERNAME]&password=[PASSWORD]&version=[VERSION]&ServerRole[2019/2016/2013/2010/2007]=[ServerRole]&UsePowershell=[USEPOWERSHELL]
API请求中涉及的参数如下所述。另外,请参阅 常见的请求参数列表.
字段 | 描述 |
---|---|
type | 要添加的邮件服务器的类型。值应为 Exchange Server。 |
host | 运行Exchange服务器的主机的名称。 |
username | 运行Exchange服务器的系统的用户名。 |
password | 运行Exchange服务器的系统的密码。 |
version | Exchange服务器版本。支持的版本是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用于数据收集,请使用是,否则使用否。此参数是强制性的。 |
http://prod-server6:9090/AppManager/xml/AddMonitor?apikey=2712f158d675135e9b3d81d9efd533c0&type=Exchange Server&displayname=apmexchange&host=emp-ex03&username=exchange\administrator&password=admin123&version=2019&ServerRole2019=mbxserver2019&UsePowershell=Yes
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&displayname=[DISPLAYNAME] &host=[HOST]&port=[PORT]&username=[USERNAME]&password=[PASSWORD]&version=[VERSION]
API请求中涉及的参数如下所述。另外,请参阅 常见的请求参数列表.
字段 | 描述 |
---|---|
type | 要添加的监视器的类型。值应为 Mail Server。 |
host | 邮件服务器运行所在的主机的名称。 |
port | SMTP端口号 |
emailid | 邮件服务器中可用的电子邮件ID。 |
timeout | 超时值(以秒为单位)。 |
mailMsg | 该消息出现在电子邮件的主题中。 |
mailSubject | 邮件主题中显示的消息。 |
smtpauth | 使用 smtpauth = true 选项启用SSL。 |
username password |
如果SMTP服务器需要身份验证,请指定用户名和密码 |
sslEnabled | 使用 SSLEnabled = true 选项启用SSL。 |
tlsEnabled | 使用 tlsEnabled = true 启用TLS以保护数据传输。 |
popenabled | 如果用于选择POP作为邮件提取服务器,请使用 popenabled = true。 |
fetchEnabled | 指定 fetchEnabled = true 以启用POP或IMAP邮件提取服务器。 |
popPort | 如果POP / Imap服务位于其他主机中,请指定其运行POP服务的POP / Imap端口。 |
popUserName popPassword |
如果POP / Imap服务位于其他主机中,请提供POP服务的身份验证详细信息用户名和密码。 |
popSSLEnabled | 使用 popSSLEnabled = true 启用SSL以保护POP/Imap中的数据传输 |
popTLSEnabled | 使用 poptlsEnabled = true 启用TLS,以保护POP/Imap中的数据传输。 |
fetchType | 选择邮件提取服务器。值为 POP 和 IMAP。 |
fsHost | 邮件提取服务器POP / IMAP主机。 |
fsport | 邮件提取服务器POP / IMAP端口。 |
fsSSLEnabled | 使用 fsSSLEnabled = true 选项启用SSL。 |
fsTLSEnabled | 使用 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.