Adam Meltzer's Configuration Manager Blog

SDK: Creating custom inventory classes for clients with the client messaging SDK

Adam Meltzer [MSFT] — Wed, 10 Apr 2013 21:26:00 GMT

Out of the box, the client messaging SDK contains several basic hardware inventory classes for sending inventory data such as CCM_System, Win32_NetworkAdapter, and some others. It has the ability to create inventory data on the fly from pre-formatted XML using InventoryInstanceGeneric. It also has some wrapper functionality to convert existing data in WMI to pre-formatted inventory classes through Microsoft.ConfigurationManagement.Messaging.Messages.WmiClassToInventoryReportInstance. If there’s interest I can go more into this in a future.

If you want to use the object model to create your own custom inventory classes for collection, it’s pretty simple to do this. A prerequisite for making the most of this is knowledge about how XML Serialization in the .NET framework works as this process is heavily dependent on this internally. If you don’t know much about this it should still be pretty easy to get started; things just become more difficult when you’re trying to expose more advanced data sets.

For basic details on how to send a hardware inventory message, check out my post with an in-depth sample on how to use the messaging SDK.

Here’s an example inventory class that I created by extending the SDK for a Contoso Perpetual Energy Reactor attachment:

/// <summary>

/// This class represents an inventory instance of a Contoso Perpetual Motion Reactor attachment

/// </summary>

[XmlRoot("Contoso_PerpetualMotionReactor")] // Must define an XmlRoot that represents the class name

public sealed class InventoryElementRecordPerpetualMotionReactor : InventoryInstanceElement

{

    private readonly Collection<string> attachments = new Collection<string>();

    /// <summary>

    /// Reactor model

    /// </summary>

    [XmlElement]

    public string Model { get; set; }

    /// <summary>

    /// Version

    /// </summary>

    [XmlElement]

    public uint Version { get; set; }

    /// <summary>

    /// Attachments for the energy reactor

    /// </summary>

    [XmlElement]

    public Collection<string> Attachments

    {

        get { return attachments; }

    }

    /// <summary>

    /// Discover an inventory instance element based local configuration

    /// </summary>

    /// <remarks>This is optional and only here for documentation purposes. By default, DiscoverSelf() will simply throw a NotImplementedException unless

    /// you override it with your own discovery logic</remarks>

    protected override void DiscoverSelf()

    {

        base.DiscoverSelf();

    }

    /// <summary>

    /// Initializes a new instance of the <see cref="InventoryElementRecordPerpetualMotionReactor"/> class.

    /// </summary>

    public InventoryElementRecordPerpetualMotionReactor()

        : base(

            "Contoso_PerpetualMotionReactor", // associated base class

            "Contoso_PerpetualMotionReactor", // associated parent class

            @"root\Contoso" /* namespace (scope) */)

    {

    }

}

Keep in mind the XmlRoot and XmlElement attributes. These are used to format the class to XML before sending it to the management point. Here’s an example of how this class will look when serialized to XML (reformatted for clarity):

<Contoso_PerpetualMotionReactor>

    <Model>Contoso Perpetual Motion Reactor (Nuclear Powered)</Model>

    <Version>1</Version>

    <Attachments>Dirty Water Cooling Tower</Attachments>

    <Attachments>Unobtanium Heat Sink</Attachments>

    <Attachments>Analogue gauges</Attachments>

    <Attachments>Sport suspension package</Attachments>

</Contoso_PerpetualMotionReactor>

This will be embedded into the inventory report that’s sent to the management point. Here’s some sample code that could bring all these things together to send this:

ConfigMgrHardwareInventoryMessage customHinvMessage = new ConfigMgrHardwareInventoryMessage();

customHinvMessage.Settings.HostName = mpHostname;

customHinvMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

customHinvMessage.SmsId = clientId;

customHinvMessage.SiteCode = siteCode;

customHinvMessage.NetBiosName = "MyDummyHostName";

customHinvMessage.DomainName = "MyDomain.net";

InventoryElementRecordPerpetualMotionReactor reactor = new InventoryElementRecordPerpetualMotionReactor();

reactor.Model = "Contoso Perpetual Motion Reactor (Nuclear Powered)";

reactor.Version = 1;

reactor.Attachments.Add("Dirty Water Cooling Tower");

reactor.Attachments.Add("Unobtanium Heat Sink");

reactor.Attachments.Add("Analogue gauges");

reactor.Attachments.Add("Sport suspension package");

// Create an instance containing the element

InventoryInstance instance = new InventoryInstance(reactor);

// Now add the instance to the inventory list

customHinvMessage.AddInstanceToInventory(instance);

customHinvMessage.SendMessage(Sender);

Now when you do this, if you look at MP_Hinv.log on the management point you’ll notice something will be wrong. The MP’s hardware inventory processor will complain about this class with a log line that looks something like this:

Hinv: class name not found in the mapping table: Contoso_PerpetualMotionReactor MP_HinvEndpoint 4/10/2013 1:44:38 PM 4592 (0x11F0)

The reason for this is you can’t just start creating new hardware inventory classes without taking some action on the site server. First you’ll need to create a .MOF file that represents the custom class you’re creating. Here’s one I created that represents the code above:

#pragma namespace ("\\\\.\\root\\contoso")

//=============================================================================

// SMS_Class_Template must be the parent of every class

//=============================================================================

class SMS_Class_Template

{

};

[ SMS_Report (TRUE),

  SMS_Group_Name ("Perpetual Motion Reactor"),

  SMS_Class_ID ("CONTOSO|PERPETUAL_MOTION_REACTOR|1.0"),

  Namespace ("\\\\\\\\.\\\\root\\\\contoso") ]

class Contoso_PerpetualMotionReactor : SMS_Class_Template

{

    [SMS_Report(TRUE), key]

    String Model;

    [SMS_Report(TRUE)]

    UInt32 Version;

    [SMS_Report(TRUE)]

    String Attachments[];

};

The next step is to import this MOF file into Configuration Manager. To do this, you need to go to the Administration view in the admin console, go to Client Settings, choose your client settings group, then go to Hardware Inventor, choose Set Classes, and import your mof file:

When you send this inventory a second time, it will get processed successfully by the management point with a line like this in the MP_Hinv.log:

Hinv Sax: Inserting class instance Contoso_PerpetualMotionReactor, attr=New MP_HinvEndpoint 4/10/2013 2:04:54 PM 4592 (0x11F0)

Now if you open Resource Explorer for your system, you’ll see this new data represented for your client:

SDK: Using the client messaging SDK to leverage client notification services in ConfigMgr 2012 SP1

Adam Meltzer [MSFT] — Mon, 11 Mar 2013 23:52:00 GMT

Configuration Manager 2012 SP1 added a new feature called “client notification services”. Normally clients send a request to the MP on an interval, but if you’re in a situation where you need clients to perform certain actions right away such as perform an anti-virus scan to detect a 0 day malware or request policy right away we now have a persistent network connection to the management point to facilitate this.

You can now also take advantage of this functionality with the SP1 release of the client messaging SDK (note: this will only work with a Configuration Manager 2012 SP1 or newer management point). As this is a completely new paradigm for messaging, it doesn’t work like traditional request/response functions of the client messaging SDK.

To use this facility, you essentially create a client notification session with the management point, and then you subscribe to events that will fire when instructions come from the management point. You respond to those messages asynchronously and then send a “response” message over the channel saying you handled the request.

In order to use the client notification feature you must have an existing SMSID and certificate. See my past posts on the client messaging SDK for details on how to get this.

Here’s some sample code on how to set up the session:

ConfigMgrBgbSession session = ConfigMgrBgbSession.CreateSession(

    BgbSessionType.Http, 

    "10.229.77.180" /* hostname or IP of your management point */, 

    MessageSecurityMode.MixedMode, 

    smsId /* SMSID from client registration */, 

    new ClientVersionV5SP1(), 

    cert /* MessageCertificateX509 derived object */);

session.BgbMessageReceived += session_BgbMessageReceived; /* Event that handles messages received from the client notification web service */

session.BgbMessageSent += session_BgbMessageSent; /* Event that handles messages sent to the client notification web service */

session.KeepAliveInterval = TimeSpan.FromMinutes(15); /* Interval to send "pings" back up to the client notification web service */

session.OpenSession();

Remember, this is asynchronous so once OpenSession() is called your code will continue. You will handle requests from the client notification web service with the BgbMessageReceived event handler. Here’s a sample implementation:

static void session_BgbMessageReceived(object sender, ConfigMgrBgbSessionEventArgs e)

{

    Console.WriteLine("Received message from client notification of type {0}: {1}", ((ConfigMgrBgbMessageReply)e.Message).Message, e.Message.Body.Payload);

    ConfigMgrBgbSynchronousMessageEventArgs configMgrBgbSynchronousMessageEventArgs = e as ConfigMgrBgbSynchronousMessageEventArgs;

    if (configMgrBgbSynchronousMessageEventArgs != null)

    {

        // Insert code here to act against the notification 

        configMgrBgbSynchronousMessageEventArgs.ResponseMessage.ReturnCode = 1; /* this says that you were successful */

        configMgrBgbSynchronousMessageEventArgs.SessionCallback.SendResponseMessage(configMgrBgbSynchronousMessageEventArgs.ResponseMessage);

    }

}

You process the notification request from the client notification web service, then you send a response back saying that you were successful. What follows is sample of this code in action.

In the administrator console, I instruct a client notification for “Download Computer Policy” to be sent to my client (other options may also be available depending on how your site or hierarchy is configured):

You can track the status of your clients through the “Client Operations” node of the “Monitoring” page of the admin console. Here we can see the status of this request:

This is not real-time so you will need to re-summarize the page if you want results immediately.

Using the sample code in a program, here’s what it might look like receiving a message and sending a response:

If you resummarize the monitoring page, you’ll see that it reflects that the client handled the message:

You’ll notice in the XML blob sent to the code that TaskType was set to 1. This is an instruction to request machine policy. There’s 2 other TaskType values: full anti-virus scan (2), and quick anti-virus scan (3).

When you’re done, you should use CloseSession() to cleanly terminate your session with the client notification web service.

By implementing this, your custom client will have all of the instant-response capabilities of a regular client!

Bonus trivia: why is the nomenclature “BGB” used throughout these SDK APIs? The feature was originally known internally as “big green button”, or “BGB” for short. The name “big green button” was to evoke the image of a panicked admin hitting the emergency button to tell all of the clients to do something right away. As for why it was a green button rather than a red button is something that has unfortunately been lost to antiquity. There’s still many references to this in log files and even in filenames before settling on the official name of “client notification”, and the SDK was one of those things that was not changed to reflect the official naming of the feature. It wouldn’t be the first time this has happened.

SDK: Creating DDRs on the site server using the client messaging SDK

Adam Meltzer [MSFT] — Mon, 11 Mar 2013 22:48:00 GMT

Despite its name, the client messaging SDK also has some strictly server side functionality. In its original release with the ConfigMgr 2012 SDK, it could write state messages and status messages directly to the inboxes on the site server. In the SP1 SDK, you can now write DDR messages directly to the site inboxes. This is equivalent to the functionality provided by the old SmsResGenCtl.dll COM library, but is a fully managed solution that doesn’t require any COM registrations or extra libraries.

The old library provided the ability to formulate a completely ad-hoc DDR which could be used to extend resource discovery by being able to add resources into Configuration Manager for objects and their properties that aren’t natively supported. For example, you could inventory your fax machines, printers, chairs (someone actually asked for this once!), and so on.

The class of interest for generating this inventory data is Microsoft.ConfigurationManagement.Messaging.Messages.Server.DiscoveryDataRecordFile.

Here is a code sample on how you may inventory a printer using this API:

DiscoveryDataRecordFile ddrFile = new DiscoveryDataRecordFile("Contoso Printersaurus"); // Agent name is the program that generated the DDR

ddrFile.Architecture = "Printer";

ddrFile.SiteCode = "NP1";

ddrFile.AddStringProperty("Name", DdmDiscoveryFlags.Key | DdmDiscoveryFlags.Name, 32, "MyPrinter001"); // You must have a field defined with Name flag

ddrFile.AddStringProperty("Model", DdmDiscoveryFlags.None, 128, "Contoso PaperMax 2000");

ddrFile.AddStringProperty("Version", DdmDiscoveryFlags.None, 12, "1.0");

ddrFile.AddStringProperty("Location", DdmDiscoveryFlags.None, 128, "Third Floor near break room");

ddrFile.AddDateTimeProperty("DateInstalled", DdmDiscoveryFlags.None, new DateTime(2011, 07, 07));

ddrFile.AddStringPropertyArray("Capabilities", DdmDiscoveryFlags.Array, 32, "Color", "Duplex", "Scanner");

ddrFile.AddIntegerProperty("RAM", DdmDiscoveryFlags.None, 64);

ddrFile.AddIntegerProperty("PagesPrinted", DdmDiscoveryFlags.None, 102);

ddrFile.AddDateTimeProperty("LastPrinted", DdmDiscoveryFlags.None, DateTime.Now);

ddrFile.AddIntegerPropertyArray("PaperLevelPercent", DdmDiscoveryFlags.Array, 100, 75, 0, 0);

ddrFile.AddStringPropertyArray("PaperType", DdmDiscoveryFlags.Array, 32, "Letter", "Letter Extended", "Legal", "A3");

string filename = ddrFile.SerializeToFile("."); // Normally you would use SerializeToInbox

Console.WriteLine("Write DDR to file: {0}", filename);

Pretty simple, right? Basically you define your properties, flags if needed, a maximum length where applicable, and then values. The Architecture field is very important as it will create SMS_R_Architecture resource tables that can be used for collections and query rules. In this sample because the architecture is “Printer”, a SMS_R_Printer class will be created.

The sample here used SerializeToFile to write a file for testing purposes and you’d drop this file into your ddm.box inbox on your site server. A better way to do this is to use the SerializeToInbox method that will automatically drop the file into the appropriate inbox.

Running this program and dropping the .DDR file into ddm.box will create an inventory record (which can be verified via ddm.log).

You can then create a Query (not a Collection since this isn’t a System or User resource) against all instances of SMS_R_Printer. I created one that looks like this:

You can then run this query, and see this resource in the admin console:

Since this data is all stored in SQL and accessible through the provider you can write reports or use other tools to slice and dice this data in interesting ways.

I hope you find this functionality useful!

SDK: How to create an application deployment type with a dependency on another application’s deployment type

Adam Meltzer [MSFT] — Fri, 30 Nov 2012 19:59:00 GMT

Update: I was incorrect in my original statements around dependency and supersedence having equivalent code. I’ll post a future example covering supersedence.

This post expands on the original sample program to demonstrate how you would add a dependency or supersedence relationship with another application. The sample here has a notable difference from the “real world” in that you would typically load the application definition for a relationship from the provider to get the required data. The sample here just clones the existing application which should be enough to demonstrate the basic concepts here.

First use the sample in this post, then add this code after line 41:

// App to act as a dependency. For this demo, just clone the existing application so we have some metadata to use. 

// If this were a real world scenario you would create an app object from an existing one loaded from the provider.

Application dependentApp = (Application)application.Clone();

// DeploymentType to act as a dependency. As with the app, we're just cloning the existing one to have some metadata. If

// this were a real world scenario, you would use a DT that is in the app instance you loaded from the provider.

DeploymentType dependentDT = (DeploymentType)scriptDT.Clone();

dependentApp.DeploymentTypes.Add(dependentDT);

dependentDT.Title = "Dependency";

dependentApp.Validate();

// Create a collection for the operands for the expression

CustomCollection<DeploymentTypeIntentExpression> operands = new CustomCollection<DeploymentTypeIntentExpression>();

operands.Add(new DeploymentTypeIntentExpression(dependentApp.Scope, dependentApp.Name, dependentApp.Version.Value, dependentDT.Scope, dependentDT.Name, dependentDT.Version.Value, DeploymentTypeDesiredState.Required, true));

// Like with any requirement rule, you can chain multiple dependencies with "And" or "Or". In this sample there's only a single dependency so it doesn't really matter.

DeploymentTypeExpression expression = new DeploymentTypeExpression(ExpressionOperator.Or, operands);

DeploymentTypeRule dependencyRule = new DeploymentTypeRule("Dependency_" + Guid.NewGuid().ToString("B"), NoncomplianceSeverity.Critical, null, expression);

// We add this other DT as a dependency. Supersedence works the same way, except you use DeploymentType.Supersedes.Add() instead.

scriptDT.Dependencies.Add(dependencyRule);

When you execute the program, the application will contain the dependency details:

<Dependencies>

  <DeploymentTypeRule id="Dependency_{d95233f2-84ff-48c3-9761-ffc588a565fd}" Severity="Critical" xmlns="http://schemas.microsoft.com/SystemsCenterConfigurationManager/2009/06/14/Rules">

    <DeploymentTypeExpression>

      <Operator>Or</Operator>

      <Operands>

        <DeploymentTypeIntentExpression DesiredState="Required">

          <DeploymentTypeApplicationReference AuthoringScopeId="MyVendorId" LogicalName="Application_02ea9552-b1a6-43c9-82cf-97cfa5b0218b" Version="1" />

          <DeploymentTypeReference AuthoringScopeId="MyVendorId" LogicalName="DeploymentType_18ac74a8-781f-4bfd-940c-74e793b58a9d" Version="1" Changeable="true" />

        </DeploymentTypeIntentExpression>

      </Operands>

    </DeploymentTypeExpression>

  </DeploymentTypeRule>

</Dependencies>

Supersedence follows the exact same concepts except instead of adding to the Dependencies collection, you’re adding your rule to the Supersedence collection.

Download sample program Program.cs

SDK: 32-bit legacy programs interoperating with the 64-bit client using COM

Adam Meltzer [MSFT] — Wed, 28 Nov 2012 19:52:00 GMT

Update @ 2013-03-21: We are aware of an issue with CPApplet interfaces not being accessible from 32-bit processes. Once I have something to share regarding a solution for this I will post about it here.

Configuration Manager 2012 for the first time offers a 64-bit native client. This will create problems if you’re using a 32-bit native application that depends on COM interfaces defined by the older 32-bit client. The most likely issue would be your applications failing with a 0x80040154 (class not registered) error. Fortunately, you don’t need to despair or rebuild your programs for 64-bit (or “Any” if .NET).

We have shipped a set of compatibility shims as part of the program bundle that will allow 32-bit programs to invoke COM methods against the 64-bit client. You will need to install the 32BitCompat.msi that is part of the CD. It can be found under SMSSETUP\BIN\X64. You can even deploy this to your 64-bit clients as part of an application deployment. Make sure you scope this to run only on 64-bit systems as it will fail to install on 32-bit systems.

The following are shimmed out to allow 32-bit interoperability:

ccmcca.dll
ccmcisdk.dll
ccmctm.dll
ccmexec.exe
ccmproxy.dll
ciagent.dll
contentaccess.dll
cpapplet.dll
dcmagent.dll
execmgr.dll
rebootcoord.dll
rtconfig.dll
scanagent.dll
sched.dll
smsclient.dll
smssha.dll
srcupdatemgr.dll
srvwinmgr.dll
statemessage.dll
uiresource.dll
updatesdeployment.dll
updatesstore.dll

Note: This is only required if you’re using 32-bit native applications for COM interop. 64-bit native applications, or .NET applications compiled as “Any” do not require this to be installed.

SDK: In-depth sample on how to use the client messaging SDK–now with ISV proxy registration capabilities

Adam Meltzer [MSFT] — Thu, 01 Nov 2012 18:36:00 GMT

A few months back I posted an in-depth sample performing various functions with the client messaging SDK. I’ve updated the sample to provide the ability to perform ISV proxy registration as well to make it easy to validate basic ISV proxy scenarios.

The sample is basically the same as it was originally but with an additional command, “I” which enables ISV proxy mode. If you type “I” you will need to enter the GUID of the ISV proxy client and then send a registration request. The client GUID will be assigned on behalf of the ISV proxy:

Here’s the updated code for quick viewing, and as always, a .cs file is attached at the end of the post.

using System;

using System.Diagnostics;

using System.Diagnostics.CodeAnalysis;

using System.Globalization;

using System.IO;

using Microsoft.ConfigurationManagement.Messaging.Framework;

using Microsoft.ConfigurationManagement.Messaging.Messages;

using Microsoft.ConfigurationManagement.Messaging.Sender.Http;

  

namespace Microsoft.ConfigurationManagement.Messaging.Tools.InteractiveSdkSample

{

    internal class SampleProgram

    {

        private static readonly HttpSender Sender = new HttpSender();

        private static readonly ConsoleTraceListener TraceListener = new ConsoleTraceListener();

        private static MessageCertificateX509 certificate;

        private static SmsClientId clientId;

        private static bool compression;

        private static bool encryption;

        private static SmsClientId isvProxyId;

        private static bool fileLogging;

        private static string mpHostname;

        private static bool replyCompression;

        private static string siteCode;

        private static bool superVerbose;

        private static bool verbose;

  

        /// <summary>

        /// Sets the logging parameters

        /// </summary>

        private static void ChangeLogging()

        {

            if (true == superVerbose)

            {

                MessagingTrace.TraceSwitch.Level = TraceLevel.Verbose;

            }

            else if (true == verbose)

            {

                MessagingTrace.TraceSwitch.Level = TraceLevel.Info;

            }

            else

            {

                MessagingTrace.TraceSwitch.Level = TraceLevel.Warning;

            }

        }

  

        /// <summary>

        /// Writes help to the console and exits

        /// </summary>

        private static void Help()

        {

            Console.WriteLine("{0} <MP Hostname> <SiteCode> [-v|-vv]", Environment.GetCommandLineArgs()[0]);

            Console.WriteLine("This program requires a certificate called MixedModeTestCert.pfx with a password of \"test\"");

            Console.WriteLine("-v: verbose -vv: super-verbose");

            Console.WriteLine("step# is a number for the step to execute");

            WriteSteps();

            Environment.Exit(1);

        }

  

        /// <summary>

        /// Performs initialization, should only be run once

        /// </summary>

        private static void Initialize()

        {

            // Only dump readable characters since we're writing to the console

            HexDumper.OnlyPrintReadable = true;

  

            // Initialize the sender and event handlers

            Sender.OnRawDataSend += OnRawDataSend;

            Sender.OnRawDataReceived += OnRawDataReceived;

            Sender.OnSend += OnSend;

            Sender.OnReceived += OnReceived;

  

            certificate = new MessageCertificateX509Volatile(Path.Combine(Environment.CurrentDirectory, "MixedModeTestCert.pfx"), "test");

  

            if (certificate == null)

            {

                Console.WriteLine(@"Could not load the test certificate");

                Environment.Exit(1);

            }

  

            Console.WriteLine(@"Using certificate for client authentication with thumbprint of '{0}'", certificate.Thumbprint);

  

            Trace.Listeners.Add(TraceListener);

            ChangeLogging();

        }

  

        /// <summary>

        /// Input loop that runs when a specific step isn't specified at the command line

        /// </summary>

        [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]

        private static void InputLoop()

        {

            while (true)

            {

                WriteSteps();

                Console.WriteLine(@"V -- change verbosity level");

                Console.WriteLine(@"Q -- quit");

                Console.WriteLine(@"C -- compression enable/disable");

                Console.WriteLine(@"R -- reply compression enable/disable");

                Console.WriteLine(@"E -- encryption enable/disable");

                Console.WriteLine(@"L -- file logging enable/disable");

                Console.WriteLine(@"I -- ISV proxy mode");

  

                Console.Write(@"Input: ");

                ConsoleKeyInfo key = Console.ReadKey();

                Console.WriteLine();

  

                switch (key.Key)

                {

                    case ConsoleKey.L:

                        fileLogging = !fileLogging;

                        Console.WriteLine(@"Setting file logging enabled to: {0}", fileLogging);

                        break;

                    case ConsoleKey.R:

                        replyCompression = !replyCompression;

                        Console.WriteLine(@"Setting reply compression enabled to: {0}", replyCompression);

                        break;

                    case ConsoleKey.E:

                        encryption = !encryption;

                        Console.WriteLine(@"Setting encryption enabled to: {0}", encryption);

                        break;

                    case ConsoleKey.C:

                        compression = !compression;

                        Console.WriteLine(@"Setting compression enabled to: {0}", compression);

                        break;

                    case ConsoleKey.I:

                        Console.Write(@"Enter ISV proxy GUID: ");

                        string guid = Console.ReadLine();

                        isvProxyId = new SmsClientId(guid, true);

                        break;

                    case ConsoleKey.V:

                        if (verbose == false)

                        {

                            Console.WriteLine(@"Changing verbosity to VERBOSE");

                            verbose = true;

                        }

                        else if (superVerbose == false)

                        {

                            Console.WriteLine(@"Changing verbosity to SUPER VERBOSE");

                            superVerbose = verbose = true;

                        }

                        else

                        {

                            Console.WriteLine(@"Changing verbosity to quiet");

                            superVerbose = verbose = false;

                        }

  

                        ChangeLogging();

  

                        break;

                    case ConsoleKey.Q:

                        Console.WriteLine(@"Quitting");

                        Environment.Exit(0);

                        break;

                    case ConsoleKey.D1:

                        PerformOperation(Step.Register);

                        break;

                    case ConsoleKey.D2:

                        PerformOperation(Step.Ddr);

                        break;

                    case ConsoleKey.D3:

                        PerformOperation(Step.Hinv);

                        break;

                    case ConsoleKey.D4:

                        PerformOperation(Step.Sinv);

                        break;

                    case ConsoleKey.D5:

                        PerformOperation(Step.FileCollection);

                        break;

                    case ConsoleKey.D6:

                        PerformOperation(Step.MachinePolicy);

                        break;

                    case ConsoleKey.D7:

                        PerformOperation(Step.UserPolicy);

                        break;

                    default:

                        Console.WriteLine(@"Invalid input received: " + key.KeyChar);

                        break;

                }

            }

        }

  

        /// <summary>

        /// Main program section

        /// </summary>

        private static void Main(string[] args)

        {

            if (args.Length < 2)

            {

                Help();

            }

  

            mpHostname = args[0];

            siteCode = args[1];

  

            if (siteCode.Length != 3)

            {

                Console.WriteLine(@"Invalid site code {0} specified", siteCode);

                Help();

            }

  

            if (args.Length == 3)

            {

                if (args[2] == "-v")

                {

                    verbose = true;

                }

                else if (args[2] == "-vv")

                {

                    verbose = superVerbose = true;

                }

                else

                {

                    Help();

                }

            }

            else if (args.Length != 2)

            {

                Help();

            }

  

            Initialize();

            InputLoop();

        }

  

        /// <summary>

        /// Captures raw data received by HTTP sender and logs if superverbose is enabled

        /// </summary>

        private static void OnRawDataReceived(object sender, HttpSenderRawDataEventArgs e)

        {

            if (superVerbose == false && fileLogging == false)

            {

                return;

            }

  

            if (superVerbose == true)

            {

                Console.WriteLine(@"Response raw data:");

                HexDumper.DumpHexToConsole(e.GetRawData());

            }

  

            if (fileLogging == true)

            {

                string dumpFile = string.Format(CultureInfo.InvariantCulture, "MsgBin_Received_{0}.bin", TimeHelpers.CurrentTimeAsUnixTime);

                dumpFile = Path.Combine(Path.GetTempPath(), dumpFile);

                Console.WriteLine("Dumping message to {0}", dumpFile);

                File.WriteAllBytes(dumpFile, e.GetRawData());

            }

        }

  

        /// <summary>

        /// Captures raw data sent by HTTP sender and logs if superverbose is enabled

        /// </summary>

        private static void OnRawDataSend(object sender, HttpSenderRawDataEventArgs e)

        {

            if (superVerbose == false && fileLogging == false)

            {

                return;

            }

  

            if (true == superVerbose)

            {

                Console.WriteLine(@"Send raw data:");

  

                HexDumper.DumpHexToConsole(e.GetRawData());

            }

  

            if (fileLogging == true)

            {

                string dumpFile = string.Format(CultureInfo.InvariantCulture, "MsgBin_Sent_{0}.bin", TimeHelpers.CurrentTimeAsUnixTime);

                dumpFile = Path.Combine(Path.GetTempPath(), dumpFile);

                Console.WriteLine("Dumping message to {0}", dumpFile);

                File.WriteAllBytes(dumpFile, e.GetRawData());

            }

        }

  

        /// <summary>

        /// Captures data received by HTTP sender and logs if superverbose is enabled

        /// </summary>

        private static void OnReceived(object sender, MessageSenderEventArgs e)

        {

            if (verbose == false)

            {

                return;

            }

  

            Console.WriteLine(@"Received payload from MP:");

            Console.WriteLine(e.Message.Body.Payload);

        }

  

        /// <summary>

        /// Captures data sent by HTTP sender and logs if superverbose is enabled

        /// </summary>

        private static void OnSend(object sender, MessageSenderEventArgs e)

        {

            if (verbose == false)

            {

                return;

            }

  

            Console.WriteLine(@"Sending payload to MP:");

            Console.WriteLine(e.Message.Body.Payload);

  

            if (e.Message.Attachments.Count > 0)

            {

                if (e.Message is ConfigMgrFileCollectionMessage ||

                    e.Message is ConfigMgrUploadRequest)

                {

                    Console.WriteLine(@"Not writing attachments for {0} message to console", e.Message);

                    return;

                }

  

                for (int i = 0; i < e.Message.Attachments.Count; i++)

                {

                    Console.WriteLine(@"+======== ATTACHMENT #{0} (name: {1}) ========+", i + 1, e.Message.Attachments[i].Name);

                    Console.WriteLine(e.Message.Attachments[i].Body.Payload);

                }

            }

        }

  

        /// <summary>

        /// Performs an atomic operation

        /// </summary>

        [SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling")]

        [SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes")]

        private static void PerformOperation(Step step)

        {

            // Some steps require a valid client ID to work, this anonymous method ensures this.

            Action checkIsClientIdPresent = () =>

                                                {

                                                    if (null == clientId)

                                                    {

                                                        throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, "Cannot execute step #{0:d} {0} because client is not registered.", step));

                                                    }

                                                };

  

            try

            {

                Console.WriteLine(@"===========================================================");

                Console.WriteLine(@"Sending '{0}' message", step);

                Console.WriteLine(@"===========================================================");

                switch (step)

                {

                    case Step.Register:

  

                        ConfigMgrRegistrationRequest regRequest = new ConfigMgrRegistrationRequest();

                        regRequest.Settings.HostName = mpHostname;

                        regRequest.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

  

                        // regRequest.Discover();

  

                        // Manual registration

                        // Required: must supply a NetBIOS hostname

                        regRequest.NetBiosName = "MyDummyHostName";

  

                        // Required: must supply an agent identity (this is the name of your client)

                        regRequest.AgentIdentity = "MyCustomClient.exe";

  

                        // Required: must supply a client FQDN

                        regRequest.ClientFqdn = "MyDummyHostName.MyDomain.net";

  

                        if (null != isvProxyId)

                        {

                            Console.WriteLine("Registering as ISV proxy client");

                            regRequest.SigningSmsId = isvProxyId;

                            regRequest.AgentType = ClientRegistrationAgentType.IsvProxyClient;

                        }

  

                        regRequest.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        regRequest.Settings.ReplyCompression = (true == replyCompression) ? MessageCompression.Zlib : MessageCompression.None;

                        clientId = regRequest.RegisterClient(Sender, TimeSpan.FromMinutes(5));

                        Console.WriteLine(@"Got SMSID from registration of: {0}", clientId);

                        break;

  

                    case Step.Ddr:

                        checkIsClientIdPresent();

  

                        ConfigMgrDataDiscoveryRecordMessage ddrMessage = new ConfigMgrDataDiscoveryRecordMessage();

                        ddrMessage.Settings.HostName = mpHostname;

                        ddrMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        ddrMessage.SmsId = clientId;

                        ddrMessage.SiteCode = siteCode;

                        ddrMessage.ADSiteName = "MyADSiteName";

                        ddrMessage.DomainName = "MyDomain.net";

                        ddrMessage.NetBiosName = "MyDummyHostName";

                        ddrMessage.ClientVersion = new ClientVersionV5();

                        ddrMessage.Discover();

                        ddrMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        ddrMessage.Settings.Security.EncryptMessage = encryption;

                        ddrMessage.SendMessage(Sender);

                        break;

  

                    case Step.Hinv:

                        checkIsClientIdPresent();

  

                        ConfigMgrHardwareInventoryMessage hinvMessage = new ConfigMgrHardwareInventoryMessage();

                        hinvMessage.Settings.HostName = mpHostname;

                        hinvMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        hinvMessage.SmsId = clientId;

                        hinvMessage.SiteCode = siteCode;

                        hinvMessage.NetBiosName = "MyDummyHostName";

                        hinvMessage.DomainName = "MyDomain.net";

                        hinvMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        hinvMessage.Settings.Security.EncryptMessage = encryption;

                        hinvMessage.AddInstancesToInventory(WmiClassToInventoryReportInstance.WmiClassToInventoryInstances(@"root\cimv2", "Win32_LogicalDisk", @"root\cimv2\sms", "SMS_LogicalDisk"));

                        hinvMessage.AddInstancesToInventory(WmiClassToInventoryReportInstance.WmiClassToInventoryInstances(@"root\cimv2", "Win32_Processor", @"root\cimv2\sms", "SMS_Processor"));

                        hinvMessage.AddInstancesToInventory(WmiClassToInventoryReportInstance.WmiClassToInventoryInstances(@"root\cimv2", "Win32_SystemDevices", @"root\cimv2\sms", "SMS_SystemDevices"));

                        hinvMessage.SendMessage(Sender);

                        break;

  

                    case Step.Sinv:

                        checkIsClientIdPresent();

  

                        ConfigMgrSoftwareInventoryMessage sinvMessage = new ConfigMgrSoftwareInventoryMessage();

                        sinvMessage.Settings.HostName = mpHostname;

                        sinvMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        sinvMessage.SmsId = clientId;

                        sinvMessage.SiteCode = siteCode;

                        sinvMessage.NetBiosName = "MyDummyHostName";

                        sinvMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        sinvMessage.Settings.Security.EncryptMessage = encryption;

                        sinvMessage.AddDirectoryFilesToInventory(Environment.ExpandEnvironmentVariables(@"%WINDIR%\system32"), "*.exe", true, true);

                        InventoryInstanceElementFileSystemFile fakeFile = new InventoryInstanceElementFileSystemFile();

                        fakeFile.LastWriteDate = TimeHelpers.Epoch.AddDays(-200);

                        fakeFile.FileVersion = "1.0";

                        fakeFile.FileDescription = "Fake File";

                        fakeFile.CompanyName = "Fake Company";

                        fakeFile.FileName = "FakeFile.EXE";

                        fakeFile.FilePath = Environment.ExpandEnvironmentVariables(@"%SYSTEMDRIVE%\MyFakeFile.EXE");

                        fakeFile.ProductName = "Fake Product";

                        fakeFile.ProductVersion = "1.0";

                        fakeFile.Size = 1024;

                        sinvMessage.AddFileSystemFileInstanceToInventory(fakeFile);

                        sinvMessage.SendMessage(Sender);

                        break;

  

                    case Step.FileCollection:

                        checkIsClientIdPresent();

  

                        ConfigMgrFileCollectionMessage fcMessage = new ConfigMgrFileCollectionMessage();

                        fcMessage.Settings.HostName = mpHostname;

                        fcMessage.Settings.BitsUpload = true;

                        fcMessage.Discover();

                        fcMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        fcMessage.SmsId = clientId;

                        fcMessage.SiteCode = siteCode;

                        fcMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        fcMessage.Settings.Security.EncryptMessage = encryption;

                        fcMessage.AddDirectoryFilesToCollection(Environment.ExpandEnvironmentVariables(@"%WINDIR%\system32"), "*.log", true, true);

                        fcMessage.SendMessage(Sender);

                        break;

  

                    case Step.UserPolicy:

                        checkIsClientIdPresent();

                        ConfigMgrPolicyAssignmentRequest userPolicyMessage = new ConfigMgrPolicyAssignmentRequest();

                        userPolicyMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        userPolicyMessage.Settings.HostName = mpHostname;

                        userPolicyMessage.ResourceType = PolicyAssignmentResourceType.User;

                        userPolicyMessage.Settings.Security.AuthenticationScheme = AuthenticationScheme.Ntlm;

                        userPolicyMessage.Settings.Security.AuthenticationType = AuthenticationType.WindowsAuth;

                        userPolicyMessage.SmsId = clientId;

                        userPolicyMessage.SiteCode = siteCode;

                        userPolicyMessage.Discover();

                        userPolicyMessage.SendMessage(Sender);

                        userPolicyMessage.Settings.Security.EncryptMessage = encryption;

                        userPolicyMessage.Settings.ReplyCompression = (true == replyCompression) ? MessageCompression.Zlib : MessageCompression.None;

                        userPolicyMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        break;

  

                    case Step.MachinePolicy:

                        checkIsClientIdPresent();

                        ConfigMgrPolicyAssignmentRequest machinePolicyMessage = new ConfigMgrPolicyAssignmentRequest();

                        machinePolicyMessage.Settings.HostName = mpHostname;

                        machinePolicyMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        machinePolicyMessage.Settings.Security.EncryptMessage = encryption;

                        machinePolicyMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        machinePolicyMessage.Settings.ReplyCompression = (true == replyCompression) ? MessageCompression.Zlib : MessageCompression.None;

                        machinePolicyMessage.ResourceType = PolicyAssignmentResourceType.Machine;

                        machinePolicyMessage.SmsId = clientId;

                        machinePolicyMessage.SiteCode = siteCode;

                        machinePolicyMessage.Discover();

                        machinePolicyMessage.SendMessage(Sender);

  

                        break;

                }

  

                Console.WriteLine(@"===========================================================");

                Console.WriteLine(@"Successfully sent '{0}' message!", step);

                Console.WriteLine(@"===========================================================");

            }

            catch (Exception e)

            {

                e.RethrowCriticalException();

                Console.WriteLine();

                MessagingTrace.TraceException("Got unexpected exception while executing messaging step #{0:d}: '{0}'", e, step);

                Console.WriteLine(@"===========================================================");

                Console.WriteLine(@"Failed to send '{0}' message!", step);

                Console.WriteLine(@"===========================================================");

            }

        }

  

        /// <summary>

        /// Writes the various steps that can be executed with this program to the console

        /// </summary>

        private static void WriteSteps()

        {

            Console.WriteLine(@"1 -- register client");

            Console.WriteLine(@"2 -- send DDR");

            Console.WriteLine(@"3 -- send hardware inventory");

            Console.WriteLine(@"4 -- send software inventory");

            Console.WriteLine(@"5 -- send collected files");

            Console.WriteLine(@"6 -- request machine policy");

            Console.WriteLine(@"7 -- request user policy");

        }

  

        #region Nested type: Step

  

        /// <summary>

        /// Steps supported by this sample

        /// </summary>

        private enum Step

        {

            /// <summary>

            /// None (implementation implies manual selection loop)

            /// </summary>

            None = 0, 

  

            /// <summary>

            /// Register client

            /// </summary>

            Register = 1, 

  

            /// <summary>

            /// Send DDR

            /// </summary>

            Ddr = 2, 

  

            /// <summary>

            /// Send HINV

            /// </summary>

            Hinv = 3, 

  

            /// <summary>

            /// Send SINV

            /// </summary>

            Sinv = 4, 

  

            /// <summary>

            /// Send collected files

            /// </summary>

            FileCollection = 5, 

  

            /// <summary>

            /// Request machine policy

            /// </summary>

            MachinePolicy = 6, 

  

            /// <summary>

            /// Request user policy

            /// </summary>

            UserPolicy = 7, 

        }

  

        #endregion

    }

}

Download the code sample: program.cs

SDK: How to create an Application with a requirement rule pointing to a global condition

Adam Meltzer [MSFT] — Tue, 23 Oct 2012 20:30:00 GMT

In a previous post, I demonstrated how to create an application with an enhanced detection rule (EHD). Creating an application with a requirements rule is a bit more complicated. In this post I will provide a sample on how to do this using one of the “out of the box” global conditions that’s provided with the product. In this case, this rule is stating that the free disk space on the system drive must be higher than 5GB.

First use the sample program in this post. Then add this code between line 39 and 41:

        1: // Now create the deployment type and bind it to the installer

       2: DeploymentType scriptDT = new DeploymentType(installer, ScriptInstaller.TechnologyId, NativeHostingTechnology.TechnologyId);

       3: scriptDT.Title = "My Application Installer";

       4: application.DeploymentTypes.Add(scriptDT);

       5:  

       6: // Expression for the properties around the drive (in this case, must be system drive)

       7: CustomCollection<ExpressionBase> settingsOperands = new CustomCollection<ExpressionBase>();

       8: GlobalSettingReference driveIdSettingRef = new GlobalSettingReference("GLOBAL", "FreeDiskSpace", DataType.String, "DriveID", ConfigurationItemSettingSourceType.CIM);

       9: GlobalSettingReference systemDriveSettingRef = new GlobalSettingReference("GLOBAL", "FreeDiskSpace", DataType.String, "SystemDrive", ConfigurationItemSettingSourceType.CIM);

settingsOperands.Add(driveIdSettingRef);

settingsOperands.Add(systemDriveSettingRef);

Expression driveSettingsExp = new Expression(ExpressionOperator.IsEquals, settingsOperands);

  

// Expression for the drive space, must be greater than n

CustomCollection<ExpressionBase> freeSpaceOperands = new CustomCollection<ExpressionBase>();

GlobalSettingReference freeSpaceSettingRef = new GlobalSettingReference("GLOBAL", "FreeDiskSpace", DataType.Int64, "FreeSpace", ConfigurationItemSettingSourceType.CIM);

ConstantValue constant = new ConstantValue(Convert.ToString((long)5000 * 1024 * 1024) /* 5000MB to KB to bytes */, DataType.Int64);

freeSpaceOperands.Add(freeSpaceSettingRef);

freeSpaceOperands.Add(constant);

Expression freeSpaceExp = new Expression(ExpressionOperator.GreaterEquals, freeSpaceOperands);

  

// Outer expression that combines the previous expressions

CustomCollection<ExpressionBase> outerOperands = new CustomCollection<ExpressionBase>();

outerOperands.Add(freeSpaceExp);

outerOperands.Add(driveSettingsExp);

  

Expression fullExp = new Expression(ExpressionOperator.And, outerOperands);

  

// Now build a rule and add it to the DT

Rule rule = new Rule("MyRule_" + Guid.NewGuid().ToString("B"), NoncomplianceSeverity.Critical, null, fullExp);

scriptDT.Requirements.Add(rule);

This code builds a tree for the requirement rule based on the global setting “FreeDiskSpace”. If the code is a bit much to take in, here’s the XML it generates internally that may explain the logic a bit better:

    <Rule id="MyRule_{bb25f0f3-dca6-4a9b-9182-2712bdca5187}" Severity="Critical" NonCompliantWhenSettingIsNotFound="false" xmlns="http://schemas.microsoft.com/SystemsCenterConfigurationManager/2009/06/14/Rules">

      <Expression>

        <Operator>And</Operator>

        <Operands>

          <Expression>

            <Operator>GreaterEquals</Operator>

            <Operands>

              <GlobalSettingReference AuthoringScopeId="GLOBAL" LogicalName="FreeDiskSpace" DataType="Int64" SettingLogicalName="FreeSpace" SettingSourceType="CIM" Method="Value" />

              <ConstantValue Value="5242880000" DataType="Int64" />

            </Operands>

          </Expression>

          <Expression>

            <Operator>Equals</Operator>

            <Operands>

              <GlobalSettingReference AuthoringScopeId="GLOBAL" LogicalName="FreeDiskSpace" DataType="String" SettingLogicalName="DriveID" SettingSourceType="CIM" Method="Value" />

              <GlobalSettingReference AuthoringScopeId="GLOBAL" LogicalName="FreeDiskSpace" DataType="String" SettingLogicalName="SystemDrive" SettingSourceType="CIM" Method="Value" />

            </Operands>

          </Expression>

        </Operands>

      </Expression>

    </Rule>

Global conditions can be accessed through the SMS Provider by looking at the SMS_GlobalCondition class instances. You can also view the unique ID information for global conditions directly through the administrator console (this way you can get the authoring scope ID and logical name) by going into Software Library –> Application Management –> Global Conditions and enabling the “CI Unique ID” column.

This is not a comprehensive example in that it only provides one specific way to use requirement rules and doesn’t provide information on how to create global conditions. I hope to provide this information in a future blog post. I hope this is enough to at least get some of you started on this area of the SDK that frequently gets questions asked about it.

Download sample program Program.cs

SDK: In-depth sample on how to use the client messaging SDK

Adam Meltzer [MSFT] — Thu, 12 Jul 2012 21:20:00 GMT

Update: I've updated this sample with ISV proxy registration capabilities.

At the Microsoft 2012 Partner Day in Las Vegas there was a session previewing changes to the Configuration Manager 2012 SDK. There was a demo given with a sample program that was using the client messaging SDK to register a client, send discovery data, inventory, and file collections. These were then demonstrated in the console showing an end to end scenario. This was all done in seconds showing how fast everything can go.

I am now sharing that sample program to show a practical example on how you can use the client messaging SDK to register a client and send data up to the site. This sample will demonstrate various functionality of the client messaging SDK.

Here is the code used in the sample (there is a link at the end of this post to download the .cs file so you don’t have to worry about copy/paste format issues):

using System;

using System.Diagnostics;

using System.Diagnostics.CodeAnalysis;

using System.Globalization;

using System.IO;

using Microsoft.ConfigurationManagement.Messaging.Framework;

using Microsoft.ConfigurationManagement.Messaging.Messages;

using Microsoft.ConfigurationManagement.Messaging.Sender.Http;

  

namespace Microsoft.ConfigurationManagement.Messaging.Tools.InteractiveSdkSample

{

    internal class SampleProgram

    {

        private static readonly HttpSender Sender = new HttpSender();

        private static readonly ConsoleTraceListener TraceListener = new ConsoleTraceListener();

        private static MessageCertificateX509 certificate;

        private static SmsClientId clientId;

        private static bool compression;

        private static bool encryption;

  

        private static string mpHostname;

        private static bool replyCompression;

        private static string siteCode;

        private static bool verbose;

  

        /// <summary>

        /// Sets the logging parameters

        /// </summary>

        private static void ChangeLogging()

        {

            if (true == verbose)

            {

                MessagingTrace.TraceSwitch.Level = TraceLevel.Info;

            }

            else

            {

                MessagingTrace.TraceSwitch.Level = TraceLevel.Warning;

            }

        }

  

        /// <summary>

        /// Writes help to the console and exits

        /// </summary>

        private static void Help()

        {

            Console.WriteLine("{0} <MP Hostname> <SiteCode> [-v]", Environment.GetCommandLineArgs()[0]);

            Console.WriteLine("-v: verbose");

            Environment.Exit(1);

        }

  

        /// <summary>

        /// Performs initialization, should only be run once

        /// </summary>

        private static void Initialize()

        {

            // Only dump readable characters since we're writing to the console

            HexDumper.OnlyPrintReadable = true;

  

            // Initialize the sender and event handlers

            Sender.OnSend += OnSend;

            Sender.OnReceived += OnReceived;

  

            // There must be a certificate file that matches the path and password.

            certificate = new MessageCertificateX509Volatile(Path.Combine(Environment.CurrentDirectory, "MixedModeTestCert.pfx"), "sccm");

  

            if (certificate == null)

            {

                Console.WriteLine(@"Could not load the test certificate");

                Environment.Exit(1);

            }

  

            Console.WriteLine(@"Using certificate for client authentication with thumbprint of '{0}'", certificate.Thumbprint);

  

            Trace.Listeners.Add(TraceListener);

            ChangeLogging();

        }

  

        /// <summary>

        /// Input loop that runs when a specific step isn't specified at the command line

        /// </summary>

        [SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]

        private static void InputLoop()

        {

            while (true)

            {

                WriteSteps();

                Console.WriteLine(@"V -- change verbosity level");

                Console.WriteLine(@"Q -- quit");

                Console.WriteLine(@"C -- compression enable/disable");

                Console.WriteLine(@"R -- reply compression enable/disable");

                Console.WriteLine(@"E -- encryption enable/disable");

                Console.Write(@"Input: ");

                ConsoleKeyInfo key = Console.ReadKey();

                Console.WriteLine();

  

                switch (key.Key)

                {

                    case ConsoleKey.R:

                        replyCompression = !replyCompression;

                        Console.WriteLine(@"Setting reply compression enabled to: {0}", replyCompression);

                        break;

                    case ConsoleKey.E:

                        encryption = !encryption;

                        Console.WriteLine(@"Setting encryption enabled to: {0}", encryption);

                        break;

                    case ConsoleKey.C:

                        compression = !compression;

                        Console.WriteLine(@"Setting compression enabled to: {0}", compression);

                        break;

                    case ConsoleKey.Q:

                        Console.WriteLine(@"Quitting");

                        Environment.Exit(0);

                        break;

                    case ConsoleKey.D1:

                        PerformOperation(Step.Register);

                        break;

                    case ConsoleKey.D2:

                        PerformOperation(Step.Ddr);

                        break;

                    case ConsoleKey.D3:

                        PerformOperation(Step.Hinv);

                        break;

                    case ConsoleKey.D4:

                        PerformOperation(Step.Sinv);

                        break;

                    case ConsoleKey.D5:

                        PerformOperation(Step.FileCollection);

                        break;

                    case ConsoleKey.D6:

                        PerformOperation(Step.MachinePolicy);

                        break;

                    case ConsoleKey.D7:

                        PerformOperation(Step.UserPolicy);

                        break;

                    default:

                        Console.WriteLine(@"Invalid input received: " + key.KeyChar);

                        break;

                }

            }

        }

  

        /// <summary>

        /// Main program section

        /// </summary>

        private static void Main(string[] args)

        {

            if (args.Length < 2)

            {

                Help();

            }

  

            mpHostname = args[0];

            siteCode = args[1];

  

            if (siteCode.Length != 3)

            {

                Console.WriteLine(@"Invalid site code {0} specified", siteCode);

                Help();

            }

  

            if (args.Length == 3)

            {

                if (args[2] == "-v")

                {

                    verbose = true;

                }

                else

                {

                    Help();

                }

            }

            else if (args.Length != 2)

            {

                Help();

            }

  

            Initialize();

            InputLoop();

        }

  

        /// <summary>

        /// Captures data received by HTTP sender and logs if verbose is enabled

        /// </summary>

        private static void OnReceived(object sender, MessageSenderEventArgs e)

        {

            if (verbose == false)

            {

                return;

            }

  

            Console.WriteLine(@"Received payload from MP:");

            Console.WriteLine(e.Message.Body.Payload);

        }

  

        /// <summary>

        /// Captures data sent by HTTP sender and logs if verbose is enabled

        /// </summary>

        private static void OnSend(object sender, MessageSenderEventArgs e)

        {

            if (verbose == false)

            {

                return;

            }

  

            Console.WriteLine(@"Sending payload to MP:");

            Console.WriteLine(e.Message.Body.Payload);

  

            if (e.Message.Attachments.Count > 0)

            {

                if (e.Message is ConfigMgrFileCollectionMessage ||

                    e.Message is ConfigMgrUploadRequest)

                {

                    Console.WriteLine(@"Not writing attachments for {0} message to console", e.Message);

                    return;

                }

  

                for (int i = 0; i < e.Message.Attachments.Count; i++)

                {

                    Console.WriteLine(@"+======== ATTACHMENT #{0} (name: {1})========+", i + 1, e.Message.Attachments[i].Name);

                    Console.WriteLine(e.Message.Attachments[i].Body.Payload);

                }

            }

        }

  

        /// <summary>

        /// Performs an atomic operation

        /// </summary>

        [SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling")]

        [SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes")]

        private static void PerformOperation(Step step)

        {

            // Some steps require a valid client ID to work, this anonymous method ensures this.

            Action checkIsClientIdPresent = () =>

                                                {

                                                    if (null == clientId)

                                                    {

                                                        throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture, "Cannot execute step #{0:d} {0} because client is not registered.", step));

                                                    }

                                                };

  

            try

            {

                Console.WriteLine(@"===========================================================");

                Console.WriteLine(@"Sending '{0}' message", step);

                Console.WriteLine(@"===========================================================");

                switch (step)

                {

                    case Step.Register:

  

                        ConfigMgrRegistrationRequest regRequest = new ConfigMgrRegistrationRequest();

                        regRequest.Settings.HostName = mpHostname;

                        regRequest.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

  

                        // Manual registration

                        // Required: must supply a NetBIOS hostname

                        regRequest.NetBiosName = "MyDummyHostName";

  

                        // Required: must supply an agent identity (this is the name of your client)

                        regRequest.AgentIdentity = "MyCustomClient.exe";

  

                        // Required: must supply a client FQDN

                        regRequest.ClientFqdn = "MyDummyHostName.MyDomain.net";

  

                        // You can try enabling this to authenticate your client at registration. This may prevent having to "Approve" the client in the administrator

                        // console.

                        //regRequest.Settings.Security.AuthenticationType = AuthenticationType.WindowsAuth;

  

                        regRequest.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        regRequest.Settings.ReplyCompression = (true == replyCompression) ? MessageCompression.Zlib : MessageCompression.None;

                        clientId = regRequest.RegisterClient(Sender, TimeSpan.FromMinutes(5));

                        Console.WriteLine(@"Got SMSID from registration of: {0}", clientId);

                        break;

  

                    case Step.Ddr:

                        checkIsClientIdPresent();

  

                        ConfigMgrDataDiscoveryRecordMessage ddrMessage = new ConfigMgrDataDiscoveryRecordMessage();

                        ddrMessage.Settings.HostName = mpHostname;

                        ddrMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        ddrMessage.SmsId = clientId;

                        ddrMessage.SiteCode = siteCode;

                        ddrMessage.ADSiteName = "MyADSiteName";

                        ddrMessage.DomainName = "MyDomain.net";

                        ddrMessage.NetBiosName = "MyDummyHostName";

                        ddrMessage.ClientVersion = new ClientVersionV5();

                        ddrMessage.Discover();

                        ddrMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        ddrMessage.Settings.Security.EncryptMessage = encryption;

                        ddrMessage.SendMessage(Sender);

                        break;

  

                    case Step.Hinv:

                        checkIsClientIdPresent();

  

                        ConfigMgrHardwareInventoryMessage hinvMessage = new ConfigMgrHardwareInventoryMessage();

                        hinvMessage.Settings.HostName = mpHostname;

                        hinvMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        hinvMessage.SmsId = clientId;

                        hinvMessage.SiteCode = siteCode;

                        hinvMessage.NetBiosName = "MyDummyHostName";

                        hinvMessage.DomainName = "MyDomain.net";

                        hinvMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        hinvMessage.Settings.Security.EncryptMessage = encryption;

                        hinvMessage.AddInstancesToInventory(WmiClassToInventoryReportInstance.WmiClassToInventoryInstances(@"root\cimv2", "Win32_LogicalDisk", @"root\cimv2\sms", "SMS_LogicalDisk"));

                        hinvMessage.AddInstancesToInventory(WmiClassToInventoryReportInstance.WmiClassToInventoryInstances(@"root\cimv2", "Win32_Processor", @"root\cimv2\sms", "SMS_Processor"));

                        hinvMessage.AddInstancesToInventory(WmiClassToInventoryReportInstance.WmiClassToInventoryInstances(@"root\cimv2", "Win32_SystemDevices", @"root\cimv2\sms", "SMS_SystemDevices"));

                        hinvMessage.SendMessage(Sender);

                        break;

  

                    case Step.Sinv:

                        checkIsClientIdPresent();

  

                        ConfigMgrSoftwareInventoryMessage sinvMessage = new ConfigMgrSoftwareInventoryMessage();

                        sinvMessage.Settings.HostName = mpHostname;

                        sinvMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        sinvMessage.SmsId = clientId;

                        sinvMessage.SiteCode = siteCode;

                        sinvMessage.NetBiosName = "MyDummyHostName";

                        sinvMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        sinvMessage.Settings.Security.EncryptMessage = encryption;

                        sinvMessage.AddDirectoryFilesToInventory(Environment.ExpandEnvironmentVariables(@"%WINDIR%\system32"), "*.exe", true, true);

                        InventoryInstanceElementFileSystemFile fakeFile = new InventoryInstanceElementFileSystemFile();

                        fakeFile.LastWriteDate = TimeHelpers.Epoch.AddDays(-200);

                        fakeFile.FileVersion = "1.0";

                        fakeFile.FileDescription = "Fake File";

                        fakeFile.CompanyName = "Fake Company";

                        fakeFile.FileName = "FakeFile.EXE";

                        fakeFile.FilePath = Environment.ExpandEnvironmentVariables(@"%SYSTEMDRIVE%\MyFakeFile.EXE");

                        fakeFile.ProductName = "Fake Product";

                        fakeFile.ProductVersion = "1.0";

                        fakeFile.Size = 1024;

                        sinvMessage.AddFileSystemFileInstanceToInventory(fakeFile);

                        sinvMessage.SendMessage(Sender);

                        break;

  

                    case Step.FileCollection:

                        checkIsClientIdPresent();

  

                        ConfigMgrFileCollectionMessage fcMessage = new ConfigMgrFileCollectionMessage();

                        fcMessage.Settings.HostName = mpHostname;

                        fcMessage.Settings.BitsUpload = true;

                        fcMessage.Discover();

                        fcMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        fcMessage.SmsId = clientId;

                        fcMessage.SiteCode = siteCode;

                        fcMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        fcMessage.Settings.Security.EncryptMessage = encryption;

                        fcMessage.AddDirectoryFilesToCollection(Environment.ExpandEnvironmentVariables(@"%WINDIR%\system32"), "*.log", true, true);

                        fcMessage.SendMessage(Sender);

                        break;

  

                    case Step.UserPolicy:

                        checkIsClientIdPresent();

                        ConfigMgrPolicyAssignmentRequest userPolicyMessage = new ConfigMgrPolicyAssignmentRequest();

                        userPolicyMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        userPolicyMessage.Settings.HostName = mpHostname;

                        userPolicyMessage.ResourceType = PolicyAssignmentResourceType.User;

                        userPolicyMessage.Settings.Security.AuthenticationScheme = AuthenticationScheme.Ntlm;

                        userPolicyMessage.Settings.Security.AuthenticationType = AuthenticationType.WindowsAuth;

                        userPolicyMessage.SmsId = clientId;

                        userPolicyMessage.SiteCode = siteCode;

                        userPolicyMessage.Discover();

                        userPolicyMessage.SendMessage(Sender);

                        userPolicyMessage.Settings.Security.EncryptMessage = encryption;

                        userPolicyMessage.Settings.ReplyCompression = (true == replyCompression) ? MessageCompression.Zlib : MessageCompression.None;

                        userPolicyMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        break;

  

                    case Step.MachinePolicy:

                        checkIsClientIdPresent();

                        ConfigMgrPolicyAssignmentRequest machinePolicyMessage = new ConfigMgrPolicyAssignmentRequest();

                        machinePolicyMessage.Settings.HostName = mpHostname;

                        machinePolicyMessage.AddCertificateToMessage(certificate, CertificatePurposes.Signing | CertificatePurposes.Encryption);

                        machinePolicyMessage.Settings.Security.EncryptMessage = encryption;

                        machinePolicyMessage.Settings.Compression = (true == compression) ? MessageCompression.Zlib : MessageCompression.None;

                        machinePolicyMessage.Settings.ReplyCompression = (true == replyCompression) ? MessageCompression.Zlib : MessageCompression.None;

                        machinePolicyMessage.ResourceType = PolicyAssignmentResourceType.Machine;

                        machinePolicyMessage.SmsId = clientId;

                        machinePolicyMessage.SiteCode = siteCode;

                        machinePolicyMessage.Discover();

                        machinePolicyMessage.SendMessage(Sender);

  

                        break;

                }

  

                Console.WriteLine(@"===========================================================");

                Console.WriteLine(@"Successfully sent '{0}' message!", step);

                Console.WriteLine(@"===========================================================");

            }

            catch (Exception e)

            {

                e.RethrowCriticalException();

                Console.WriteLine();

                MessagingTrace.TraceException("Got unexpected exception while executing messaging step #{0:d}: '{0}'", e, step);

                Console.WriteLine(@"===========================================================");

                Console.WriteLine(@"Failed to send '{0}' message!", step);

                Console.WriteLine(@"===========================================================");

            }

        }

  

        /// <summary>

        /// Writes the various steps that can be executed with this program to the console

        /// </summary>

        private static void WriteSteps()

        {

            Console.WriteLine(@"1 -- register client");

            Console.WriteLine(@"2 -- send DDR");

            Console.WriteLine(@"3 -- send hardware inventory");

            Console.WriteLine(@"4 -- send software inventory");

            Console.WriteLine(@"5 -- send collected files");

            Console.WriteLine(@"6 -- request machine policy");

            Console.WriteLine(@"7 -- request user policy");

        }

  

        #region Nested type: Step

  

        /// <summary>

        /// Steps supported by this sample

        /// </summary>

        private enum Step

        {

            /// <summary>

            /// None (implementation implies manual selection loop)

            /// </summary>

            None = 0, 

  

            /// <summary>

            /// Register client

            /// </summary>

            Register = 1, 

  

            /// <summary>

            /// Send DDR

            /// </summary>

            Ddr = 2, 

  

            /// <summary>

            /// Send HINV

            /// </summary>

            Hinv = 3, 

  

            /// <summary>

            /// Send SINV

            /// </summary>

            Sinv = 4, 

  

            /// <summary>

            /// Send collected files

            /// </summary>

            FileCollection = 5, 

  

            /// <summary>

            /// Request machine policy

            /// </summary>

            MachinePolicy = 6, 

  

            /// <summary>

            /// Request user policy

            /// </summary>

            UserPolicy = 7, 

        }

  

        #endregion

    }

}

A couple of quick notes about the sample.

The sample as coded requires two arguments at the command line: the management point, and the site code. If this is the first time you’re running this on your site, you may need to “Approve” the client through the administrator console. You can also try to change the registration request to authenticate your machine by setting regRequest.Settings.Authentication

As coded, it expects a certificate file called MixedModeTestCert.pfx with a password of sccm to be in the same directory as the executable (see line 74). You can obviously change this to your liking but that’s how it’s implemented. To create this certificate, you can use makecert.exe (part of the Windows SDK):

makecert -len 2048 -sky exchange -a sha1 -sy 24 -pe -r -n CN=”ConfigMgr Test Certificate” -ss MY

That will create a certificate and add it to your Personal certificate store. You can then export it and provide a password that matches the code. Alternatively, you could change line 74 to use MessageCertificateX509File instead. The difference between MessageCertificateX509Volatile and MessageCertificateX509File is that the ‘Volatile class reads a certificate file into memory while the ‘File class reads from the certificate store (I admit the naming is a bit confusing).

I hope you found this sample useful.

Download the code sample: Program.cs

SDK: Configuration Manager 2012 SDK has RTM’ed

Adam Meltzer [MSFT] — Thu, 12 Jul 2012 17:46:53 GMT

The final version of the Configuration Manager 2012 SDK has been released. You can download it from here: http://www.microsoft.com/en-us/download/details.aspx?id=29559.

Documentation can be found here: http://msdn.microsoft.com/en-us/library/hh948960.aspx.

If you had been using the client messaging SDK from the RC version of the SDK, there have been numerous fixes and improvements in the RTM version thanks to some great feedback collected during the RC period. Please make sure you update to the latest version of this SDK if you had been using the RC bits.

SDK: How to create a custom client using the client messaging SDK (link)

Adam Meltzer [MSFT] — Mon, 30 Apr 2012 16:58:00 GMT

One of my colleagues, Minfang Lu has posted an introduction on how to create a custom client using the client messaging SDK. Her post expands on the sample.cs included with the SDK providing lots of useful information on how you can implement your own custom client solution.

You can read her post here: http://blogs.msdn.com/b/minfangl/archive/2012/04/25/step-by-step-on-how-to-create-a-fake-client-using-system-center-2012-configuration-manager-client-sdk.aspx

Thanks, Minfang!