SMS_ImagePackage Server WMI Class

The SMS_ImagePackage Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that serves as the unit of distribution for image source files that are used to deploy a valid operating system, for example, Windows 10, in WIM format to a client computer.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.

Syntax

Class SMS_ImagePackage : SMS_PackageBaseclass  
{  
      UInt32 ActionInProgress;  
      String AlternateContentProviders;  
      String Description;  
      UInt8 ExtendedData[];  
      UInt32 ExtendedDataSize;  
      UInt32 ForcedDisconnectDelay;  
      Boolean ForcedDisconnectEnabled;  
      UInt32 ForcedDisconnectNumRetries;  
      UInt8 Icon[];  
      UInt32 IconSize;  
      Boolean IgnoreAddressSchedule;  
      String ImageDiskLayout;  
      String ImageProperty;  
      UInt8 ISVData[];  
      UInt32 ISVDataSize;  
      String Language;  
      DateTime LastRefreshTime;  
      String LocalizedCategoryInstanceNames[];  
      String Manufacturer;  
      String MIFFilename;  
      String MIFName;  
      String MIFPublisher;  
      String MIFVersion;  
      String Name;  
      UInt32 NumOfPrograms;  
      String PackageID;  
      UInt32 PackageType;  
      UInt32 PkgFlags;  
      UInt32 PkgSourceFlag;  
      String PkgSourcePath;  
      String PreferredAddressType;  
      UInt32 Priority;  
      Boolean RefreshPkgSourceFlag;  
      SMS_ScheduleToken RefreshSchedule[];  
      String SecuredScopeNames[];  
      String SedoObjectVersion;  
      String ShareName;  
      UInt32 ShareType;  
      DateTime SourceDate;  
      String SourceSite;  
      UInt32 SourceVersion;  
      String StoredPkgPath;  
      UInt32 StoredPkgVersion;  
      String Version;  
};  

Methods

The following table shows the methods in SMS_ImagePackage.

Method Description
AddChangeNotification Method in Class SMS_ImagePackage Adds an image package change notification.
AddDistributionPoints Method in Class SMS_ImagePackage Adds the distribution points for the package.
GetImageProperties Method in Class SMS_ImagePackage Reads all image properties from the specified WIM file to an XML string.
RefreshPkgSource Method in Class SMS_ImagePackage Refreshes the package source at all distribution points, when the package properties have not changed.
ReloadImageProperties Method in Class SMS_ImagePackage Reloads image properties from source WIM file and updates the database.
RunOfflineServicingManager Method in Class SMS_ImagePackage Triggers the offline servicing manager to run as soon as possible.
SetSourceSite Method in Class SMS_ImagePackage Sets the code of the source site for the image package.
Unlock Method in Class SMS_ImagePackage Sets the source site to the current site, unlocking the image package.

Properties

ActionInProgress
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_PackageBaseclass Server WMI Class.

AlternateContentProviders
Data type: String

Access type: Read/Write

Qualifiers: [large, lazy]

See SMS_PackageBaseclass Server WMI Class.

Description
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

ExtendedData
Data type: UInt8 Array

Access type: Read/Write

Qualifiers: [large, lazy]

See SMS_PackageBaseclass Server WMI Class.

ExtendedDataSize
Data type: UInt32

Access type: Read/Write

Qualifiers: [lazy]

See SMS_PackageBaseclass Server WMI Class.

ForcedDisconnectDelay
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

ForcedDisconnectEnabled
Data type: Boolean

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

ForcedDisconnectNumRetries
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

Icon
Data type: UInt8 Array

Access type: Read/Write

Qualifiers: [large]

See SMS_PackageBaseclass Server WMI Class.

IconSize
Data type: UInt32

Access type: Read/Write

Qualifiers: [lazy]

See SMS_PackageBaseclass Server WMI Class.

IgnoreAddressSchedule
Data type: Boolean

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

ImageDiskLayout
Data type: String

Access type: Read-only

Qualifiers: [lazy, read]

An XML string of disk drive layout information about the source WIM image. The default value is "".

ImageProperty
Data type: String

Access type: Read/Write

Qualifiers: [lazy]

An XML string of image metadata for the source WIM file. The default value is "".

ISVData
Data type: UInt8 Array

Access type: Read/Write

Qualifiers: [large, lazy]

See SMS_PackageBaseclass Server WMI Class.

ISVDataSize
Data type: UInt32

Access type: Read/Write

Qualifiers: [lazy]

See SMS_PackageBaseclass Server WMI Class.

Language
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

LastRefreshTime
Data type: DateTime

Access type: Read-only

Qualifiers: [read]

See SMS_PackageBaseclass Server WMI Class.

LocalizedCategoryInstanceNames
Data type: String Array

Access type: Read-only

Qualifiers: [read]

See SMS_PackageBaseclass Server WMI Class.

Manufacturer
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

MIFFilename
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

MIFName
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

MIFPublisher
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

MIFVersion
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

Name
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

NumOfPrograms
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

PackageID
Data type: String

Access type: [key]

See SMS_PackageBaseclass Server WMI Class.

PackageType
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

For this class, the package type is PKG_TYPE_IMAGE (257).

PkgFlags
Data type: UInt32

Access type: Read/Write

Qualifiers: [bits]

See SMS_PackageBaseclass Server WMI Class.

PkgSourceFlag
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

PkgSourcePath
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

PreferredAddressType
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

Priority
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

RefreshPkgSourceFlag
Data type: Boolean

Access type: Read/Write

Qualifiers: [lazy]

See SMS_PackageBaseclass Server WMI Class.

RefreshSchedule
Data type: SMS_ScheduleToken Array

Access type: [max(15), lazy, ResID(725), ResDLL("SMS_RSTT.dll")]

See SMS_PackageBaseclass Server WMI Class.

SecuredScopeNames
Data type: String Array

Access type: Read-only

Qualifiers: [read]

See SMS_PackageBaseclass Server WMI Class.

SedoObjectVersion
Data type: String

Access type: Read-only

Qualifiers: [read]

See SMS_PackageBaseclass Server WMI Class.

ShareName
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

ShareType
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

SourceDate
Data type: DateTime

Access type: Read-only

Qualifiers: [read]

See SMS_PackageBaseclass Server WMI Class.

SourceSite
Data type: String

Access type: Read-only

Qualifiers: [read]

See SMS_PackageBaseclass Server WMI Class.

SourceVersion
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_PackageBaseclass Server WMI Class.

StoredPkgPath
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

StoredPkgVersion
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

Version
Data type: String

Access type: Read/Write

Qualifiers: None

See SMS_PackageBaseclass Server WMI Class.

Remarks

Class qualifiers for this class include:

  • Secured

  • Icon("Package.ico")

    For more information about both the class qualifiers and the property qualifiers included in the Properties section, see Configuration Manager Class and Property Qualifiers.

    To get started using this class, see How to Add an Operating System Image Package in Configuration Manager.

Requirements

Runtime Requirements

For more information, see Configuration Manager Server Runtime Requirements.

Development Requirements

For more information, see Configuration Manager Server Development Requirements.