SMS_Package Server WMI Class
Applies To: System Center 2012 Configuration Manager, System Center 2012 Configuration Manager SP1, System Center 2012 R2 Configuration Manager
The SMS_Package Windows Management Instrumentation (WMI) class is an SMS Provider server class, in System Center 2012 R2 Configuration Manager, that contains information about Configuration Manager packages.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Syntax
Class SMS_Package : SMS_PackageBaseclass
{
UInt32 ActionInProgress;
String AlternateContentProviders;
SInt32 DefaultImageFlags;
String Description;
UInt8 ExtendedData[];
UInt32 ExtendedDataSize;
UInt32 ForcedDisconnectDelay;
Boolean ForcedDisconnectEnabled;
UInt32 ForcedDisconnectNumRetries;
UInt8 Icon[];
UInt32 IconSize;
Boolean IgnoreAddressSchedule;
Boolean IsPredefinedPackage;
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 PackageSize;
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;
DateTime TransformAnalysisDate;
UInt32 TransformReadiness;
String Version;
};
Methods
The following table lists the methods in the SMS_Package class.
Method |
Description |
---|---|
Adds a package change notification. |
|
Adds the distribution points for the package. |
|
Determines if any other package is using the same custom share name. |
|
Determines whether the specified source name is used by another package. |
|
CheckPackageShareForTaskSequenceDeployment Method in Class SMS_Package |
Checks whether the package share type meets the requirements of a task sequence deployment. |
Refreshes the package source at all distribution points, when the package properties have not changed. |
|
Sets the code of the source site for the package. |
|
Sets the source site to the current site, unlocking the package. |
Properties
ActionInProgress
Data type: UInt32Access type: Read-only
Qualifiers: [read]
AlternateContentProviders
Data type: StringAccess type: Read/Write
Qualifiers: [large, lazy]
DefaultImageFlags
Data type: SInt32Access type: Read/Write
Qualifiers: None
A flag that indicates the package type. Possible values are:
2
USMT
Warning
Currently only the USMT package type is defined, all of other package types are 0.
This information applies to System Center 2012 Configuration Manager SP1 or later, and System Center 2012 R2 Configuration Manager or later.
Description
Data type: StringAccess type: Read/Write
Qualifiers: None
ExtendedData
Data type: UInt8 ArrayAccess type: Read/Write
Qualifiers: [large, lazy]
ExtendedDataSize
Data type: UInt32Access type: Read/Write
Qualifiers: [lazy]
ForcedDisconnectDelay
Data type: UInt32Access type: Read/Write
Qualifiers: None
ForcedDisconnectEnabled
Data type: BooleanAccess type: Read/Write
Qualifiers: None
ForcedDisconnectNumRetries
Data type: UInt32Access type: Read/Write
Qualifiers: None
Icon
Data type: UInt8 ArrayAccess type: Read/Write
Qualifiers: [large]
IconSize
Data type: UInt32Access type: Read/Write
Qualifiers: [lazy]
IgnoreAddressSchedule
Data type: BooleanAccess type: Read/Write
Qualifiers: None
IsPredefinedPackage
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
A flag that indicates whether this package is a predefined package.
ISVData
Data type: UInt8 ArrayAccess type: Read/Write
Qualifiers: [large, lazy]
ISVDataSize
Data type: UInt32Access type: Read/Write
Qualifiers: [lazy]
Language
Data type: StringAccess type: Read/Write
Qualifiers: None
LastRefreshTime
Data type: DateTimeAccess type: Read-only
Qualifiers: [read]
LocalizedCategoryInstanceNames
Data type: String ArrayAccess type: Read-only
Qualifiers: [read]
Manufacturer
Data type: StringAccess type: Read/Write
Qualifiers: None
MIFFilename
Data type: StringAccess type: Read/Write
Qualifiers: None
MIFName
Data type: StringAccess type: Read/Write
Qualifiers: None
MIFPublisher
Data type: StringAccess type: Read/Write
Qualifiers: None
MIFVersion
Data type: StringAccess type: Read/Write
Qualifiers: None
Name
Data type: StringAccess type: Read/Write
Qualifiers: None
NumOfPrograms
Data type: UInt32Access type: Read/Write
Qualifiers: None
PackageID
Data type: StringAccess type: [key]
PackageSize
Data type: UInt32Access type: Read
PackageType
Data type: UInt32Access type: Read/Write
Qualifiers: None
PkgFlags
Data type: UInt32Access type: Read/Write
Qualifiers: [bits]
PkgSourceFlag
Data type: UInt32Access type: Read/Write
Qualifiers: None
PkgSourcePath
Data type: StringAccess type: Read/Write
Qualifiers: None
PreferredAddressType
Data type: StringAccess type: Read/Write
Qualifiers: None
Priority
Data type: UInt32Access type: Read/Write
Qualifiers: None
RefreshPkgSourceFlag
Data type: BooleanAccess type: Read/Write
Qualifiers: [lazy]
RefreshSchedule
Data type: SMS_ScheduleToken ArrayAccess type: Read/Write]
Qualifiers: [max(15), lazy]
SecuredScopeNames
Data type: String ArrayAccess type: Read-only
Qualifiers: [read]
SedoObjectVersion
Data type: StringAccess type: Read-only
Qualifiers: [read]
ShareName
Data type: StringAccess type: Read/Write
Qualifiers: None
ShareType
Data type: UInt32Access type: Read/Write
Qualifiers: None
SourceDate
Data type: DateTimeAccess type: Read-only
Qualifiers: [read]
SourceSite
Data type: StringAccess type: Read-only
Qualifiers: [read]
SourceVersion
Data type: UInt32Access type: Read-only
Qualifiers: [read]
StoredPkgPath
Data type: StringAccess type: Read/Write
Qualifiers: None
StoredPkgVersion
Data type: UInt32Access type: Read/Write
Qualifiers: None
TransformAnalysisDate
Data type: DateTimeAccess type: Read/Write
Qualifiers: None
Date when the package was last analyzed by Package Conversion Manager.
TransformReadiness
Data type: UInt32Access type: Read/Write
Qualifiers: None
Stores the readiness value as determined by the analyze process in Package Conversion Manager. The default value is 0.
Possible values are:
0
Unknown
1
NotApplicable
2
NotReady
3
Ready
4
Transformed
5
Error
Version
Data type: StringAccess type: Read/Write
Qualifiers: None
Remarks
Class qualifiers for this class include:
- Secured
For more information about both the class qualifiers and the property qualifiers included in the Properties section, see Configuration Manager Class and Property Qualifiers.
Configuration Manager uses packages to distribute software to clients. Every package must contain at least one program (SMS_Program Server WMI Class), identifying what actions should occur on the client when the package is received. You can also identify whether the program provides an install status Management Information Format (MIF) file to report status or just uses an exit code.
When your application deletes an SMS_Package object, it is not fully deleted until deletion of its related items, for example, programs, source files, distribution points, and advertisements. Instead, Configuration Manager sets the ActionInProgress property to DELETE to mark the package for deletion. In SMS 2.0, to ensure that a query does not retrieve packages that have been marked for deletion, add this case to the WHERE clause. In SMS 2003, the WHERE clause is not required, because packages that are marked for deletion are not retrieved by a query. Use a status MIF file to generate detailed status reporting. To generate a status MIF file, your application must call the InstallStatusMIF function. For more information, see Status MIF Functions.
The values that your application provides when creating a package are entirely dependent on the programs that the package contains. For example, if the package contains a simple program that does not use source files and does not generate a status MIF file, the application can create a package that merely contains a value for the Name property.
Changing the ShareName or the PkgSourcePath property causes the Distribution Manager to delete and recreate the package on all distribution points of the current site. Because this can be an expensive process, your application should be efficient when updating these fields.
Note
Your application can also use the GetPDFData Method in Class SMS_PDF_Package to generate an SMS_Package object.
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
Configuration Manager Software Distribution Server WMI Classes
SMS_PackageBaseclass Server WMI Class
GetPDFData Method in Class SMS_PDF_Package
How to Create a Package
PowerShell Cmdlet: New-CMPackage