SMS_SoftwareUpdate Server WMI Class

Article
10/10/2022

The SMS_SoftwareUpdate Windows Management Instrumentation (WMI) class is an SMS Provider server class, in 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;   
      UInt64 ConfigurationFlags;  
      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
AcceptEULA Method in Class SMS_SoftwareUpdate	Accepts or declines the Microsoft Software License Terms of a software update.
FilterUpdates Method in Class SMS_SoftwareUpdate	For internal use only.
GetEULA Method in Class SMS_SoftwareUpdate	Gets the localized Microsoft Software License Terms content of a software update.
SetEnforcement Method in Class SMS_SoftwareUpdate	Sets policy enforcement of a software update.
SyncNow Method in Class SMS_SoftwareUpdate	Performs a manual synchronization of the Software Update Point.

Properties

ApplicabilityCondition
Data type: String

Access type: Read/Write

Qualifiers: [SizeLimit("512"), not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

ArticleID
Data type: String

Access type: Read-only

Qualifiers: [read, SizeLimit("64"), not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

BulletinID
Data type: String

Access type: Read-only

Qualifiers: [read, SizeLimit("64"), not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

CategoryInstance_UniqueIDs
Data type: String Array

Access type: Read/Write

Qualifiers: None

See SMS_SoftwareUpdateBase Server WMI Class.

CI_ID
Data type: UInt32

Access type: Read/Write

Qualifiers: [key]

See SMS_SoftwareUpdateBase Server WMI Class.

CI_UniqueID
Data type: String

Access type: Read/Write

Qualifiers:[unique, not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

CIType_ID
Data type: UInt32

Access type: Read-only

Qualifiers: [not_null, read]

See SMS_SoftwareUpdateBase Server WMI Class.

For this class, the type ID is SoftwareUpdate (1) or SoftwareUpdateBundle (8).

CIVersion
Data type: UInt32

Access type: Read-only

Qualifiers: [read, not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

ConfigurationFlags
Data type: UInt64

Access type: Read-only

Qualifiers: [bits("COMPLIANCE_POLICY(0)"), read]

See SMS_SoftwareUpdateBase Server WMI Class.

CreatedBy
Data type: String

Access type: Read-only

Qualifiers: [SizeLimit("512"), read, not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

CustomSeverity
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_SoftwareUpdateBase Server WMI Class.

CustomSeverityName
Data type: String

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

DateCreated
Data type: DateTime

Access type: Read-only

Qualifiers: [not_null, read]

See SMS_SoftwareUpdateBase Server WMI Class.

DateLastModified
Data type: DateTime

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

DatePosted
Data type: DateTime

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

DateRevised
Data type: DateTime

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

EffectiveDate
Data type: DateTime

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

EULAAccepted
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

EULAExists
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

EULASignoffDate
Data type: DateTime

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

EULASignoffUser
Data type: String

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

ExecutionContext
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

IsBundle
Data type: Boolean

Access type: Read/Write

Qualifiers: [not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

IsContentProvisioned
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

IsDeployable
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

IsDeployed
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

IsDigest
Data type: Boolean

Access type: Read-only

Qualifiers: [read, lazy]

See SMS_SoftwareUpdateBase Server WMI Class.

IsEnabled
Data type: Boolean

Access type: Read/Write

Qualifiers: [not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

IsExpired
Data type: Boolean

Access type: Read/Write

Qualifiers: [not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

IsHidden
Data type: Boolean

Access type: Read/Write

Qualifiers: [not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

IsLatest
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

IsMetadataOnlyUpdate
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

IsOfflineServiceable
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

IsQuarantined
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

IsSuperseded
Data type: Boolean

Access type: Read-only

Qualifiers: [read, not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

IsUserDefined
Data type: Boolean

Access type: Read/Write

Qualifiers: [not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

LastModifiedBy
Data type: String

Access type: Read-only

Qualifiers: [SizeLimit("512"), read, not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

LastStatusTime
Data type: DateTime

Access type: Read-only

Qualifiers: read

See SMS_SoftwareUpdateBase Server WMI Class.

LocalizedCategoryInstanceNames
Data type: String Array

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

LocalizedDescription
Data type: String

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

LocalizedDisplayName
Data type: String

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

LocalizedEulas
Data type: SMS_CI_LocalizedEulas Array

Access type: Read-only

Qualifiers: [read, lazy]

See SMS_SoftwareUpdateBase Server WMI Class.

LocalizedInformation
Data type: SMS_CI_LocalizedProperties Array

Access type: Read-only

Qualifiers: [read, lazy]

See SMS_SoftwareUpdateBase Server WMI Class.

LocalizedInformativeURL
Data type: String

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

LocalizedPropertyLocaleID
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

MaxExecutionTime
Data type: UInt32

Access type: Read/Write

Qualifiers: None

See SMS_SoftwareUpdateBase Server WMI Class.

ModelID
Data type: UInt32

Access type: Read/Write

Qualifiers: [not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

ModelName
Data type: String

Access type: Read/Write

Qualifiers: [unique, not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

NumMissing
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

NumNotApplicable
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

NumPresent
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

NumTotal
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

NumUnknown
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

PercentCompliant
Data type: UInt32

Access type: Read

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

PermittedUses
Data type: UInt32

Access type: Read/Write

Qualifiers: [not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

PlatformCategoryInstance_UniqueIDs
Data type: String array

Access type: Read/Write

Qualifiers: none

See SMS_SoftwareUpdateBase Server WMI Class.

PlatformType
Data type: UInt32

Access type: Read/Write

Qualifiers: none

See SMS_SoftwareUpdateBase Server WMI Class.

RequiresExclusiveHandling
Data type: Boolean

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

RevisionNumber
Data type: UInt32

Access type: Read-only

Qualifiers: [read, not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

SDMPackageLocalizedData
Data type: SMS_SDMPackageLocalizedData Array

Access type: Read/Write

Qualifiers: [lazy]

See SMS_SoftwareUpdateBase Server WMI Class.

SDMPackageVersion
Data type: UInt32

Access type: Read/Write

Qualifiers: [not_null]

See SMS_SoftwareUpdateBase Server WMI Class.

SDMPackageXML
Data type: String

Access type: Read/Write

Qualifiers: [lazy]

See SMS_SoftwareUpdateBase Server WMI Class.

SecuredScopeNames
Data type: String Array

Access type: Read-only

Qualifiers: none

See SMS_SoftwareUpdateBase Server WMI Class.

SedoObjectVersion
Data type: String

Access type: Read-only

Qualifiers: none

See SMS_SoftwareUpdateBase Server WMI Class.

Severity
Data type: UInt32

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

SeverityName
Data type: String

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

Size
Data type: SInt64

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

SourceSite
Data type: String

Access type: Read/Write

Qualifiers: [SizeLimit("3")]

See SMS_SoftwareUpdateBase Server WMI Class.

UpdateLocales
Data type: String Array

Access type: Read-only

Qualifiers: [read]

See SMS_SoftwareUpdateBase Server WMI Class.

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 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.

Share via

SMS_SoftwareUpdate Server WMI Class

Syntax

Methods

Properties

Remarks

Requirements

Runtime Requirements

Development Requirements

See Also

Feedback

Additional resources