|
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
Sites.asmx
| AddSite(groupName, siteName) |
| Adds a new site. For Tembria Multi-Site Monitor only. |
| groupName: |
The full path to the group where the site will be added. For example "\My Colocations\East Coast". This value must refer to a group that already exists. |
| siteName: |
The name of the site to be added. If an existing site has the same name, the operation will fail. |
| AddSiteGroup(groupName) |
| Adds a new site group. For Tembria Multi-Site Monitor only. |
| groupName: |
The full path to where the group will be added including the new group name. For example "\MyColocations\Ottawa". The new group must be a direct child of an existing group. For example, to add "\My Colocations\East Coast" the group "\My Colocations" must already exist. |
| GetSite(siteId) |
| Returns a SiteProperties object for the specified site which has the site name, identifier, notes, group name, pause status, IP address, the last results update time and the last configuration update time. |
| siteId: |
A numeric value identifying the site. For Tembria Server Monitor this value must be 1. |
| returns: |
A SiteProperties object. |
| GetSiteErrorEvents(siteId, maxEvents) |
| Returns error events for the specified site. 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. |
| maxEvents: |
Controls the maxium number of events that will be returned. Set this value to zero to return all error events for the site. |
| returns: |
An array of EventLog objects. |
| GetSiteEvents(siteId, maxEvents) |
| Returns events for the specified site. 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. |
| maxEvents: |
Controls the maxium number of events that will be returned. Set this value to zero to return all error events for the site. |
| returns: |
An array of EventLog objects. |
| GetSiteGroups(siteId) |
| Returns an array of Strings with one string for each site 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 |
| GetSiteId(siteName) |
| Returns a numeric value identifying the specified site. If the site does not exist, it will be created using the given siteName and stored in the root site group. |
| siteName: |
The name of the site to retrieve the identifier for. |
| returns: |
The site identifier. |
| GetSites() |
| Returns an array of Site objects each of which has the site name, identifier and group name for the site. |
| returns: |
An array of Site objects |
| GetSitesInErrorState() |
| Returns an array of integers containing the identifiers for all sites currently in an error state. |
| returns: |
An array of integers. |
| GetSitesInGroup(groupName) |
| Returns an array of integers containing the identifiers for all sites in the specified group. |
| groupName: |
The full path to the group where the sites are stored. For example "\My Colocations\East Coast". |
| returns: |
An array of integers. |
| GetSiteSubGroups(groupName) |
| Returns an array of String objects containing each of the subgroups of the specified group. |
| groupName: |
The full path to the group where the subgroups are stored. For example "\My Colocations\East Coast". |
| returns: |
An array of String objects |
| MoveSite(siteId,newGroupName) |
| Moves the specified site to the specified group name. The group name must already exist. |
| siteId: |
A numeric value identifying the site to be moved. For Tembria Server Monitor this value must be 1. |
| newGroupName: |
The group to which the site will be moved. For example "\My Colocations\East Coast". |
| PauseSite(siteId) |
| Pauses the specified site. Event monitors are not checked in paused sites. |
| siteId: |
A numeric value identifying the site to be paused. For Tembria Server Monitor this value must be 1. |
| PauseSiteGroup(groupName) |
| Pauses all of the sites in the specified group. Event monitors are not checked in paused sites. |
| groupName: |
The group whose sites will be paused. For example "\My Colocations\East Coast". |
| RemoveSiteGroup(groupName) |
| Removes a site group and all sites underneath it. |
| groupName: |
The name of the site group to be removed. For example "\My Colocations\East Coast". |
| RenameSiteGroup(originalGroupName,newGroupName) |
| Renames a site group. To rename a site, leave it under the same parent group. For example use "\My Colocations\Old Group Name" and "\My Colocations\New Group Name" for the group name parameters. |
| originalGroupName: |
The name of the site group to be renamed. For example "\My Colocations\Old Group Name". |
| originalGroupName: |
The new name for the group. For example "\My Colocations\New Group Name". |
| ResumeSite(siteId) |
| Resumes the specified site from a paused state. This allows Event monitors that belong to the site to run again. |
| siteId: |
A numeric value identifying the site to resume from a paused state. For Tembria Server Monitor this value must be 1. |
| ResumeSiteGroup(groupName) |
| Resumes all of the sites in the specified group from a paused state. This allows Event monitors that belong to the sites to run again. |
| groupName: |
The group whose sites will be resumed. For example "\My Colocations\East Coast". |
|