IUpdateServer.GetSummariesPerUpdate Method (UpdateScope, ComputerTargetScope)

Article
10/10/2016

Applies To: Windows Server Update Services

Get per-update summaries for each of the specified updates, summed across all of the specified computers.

Namespace: Microsoft.UpdateServices.Administration
Assembly: Microsoft.UpdateServices.Administration (in Microsoft.UpdateServices.Administration.dll)

Syntax

UpdateSummaryCollection GetSummariesPerUpdate(
    UpdateScope updatesToInclude,
    ComputerTargetScope computersToInclude
)

UpdateSummaryCollection^ GetSummariesPerUpdate(
    UpdateScope^ updatesToInclude,
    ComputerTargetScope^ computersToInclude
)

abstract GetSummariesPerUpdate : 
        updatesToInclude:UpdateScope *
        computersToInclude:ComputerTargetScope -> UpdateSummaryCollection

Function GetSummariesPerUpdate (
    updatesToInclude As UpdateScope,
    computersToInclude As ComputerTargetScope
) As UpdateSummaryCollection

Parameters

updatesToInclude
Type: Microsoft.UpdateServices.Administration.UpdateScope

Search criteria defining the set of updates to include in the summary.

computersToInclude
Type: Microsoft.UpdateServices.Administration.ComputerTargetScope

Search criteria defining the set of computers to include in the summary.

Return Value

Type: Microsoft.UpdateServices.Administration.UpdateSummaryCollection

UpdateSummaryCollection containing one summary for each update.

Exceptions

Exception

Condition

ArgumentNullException

Either updatesToInclude or computersToInclude is null.

ArgumentOutOfRangeException

One of the following conditions exists:

updatesToInclude.FromArrivalDate is greater than updatesToInclude.ToArrivalDate
updatesToInclude.FromCreationDate is greater than updatesToInclude.ToCreationDate
computersToInclude.FromLastSyncTime is greater than computersToInclude.ToLastSyncTime
computersToInclude.FromLastReportedStatusTime is greater than computersToInclude.ToLastReportedStatusTime

Remarks

In this method you can specify the sets of updates for which you would like update summaries. The method will first evaluate the ComputerTargetScope to determine the set of computers against which to evaluate the set of updates. (Since both UpdateScope and ComputerTargetScope have IncludedInstallationStates and ExcludedInstallationStates properties, the installation state properties of UpdateScope override those of ComputerTargetScope.) For example, suppose that there are three computers (C1, C2, C3) and two updates (U1, U2), such that C1 and C2 have failed to install U1 and C2 and C3 have failed to install U2. If you call this method using both UpdateScope.IncludedInstallationStates.Failed and ComputerTargetScope.ExcludedInstallationStates.Failed, you will get two update summaries, both of which have FailedCount = 2.

If, given the same scenario as above, except that C1 belongs to target group TG1, if you call this method with ComputerTargetGroups = TG1, then you will get one update summary, with FailedCount = 1. This method evaluates the ComputerTargetScope and UpdateScope as follows:

Evaluate the ComputerTargetScope. Only one computer (C1) is in target group TG1, so only C1 matches.
Evaluate the UpdateScope over the set of computers (only C1). C1 failed one update (U1).
Return an UpdateSummaryCollection with one update (U1), showing the updates that have failed on computers in TG1, with FailedCount = 1.