ConfigMgrWebService

This web service was designed to extend the functionality of Operating System Deployment with Configuration Manager 2012 (and above). Included in this web service, the following methods are made available:

• Get Primary User by Device
• Get Primary Device by User
• Get Boot Image Source Version
• Get Deployed Applications by User
• Get Deployed Applications by Device
• Get Hidden Task Sequence Deployments

Supported Configurations

This web service has been built to support the following versions of System Center Configuration Manager:

• Configuration Manager 2012 SP1
• Configuration Manager 2012 SP2
• Configuration Manager 2012 R2
• Configuration Manager 2012 R2 SP1
• Configuration Manager Current Branch (1511, 1602 and 1606)

Make sure that .NET Framework 4.5.2 is available on the member server you intend to host this web service on.

Installation instructions

To successfully run this web service, you'll need to have IIS installed on a member server with ASP.NET enabled. Easiest way to get going is to install the ConfigMgrWebService on the same server as where your Management Point role is hosted. You'll also need to have a service account for the application pool in IIS. It's recommended that you add the service account in ConfigMgr with Full Administrator privileges.

1 - Create folder structure

1. Download the project and compile the solution in Visual Studio (you can download the free version called Visual Studio Community Edition)
2. Create a folder in C:\inetpub called ConfigMgrWebService. Inside that folder, create a folder called bin.
3. Copy the compiled ConfigMgrWebService.dll to C:\inetpub\ConfigMgrWebService\bin.
4. Rename Web.Release.config to Web.config and copy it to C:\inetpub\ConfigMgrWebService.
5. Copy ConfigMgrWebService.asmx to C:\inetpub\ConfigMgrWebService.
6. Locate AdminUI.WqlQueryEngine.dll and Microsoft.ConfigurationManagement.ManagementProvider.dll in the ConfigMgr console installation location and copy them to C:\inetpub\ConfigMgrWebService\bin.

2 - Add an Application Pool in IIS

1. Open IIS management console, right click on Application Pools and select Add Application Pool.
2. Enter ConfigMgrWebService as name, select the .NET CLR version .NET CLR Version v4.0.30319 and click OK.
3. Select the new ConfigMgrWebService application pool and select Advanced Settings.
4. In the Process Model section, specify the service account that will have access to ConfigMgr in the Identity field and click OK.

3 - Add an Application to Default Web Site

1. Open IIS management console, expand Sites, right click on Default Web Site and select Add Application.
2. As for Alias, enter ConfigMgrWebService.
3. Select ConfigMgrWebService as application pool.
4. Set the physical path to C:\inetpub\ConfigMgrWebService and click OK.

4 - Set Application Settings

1. Open IIS management console, expand Sites and Default Web Site.
2. Select ConfigMgrWebService application and go to Application Settings.
3. Enter values for each application settings, SiteServer being the server where the SMS Provider is installed, SiteCode being the site code of your site and SecretKey being a custom string that you create yourself.

Documentation

Application Settings

When calling the web service methods, you'll need to pass along a secret key that matches what's specified for the SecretKey application setting in web.config as a parameter. Without this parameter, the method will be invoked properly. This is a somewhat reasonable security mechanism (at least it's something) that prevents unathorized users to invoke the methods and retrieve data from your ConfigMgr environment. It's recommended that you generate a GUID and enter that as the SecretKey.

Available Methods

GetPrimaryUserByDevice

This method returns all primary user associated for a specified device.

Parameters

deviceName (string), secretKey (string)

GetPrimaryDeviceByUser

This methods returns all primary devices associated with a specified user.

Parameters

userName (string), secretKey (string)

GetDeployedApplicationsByUser

This methods returns a list of all applications deployed targeting a specified user.

Parameters

userName (string), secretKey (string)

GetDeployedApplicationsByDevice

This methods returns a list of all applications deployed targeting a specified device.

Parameters

deviceName (string), secretKey (string)

GetHiddenTaskSequenceDeployments

This method returns a list of all task sequences deployed (available and required) as hidden.

Parameters

secretKey (string)

GetBootImageSourceVersion

This method returns the source version of a specified Boot Image.

Parameters

packageId (string), secretKey (string)