Warning: include(analytics.include): failed to open stream: No such file or directory in /home/dleclair/tembria.com/products/api/reference2.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/reference2.html on line 8

Warning: include(header.include): failed to open stream: No such file or directory in /home/dleclair/tembria.com/products/api/reference2.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/reference2.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

Devices.asmx

AddDevice(siteId, groupName, deviceName, displayName)
Adds a new network device.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
groupName: The full path to the group where the device will be added. For example "\My Servers\Database Servers". This value must refer to a group that already exists.
deviceName: The name or address of the device to be added. This is the network name of the device that will be added. If an existing device has the same name or display name, the operation will fail.
displayName: The display name for the device which controls how it is displayed in the user interface. Set this value to the same value as the deviceName if no display name is required.
AddDeviceGroup(siteId, groupName)
Adds a new device group.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
groupName: The full path to where the group will be added including the new group name. For example "\My Servers\Database Servers". The new group must be a direct child of an existing group. For example, to add "\My Servers\Database Servers" the group "\My Servers" must already exist.
AddDeviceTag(int siteId, string deviceName, string tag)
Adds a tag to the specified device.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The device name of the device.
tag: The tag to be assigned to the device.
GetDeviceErrorEvents(siteId, deviceName, maxEvents)
Returns error events for 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.
deviceName: The name of the device to retrieve the events for.
maxEvents: Controls the maxium number of events that will be returned. Set this value to zero to return all error events for the device.
returns: An array of EventLog objects.
GetDeviceEvents(siteId, deviceName, maxEvents)
Returns events for 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.
deviceName: The name of the device to retrieve the events for.
maxEvents: Controls the maxium number of events that will be returned. Set this value to zero to return all error events for the device.
returns: An array of EventLog objects.
GetDevicesEventsByTag(int siteId, string tag, int maxEvents)
Returns events for the devices 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 device tag to filter on.
maxEvents: Controls the maxium number of events that will be returned. Set this value to zero to return all error events for the matching devices.
returns: An array of EventLog objects.
GetDeviceGroups(siteId)
Returns an array of Strings with one string for each device group that has been created.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
returns: An array of String objects
GetDeviceProperties(siteId, deviceName)
Returns a DeviceProperties object with the device name, display name, IP address, notes, type, group name, and paused statuses.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The name of the device to retrieve the promperties for.
returns: A DeviceProperties object
GetDeviceTags(int siteId, string deviceName)
Returns an array of Strings with one string for each assigned tag.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The name of the device to retrieve the tags for.
returns: A array of Strings
GetDevices(siteId)
Returns an array of Device objects each of which has the device name, display name and group name for the device.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
returns: An array of Device objects
GetDevicesByTag(int siteId, string tag)
Returns an array of Device objects each of which has the device name, display name and group name for the devices 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 devices.
returns: An array of Device objects
GetDevicesInErrorState(siteId)
Returns an array of strings containing the device names for all devices 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 String objects
GetDevicesInGroup(siteId,groupName)
Returns an array of strings containing the device names for all devices in the specified group.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
groupName: The full path to the group where the devices are stored. For example "\My Servers\Database Servers".
returns: An array of String objects
GetDevicesStatus(siteId)
Returns an array of DeviceStatus objects, each indicating whether or not the device is currently in a success or failure state.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
returns: An array of DeviceStatus objects
GetDevicesStatusByTag(int siteId, string tag)
Returns an array of DeviceStatus objects for each device the tag matches. Each DeviceStatus object indicates whether or not the device is currently in a success or failure state.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
tag: The tag to match on the devices.
returns: An array of DeviceStatus objects
GetDeviceSubGroups(siteId, groupName)
Returns an array of String objects containing each of the subgroups of the specified group.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
groupName: The full path to the group where the subgroups are stored. For example "\My Servers\Database Servers".
returns: An array of String objects
GetPausedDevices(siteId)
Returns an array of String objects containing the device names of all paused devices.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
returns: An array of String objects
MoveDevice(siteId,deviceName,newGroupName)
Moves the specified device to the specified group name. The group name must already exist.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The device to be moved.
newGroupName: The group to which the device will be moved. For example "\My Servers\Database Servers".
PauseDevice(siteId,deviceName)
Pauses the specified device. Event monitors do not check devices that are paused.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The device to be paused.
PauseDeviceGroup(siteId,groupName)
Pauses all of the devices in the specified group. Event monitors do not check devices that are paused.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
groupName: The group whose devices will be paused. For example "\My Servers\Database Servers".
RemoveDevice(siteId,deviceName)
Removes a device. When the device is removed it will be removed from all event monitors that it was assigned to and all of its events will be removed.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The name of the device to be removed.
RemoveDeviceGroup(siteId,groupName)
Removes a device group and all devices underneath it. When devices are removed they will be removed from all event monitors that they were assigned to and all of their events will be removed.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
groupName: The name of the device group to be removed. For example "\My Servers\Database Servers".
RemoveDeviceTag(int siteId, string deviceName, string tag)
Removes a tag from the specified device.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The device name of the device.
tag: The tag to remove from the device.
RenameDeviceGroup(siteId,originalGroupName,newGroupName)
Renames or moves a device group. To rename a group, leave it under the same parent group. For example use "\My Servers\Old Group Name" and "\My Servers\New Group Name" for the group name parameters. To move a group, specify a complete new path for the group. For example use "\My Servers\Old Group Name" and "\My Workstations\New Group Name".
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
originalGroupName: The name of the device group to be renamed or moved. For example "\My Servers\Old Group Name".
originalGroupName: The new name for the group. For example "\My Servers\New Group Name".
ResumeDevice(siteId,deviceName)
Resumes the specified device from a paused state. This allows Event monitors to check them.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The device to be resumed.
ResumeDeviceGroup(siteId,groupName)
Resumes all of the devices in the specified group from a paused state. This allows Event monitors to check them.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
groupName: The group whose devices will be resumed.
SetDeviceDisplayName(siteId,deviceName,displayName)
Sets the display name for the specified device. If you do not wish to assign a display name, set the display name to the same value as the device name.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The device whose display name will be set.
displayName: The display name to assign to the device..
SetDeviceNotes(siteId,deviceName,notes)
Sets the notes field for the specified device.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The device whose display name will be set.
notes: The notes field to assign to the device.
SetDeviceType(siteId,deviceName,deviceType)
Sets the type field for the specified device.
siteId: A numeric value identifying the site. For Tembria Server Monitor this value must be 1.
deviceName: The device whose display name will be set.
deviceType: The type field to assign to the device.