How to Enable or Disable the Software Distribution Advertised Programs Client Agent
Updated: November 1, 2013
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 site. This topic shows how to enable or disable the Software Distribution Advertised Programs Client Agent setting in the site control file. Details about reading from and writing to the site control file are discussed in the Configuration Manager Site Control File section of the Configuration Manager SDK.
Caution |
|---|
You should be experienced in managing a site's configuration before using the SMS Provider classes to modify the site configuration. You should use caution or avoid using the SMS_SCI_FileDefinition and SMS_SCI_SiteDefinition classes altogether. These classes manage the site control file itself. You can cause significant damage to a site by changing some configurable items. |
To enable or disable the client agent
Set up a connection to the SMS Provider. For more information, see About the SMS Provider in Configuration Manager.
Make a connection to the software distribution client component section of the site control file by using the SMS_SCI_ClientComp class.
Adjust the client agent settings by setting the flag value to 0 to disable the agent or 1 to enable the agent.
Commit the property changes to the site control file.
Example
The following example method queries for the specific site control file item, software distribution client component section, and changes the flag value to enable or disable the client agent.
For information about calling the sample code, see Calling Configuration Manager Code Snippets.
Sub EnableDisableSWDClientAgent(swbemServices, swbemContext, enableDisableFlag, siteToChange )
' Load site control file and get SWD client component section.
swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteToChange & """", "Refresh", , , swbemContext
Set objSWbemInst = swbemServices.Get("SMS_SCI_ClientComp.Filetype=1,Itemtype='Client Component',Sitecode='" & siteToChange & "',ItemName='Software Distribution'", , swbemContext)
' Display SWD client agent settings before change
Wscript.Echo " "
Wscript.Echo "Properties - Before Change"
Wscript.Echo "---------------------------"
Wscript.Echo objSWbemInst.ClientComponentName
Wscript.Echo objSWbemInst.Flags & " (0 = Disabled, 1 = Enabled)"
' Set SWD client agent by setting Flags value to 0 or 1 using the sEnableDisableFlag variable.
objSWbemInst.Flags = enableDisableFlag
' Save new client agent settings.
objSWbemInst.Put_ , swbemContext
swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteToChange & """", "Commit", , , swbemContext
' Refresh in-memory copy of the site control file and get the DCM client component section.
swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteToChange & """", "Refresh", , , swbemContext
Set objSWbemInst = swbemServices.Get("SMS_SCI_ClientComp.Filetype=1,Itemtype='Client Component',Sitecode='" & siteToChange & "',ItemName='Software Distribution'", , swbemContext)
' Display SWD client agent settings after change.
Wscript.Echo " "
Wscript.Echo "Properties - After Change"
Wscript.Echo "---------------------------"
Wscript.Echo objSWbemInst.ClientComponentName
Wscript.Echo objSWbemInst.Flags & " (0 = Disabled, 1 = Enabled)"
End Sub
public void EnableDisableSWDClientAgent(WqlConnectionManager connection, string enableDisableFlag, string siteCode) { try { IResultObject siteDefinition = connection.GetInstance(@"SMS_SCI_ClientComp.FileType=1,ItemType='Client Component',SiteCode='" + siteCode + "',ItemName='Software Distribution'"); // Display SWD client agent settings before change. Console.WriteLine(); Console.WriteLine("Properties - Before Change"); Console.WriteLine("---------------------------"); Console.WriteLine(siteDefinition["ClientComponentName"].StringValue); Console.WriteLine(siteDefinition["Flags"].StringValue + " (0 = Disabled, 1 = Enabled)"); // Set SWD client agent by setting "Flags" value to 0 or 1 using the enableDisableFlag variable. siteDefinition["Flags"].StringValue = enableDisableFlag; // Save the settings. siteDefinition.Put(); // Verify change by reconnecting and getting the value again. IResultObject siteDefinition2 = connection.GetInstance(@"SMS_SCI_ClientComp.FileType=1,ItemType='Client Component',SiteCode='" + siteCode + "',ItemName='Software Distribution'"); // Display SWD client agent settings after change. Console.WriteLine(); Console.WriteLine("Properties - After Change"); Console.WriteLine("--------------------------"); Console.WriteLine(siteDefinition2["ClientComponentName"].StringValue); Console.WriteLine(siteDefinition2["Flags"].StringValue + " (0 = Disabled, 1 = Enabled)"); } 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.
Configuration Manager Software Distribution
Software Distribution Setup and Configuration
About the Configuration Manager Site Control File
How to Read and Write to the Configuration Manager Site Control File by Using Managed Code
How to Read and Write to the Configuration Manager Site Control File by Using WMI
SMS_SCI_Component Server WMI Class

The example method has the following parameters:
Parameter
Type
Description
connection
swbemServices
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.
enableDisableFlag
Managed: String
VBScript: String
Flag to enable or disable the client agent.
siteCode
siteToChange
Managed: String
VBScript: String
The site code.