SMS_SoftwareUpdate Server WMI Class
Applies To: System Center 2012 Configuration Manager, System Center 2012 Configuration Manager SP1, System Center 2012 R2 Configuration Manager
The SMS_SoftwareUpdate Windows Management Instrumentation (WMI) class is an SMS Provider server class, in System Center 2012 R2 Configuration Manager, that exposes software update information available on a site and serves as the core class for software updates.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Syntax
Class SMS_SoftwareUpdate : SMS_ConfigurationItemBaseClass
{
String ApplicabilityCondition;
String ArticleID;
String BulletinID;
String CategoryInstance_UniqueIDs[];
UInt32 CI_ID;
String CI_UniqueID;
UInt32 CIType_ID;
UInt32 CIVersion;
String CreatedBy;
UInt32 CustomSeverity;
String CustomSeverityName;
DateTime DateCreated;
DateTime DateLastModified;
DateTime DatePosted;
DateTime DateRevised;
DateTime EffectiveDate;
UInt32 EULAAccepted;
Boolean EULAExists;
DateTime EULASignoffDate;
String EULASignoffUser;
UInt32 ExecutionContext;
Boolean IsBundle;
Boolean IsContentProvisioned;
Boolean IsDeployable;
Boolean IsDeployed;
Boolean IsDigest;
Boolean IsEnabled;
Boolean IsExpired;
Boolean IsHidden;
Boolean IsLatest;
Boolean IsMetadataOnlyUpdate;
Boolean IsOfflineServiceable;
Boolean IsQuarantined;
Boolean IsSuperseded;
Boolean IsUserDefined;
String LastModifiedBy;
DateTime LastStatusTime;
String LocalizedCategoryInstanceNames[];
String LocalizedDescription;
String LocalizedDisplayName;
SMS_CI_LocalizedEulas LocalizedEulas[];
SMS_CI_LocalizedProperties LocalizedInformation[];
String LocalizedInformativeURL;
UInt32 LocalizedPropertyLocaleID;
UInt32 MaxExecutionTime;
UInt32 ModelID;
String ModelName;
UInt32 NumMissing;
UInt32 NumNotApplicable;
UInt32 NumPresent;
UInt32 NumTotal;
UInt32 NumUnknown;
UInt32 PercentCompliant;
UInt32 PermittedUses;
String PlatformCategoryInstance_UniqueIDs[];
UInt32 PlatformType;
Boolean RequiresExclusiveHandling;
UInt32 RevisionNumber;
SMS_SDMPackageLocalizedData SDMPackageLocalizedData[];
UInt32 SDMPackageVersion;
String SDMPackageXML;
String SecuredScopeNames[];
String SedoObjectVersion;
UInt32 Severity;
String SeverityName;
SInt64 Size;
String SourceSite;
String UpdateLocales[];
};
Methods
The following table shows the methods in SMS_SoftwareUpdate.
Method |
Description |
---|---|
Accepts or declines the Microsoft Software License Terms of a software update. |
|
FilterUpdates Method in Class SMS_SoftwareUpdate |
For internal use only. |
Gets the localized Microsoft Software License Terms content of a software update. |
|
Sets policy enforcement of a software update. |
|
Performs a manual synchronization of the Software Update Point. |
Properties
ApplicabilityCondition
Data type: StringAccess type: Read/Write
Qualifiers: [SizeLimit("512"), not_null]
ArticleID
Data type: StringAccess type: Read-only
Qualifiers: [read, SizeLimit("64"), not_null]
Knowledge base article ID for the software update. The maximum length for this value is 64 characters.
BulletinID
Data type: StringAccess type: Read-only
Qualifiers: [read, SizeLimit("64"), not_null]
Bulletin ID for security updates released by Microsoft. The maximum length for this value is 64 characters. The default value is "None".
CategoryInstance_UniqueIDs
Data type: String ArrayAccess type: Read/Write
Qualifiers: None
CI_ID
Data type: UInt32Access type: Read/Write
Qualifiers: [key]
CI_UniqueID
Data type: StringAccess type: Read/Write
Qualifiers:[unique, not_null]
CIType_ID
Data type: UInt32Access type: Read-only
Qualifiers: [not_null, read]
See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
For this class, the type ID is SoftwareUpdate (1) or SoftwareUpdateBundle (8).
CIVersion
Data type: UInt32Access type: Read-only
Qualifiers: [read, not_null]
CreatedBy
Data type: StringAccess type: Read-only
Qualifiers: [SizeLimit("512"), read, not_null]
CustomSeverity
Data type: UInt32Access type: Read/Write
Qualifiers: None
Custom severity rating for the software update. The default value is 0.
CustomSeverityName
Data type: StringAccess type: Read-only
Qualifiers: [read]
Text for the custom severity rating.
DateCreated
Data type: DateTimeAccess type: Read-only
Qualifiers: [not_null, read]
DateLastModified
Data type: DateTimeAccess type: Read-only
Qualifiers: [read]
DatePosted
Data type: DateTimeAccess type: Read-only
Qualifiers: [read]
Date and time when the software update was published.
DateRevised
Data type: DateTimeAccess type: Read-only
Qualifiers: [read]
Date and time when the software update was revised.
EffectiveDate
Data type: DateTimeAccess type: Read-only
Qualifiers: [read]
EULAAccepted
Data type: UInt32Access type: Read-only
Qualifiers: [read]
EULAExists
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
EULASignoffDate
Data type: DateTimeAccess type: Read-only
Qualifiers: [read]
EULASignoffUser
Data type: StringAccess type: Read-only
Qualifiers: [read]
ExecutionContext
Data type: UInt32Access type: Read-only
Qualifiers: [read]
IsBundle
Data type: BooleanAccess type: Read/Write
Qualifiers: [not_null]
IsContentProvisioned
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
true if the software update content is provisioned. The default value is false.
IsDeployable
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
true if the software update is ready to be included in a deployment. The default value is false.
IsDeployed
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
true if the software update has been deployed. The default value is false.
IsDigest
Data type: BooleanAccess type: Read-only
Qualifiers: [read, lazy]
IsEnabled
Data type: BooleanAccess type: Read/Write
Qualifiers: [not_null]
IsExpired
Data type: BooleanAccess type: Read/Write
Qualifiers: [not_null]
IsHidden
Data type: BooleanAccess type: Read/Write
Qualifiers: [not_null]
IsLatest
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
IsMetadataOnlyUpdate
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
true if the software update metabase is only Update CI. The default value is false.
IsOfflineServiceable
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
Whether or not the update can be applied to offline images.
IsQuarantined
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
IsSuperseded
Data type: BooleanAccess type: Read-only
Qualifiers: [read, not_null]
IsUserDefined
Data type: BooleanAccess type: Read/Write
Qualifiers: [not_null]
LastModifiedBy
Data type: StringAccess type: Read-only
Qualifiers: [SizeLimit("512"), read, not_null]
LastStatusTime
Data type: DateTimeAccess type: Read-only
Qualifiers: read
Last status update time.
LocalizedCategoryInstanceNames
Data type: String ArrayAccess type: Read-only
Qualifiers: [read]
LocalizedDescription
Data type: StringAccess type: Read-only
Qualifiers: [read]
LocalizedDisplayName
Data type: StringAccess type: Read-only
Qualifiers: [read]
LocalizedEulas
Data type: SMS_CI_LocalizedEulas ArrayAccess type: Read-only
Qualifiers: [read, lazy]
An array of localized Microsoft Software License Terms for the software update.
LocalizedInformation
Data type: SMS_CI_LocalizedProperties ArrayAccess type: Read-only
Qualifiers: [read, lazy]
A list of language-specific localized information about the software update:
String DisplayName
String Description
String InformativeURL
UInt32 LocaleID
LocalizedInformativeURL
Data type: StringAccess type: Read-only
Qualifiers: [read]
LocalizedPropertyLocaleID
Data type: UInt32Access type: Read-only
Qualifiers: [read]
MaxExecutionTime
Data type: UInt32Access type: Read/Write
Qualifiers: None
Maximum time required for the software update to run. The default value is 30.
ModelID
Data type: UInt32Access type: Read/Write
Qualifiers: [not_null]
ModelName
Data type: StringAccess type: Read/Write
Qualifiers: [unique, not_null]
NumMissing
Data type: UInt32Access type: Read-only
Qualifiers: [read]
Number of computers in the targeted collections on which the software update is missing.
NumNotApplicable
Data type: UInt32Access type: Read-only
Qualifiers: [read]
Number of computers in the targeted collections on which the software update is not applicable.
NumPresent
Data type: UInt32Access type: Read-only
Qualifiers: [read]
Number of computers in the targeted collections on which the software update is already installed.
NumTotal
Data type: UInt32Access type: Read-only
Qualifiers: [read]
Total number of computers in the targeted collections for the software update.
NumUnknown
Data type: UInt32Access type: Read-only
Qualifiers: [read]
Number of computers in the targeted collections on which the state for the software update is known.
PercentCompliant
Data type: UInt32Access type: Read
Qualifiers: [read]
Percentage of client machines that are compliant for this configuration item.
PermittedUses
Data type: UInt32Access type: Read/Write
Qualifiers: [not_null]
PlatformCategoryInstance_UniqueIDs
Data type: String arrayAccess type: Read/Write
Qualifiers: none
PlatformType
Data type: UInt32Access type: Read/Write
Qualifiers: none
RequiresExclusiveHandling
Data type: BooleanAccess type: Read-only
Qualifiers: [read]
true if the software update must be installed separately. The default value is false.
RevisionNumber
Data type: UInt32Access type: Read-only
Qualifiers: [read, not_null]
Revision number for the update.
SDMPackageLocalizedData
Data type: SMS_SDMPackageLocalizedData ArrayAccess type: Read/Write
Qualifiers: [lazy]
SDMPackageVersion
Data type: UInt32Access type: Read/Write
Qualifiers: [not_null]
SDMPackageXML
Data type: StringAccess type: Read/Write
Qualifiers: [lazy]
SecuredScopeNames
Data type: String ArrayAccess type: Read-only
Qualifiers: none
SedoObjectVersion
Data type: StringAccess type: Read-only
Qualifiers: none
Severity
Data type: UInt32Access type: Read-only
Qualifiers: [read]
Severity rating for the software update. The default value is 0.
SeverityName
Data type: StringAccess type: Read-only
Qualifiers: [read]
Text for the severity rating.
Size
Data type: SInt64Access type: Read-only
Qualifiers: [read]
Size of the software update.
SourceSite
Data type: StringAccess type: Read/Write
Qualifiers: [SizeLimit("3")]
See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
For this class, the possible source sites are defined by the UpdateSource_ID property of SMS_CIUpdateSources Server WMI Class.
UpdateLocales
Data type: String ArrayAccess type: Read-only
Qualifiers: [read]
Locales applicable to the software update.
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.
An SMS_SoftwareUpdate object is a type of configuration item, defined by SMS_ConfigurationItemBaseClass Server WMI Class. Use SMS_SoftwareUpdate to determine the compliance of software updates using the Software Updates feature in System Center 2012 R2 Configuration Manager.
Software update content must be downloaded manually. To identify which contents need to be downloaded, your application queries SMS_CIToContent Server WMI Class and obtains the list of ContentID properties matching the specific language criteria. With this list, the application can obtain the associated download URL and the related properties for the content files from SMS_CIContentFiles Server WMI Class.
When the update content has been determined, the application optionally prepares the update for deployment using an SMS_AuthorizationList Server WMI Class object to create an authorized list of updates. Your application also has the option of implementing SMS_Template Server WMI Class to create a custom deployment template.
Note
When it is building an authorization list to include the software update, the application must set the IsBundle property of SMS_SoftwareUpdate to true to indicate that the update is part of a bundle. For more information, see SMS_AuthorizationList Server WMI Class.
When the application is ready to deploy the software update, it uses an SMS_UpdatesAssignment Server WMI Class object to create a deployment.
You cannot import, create, or configure software updates in the Desired Configuration Management node. These functions are made available to configuration baselines through the Software Updates feature when software updates are downloaded. Therefore, software update configuration items can be selected to be included in configuration baselines even though they are not displayed under the Configuration Items node.
See How to Enumerate Updates Matching a Specific Criteria for a discussion of queries that you can use to enumerate the information about multiple software updates.
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 Updates Server WMI Classes
SMS_AuthorizationList Server WMI Class
SMS_CIToContent Server WMI Class
SMS_CIContentFiles Server WMI Class
SMS_CIUpdateSources Server WMI Class
SMS_Template Server WMI Class
SMS_UpdatesAssignment Server WMI Class
Configuration Manager Software Updates