Your application can create a System Center 2012 Configuration Manager maintenance window by using the SMS_CollectionSettings Server WMI Class and SMS_ServiceWindow Server WMI Class classes and properties.
To create 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 supplied collection ID.
-
Create and populate the properties of a new service window object by using the SMS_ServiceWindow Server WMI Class class.
-
Add the new SMS_ServiceWindow object to the collection settings instance obtained earlier.
-
Save the collection settings instance and properties.
Note |
---|
The example below includes additional steps, primarily to handle the overhead of dealing with the maintenance window objects, which are stored as embedded objects in the collection settings instance. |
Example
The following example method creates a maintenance window for a collection, assuming 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.
Visual Basic Script | Copy Code |
---|---|
Sub CreateMaintenanceWindow(connection, _ targetCollectionID, _ newMaintenanceWindowName, _ newMaintenanceWindowDescription, _ newMaintenanceWindowServiceWindowSchedules, _ newMaintenanceWindowIsEnabled, _ newMaintenanceWindowServiceWindowType) ' Build a query to get the specified collection. collectionSettingsQuery = "SMS_CollectionSettings.CollectionID='" & targetCollectionID & "'" ' Get the collection settings instance for the targetCollectionID. Set allCollectionSettings = connection.ExecQuery("Select * From SMS_CollectionSettings Where CollectionID = '" & targetCollectionID & "'") ' If a collection settings instance does not exist for the target collection, create one. If allCollectionSettings.Count = 0 Then Wscript.Echo "Creating collection settings instance." Set collectionSettingsInstance = connection.Get("SMS_CollectionSettings").SpawnInstance_ collectionSettingsInstance.CollectionID = targetCollectionID collectionSettingsInstance.Put_ End If ' Get the specific collection settings instance. Set collectionSettingsInstance = connection.Get("SMS_CollectionSettings.CollectionID='" & targetCollectionID &"'" ) ' Create and populate a temporary SMS_ServiceWindow object with the new maintenance window values. Set tempServiceWindowObject = connection.Get("SMS_ServiceWindow").SpawnInstance_ ' Populate temporary SMS_ServiceWindow object with the new maintenance window values. tempServiceWindowObject.Name = newMaintenanceWindowName tempServiceWindowObject.Description = newMaintenanceWindowDescription tempServiceWindowObject.ServiceWindowSchedules = newMaintenanceWindowServiceWindowSchedules tempServiceWindowObject.IsEnabled = newMaintenanceWindowIsEnabled tempServiceWindowObject.ServiceWindowType = newMaintenanceWindowServiceWindowType ' Populate the local array list with the existing service window objects (from the target collection). tempServiceWindowArray = collectionSettingsInstance.ServiceWindows ' Add the newly created service window object to the temporary array. ReDim Preserve tempServiceWindowArray (Ubound(tempServiceWindowArray) + 1) Set tempServiceWindowArray(Ubound(tempServiceWindowArray)) = tempServiceWindowObject ' Replace the existing service window objects from the target collection with the temporary array that includes the new service window. collectionSettingsInstance.ServiceWindows = tempServiceWindowArray ' Save the collection settings instance with the new service window object. collectionSettingsInstance.Put_ ' Output success message. wscript.echo "New Maintenance Window created." End Sub |
C# | Copy Code |
---|---|
public void CreateMaintenanceWindow(WqlConnectionManager connection, string targetCollectionID, string newMaintenanceWindowName, string newMaintenanceWindowDescription, string newMaintenanceWindowServiceWindowSchedules, bool newMaintenanceWindowIsEnabled, int newMaintenanceWindowServiceWindowType) { try { // Create an object to hold the collection settings instance (used to check whether a collection settings instance exists). IResultObject collectionSettingsInstance = null; // Get the collection settings instance for the targetCollectionID. IResultObject allCollectionSettings = connection.QueryProcessor.ExecuteQuery("Select * from SMS_CollectionSettings where CollectionID='" + targetCollectionID + "'"); // Enumerate the allCollectionSettings collection (there should be just one item) and save the instance. foreach (IResultObject collectionSetting in allCollectionSettings) { collectionSettingsInstance = collectionSetting; } // If a collection settings instance does not exist for the target collection, create one. if (collectionSettingsInstance == null) { collectionSettingsInstance = connection.CreateInstance("SMS_CollectionSettings"); collectionSettingsInstance["CollectionID"].StringValue = targetCollectionID; collectionSettingsInstance.Put(); collectionSettingsInstance.Get(); } // Create a new array list to hold the service window object. List<IResultObject> tempServiceWindowArray = new List<IResultObject>(); // Create and populate a temporary SMS_ServiceWindow object with the new maintenance window values. IResultObject tempServiceWindowObject = connection.CreateEmbeddedObjectInstance("SMS_ServiceWindow"); // Populate temporary SMS_ServiceWindow object with the new maintenance window values. tempServiceWindowObject["Name"].StringValue = newMaintenanceWindowName; tempServiceWindowObject["Description"].StringValue = newMaintenanceWindowDescription; tempServiceWindowObject["ServiceWindowSchedules"].StringValue = newMaintenanceWindowServiceWindowSchedules; tempServiceWindowObject["IsEnabled"].BooleanValue = newMaintenanceWindowIsEnabled; tempServiceWindowObject["ServiceWindowType"].IntegerValue = newMaintenanceWindowServiceWindowType; // Populate the local array list with the existing service window objects (from the target collection). tempServiceWindowArray = collectionSettingsInstance.GetArrayItems("ServiceWindows"); // Add the newly created service window object to the local array list. tempServiceWindowArray.Add(tempServiceWindowObject); // Replace the existing service window objects from the target collection with the temporary array that includes the new service window. collectionSettingsInstance.SetArrayItems("ServiceWindows", tempServiceWindowArray); // Save the new values in the collection settings instance associated with the target collection. collectionSettingsInstance.Put(); } catch (SmsException ex) { Console.WriteLine("Failed. Error: " + ex.InnerException.Message); throw; } } |
The example method has the following parameters:
Parameter | Type | Description | |
---|---|---|---|
connection swebemServices |
|
A valid connection to the SMS Provider. |
|
targetCollectionID |
|
The ID of the collection. |
|
newMaintenanceWindowName |
|
The name of the new maintenance window. |
|
newMaintenanceWindowDescription |
|
The description of the new maintenance window. |
|
newMaintenanceWindowServiceWindowSchedules |
|
The service schedules for the new maintenance window. |
|
newMaintenanceWindowIsEnabled |
|
true if the new maintenance window is enabled. |
|
newMaintenanceWindowServiceWindowType |
|
Type for the new maintenance window. |
Compiling the Code
The C# example requires:
Namespaces
System
System.Collections.Generic
System.ComponentModel
Microsoft.ConfigurationManagement.ManagementProvider
Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine
Assembly
adminui.wqlqueryengine
microsoft.configurationmanagement.managementprovider
Robust Programming
For more information about error handling, see About Configuration Manager Errors.
Security
For more information about securing Configuration Manager applications, see Securing Configuration Manager Applications.
See Also
Tasks
How to Connect to an SMS Provider in Configuration Manager by Using Managed CodeHow to Connect to an SMS Provider in Configuration Manager by Using WMI
How to Create a Schedule Token
Reference
SMS_CollectionSettings Server WMI ClassSMS_ServiceWindow Server WMI Class
Concepts
Software Distribution Maintenance WindowsSoftware Distribution Packages
Software Distribution Programs
Software Distribution Advertisements
How to Use Configuration Manager Objects with WMI
How to Use Configuration Manager Objects with Managed Code
Configuration Manager Schedules
Other Resources
Configuration Manager CollectionsConfiguration Manager Software Distribution