RecurringMaintenanceWindow

A RecurringMaintenanceWindow element represents the definition of a maintenance window, one that recurs once every week.

Derived by

Restricting anyType

Attributes

Name Type Required? Default Description
dayOfWeek DayType Yes The day of the week the maintenance window recurs.
startTime time Yes The time of day when testing is suspended.
endTime time Yes The time of day when testing resumes.

Content model

Always empty

Referenced by

Remarks

An example of the RecurringMaintenanceWindows as they appear in a GetMaintenanceWindowsResponse. Note that there can be several of these under a given account if a recurring maintenance window is defined as an account preference and applied globally. In that case, every new monitor has a recurring maintenance window provisioned.

<GetMaintenanceWindowsResponse
   xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <ResponseStatus>SUCCESS</ResponseStatus>
   <MaintenanceWindowMonitor monitorId="263717" createDate="2012-07-19T14:14:18.653"
   modifyDate="2012-11-27T20:27:13.88" monitorStatus="Inactive">
      <RecurringMaintenanceWindows>
         <RecurringMaintenanceWindow dayOfWeek="SUN"
            startTime="21:50:00.0000000-05:00" endTime="22:50:00.0000000-05:00"/>
         <RecurringMaintenanceWindow dayOfWeek="SAT"
            startTime="00:00:00.0000000-05:00" endTime="01:20:00.0000000-05:00"/>
      </RecurringMaintenanceWindows>
   </MaintenanceWindowMonitor>
   <MaintenanceWindowMonitor monitorId="328430" createDate="2012-11-13T21:27:29.513"
         modifyDate="2012-11-21T18:57:53.393" monitorStatus="Active">
      <RecurringMaintenanceWindows>
         <RecurringMaintenanceWindow dayOfWeek="SAT"
            startTime="21:50:00.0000000-05:00" endTime="22:50:00.0000000-05:00"/>
      </RecurringMaintenanceWindows>
   </MaintenanceWindowMonitor>
</GetMaintenanceWindowsResponse>

An example of the RecurringMaintenanceWindows as they appear in an AddOrUpdateMaintenanceWindowsRequest:

<prov:AddOrUpdateMaintenanceWindowsRequest    xmlns="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:MaintenanceWindowMonitor monitorId="326334"
         xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
      <prov:RecurringMaintenanceWindows>
         <prov:RecurringMaintenanceWindow dayOfWeek="SAT"
            startTime="01:00:00.0000000-04:00" endTime="02:20:00.0000000-04:00"/>
         <prov:RecurringMaintenanceWindow dayOfWeek="SUN"
            startTime="21:50:00.0000000-05:00" endTime="22:50:00.0000000-05:00"/>
      </prov:RecurringMaintenanceWindows>
   </prov:MaintenanceWindowMonitor>
   <prov:MaintenanceWindowMonitor monitorId="263717"
         xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
      <prov:RecurringMaintenanceWindows>
         <prov:RecurringMaintenanceWindow dayOfWeek="SAT"
            startTime="01:00:00.0000000-04:00" endTime="02:20:00.0000000-04:00"/>
         <prov:RecurringMaintenanceWindow dayOfWeek="SUN"
            startTime="21:50:00.0000000-05:00" endTime="22:50:00.0000000-05:00"/>
      </prov:RecurringMaintenanceWindows>
   </prov:MaintenanceWindowMonitor>
</prov:AddOrUpdateMaintenanceWindowsRequest>

In the previous example, each RecurringMaintenanceWindow element is applied to only one monitor (the one designated in its enclosing MaintenanceWindowMonitor element). In the next example, where a RecurringMaintenanceWindow appears in an ApplyMaintenanceWindowTemplateRequest, it is applied to multiple monitors. This is a common use case, since a planned outage can easily impact multiple monitors:

<prov:ApplyMaintenanceWindowTemplateRequest>
   <prov:Credentials>
      <prov:UserName>erics</prov:UserName>
      <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <prov:MonitorIds>
      <prov:MonitorId>326334</prov:MonitorId>
      <prov:MonitorId>328141</prov:MonitorId>
      <prov:MonitorId>328196</prov:MonitorId>
   </prov:MonitorIds>
   <prov:RecurringMaintenanceWindows>
      <prov:RecurringMaintenanceWindow dayOfWeek="MON"
         startTime="03:00:00.0000000-05:00" endTime="04:00:00.0000000-05:00"/>
   </prov:RecurringMaintenanceWindows>
</prov:ApplyMaintenanceWindowTemplateRequest>