How to Change the Maintenance Window Properties for a Collection
Updated: November 1, 2013
Applies To: System Center 2012 Configuration Manager, System Center 2012 Configuration Manager SP1, System Center 2012 R2 Configuration Manager
You can change maintenance window properties for a collection, in System Center 2012 R2 Configuration Manager, by using the SMS_CollectionSettings Server WMI Class and SMS_ServiceWindow Server WMI Class classes and properties.
To change the properties of a maintenance window
Set up a connection to the SMS Provider. For more information, see About the SMS Provider in Configuration Manager.
Get the existing collection settings instance by using the existing collection ID provided.
Get the existing service window object by using the existing service window ID provided.
Change an existing property value (in this case the maintenance window description).
Save the collection settings instance and properties.
Note |
|---|
The steps in the example method include additional steps, primarily to handle the overhead of dealing with the service window objects, which are stored as embedded objects in the collection settings instance. |
Example
The following example method changes the properties of a specific maintenance window instance.
Important |
|---|
This assumes that the collection instance can modified. This might not be the case at child sites, where the collections are owned by the parent site(s). |
For information about calling the sample code, see Calling Configuration Manager Code Snippets.
Sub ChangeMaintenanceWindowProperties(connection, _
targetCollectionID, _
targetServiceWindowID, _
newMaintenanceWindowDescription, _
newMaintenanceWindowServiceWindowSchedules, _
newMaintenanceWindowIsEnabled)
' Get the specific collection settings instance.
Set collectionSettingsInstance = connection.Get("SMS_CollectionSettings.CollectionID='" & targetCollectionID &"'" )
' Populate the local array list with the existing service window objects (from the target collection).
tempMaintenanceWindowArray = collectionSettingsInstance.ServiceWindows
' Enumerate through the array list to access each maintenance window object.
For Each maintenanceWindow in tempMaintenanceWindowArray
' If the service window ID matches the one passed in to the function, change the specific values.
If maintenanceWindow.ServiceWindowID = targetServiceWindowID Then
' Populate retrieved SMS_ServiceWindow object with the new maintenance window values.
maintenanceWindow.Description = newMaintenanceWindowDescription
maintenanceWindow.ServiceWindowSchedules = newMaintenanceWindowServiceWindowSchedules
maintenanceWindow.IsEnabled = newMaintenanceWindowIsEnabled
End If
Next
' Replace the existing service window objects from the target collection with the temporary array that includes the modified service window.
collectionSettingsInstance.ServiceWindows = tempMaintenanceWindowArray
' Save the new values in the collection settings instance associated with the collection ID.
collectionSettingsInstance.Put_
' Output success message.
wscript.echo "Maintenance Window " & targetServiceWindowID & " modified."
End Sub
public void ChangeMaintenanceWindowProperties(WqlConnectionManager connection, string targetCollectionID, string serviceWindowID, string newMaintenanceWindowDescription) { try { // Create a new array list to hold the service window objects. List<IResultObject> tempMaintenanceWindowArray = new List<IResultObject>(); // Establish connection to collection settings instance associated with the Collection ID. IResultObject collectionSettings = connection.GetInstance(@"SMS_CollectionSettings.CollectionID='" + targetCollectionID + "'"); // Populate the array list with the existing service window objects (from the target collection). tempMaintenanceWindowArray = collectionSettings.GetArrayItems("ServiceWindows"); // Enumerate through the array list to access each maintenance window object. foreach (IResultObject maintenanceWindow in tempMaintenanceWindowArray) { // If the service window ID matches the one passed in to the function, change the specific values. if (maintenanceWindow["ServiceWindowID"].StringValue == serviceWindowID) { maintenanceWindow["Description"].StringValue = newMaintenanceWindowDescription; break; } } // Replace the existing service window objects from the target collection with the temporary array that includes the new service window. collectionSettings.SetArrayItems("ServiceWindows", tempMaintenanceWindowArray); // Save the new values in the collection settings instance associated with the Collection ID. collectionSettings.Put(); } catch (SmsException ex) { Console.WriteLine("Failed. Error: " + ex.InnerException.Message); throw; } }
Compiling the Code
The C# example requires:
System
System.Collections.Generic
System.ComponentModel
Microsoft.ConfigurationManagement.ManagementProvider
Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine
adminui.wqlqueryengine
microsoft.configurationmanagement.managementprovider
Robust Programming
For more information about error handling, see About Configuration Manager Errors.
.NET Framework Security
For more information about securing Configuration Manager applications, see Securing Configuration Manager Applications.
Software Distribution Maintenance Windows
Software Distribution Packages
Software Distribution Programs
Software Distribution Advertisements
Configuration Manager Collections
Configuration Manager Software Distribution
How to Use Configuration Manager Objects with WMI
How to Use Configuration Manager Objects with Managed Code
How to Connect to an SMS Provider in Configuration Manager by Using Managed Code
How to Connect to an SMS Provider in Configuration Manager by Using WMI
SMS_CollectionSettings Server WMI Class
SMS_ServiceWindow Server WMI Class
Configuration Manager Schedules
How to Create a Schedule Token


The example method has the following parameters:
Parameter
Type
Description
connection
swebemServices
Managed: WqlConnectionManager
VBScript: SWbemServices
A valid connection to the SMS Provider.
targetCollectionID
Managed: String
VBScript: String
The ID of the collection.
serviceWindowID
Managed: String
VBScript: String
The ID of the maintenance window for which to change properties.
newMaintenanceWindowDescription
Managed: String
VBScript: String
The description of the new maintenance window.