How to Configure the Default Compliance Evaluation Schedule

Article
06/30/2016

Applies To: System Center 2012 Configuration Manager, System Center 2012 Configuration Manager SP1, System Center 2012 R2 Configuration Manager

In System Center 2012 R2 Configuration Manager, the site control file maintains configuration for the configuration of the site. These code samples query for the specific site control file item Configuration Management Agent, and change the EvaluationSchedule value to set the client agent evaluation schedule.

To configure the Default Compliance Evaluation Schedule

Set up a connection to the SMS Provider.
Make a connection to the Desired Configuration Management Client Agent section of the site control file by using the SMS_SCI_ClientComp class.
Loop through the array of available properties, making changes as needed.
Commit the changes to the site control file.

Example

The following code example shows how to change the default compliance evaluation schedule for the configuration management client agent.

For information about calling the sample code, see Calling Configuration Manager Code Snippets.

Sub ChangeDCMAgentEvaluationSchedule(swbemServices,    _
                                     swbemContext,     _
                                     siteCode,         _
                                     newAgentSchedule)

    ' The evaluation schedule is defined by a string stored in a schedule token format. 
    ' Detailed information on the schedule token format can be found in the class SMS_ScheduleToken reference material.

    ' Load site control file and get DCM client component section.
swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteCode & """", "Refresh", , , swbemContext
Set swbemInst = swbemServices.Get("SMS_SCI_ClientComp.Filetype=1,Itemtype='Client Component',Sitecode='" & siteCode & "',ItemName='Configuration Management Agent'", , swbemContext)

    ' Loop through the array of embedded SMS_EmbeddedProperty instances for the 
    ' Number of Retries PropertyName. Get its value and display it.
    For Each vProperty In swbemInst.Props

        If vProperty.PropertyName = "EvaluationSchedule" Then

            ' Display DCM client agent evaluation schedule before change.
            Wscript.Echo " "
            Wscript.Echo "Evaluation Schedule - Before Change"
            Wscript.Echo "-----------------------------------"
            Wscript.Echo vProperty.Value2

            ' Set DCM client agent evaluation schedule using the newAgentSchedule variable.
            vProperty.Value2 = newAgentSchedule

            ' Save new client agent settings
            swbemInst.Put_ , swbemContext
            swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteCode & """", "Commit", , , swbemContext

        End If
    Next

    ' Refresh in-memory copy of the site control file and get the DCM client component section.
swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteCode & """", "Refresh", , , swbemContext
Set swbemInst = Nothing

Set swbemInst = swbemServices.Get("SMS_SCI_ClientComp.Filetype=1,Itemtype='Client Component',Sitecode='" & siteCode & "',ItemName='Configuration Management Agent'", , swbemContext)

    For Each vProperty In swbemInst.Props

        If vProperty.PropertyName = "EvaluationSchedule" Then

            ' Sisplay DCM client agent evaluation schedule before change.
            Wscript.Echo " "
            Wscript.Echo "Evaluation Schedule - After Change"
            Wscript.Echo "----------------------------------"
            Wscript.Echo vProperty.Value2

        End If
    Next

End Sub

public void ChangeDCMAgentEvaluationSchedule(WqlConnectionManager connection,
                                             string siteCode,
                                             string newAgentSchedule)
{

    // The evaluation schedule is defined by a string stored in a schedule token format. 
    // Detailed information on the schedule token format can be found in the class SMS_ScheduleToken reference material.

    try
    {
        IResultObject siteDefinition = connection.GetInstance(@"SMS_SCI_ClientComp.FileType=1,ItemType='Client Component',SiteCode='" + siteCode + "',ItemName='Configuration Management Agent'");

        if (siteDefinition.EmbeddedProperties.ContainsKey("EvaluationSchedule"))
        {
            Dictionary<string, IResultObject> WorkingEmbeddedProperties = siteDefinition.EmbeddedProperties; //get temporary copy

            // Display DCM client agent settings before change.
            Console.WriteLine();
            Console.WriteLine("DCM Client Agent Schedule - Before Change");
            Console.WriteLine("-----------------------------------------");             
            Console.WriteLine("Schedule in token format: " + WorkingEmbeddedProperties["EvaluationSchedule"]["Value2"].StringValue);

            // Set DCM client agent setting to new value.
            WorkingEmbeddedProperties["EvaluationSchedule"]["Value2"].StringValue = newAgentSchedule; 
            siteDefinition.EmbeddedProperties = WorkingEmbeddedProperties;

            // Save the settings.
            siteDefinition.Put();

            // Verify change by reconnecting and getting the value again.
            Dictionary<string, IResultObject> WorkingEmbeddedProperties2 = siteDefinition.EmbeddedProperties; //Get temporary copy for change verification.

            // Display DCM client agent settings after change.
            Console.WriteLine();
            Console.WriteLine("DCM Client Agent Schedule - After Change");
            Console.WriteLine("-----------------------------------------");
            Console.WriteLine("Schedule in token format: " + WorkingEmbeddedProperties2["EvaluationSchedule"]["Value2"].StringValue);

        }
    }

    catch (SmsException eX)
    {
        Console.WriteLine("Failed. Error: " + eX.InnerException.Message);
        throw;
    }

}

The example method has the following parameters:

Parameter	Type	Description
connection	Managed: WqlConnectionManager VBScript: SWbemServices	A valid connection to the SMS Provider.
swbemContext	VBScript: SWbemContext	A valid context object. For more information, see How to Add a Configuration Manager Context Qualifier by Using WMI.
siteCode	Managed: String VBScript: String	The site code.
newAgentSchedule	Managed: String VBScript: String	The new schedule in string format. See Configuration Manager Schedules for more information.

Compiling the Code

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.

.NET Framework Security

For more information about securing Configuration Manager applications, see Securing Configuration Manager Applications.

Share via