OneTimeMaintenanceWindow

A OneTimeMaintenanceWindow appears in a GetMaintenanceWindowsResponse, an AddOrUpdateMaintenanceWindowsRequest, and a ApplyMaintenanceWindowTemplateRequest. In each context, it represents a definition of a non-recurring maintenance window.

Derived by

Restricting anyType

Attributes

Name Type Required? Default Description
beginDate dateTime Yes The date and time when the one-time maintenance window starts (i.e., the moment in time when testing is suspended.)
endDate dateTime Yes The date and time when the one-time maintenance window stops (i.e., the moment in time when testing resumes).

Content model

Always empty

Referenced by

Example

Here are OneTimeMaintenanceWindows as they appear in a GetMaintenanceWindowsResponse:

<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">
      <OneTimeMaintenanceWindows>
         <OneTimeMaintenanceWindow beginDate="2012-11-09T15:03:42"
                                   endDate="2012-11-10T18:03:42"/>
         <OneTimeMaintenanceWindow beginDate="2012-11-15T15:03:42"
                                   endDate="2012-11-16T18:03:42"/>
      </OneTimeMaintenanceWindows>
   </MaintenanceWindowMonitor>
   <MaintenanceWindowMonitor monitorId="309545" createDate="2012-09-20T20:26:01.157"
      modifyDate="2012-09-20T20:26:01.18" monitorStatus="Active">
      <OneTimeMaintenanceWindows>
         <OneTimeMaintenanceWindow beginDate="2012-11-15T15:03:42"
                                   endDate="2012-11-10T18:03:42"/>
         <OneTimeMaintenanceWindow beginDate="2012-11-16T15:03:42"
                                   endDate="2012-11-16T18:03:42"/>
         <OneTimeMaintenanceWindow beginDate="2012-11-17T15:03:42"
                                   endDate="2012-11-16T18:03:42"/>
      </OneTimeMaintenanceWindows>
   </MaintenanceWindowMonitor>
</GetMaintenanceWindowsResponse>

Here are OneTimeMaintenanceWindows as they appear in an AddOrUpdateMaintenanceWindowsRequest:

<prov:AddOrUpdateMaintenanceWindowsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
     <prov:UserName>erics</prov:UserName>
     <prov:Password>erics</prov:Password>
   </prov:Credentials>
   <!--1 or more repetitions:-->
   <prov:MaintenanceWindowMonitor monitorId="263717">
      <!--Optional:-->
      <prov:OneTimeMaintenanceWindows>
         <!--Zero or more repetitions:-->
         <prov:OneTimeMaintenanceWindow beginDate="2012-11-09T15:03:42"
            endDate="2012-11-10T18:03:42"/>
         <prov:OneTimeMaintenanceWindow beginDate="2012-11-15T15:03:42"
            endDate="2012-11-16T18:03:42"/>
      </prov:OneTimeMaintenanceWindows>
   </prov:MaintenanceWindowMonitor>
</prov:AddOrUpdateMaintenanceWindowsRequest>

In the next example, OneTimeMaintenanceWindows appear in an ApplyMaintenanceWindowTemplateRequest. In the previous example, each OneTimeMaintenanceWindow element was applied to only one monitor (the one designated in its enclosing MaintenanceWindowMonitor element), in the following example, the OneTimeMaintenanceWindow is applied to multiple monitors. This may be a very common use case, since a planned outage can very easily impact multiple monitors:

<prov:ApplyMaintenanceWindowTemplateRequest    xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <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:OneTimeMaintenanceWindows>
      <prov:OneTimeMaintenanceWindow beginDate="2012-11-15T15:03:42"
         endDate="2012-11-10T18:03:42"/>
      <prov:OneTimeMaintenanceWindow beginDate="2012-11-16T15:03:42"
         endDate="2012-11-16T18:03:42"/>
      <prov:OneTimeMaintenanceWindow beginDate="2012-11-17T15:03:42"
         endDate="2012-11-16T18:03:42"/>
   </prov:OneTimeMaintenanceWindows>
</prov:ApplyMaintenanceWindowTemplateRequest>