MonitorSite

This element is used pretty widely in the Test Management API to represent a Backbone node.

Derived by

Restricting anyType

Attributes

Name Type Required? Default Description
siteId string Yes   The SiteId uniquely identifies the Backbone node within the Dynatrace Portal.
siteName string No   The SiteName is a human-readable description of the site.
city string No   The city indicates where the Backbone node actually runs (for example, New York, London, Beijing).
state string No   The State indicates a larger region within a country where the Backbone node runs (for example, New Jersey, New York, New Brunswick, Ile de France).
countryCode string No   The country code is a two letter abbreviation for the country where the Backbone node runs.
isPrivate boolean No   This indication is optionally provided by the system. It indicates whether the Backbone node is a private node (dedicated to a particular customer or test activity). If true, the node is private; if false, the node is not private.
status SiteStatusType No   Backbone nodes may have one of three statuses: ACTIVE, INACTIVE, or DELETED. The GetSites query only returns ACTIVE sites.
ipV6Enabled boolean No   This field indicates whether the Backbone node supports IPv6. If true, the node supports IPv4 and IPv6. If false, the node only supports only IPv4.

Content model

Contains elements as defined in the following table.

Component Type Occurs Nillable? Description
SEQUENCE   1..1    
SubstitutionParameters SubstitutionParametersType 0..1 No A SubstitutionParameters collection. A SubstitutionParameters collection is only present in methods dealing with SubstitutionParameters and not in a GetTests() response or a GetSites() response. See SubstitutionParameter for more details.

Referenced by

Example

The following is an example of MonitorSite as it appears in the GetSites query response:

<GetSitesResponse
  xmlns="http://www.gomeznetworks.com/schemas/provisioning">
  <ResponseStatus>SUCCESS</ResponseStatus>
  <MonitorSites>
    <MonitorSite siteId="777" siteName="TPN7 - MA: Boston"
        city="Lexington" state="MA" countryCode="US"
        ipV6Enabled="false"/>
    <MonitorSite siteId="850" siteName="TPN1 - Boston MA - SAVVIS"
        city= "WALTHAM" state="MA" countryCode="US" ipV6Enabled="true"/>
    <MonitorSite siteId="865" siteName="TPN12 - Beijing China test"
        city="Beijing" state="" countryCode="CN" ipV6Enabled="false"/>
  </MonitorSites>
</GetSitesResponse>

In the previous example, all of attributes of MonitorSite are populated, as the GetSites() query exists to provide this kind of information. However, in other types of provisioning request, where you are sending a MonitorSite element, only siteId is required, as this field uniquely identifies a Backbone node in the Dynatrace Portal network.

Here is MonitorSite as it appears in a ProvisionTestsRequest:

<prov:ProvisionTestsRequest>
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:MultiStepMonitors>
      <prov:MultiStepMonitor name="EG 10-05-2012 001  Hotmail Authentication
        with Params" folder="Hotmail Authentication" agentType="IE"
        frequencyInMins="60" monitorStatus="Inactive"
        scriptId="326334" ipVersion="IPv6_preferred">
       <prov:MonitorSites>
          <prov:MonitorSite siteId="880"/>
       </prov:MonitorSites>
      </prov:MultiStepMonitor>
   </prov:MultiStepMonitors>
</prov:ProvisionTestsRequest>

Here is MonitorSite as it appears in an UpdateTests request:

<prov:UpdateTestsRequest>
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:Monitors>
      <prov:Monitor name="eg_2012-08-16T13:11:50.460_FF 2"
        folder="ws_provision" agentType="FF" summaryFlag="Off"
        includeRenderTimeFlag="Off" frequencyInMins="5" ipVersion="IPv6_preferred"
        monitorStatus="Active" folderStatus="Active" monitorId="306528"
        createDate="2012-08-16T18:58:17.513" modifyDate="2012-08-16T18:58:17.52"
        scriptId="306528">
         <prov:MonitorSites>
            <prov:MonitorSite siteId="884" />
            <prov:MonitorSite siteId="885" />
            <prov:MonitorSite siteId="886" />
            <prov:MonitorSite siteId="887" />
         </prov:MonitorSites>
         <prov:Steps>
            <prov:Step stepSeqNum="0">
               <prov:URL>http://www.google.com</prov:URL>
               <prov:DisplayName/>
             </prov:Step>
         </prov:Steps>
      </prov:Monitor>
   </prov:Monitors>
</prov:UpdateTestsRequest>

Here is MonitorSite as it appears in an UpdateTestsParameters Request:

<prov:UpdateTestParametersRequest>
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <!--1 or more repetitions:-->
   <prov:PartialUpdate monitorId="326334">
      <prov:MonitorSites>
         <prov:MonitorSite siteId="777"/>
         <prov:MonitorSite siteId="865"/>
      </prov:MonitorSites>
   </prov:PartialUpdate>
</prov:UpdateTestParametersRequest>

In the web methods provided for managing the substitution parameters, the MonitorSite elements also contain information about the site-level substitution parameters. This is shown in the ParameterizedMonitor element displayed below:

<ParameterizedMonitor monitorId="328430"
 createDate="2012-11-13T21:27:29.513"
 modifyDate="2012-11-21T18:57:53.393"
 monitorStatus="Active">
<SubstitutionParameters>
  <SubstitutionParameter id="0" name="UserName"
      value="Updated User 11/05/2012 2:56:05 PM"/>
  <SubstitutionParameter id="1" name="Password"
      value="erics"/>
 </SubstitutionParameters>
  <MonitorSites>
   <MonitorSite siteId="865">
    <SubstitutionParameters>
      <SubstitutionParameter id="0" name="UserName" value="user2"/>
      <SubstitutionParameter id="1" name="Password" value="password2"/>
    </SubstitutionParameters>
   </MonitorSite>
   <MonitorSite siteId="880">
    <SubstitutionParameters>
     <SubstitutionParameter id="0" name="UserName" value="user3"/>
     <SubstitutionParameter id="1" name="Password" value="password3"/>
    </SubstitutionParameters>
   </MonitorSite>
  <MonitorSite siteId="886"/>
 </MonitorSites>
</ParameterizedMonitor>