The SMS_SoftwareUpdate Windows Management Instrumentation (WMI) class is an SMS Provider server class, in System Center 2012 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.
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. |
|
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/WriteQualifiers: [SizeLimit("512"), not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- ArticleID
- Data type: StringAccess type: Read-onlyQualifiers: [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-onlyQualifiers: [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/WriteQualifiers: NoneSee SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- CI_ID
- Data type: UInt32Access type: Read/WriteQualifiers: [key]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- CI_UniqueID
- Data type: StringAccess type: Read/WriteQualifiers:[unique, not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- CIType_ID
- Data type: UInt32Access type: Read-onlyQualifiers: [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-onlyQualifiers: [read, not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- CreatedBy
- Data type: StringAccess type: Read-onlyQualifiers: [SizeLimit("512"), read, not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- CustomSeverity
- Data type: UInt32Access type: Read/WriteQualifiers: NoneCustom severity rating for the software update. The default value is 0.
- CustomSeverityName
- Data type: StringAccess type: Read-onlyQualifiers: [read]Text for the custom severity rating.
- DateCreated
- Data type: DateTimeAccess type: Read-onlyQualifiers: [not_null, read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- DateLastModified
- Data type: DateTimeAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- DatePosted
- Data type: DateTimeAccess type: Read-onlyQualifiers: [read]Date and time when the software update was published.
- DateRevised
- Data type: DateTimeAccess type: Read-onlyQualifiers: [read]Date and time when the software update was revised.
- EffectiveDate
- Data type: DateTimeAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- EULAAccepted
- Data type: UInt32Access type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- EULAExists
- Data type: BooleanAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- EULASignoffDate
- Data type: DateTimeAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- EULASignoffUser
- Data type: StringAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- ExecutionContext
- Data type: UInt32Access type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsBundle
- Data type: BooleanAccess type: Read/WriteQualifiers: [not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsContentProvisioned
- Data type: BooleanAccess type: Read-onlyQualifiers: [read]true if the software update content is provisioned. The default value is false.
- IsDeployable
- Data type: BooleanAccess type: Read-onlyQualifiers: [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-onlyQualifiers: [read]true if the software update has been deployed. The default value is false.
- IsDigest
- Data type: BooleanAccess type: Read-onlyQualifiers: [read, lazy]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsEnabled
- Data type: BooleanAccess type: Read/WriteQualifiers: [not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsExpired
- Data type: BooleanAccess type: Read/WriteQualifiers: [not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsHidden
- Data type: BooleanAccess type: Read/WriteQualifiers: [not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsLatest
- Data type: BooleanAccess type: Read-only Qualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsMetadataOnlyUpdate
- Data type: BooleanAccess type: Read-onlyQualifiers: [read]true if the software update metabase is only Update CI. The default value is false.
- IsOfflineServiceable
- Data type: BooleanAccess type: Read-onlyQualifiers: [read]Whether or not the update can be applied to offline images.
- IsQuarantined
- Data type: BooleanAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsSuperseded
- Data type: BooleanAccess type: Read-onlyQualifiers: [read, not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- IsUserDefined
- Data type: BooleanAccess type: Read/WriteQualifiers: [not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- LastModifiedBy
- Data type: StringAccess type: Read-onlyQualifiers: [SizeLimit("512"), read, not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- LastStatusTime
- Data type: DateTimeAccess type: Read-onlyQualifiers: readLast status update time.
- LocalizedCategoryInstanceNames
- Data type: String ArrayAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- LocalizedDescription
- Data type: StringAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- LocalizedDisplayName
- Data type: StringAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- LocalizedEulas
- Data type: SMS_CI_LocalizedEulas ArrayAccess type: Read-onlyQualifiers: [read, lazy] An array of localized Microsoft Software License Terms for the software update.
- LocalizedInformation
- Data type: SMS_CI_LocalizedProperties ArrayAccess type:
Read-onlyQualifiers: [read, lazy]A list of language-specific
localized information about the software update:
- String DisplayName
- String Description
- String InformativeURL
- UInt32 LocaleID
- String DisplayName
- LocalizedInformativeURL
- Data type: StringAccess type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- LocalizedPropertyLocaleID
- Data type: UInt32Access type: Read-onlyQualifiers: [read]See SMS_ConfigurationItemBaseClass Server WMI Class.
- MaxExecutionTime
- Data type: UInt32Access type: Read/WriteQualifiers: NoneMaximum time required for the software update to run. The default value is 30.
- ModelID
- Data type: UInt32Access type: Read/Write Qualifiers: [not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- ModelName
- Data type: StringAccess type: Read/WriteQualifiers: [unique, not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- NumMissing
- Data type: UInt32Access type: Read-onlyQualifiers: [read]Number of computers in the targeted collections on which the software update is missing.
- NumNotApplicable
- Data type: UInt32Access type: Read-onlyQualifiers: [read]Number of computers in the targeted collections on which the software update is not applicable.
- NumPresent
- Data type: UInt32Access type: Read-onlyQualifiers: [read]Number of computers in the targeted collections on which the software update is already installed.
- NumTotal
- Data type: UInt32Access type: Read-onlyQualifiers: [read]Total number of computers in the targeted collections for the software update.
- NumUnknown
- Data type: UInt32Access type: Read-onlyQualifiers: [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/WriteQualifiers: [not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- PlatformCategoryInstance_UniqueIDs
- Data type: String arrayAccess type: Read/WriteQualifiers: noneSee SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- PlatformType
- Data type: UInt32Access type: Read/WriteQualifiers: noneSee SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- RequiresExclusiveHandling
- Data type: BooleanAccess type: Read-onlyQualifiers: [read]true if the software update must be installed separately. The default value is false.
- RevisionNumber
- Data type: UInt32Access type: Read-onlyQualifiers: [read, not_null]Revision number for the update.
- SDMPackageLocalizedData
- Data type: SMS_SDMPackageLocalizedData ArrayAccess type: Read/WriteQualifiers: [lazy]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- SDMPackageVersion
- Data type: UInt32Access type: Read/WriteQualifiers: [not_null]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- SDMPackageXML
- Data type: StringAccess type: Read/WriteQualifiers: [lazy]See SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- SecuredScopeNames
- Data type: String ArrayAccess type: Read-onlyQualifiers: noneSee SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- SedoObjectVersion
- Data type: StringAccess type: Read-onlyQualifiers: noneSee SMS_ConfigurationItemLatestBaseClass Server WMI Class.
- Severity
- Data type: UInt32Access type: Read-onlyQualifiers: [read]Severity rating for the software update. The default value is 0.
- SeverityName
- Data type: StringAccess type: Read-onlyQualifiers: [read]Text for the severity rating.
- Size
- Data type: SInt64Access type: Read-onlyQualifiers: [read]Size of the software update.
- SourceSite
- Data type: StringAccess type: Read/WriteQualifiers: [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-onlyQualifiers: [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 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
Reference
SMS_AuthorizationList Server WMI ClassSMS_CIToContent Server WMI Class
SMS_CIContentFiles Server WMI Class
SMS_CIUpdateSources Server WMI Class
SMS_Template Server WMI Class
SMS_UpdatesAssignment Server WMI Class
Concepts
Software Updates Server WMI ClassesConfiguration Manager Software Updates