IUpdateServer.GetSummariesPerComputerTarget Method (UpdateScope, ComputerTargetScope)

Article
10/10/2016

Applies To: Windows Server Update Services

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

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

Syntax

UpdateSummaryCollection GetSummariesPerComputerTarget(
    UpdateScope updatesToInclude,
    ComputerTargetScope computersToInclude
)

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

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

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

Parameters

updatesToInclude
Type: Microsoft.UpdateServices.Administration.UpdateScope

Update search criteria.

computersToInclude
Type: Microsoft.UpdateServices.Administration.ComputerTargetScope

Computer search criteria.

Return Value

Type: Microsoft.UpdateServices.Administration.UpdateSummaryCollection

UpdateSummaryCollection containing one summary for each computer.

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 computers for which you would like update summaries. The method will first evaluate the UpdateScope to determine the set of updates against which to evaluate the set of computers. (Since both UpdateScope and ComputerTargetScope have IncludedInstallationStates and ExcludedInstallationStates properties, the installation state properties of ComputerTargetScope override those of UpdateScope.) 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.ExcludedInstallationStates.Failed and ComputerTargetScope.IncludedInstallationStates.Failed, you will get three update summaries, one for each computer; the update summary for C1 has FailedCount = 1, the update summary for C2 has FailedCount = 2, and the update summary for C3 has FailedCount = 1.

If, given the same scenario as above, except that U1 belongs to category UC1, if you call this method with Categories = UC1, then you will get one update summary, with FailedCount = 1. This method evaluates the ComputerTargetScope and UpdateScope as follows:

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