The SMS_TaskSequencePackage Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that represents a task sequence package that defines the steps to run for the task sequence.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Class SMS_TaskSequencePackage : SMS_PackageBaseclass
{
UInt32 ActionInProgress;
String AlternateContentProviders;
String BootImageID;
String Category;
String CustomProgressMsg;
String DependentProgram;
String Description;
UInt32 Duration;
UInt8 ExtendedData[];
UInt32 ExtendedDataSize;
UInt32 ForcedDisconnectDelay;
Boolean ForcedDisconnectEnabled;
UInt32 ForcedDisconnectNumRetries;
UInt8 Icon[];
UInt32 IconSize;
Boolean IgnoreAddressSchedule;
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;
UInt32 ProgramFlags;
SMS_TaskSequence_Reference References[];
Boolean RefreshPkgSourceFlag;
SMS_ScheduleToken RefreshSchedule[];
String Reserved;
String Sequence;
String ShareName;
UInt32 ShareType;
DateTime SourceDate;
String SourceSite;
UInt32 SourceVersion;
String StoredPkgPath;
UInt32 StoredPkgVersion;
SMS_OS_Details SupportedOperatingSystems[];
UInt32 TaskSequenceFlags;
UInt32 Type;
String Version;
};
|
Methods
The following table shows the methods in SMS_TaskSequencePackage.
| Method | Description |
|---|---|
|
AddChangeNotification Method in Class SMS_TaskSequencePackage |
Adds a task sequence package change notification. |
|
AddDistributionPoints Method in Class SMS_TaskSequencePackage |
Adds the distribution points for the task sequence package. |
|
GetClientConfigPolicies Method in Class SMS_TaskSequencePackage |
Gets all site-wide client configuration policies and their corresponding policy assignments. |
|
Gets the certificate hash for the task sequence package. |
|
|
Gets a task sequence from a task sequence package. |
|
|
Gets all policies associated with the specified task sequence. |
|
|
Refreshes the package source at all distribution points when the package properties have not changed. |
|
|
Updates a task sequence package with the input task sequence. |
|
|
Sets the code of the source site for the task sequence package. |
|
|
Sets the source site to the current site, unlocking the task sequence package. |
Properties
- 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.
- BootImageID
- Data type: StringAccess type: Read/WriteQualifiers: [lazy]ID of the boot image package if the task sequence contains a reference to a boot image in the References property. For information about the boot image package, see SMS_BootImagePackage Server WMI Class.
- Category
- Data type: StringAccess type: Read/WriteQualifiers: [lazy, ResID(903), ResDLL("SMS_RSTT.dll")]Task sequence package category. The default value is "". The category for the package is assigned using the Category property of SMS_TaskSequence Server WMI Class.
- CustomProgressMsg
- Data type: StringAccess type: Read/WriteQualifiers: [lazy, ResID(903), ResDLL("SMS_RSTT.dll")]A custom progress message specified in the Configuration Manager console.
- DependentProgram
- Data type: StringAccess type: Read/WriteQualifiers: [lazy, ResID(907), ResDLL("SMS_RSTT.dll")]A formatted text string defining any program that should be run before the current program. The format is "<PackageID>;;<ProgramName>". For more information, see SMS_Program Server WMI Class.
- Description
- Data type: StringAccess type: Read/WriteQualifiers: [ResID(706), ResDLL("SMS_RSTT.dll")]See SMS_PackageBaseclass Server WMI Class.
- Duration
- Data type: UInt32Access type: Read/WriteQualifiers: [ResID(916), ResDLL("SMS_RSTT.dll")]The approximate duration of time, in minutes, that the program takes to run. The default value is 0.
- 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.
- 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: ReadQualifiers [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_TASK_SEQUENCE (4).
- 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.
- ProgramFlags
- Data type: UInt32Access type: Read/WriteQualifiers:
[bits, ResID(914), ResDLL("SMS_RSTT.dll")]Flags identifying the
installation characteristics of the program. The default flags are
default program, UNATTENDED, UNCPATH, HIDEWINDOW, ADMINRIGHTS, and
ANY_PLATFORM. The default value is 152084496.
Bit Description 0
AUTHORIZED_DYNAMIC_INSTALL. The program is authorized for dynamic installation.
1
USE_CUSTOM_PROGRESS_MSG. The program uses a customized progress message.
8
WINDOWS_CE. Use Windows CE as the device program. If this value is set, the program is not offered to desktop clients.
9
RUN_DEPENDANT_ALWAYS. Always run the immediate dependent of the program.
10
COUNTDOWN. Display the countdown dialog.
12
DISABLED. The program is disabled.
13
UNATTENDED. The program requires no user interaction.
14
USERCONTEXT. The program needs to run in the user context. Always set the value to 0.
15
ADMINRIGHTS. The program must run under administrator rights.
16
EVERYUSER. The program must be run by every user for whom it is valid. This setting is valid only for mandatory jobs. Always set the value to 0.
17
NOUSERLOGGEDIN. The program is run only when no user is logged on.
18
OKTOQUIT. Program shutdown is enabled. Always set the value to 0.
19
OKTOREBOOT. Computer reboot is enabled. Always set the value to 0.
20
USEUNCPATH. Program access uses a Universal Naming Convention (UNC) path.
21
PERSISTCONNECTION. The program connection is persisted. Always set the value to 0.
22
RUNMINIMIZED. Maximize the program window. Always set the value to 0.
23
RUNMAXIMIZED. Minimize the program window. Always set the value to 0.
24
HIDEWINDOW. Hide the program window.
25
OKTOLOGOFF. Logoff is enabled. Always set the value to 0.
26
RUNACCOUNT. Run the program using account access.
27
ANY_PLATFORM. The program can run on any operating system.
28
STILL_RUNNING. The program is currently running.
29
SUPPORT_UNINSTALL. The program has an uninstall utility. Always set the value to 0.
31
SHOW_IN_ARP. Display the program in Add or Remove Programs.
- References
- Data type: SMS_TaskSequence_Reference ArrayAccess type: Read-onlyQualifiers: [lazy, read]SMS_TaskSequence_Reference Server WMI Class objects representing the packages and programs referred to by steps in the task sequence.
- 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.
- Reserved
- Data type: StringAccess type: Read/WriteQualifiers: [lazy]Used internally by the SMS Provider.
- Sequence
- Data type: StringAccess type: Read-onlyQualifiers: [lazy, read]XML-formatted data containing task sequence information.
- 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.
- SupportedOperatingSystems
- Data type: SMS_OS_Details ArrayAccess type: Read/WriteQualifiers: [lazy, ResID(910), ResDLL("SMS_RSTT.dll")]SMS_OS_Details Server WMI Class objects that describe details for the platforms on which the program can run.
- TaskSequenceFlags
- Data type: UInt32Access type: Read/WriteQualifiers:
[lazy, bits("DANGLING_REF(0)")]Flags indicating task sequence
package conditions. The only flag currently defined is DANGLING_REF
(bit 0).
Bit Description 0
Set if the task sequence references a package that is not defined on the site.
- Type
- Data type: UInt32Access type: Read-onlyQualifiers:
[lazy, read]The type of task sequence represented by the package.
Possible values are:
Value Description 1
Generic task sequence
2
Operating system deployment task sequence
- 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, seeHow to Create an Operating System Deployment Task Sequence Package.
You create an operating system deployment task sequence package by creating an instance of the SMS_TaskSequencePackage class to hold a task sequence. The task sequence itself is created by using the Operating System Deployment Task Sequence Object Model, and it is associated with the task sequence package by using the SetSequence Method in Class SMS_TaskSequencePackage method. The package is advertised to clients who can then run the task sequence. For more information, see How to Create an Operating System Deployment Task Sequence Package.
For more information about the task sequencing WMI objects, see About Operating System Deployment Task Sequences.
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 Create an Operating System Deployment Task Sequence PackageReference
SMS_PackageBaseclass Server WMI ClassSMS_OS_Details Server WMI Class
SMS_TaskSequence Server WMI Class
Other Resources
Operating System Deployment Server WMI ClassesConfiguration Manager Operating System Deployment
About Operating System Deployment Task Sequences
Send comments about this topic to Microsoft.