The SMS_BootImagePackage Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that serves as the unit of distribution for boot image source files that are used to start a computer with Windows Pre-Installation Environment (PE) 2.0 and allow operating system deployment task sequence actions.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Class SMS_BootImagePackage : SMS_PackageBaseclass
{
UInt32 ActionInProgress;
String AlternateContentProviders;
String Architecture;
String BackgroundBitmapPath;
String ContextID;
String Description;
Boolean EnableLabShell;
UInt8 ExtendedData[];
UInt32 ExtendedDataSize;
UInt32 ForcedDisconnectDelay;
Boolean ForcedDisconnectEnabled;
UInt32 ForcedDisconnectNumRetries;
UInt8 Icon[];
UInt32 IconSize;
Boolean IgnoreAddressSchedule;
String ImageDiskLayout;
UInt32 ImageIndex;
String ImagePath;
String ImageProperty;
UInt8 ISVData[];
UInt32 ISVDataSize;
String Language;
DateTime LastRefreshTime;
String Manufacturer;
String MIFFilename;
String MIFName;
String MIFPublisher;
String MIFVersion;
String Name;
String PackageID;
UInt32 PackageType;
UInt32 PkgFlags;
UInt32 PkgSourceFlag;
String PkgSourcePath;
String PreferredAddressType;
UInt32 Priority;
SMS_Driver_Details ReferencedDrivers[];
Boolean RefreshPkgSourceFlag;
SMS_ScheduleToken RefreshSchedule[];
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_BootImagePackage.
| Method | Description |
|---|---|
|
Adds a boot image package change notification. |
|
|
Adds the distribution points for the package. |
|
|
Deletes the status queue that is associated with the specified context ID for the boot image package. |
|
|
Finalizes and exports a boot image from a Windows Automated Installation Kit installation source to a specified location. |
|
|
Reads all image properties from the specified source .wim file to an XML string. |
|
|
QueryOSDBinaryInjectionStatus Method in Class SMS_BootImagePackage |
Queries the current status of the injection of operating system deployment binaries. |
|
Refreshes the package source at all distribution points, when the package properties have not changed. |
|
|
Reloads image properties from the source .wim file and updates the database. |
|
|
Sets the code of the source site for the boot image package. |
|
|
Sets the source site to the current site, unlocking the boot image package. |
|
|
Creates a copy of the image for the boot image package and updates the image with files for boot image deployment. |
Properties
- Architecture
- Data type: StringAccess type: Read-onlyQualifiers:
[read]Architecture of the boot image. The following values are the
possible values. The default value is "".
x86
I386 32-bit microprocessor
ia64
Itanium 64-bit microprocessor
x64
X86-64 64-bit microprocessor
- ActionInProgress
- Data type: UInt32Access type: Read-onlyQualifiers: [read, ResID(733), ResDLL("SMS_RSTT.dll"), ResIDValueLookup("ActionInProgress")]See SMS_PackageBaseclass Server WMI Class.
- AlternateContentProviders
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(739), ResDLL("SMS_RSTT.dll"), large, lazy]See SMS_PackageBaseclass Server WMI Class.
- BackgroundBitmapPath
- Data type: StringAccess type: Read/WriteQualifiers: [lazy]Universal Naming Convention (UNC) path of the WinPE background bitmap. Your application can set this property to use a custom bitmap by supplying the path to the custom bitmap files.
- ContextID
- Data type: StringAccess type: Read/WriteQualifiers: [lazy]A context ID that can be queried for the status of injecting operating system deployment binaries. The injection operation takes quite a while, and your application can use this property for periodic status. The default value is "".
- Description
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(706), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- EnableLabShell
- Data type: BooleanAccess type: Read/WriteQualifiers: [lazy]true if command line support is enabled. The default value is false.
- ExtendedData
- Data type: UInt8 ArrayAccess type: Read/WriteQualifiers: [ResID(735), ResDLL("SMS_RSTT.dll"), large, lazy]See SMS_PackageBaseclass Server WMI Class.
- ExtendedDataSize
- Data type: UInt32Access type: Read/WriteQualifiers: [lazy, ResID(736), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- ForcedDisconnectDelay
- Data type: UInt32Access type: Read/WriteQualifiers: [ResID(719), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- ForcedDisconnectEnabled
- Data type: BooleanAccess type: Read/WriteQualifiers: [ResID(717), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- ForcedDisconnectNumRetries
- Data type: UInt32Access type: Read/WriteQualifiers: [ResID(718), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- Icon
- Data type: UInt8 ArrayAccess type: Read/WriteQualifiers: [ResID(724), ResDLL("SMS_RSTT.dll"), large]See SMS_PackageBaseclass Server WMI Class.
- IconSize
- Data type: UInt32Access type: Read/WriteQualifiers: [lazy, ResID(723), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- IgnoreAddressSchedule
- Data type: BooleanAccess type: Read/WriteQualifiers: [ResID(722), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- ImageDiskLayout
- Data type: StringAccess type: Read-onlyQualifiers: [lazy, read]An XML string of disk layout information for the source image, represented by a .wim file (WIM format). The default value is "".
- ImageIndex
- Data type: UInt32Access type: Read/WriteQualifiers: [lazy]Not used for a boot image.
- ImagePath
- Data type: StringAccess type: Read/WriteQualifiers: NoneOriginal image source path. Configuration Manager uses this path internally when the administrator imports an image. When the image is imported, Configuration Manager injects it with operating system deployment binaries.
- ImageProperty
- Data type: StringAccess type: Read/WriteQualifiers: [lazy]An XML string holding metadata of the source .wim file, for example, the version. The default value is "".
- ISVData
- Data type: UInt8 ArrayAccess type: Read/WriteQualifiers: [ResID(737), ResDLL("SMS_RSTT.dll"), large, lazy]See SMS_PackageBaseclass Server WMI Class.
- ISVDataSize
- Data type: UInt32Access type: Read/WriteQualifiers: [lazy, ResID(738), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- Language
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(704), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- LastRefreshTime
- Data type: DateTimeAccess type: Read-onlyQualifiers: [read, ResID(726), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- Manufacturer
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(705), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- MIFFilename
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(729), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- MIFName
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(731), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- MIFPublisher
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(730), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- MIFVersion
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(732), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- Name
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(702), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- PackageID
- Data type: StringAccess type: [key, ResID(701), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- PackageType
- Data type: UInt32Access type: Read/WriteQualifiers: [ResID(734), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.For this class, the package type is PKG_TYPE_BOOTIMAGE (258).
- PkgFlags
- Data type: UInt32Access type: Read/WriteQualifiers: [bits, ResID(728), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- PkgSourceFlag
- Data type: UInt32Access type: Read/WriteQualifiers: [ResID(707), ResDLL("SMS_RSTT.dll"), ResIDValueLookup("PkgSourceFlag")]See SMS_PackageBaseclass Server WMI Class.
- PkgSourcePath
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(708), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- PreferredAddressType
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(721), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- Priority
- Data type: UInt32Access type: Read/WriteQualifiers: [ResID(720), ResDLL("SMS_RSTT.dll"), ResIDValueLookup("Priority")]See SMS_PackageBaseclass Server WMI Class.
- ReferencedDrivers
- Data type: SMS_Driver_Details ArrayAccess type: Read/WriteQualifiers: [lazy]Array of details about Configuration Manager drivers included in the boot image for import.
- RefreshPkgSourceFlag
- Data type: BooleanAccess type: Read/WriteQualifiers: [lazy, ResID(709), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- RefreshSchedule
- Data type: SMS_ScheduleToken ArrayAccess type: [max(15), lazy, ResID(725), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- ShareName
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(715), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- ShareType
- Data type: UInt32Access type: Read/WriteQualifiers: [ResID(714), ResDLL("SMS_RSTT.dll"), ResIDValueLookup("ShareType")]See SMS_PackageBaseclass Server WMI Class.
- SourceDate
- Data type: DateTimeAccess type: Read-onlyQualifiers: [read, ResID(713), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- SourceSite
- Data type: StringAccess type: Read-onlyQualifiers: [read, ResID(716), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- SourceVersion
- Data type: UInt32Access type: Read-onlyQualifiers: [read, ResID(712), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- StoredPkgPath
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(710), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- StoredPkgVersion
- Data type: UInt32Access type: Read/WriteQualifiers: [ResID(711), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- Version
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(703), ResDLL("SMS_RSTT.dll")]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 a Boot Image from a WIM File in Configuration Manager.
Windows device drivers that are imported into the driver catalog can be added to one or more boot images, represented by SMS_BootImagePackage objects. Within a boot image, drivers are stored in an array of referenced drivers. For more information, see How to Add a Windows Driver to a Configuration Manager Boot Image Package and How to Remove a Windows Driver from a Boot Image Package.
Requirements
Runtime Requirements
For more information, see Configuration Manager Server Runtime Requirements.
Development Requirements
For more information, see Configuration Manager Server Development Requirements.
See Also
Tasks
How to Add a Windows Driver to a Configuration Manager Boot Image PackageHow to Remove a Windows Driver from a Boot Image Package
How to Add a Boot Image from a WIM File in Configuration Manager
How to Modify a Configuration Manager Object by Using WMI
Other Resources
Operating System Deployment Server WMI ClassesConfiguration Manager Operating System Deployment
Operating System Deployment Image Management
About Operating System Deployment Task Sequences
Send comments about this topic to Microsoft.