You set the software distribution branding information for the System Center 2012 Configuration Manager client by changing the SWDBrandingSubTitle property of the client agent component section in the site control file.
To customize advertisement branding information
-
Set up a connection to the SMS Provider. For more information, see About the SMS Provider in Configuration Manager.
-
Get the Client Agent site control file Client Component object from SMS_SCI_ClientComp Server WMI Class.
-
Set the SWDBrandingSubtitle property to the value you want.
-
Commit the changes back to the site control file.
Example
The following example method changes the software distribution branding text to the supplied value.
For information about calling the sample code, see Calling Configuration Manager Code Snippets.
Visual Basic Script | Copy Code |
---|---|
Sub SetAdvertBranding(swbemServices, _ swbemContext, _ siteCode, _ brandingText) ' Load the site control file and get the Client Agent section. swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteCode & """", "Refresh", , , swbemContext Query = "SELECT * FROM SMS_SCI_ClientComp " & _ "WHERE ClientComponentName = 'Client Agent' " & _ "AND SiteCode = '" & siteCode & "'" Set SCIComponentSet = swbemServices.ExecQuery(Query, ,wbemFlagForwardOnly Or wbemFlagReturnImmediately, swbemContext) ' Only one instance is returned from the query. For Each SCIComponent In SCIComponentSet ' Loop through the array of embedded SMS_EmbeddedProperty instances. For Each vProperty In SCIComponent.Props ' Setting: SWDBrandingSubTitle If vProperty.PropertyName = "SWDBrandingSubTitle" Then wscript.echo " " wscript.echo vProperty.PropertyName wscript.echo "Current value " & vProperty.Value1 ' Modify the value. vProperty.Value1 = brandingText wscript.echo "New value: " & brandingText End If Next ' Update the component in your copy of the site control file. Get the path ' to the updated object, which could be used later to retrieve the instance. Set SCICompPath = SCIComponent.Put_(wbemChangeFlagUpdateOnly, swbemContext) Next ' Commit the change to the actual site control file. Set InParams = swbemServices.Get("SMS_SiteControlFile").Methods_("CommitSCF").InParameters.SpawnInstance_ InParams.SiteCode = siteCode swbemServices.ExecMethod "SMS_SiteControlFile", "CommitSCF", InParams, , swbemContext End Sub |
C# | Copy Code |
---|---|
public void SetAdvertBranding(WqlConnectionManager connection, string siteCode, string brandingText) { try { // Get the site control file client component section. IResultObject clientAgent = connection.GetInstance(@"SMS_SCI_ClientComp.FileType=1,ItemType='Client Component',SiteCode='" + siteCode + "',ItemName='Client Agent'"); // Update the branding information. Dictionary<string, IResultObject> embeddedProperties = clientAgent.EmbeddedProperties; embeddedProperties["SWDBrandingSubTitle"]["Value1"].StringValue=brandingText; clientAgent.EmbeddedProperties = embeddedProperties; // Commit the change back to the site control file. clientAgent.Put(); } catch (SmsException e) { Console.WriteLine("Failed to set branding text: " + e.Message); throw; } } |
The example method has the following parameters:
Parameter | Type | Description |
---|---|---|
connection swbemServices |
|
A valid connection to the SMS Provider. |
swbemContext |
|
A valid context object. For more information, see How to Add a Configuration Manager Context Qualifier by Using WMI. |
siteCode |
|
The site code for the System Center 2012 Configuration Manager site. |
brandingText |
|
The text used to update the branding text. |
Compiling the Code
This C# example requires:
Namespaces
System
System.Collections.Generic
System.Text
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 Read and Write to the Configuration Manager Site Control File by Using Managed CodeHow to Read and Write to the Configuration Manager Site Control File by Using WMI
Reference
SMS_SCI_Component Server WMI ClassConcepts
Configuration Manager Software DistributionSoftware Distribution Setup and Configuration
About the Configuration Manager Site Control File