How to View the Properties for an Operating System Image

Article
10/04/2022

In Configuration Manager, you view the image properties for the Windows Image (WIM) file that is contained in an operating system package by calling the SMS_ImagePackage class instance GetImageProperties method.

The image properties are available in XML format.

To view image properties

Set up a connection to the SMS Provider. For more information, see SMS Provider fundamentals.
Get the SMS_ImagePackage class instance that you want to update.
Call the GetImageProperties class instance method.
Access property XML by using the ImageProperty parameter.

Example

The following example displays the operating system image package property XML that defines the package.

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

Sub ViewOSImage(connection,imagePackageID)  

    Dim imagePackage  
    Dim inParam  
    Dim outParams  

    ' Get the image.  
    Set imagePackage = connection.Get("SMS_ImagePackage.PackageID='" & imagePackageID & "'")  

    ' Obtain an InParameters object specific  
    ' to the method.  
    Set inParam = imagePackage.Methods_("GetImageProperties"). _  
        inParameters.SpawnInstance_()  

    ' Add the input parameters.  
    inParam.Properties_.Item("SourceImagePath") =  imagePackage.PkgSourcePath  

    ' Execute the method.  
    Set outParams = connection.ExecMethod("SMS_ImagePackage", "GetImageProperties", inParam)  

    ' Display the image properties XML.  
    Wscript.echo "ImageProperty: " & outParams.ImageProperty  

End Sub

public void ViewOSImage(  
    WqlConnectionManager connection,   
    string imagePackageId)  
{  
    try  
    {  
        IResultObject imagePackage = connection.GetInstance(@"SMS_ImagePackage.PackageID='" + imagePackageId + "'");  

        Dictionary<string, Object> inParams = new Dictionary<string, object>();  

        inParams.Add("SourceImagePath", imagePackage["PkgSourcePath"].StringValue);  
        IResultObject result = connection.ExecuteMethod("SMS_ImagePackage", "GetImageProperties", inParams);  

        Console.WriteLine(result["ImageProperty"].StringValue);  
    }  
    catch (SmsException e)  
    {  
        Console.WriteLine(e.Message);  
        throw;  
    }  
}

The example method has the following parameters:

Parameter	Type	Description
`connection`	- Managed: `WqlConnectionManager` - VBScript: SWbemServices	A valid connection to the SMS Provider.
`imagePackageID`	- Managed: `String` - VBScript: `String`	The package image identifier. It is available from `SMS_ImagePackage. PackageID`.

Compiling the Code

The C# example has the following compilation requirements:

Namespaces

System

System.Collections.Generic

System.Text

Microsoft.ConfigurationManagement.ManagementProvider

Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine

Assembly

microsoft.configurationmanagement.managementprovider

adminui.wqlqueryengine

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