SMS_BootImagePackage Server WMI Class

  • Article

Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2

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

AddChangeNotification Method in Class SMS_BootImagePackage

Adds a boot image package change notification.

AddDistributionPoints Method in Class SMS_Package

Adds the distribution points for the package.

DeleteContextID Method in Class SMS_BootImagePackage

Deletes the status queue that is associated with the specified context ID for the boot image package.

ExportDefaultBootImage Method in Class SMS_BootImagePackage

Finalizes and exports a boot image from a Windows Automated Installation Kit installation source to a specified location.

GetImageProperties Method in Class SMS_BootImagePackage

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.

RefreshPkgSource Method in Class SMS_BootImagePackage

Refreshes the package source at all distribution points, when the package properties have not changed.

ReloadImageProperties Method in Class SMS_BootImagePackage

Reloads image properties from the source .wim file and updates the database.

SetSourceSite Method in Class SMS_BootImagePackage

Sets the code of the source site for the boot image package.

Unlock Method in Class SMS_BootImagePackage

Sets the source site to the current site, unlocking the boot image package.

UpdateDefaultImage Method in Class SMS_BootImagePackageUpdateDefaultImage Method in Class SMS_BootImagePackage

Creates a copy of the WIM image pointed to by the ImagePath property and injects it with OSD files for boot image deployment.

UpdateImage Method in Class SMS_BootImagePackage

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: String

    Access type: Read-only

    Qualifiers: [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: UInt32

    Access type: Read-only

    Qualifiers: [read, ResID(733), ResDLL("SMS_RSTT.dll"), ResIDValueLookup("ActionInProgress")]

    See SMS_PackageBaseclass Server WMI Class.

  • BackgroundBitmapPath
    Data type: String

    Access type: Read/Write

    Qualifiers: [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: String

    Access type: Read/Write

    Qualifiers: [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 "".

  • EnableLabShell
    Data type: Boolean

    Access type: Read/Write

    Qualifiers: [lazy]

    true if command line support is enabled. The default value is false.

  • ImageDiskLayout
    Data type: String

    Access type: Read-only

    Qualifiers: [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: UInt32

    Access type: Read/Write

    Qualifiers: [lazy]

    Not used for a boot image.

  • ImagePath
    Data type: String

    Access type: Read/Write

    Qualifiers: None

    Original 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: String

    Access type: Read/Write

    Qualifiers: [lazy]

    An XML string holding metadata of the source .wim file, for example, the version. The default value is "".

  • PackageType
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: [ResID(734), ResDLL("SMS_RSTT.dll")]

    See SMS_PackageBaseclass Server WMI Class.

    For this class, the package type is PKG_TYPE_BOOTIMAGE (258).

  • ReferencedDrivers
    Data type: SMS_Driver_Details Array

    Access type: Read/Write

    Qualifiers: [lazy]

    Array of details about Configuration Manager drivers included in the boot image for import.

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

Concepts

Operating System Deployment Server WMI Classes
Configuration Manager Operating System Deployment
Operating System Deployment Image Management
About Operating System Deployment Task Sequences
How to Add a Windows Driver to a Configuration Manager Boot Image Package
How 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