How to Configure Heartbeat Discovery

Article
2022-10-04

In Configuration Manager, you configure the Heartbeat Discovery settings by modifying the necessary site control file settings.

To configure Heartbeat Discovery

Set up a connection to the SMS Provider.
Make a connection to the Heartbeat Discovery section of the site control file by using the SMS_SCI_Component class.
Loop through the array of available properties, making changes as needed.
Commit the changes to the site control file.

Example

The following example sets the Heartbeat Discovery settings by using the SMS_SCI_Component class to connect to the site control file and change properties.

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


Sub ConfigureHeartbeatDiscoverySettings1(swbemServices,                       _  
                                         swbemContext,                        _  
                                         siteCode,                            _  
                                         serverName,                          _  
                                         newHeartbeatSiteControlFileSchedule)  

    ' Load site control file and get the SMS_SITE_CONTROL_MANAGER section.  
    swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteCode & """", "Refresh", , , swbemContext                     

    Query = "SELECT * FROM SMS_SCI_Component " &                         _  
    "WHERE ItemName = 'SMS_SITE_CONTROL_MANAGER|" & serverName & "' " &  _     
    "AND SiteCode = '" & siteCode & "'"  

    ' Get the SMS Software Update Point properties.  
    Set SCIComponentSet = swbemServices.ExecQuery(Query, ,wbemFlagForwardOnly Or wbemFlagReturnImmediately, swbemContext)  

    ' Only one instance is returned from the query.  
    For Each SCIComponent In SCIComponentSet  

        ' Display the server name.  
        wscript.echo "Server: " & SCIComponent.Name        

        ' Loop through the array of embedded SMS_EmbeddedProperty instances.  
        For Each vProperty In SCIComponent.Props  

            ' Setting: Heartbeat Site Control File Schedule.  
            If vProperty.PropertyName = "Heartbeat Site Control File Schedule" Then  
                wscript.echo " "  
                wscript.echo vProperty.PropertyName                 
                wscript.echo "Current value " &  vProperty.Value1     

                'Modify the value.  
                vProperty.Value1 = newHeartbeatSiteControlFileSchedule  
                wscript.echo "New value " & newHeartbeatSiteControlFileSchedule  
            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  

' SEPARATE EXAMPLE TO ENABLE HEARTBEAT DISCOVERY ON THE CLIENT  
Sub ConfigureHeartbeatDiscoverySettings2(swbemServices,                       _  
                                         swbemContext,                        _  
                                         siteCode,                            _  
                                         enableDisableHeartbeatDDR)  

    ' Load site control file and get the SMS_SCI_ClientConfig section.  
    swbemServices.ExecMethod "SMS_SiteControlFile.Filetype=1,Sitecode=""" & siteCode & """", "Refresh", , , swbemContext  

    Query = "SELECT * FROM SMS_SCI_ClientConfig " &   _  
    "WHERE ItemName  = 'Client Properties'" & _  
    "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: Enable Heartbeat DDR  
            If vProperty.PropertyName = "Enable Heartbeat DDR" Then  
                wscript.echo " "  
                wscript.echo vProperty.PropertyName  
                wscript.echo "Current value " &  vProperty.Value                 

                'Modify the value.  
                vProperty.Value = enableDisableHeartbeatDDR  
                wscript.echo "New value " & enableDisableHeartbeatDDR  
            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


public void ConfigureHeartbeatDiscoverySettings(WqlConnectionManager connection,  
                                                string siteCode,  
                                                string serverName,  
                                                string newHeartbeatSiteControlFileSchedule,  
                                                string newEnableDisableHeartbeatDDR)  
{  

    try  
    {  
    // Change the Heartbeat Site Control File Schedule value.  

        // Connect to SMS_SITE_CONTROL_MANAGER section of the site control file.  
         IResultObject siteDefinition = connection.GetInstance(@"SMS_SCI_Component.FileType=2,ItemType='Component',SiteCode='" + siteCode + "',ItemName='SMS_SITE_CONTROL_MANAGER|" + serverName + "'");  

        // Temporary copy of the embedded properties.  
        Dictionary<string, IResultObject> embeddedProperties = siteDefinition.EmbeddedProperties;  

        foreach (KeyValuePair<string, IResultObject> kvp in siteDefinition.EmbeddedProperties)  
        {                                         
            // Property: Heartbeat Site Control File Schedule  
            if (kvp.Value.PropertyList["PropertyName"] == "Heartbeat Site Control File Schedule")  
            {  
                Console.WriteLine();  
                Console.WriteLine(kvp.Value.PropertyList["PropertyName"]);  
                Console.WriteLine("Current value: " + embeddedProperties["Heartbeat Site Control File Schedule"]["Value1"].StringValue);  

                embeddedProperties["Heartbeat Site Control File Schedule"]["Value1"].StringValue = newHeartbeatSiteControlFileSchedule;  
                Console.WriteLine("New value    : " + newHeartbeatSiteControlFileSchedule);  
            }  
        }  

        // Store the settings that have changed.  
        siteDefinition.EmbeddedProperties = embeddedProperties;  

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

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

    try  
    {  
    // Change the Enable Heartbeat DDR value.  

        // Connect to SMS_SCI_ClientConfig section of the site control file.  
    IResultObject siteDefinition = connection.GetInstance(@"SMS_SCI_ClientConfig.FileType=2,ItemType='Client Configuration',SiteCode='" + siteCode + "',ItemName='Client Properties'");  

        // Create temporary working copy of embedded properties.  
        Dictionary<string, IResultObject> embeddedProperties = siteDefinition.EmbeddedProperties;  

        foreach (KeyValuePair<string, IResultObject> kvp in siteDefinition.EmbeddedProperties)  
        {  
            // Setting: Enable Heartbeat DDR  
            if (kvp.Value.PropertyList["PropertyName"] == "Enable Heartbeat DDR")  
            {  
                Console.WriteLine();  
                Console.WriteLine(kvp.Value.PropertyList["PropertyName"]);  
                Console.WriteLine("Current value: " + kvp.Value.PropertyList["Value"]);  

                // Change value using the newEnableDisableHeartbeatDDR value passed in.   
                embeddedProperties["Enable Heartbeat DDR"]["Value"].StringValue = newEnableDisableHeartbeatDDR;  
                Console.WriteLine("New value    : " + newEnableDisableHeartbeatDDR);  
            }                      
        }  

        // Store the settings that have changed.  
        siteDefinition.EmbeddedProperties = embeddedProperties;  

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

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

}

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.
`siteCode`	- Managed: `String` - VBScript: `String`	The site code.
`serverName`	- Managed: `String` - VBScript: `String`	The server name.
`newHeartbeatSiteControlFileSchedule`	- Managed: `String` - VBScript: `String`	The schedule defining how often the client will produce heartbeat data discovery records (DDRs).
- `newEnableDisableHeartbeatDDR` - `enableDisableHeartbeatDDR`	- Managed: `String` - VBScript: `String`	A value to enable or disable the heartbeat DDR. Disabled - 0 Enabled - 1

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.

.NET Framework Security

For more information about securing Configuration Manager applications, see Configuration Manager role-based administration.

Share via