SMS_SoftwareUpdate Server WMI Class

  • Article

Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2

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.

 
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; 
      Boolean IsBundle; 
      Boolean IsContentProvisioned; 
      Boolean IsDeployable; 
      Boolean IsDeployed; 
      Boolean IsDigest; 
      Boolean IsEnabled; 
      Boolean IsExpired; 
      Boolean IsHidden; 
      Boolean IsLegacyEnabled;
      Boolean IsMetadataOnlyUpdate; 
      Boolean IsQuarantined; 
      Boolean IsSuperseded; 
      Boolean IsUserDefined; 
      String LastModifiedBy; 
      String LocalizedCategoryInstanceNames[]; 
      String LocalizedDescription; 
      String LocalizedDisplayName; 
      SMS_CI_LocalizedEulas LocalizedEulas[]; 
      SMS_CI_LocalizedProperties LocalizedInformation[]; 
      String LocalizedInformativeURL; 
      UInt32 LocalizedPropertyLocaleID; 
      UInt32 MaxExecutionTime; 
      String ModelName; 
      UInt32 NumMissing; 
      UInt32 NumNotApplicable; 
      UInt32 NumPresent; 
      UInt32 NumTotal; 
      UInt32 NumUnknown; 
      UInt32 PermittedUses; 
      Boolean RequiresExclusiveHandling; 
      UInt32 RevisionNumber; 
      SMS_SDMPackageLocalizedData SDMPackageLocalizedData[]; 
      UInt32 SDMPackageVersion; 
      String SDMPackageXML; 
      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.

GetEULA Method in Class SMS_SoftwareUpdate

Gets the localized Microsoft Software License Terms content of a software update.

ResendObjectToAllSites Method in Class SMS_SoftwareUpdate

Replicates software update information to all child sites.

SetEnforcement Method in Class SMS_SoftwareUpdate

Sets policy enforcement of a software update.

Properties

  • ArticleID
    Data type: String

    Access 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: String

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

  • CustomSeverity
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: None

    Custom severity rating for the software update. The default value is 0.

  • CustomSeverityName
    Data type: String

    Access type: Read-only

    Qualifiers: [read]

    Text for the custom severity rating.

  • DatePosted
    Data type: DateTime

    Access type: Read-only

    Qualifiers: [read]

    Date and time when the software update was published.

  • DateRevised
    Data type: DateTime

    Access type: Read-only

    Qualifiers: [read]

    Date and time when the software update was revised.

  • IsContentProvisioned
    Data type: Boolean

    Access type: Read-only

    Qualifiers: [read]

    true if the software update content is provisioned. The default value is false.

  • IsDeployable
    Data type: Boolean

    Access 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: Boolean

    Access type: Read-only

    Qualifiers: [read]

    true if the software update has been deployed. The default value is false.

  • IsLegacyEnabled
    Data type: Boolean

    Access type: Read-only

    Qualifiers: [read]

    true if the software update is associated with a legacy update source. The default value is false.

  • IsMetadataOnlyUpdate
    Data type: Boolean

    Access type: Read-only

    Qualifiers: [read]

    true if the software update metabase is only Update CI. The default value is false.

  • LocalizedEulas
    Data type: SMS_CI_LocalizedEulas Array

    Access type: Read-only

    Qualifiers: [read, lazy]

    An array of localized Microsoft Software License Terms for the software update.

  • LocalizedInformation
    Data type: SMS_CI_LocalizedProperties Array

    Access 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

  • MaxExecutionTime
    Data type: UInt32

    Access type: Read/Write

    Qualifiers: None

    Maximum time required for the software update to run. The default value is 30.

  • NumMissing
    Data type: UInt32

    Access type: Read-only

    Qualifiers: [read]

    Number of computers in the targeted collections on which the software update is missing.

  • NumNotApplicable
    Data type: UInt32

    Access type: Read-only

    Qualifiers: [read]

    Number of computers in the targeted collections on which the software update is not applicable.

  • NumPresent
    Data type: UInt32

    Access type: Read-only

    Qualifiers: [read]

    Number of computers in the targeted collections on which the software update is already installed.

  • NumTotal
    Data type: UInt32

    Access type: Read-only

    Qualifiers: [read]

    Total number of computers in the targeted collections for the software update.

  • NumUnknown
    Data type: UInt32

    Access type: Read-only

    Qualifiers: [read]

    Number of computers in the targeted collections on which the state for the software update is known.

  • RequiresExclusiveHandling
    Data type: Boolean

    Access type: Read-only

    Qualifiers: [read]

    true if the software update must be installed separately. The default value is false.

  • RevisionNumber
    Data type: UInt32

    Access type: Read-only

    Qualifiers: [read, not_null]

    Revision number for the update.

  • Severity
    Data type: UInt32

    Access type: Read-only

    Qualifiers: [read]

    Severity rating for the software update. The default value is 0.

  • SeverityName
    Data type: String

    Access type: Read-only

    Qualifiers: [read]

    Text for the severity rating.

  • Size
    Data type: SInt64

    Access type: Read-only

    Qualifiers: [read]

    Size of the software update.

  • UpdateLocales
    Data type: String Array

    Access 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 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. To synchronize metadata among the parent site and the child sites, the application can call ResendObjectToAllSites Method in Class SMS_SoftwareUpdate.

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_ConfigurationItemBaseClass Server WMI Class

Concepts

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
About Software Updates Deployments
About Configuration Baselines and Configuration Items
How to Enumerate Updates Matching a Specific Criteria