ManageEngine® Applications Manager Chapter 10.7.6 AddMonitor API - Services |
||
This section explains how to use the AddMonitor API to add monitors of the category type 'Services'. The following services are supported:
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be 'ActiveDirectory'. |
displayname | The display name of the host in which the monitor is running. |
host | The name of the host in which the Active Directory service is running. |
username | The Active Directory username. |
password | The Active Directory password. |
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be 'DNSMonitor'. |
displayname | The display name of the host in which the monitor is running. |
timeout | The timeout value in seconds. |
SearchField | The value of SearchField. Options include None, Record Name, Address, Additional Name, Target, Admin, Host, Alias, Port and Priority. |
TargetAddress | Host Name / IP Address to connect to the service |
LookupAddress | The address you want to check in the DNS Server. |
RecordType | The expected record type returned for the lookup address. The options include A, AAAA, CNAME, MX, NS, PTR, SOA, SPF, SRV and TXT. |
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be 'FTPMonitor'. |
displayname | The display name of the host in which the monitor is running. |
port | The port number where the FTP/SFTP service is running. |
username | The FTP/SFTP user name. |
password | The FTP/SFTP password. |
TargetAddress | Host Name / IP Address to connect to the service. |
DownloadFile | Indicates if download is enabled. Possible values include yes and no. If you would like to monitor the downloads (mget) through FTP/SFTP while simulateneously downloading the file, specify yes. |
IsSecured | Specifies if the connection is secure or not. Value is either yes or no. |
UploadFile | Indicates if upload file option is enabled. Values include yes and no. If you would like to upload a file to target address, specify yes. |
RemoteSourceFileName | The Remote Source FileName located in the target address. This is applicable only if the value of 'DownloadFile' option is specified as yes. |
RemoteDestinationFileName | The Remote Destination FileName located in the target address. This is applicable only if the value of 'UploadFile' option is specified as yes. |
LocalSourceFileName | The name of the local source file with full path. The file must be available where Applications Manager instance is running. This is applicable only if the value of 'UploadFile' option is specified as yes. |
LocalDestinationFileName | The local destination FileName with full path. The file will download in the given path where Applications Manager instance is running. This field is applicable only if the value of 'DownloadFile' option is specified as yes |
timeout | The timeout value in seconds. |
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be 'JMX Applications'. |
host | The name of the host in which the monitor is running. |
port | The port number where the RMI adapter is running. |
jndiurl | The JNDI name. Example:/jmxrmi |
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be 'LDAP Server'. |
displayname | The display name of the host in which the monitor is running. |
username | The user name of the LDAP server. |
timeout | The timeout value in seconds. |
LDAPServer | The name of the LDAP Server. |
LDAPServerPort | The port at which the LDAP server is running. |
MatchingAttribute | The matching attribute value. Values include cn, uid, sn, displayname, givenname, objectclass, dc and ou |
FilterCondition | The value of filter condition. Values include equals, contains and notequals |
IsSecured | Specifies if the connection is secure or not. Value is either yes or no. |
SearchFilter | The value of Search Filter. This field is optional. |
SearchResult | The string value that matches with search results. |
SearchBase | The value of SearchBase. This is mandatory field when adding a LDAP monitor. |
password | The password of the LDAP server. |
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be 'Ping Monitor'. |
host | The host in which the monitor is running. |
timeout | The timeout value in seconds. |
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be service. |
host | The host in which the monitor is running. |
port | The port number in which the service is running. |
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be SNMP / Network Device. |
host | The host in which the monitor is running. |
port | The port number in which SNMP is running. |
snmpCommunityString | The SNMP community string value. Default value is public. |
timeout | The timeout value in seconds. |
The parameters involved in the API request are described below. Also, refer the list of common Request Parameters.
Field | Description |
---|---|
type | The type of the service you want to add. Value should be telnet. |
host | The host name in which the monitor is running. |
port | The port number in which Telnet is running. |
AddMonitor API - Database Servers |
AddMonitor API - Web Server/Services |