Warning: include(analytics.include): failed to open stream: No such file or directory in /home/dleclair/tembria.com/products/api/reference3.html on line 8

Warning: include(): Failed opening 'analytics.include' for inclusion (include_path='.:/usr/local/lib/php:/usr/local/php5/lib/pear') in /home/dleclair/tembria.com/products/api/reference3.html on line 8

Warning: include(header.include): failed to open stream: No such file or directory in /home/dleclair/tembria.com/products/api/reference3.html on line 15

Warning: include(): Failed opening 'header.include' for inclusion (include_path='.:/usr/local/lib/php:/usr/local/php5/lib/pear') in /home/dleclair/tembria.com/products/api/reference3.html on line 15
Tembria Multi-Site Monitor Menu
= Introduction and Overview
= Installation and Deployment
= Frequently Asked Questions
= API Reference
= Configuration Methods
= Device Methods
= Event Monitor Methods
= Graph Data Methods
= Site Methods

Resources
= Pricing and How to Order
= Version History
Tembria API Reference

EventMonitors.asmx

AddMonitorTag(int siteId, ulong eventMonitorId, string tag)
Adds a tag to the specified event monitor.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor.
tag: The tag to be assigned to the event monitor.
CloneMonitor(int siteId, ulong eventMonitorId)
Clones the specified event monitor.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor to be cloned.
returns: The ID for the newly cloned event monitor.
GetDevices(int siteId, ulong eventMonitorId)
Retrieves the list of devices that are assigned to the specified event monitor.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor.
returns: A list of device names that are assigned to the specified event monitor. This list can include tags and group names. Tags are prefixed with "tag:" while groups are prefixed with "group:".
GetMonitorErrorEvents(siteId,eventMonitorId,maxEvents)
Returns error events for the specified event monitor. The returned events are sorted by date time with the most recent events appearing first.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor whose error events will be returned.
maxEvents: Controls the maxium number of events that will be returned. Set this value to zero to return all error events.
returns: An array of EventLog objects.
GetMonitorErrorEventsForDevice(siteId,eventMonitorId,deviceName,maxEvents)
Returns error events for the specified event monitor which are associated with the specified device. The returned events are sorted by date time with the most recent events appearing first.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor whose error events will be returned.
deviceName: The device name for the device whose events will be returned.
maxEvents: Controls the maxium number of events that will be returned. Set this value to zero to return all error events.
returns: An array of EventLog objects.
GetMonitorEvents(siteId,eventMonitorId,maxEvents)
Returns events, both successes and errors, for the specified event monitor. The returned events are sorted by date time with the most recent events appearing first.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor whose events will be returned.
maxEvents: Controls the maxium number of events that will be returned. Set this value to zero to return all error events.
returns: An array of EventLog objects.
GetMonitorEventsByTag(int siteId, string tag, int maxEvents)
Returns events, both successes and errors, for the specified event monitors that match the specified tag. The returned events are sorted by date time with the most recent events appearing first.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
tag: The tag to match on the event monitors.
maxEvents: Controls the maxium number of events that will be returned. Set this value to zero to return all error events.
returns: An array of EventLog objects.
GetMonitorEventsForDevice(siteId,eventMonitorId,deviceName,maxEvents)
Returns events, both successes and errors, for the specified event monitor which are associated with the specified device. The returned events are sorted by date time with the most recent events appearing first.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor whose events will be returned.
deviceName: The device name for the device whose events will be returned.
maxEvents: Controls the maxium number of events that will be returned. Set this value to zero to return all error events.
returns: An array of EventLog objects.
GetMonitorProperties(siteId,eventMonitorId)
Returns an EventMonitorProperties object that includes properties for the event monitor including group name, paused states, last run time, assigned devices, success count, failure count and last status.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor whose properties will be returned.
returns: An EventMonitorProperties object.
GetMonitors(siteId)
Returns an array of EventMonitor objects with the ID, description and group name for all event monitors.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
returns: An array of EventMonitor objects.
GetMonitorsByTag(int siteId, string tag)
Returns an array of EventMonitor objects with the ID, description and group name for all event monitors matching the specified tag.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
tag: The tag to match on the event monitors.
returns: An array of EventMonitor objects.
GetMonitorsInErrorState(siteId)
Returns an array of event monitor IDs for the event monitor that are currently in an error state.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
returns: An array of event monitor IDs.
GetMonitorTags(int siteId, ulong eventMonitorId)
Returns an array of String objects with one string for each assigned tag.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor.
returns: An array of Strings.
PauseMonitor(siteId, eventMonitorId)
Pauses the specified event monitor.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID of the event monitor to be paused.
RemoveMonitorTag(int siteId, ulong eventMonitorId, string tag)
Removes a tag from the specified event monitor.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID for the event monitor.
tag: The tag to be removed from the event monitor.
ResumeMonitor(siteId, eventMonitorId)
Resumes the specified event monitor from a paused state.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID of the event monitor to be resumed.
RunMonitor(siteId, eventMonitorId)
Specifies an event monitor should be queued to run. Event Monitors in a paused state will be ignored.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID of the event monitor to run.
SetDependencies(siteId, eventMonitorId, dependencies, matchByMonitorAndDevice)
Sets the event monitor's dependencies.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID of the event monitor.
dependencies: A comma separated list of event monitor identifiers or an empty value to clear the current dependencies.
matchByMonitorAndDevice: This value controls how the dependency works. If the value is false, the event monitor will not run if the dependencies (event monitors) are in an error state for any reason. When this value is true, the event monitor will not run checks for devices that are in an error state in the dependencies (event monitors) but will run checks for devices that are in a success state in the dependencies (event monitors).
SetDevices(siteId, eventMonitorId, devices)
Assigns a list of devices to the specified event monitor.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID of the event monitor.
devices: A comma separated list of device names to be assigned to the event monitor. If the device does not exist, it will be created automatically. Tags and groups can be assigned too. Tags are prefixed with "tag:" while groups are prefixed with "group:". Groups must include the full path. Ex: "group:\My Servers\Database Servers" NOTE: any currently assigned devices that aren't included, will be unassigned.
SetMonitorDescription(siteId, eventMonitorId, description)
Sets the event monitor's description.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
eventMonitorId: The ID of the event monitor.
description: The new description for the event monitor.