Get-WsusComputer
Gets the WSUS computer object that represents the client computer.
Syntax
Get-WsusComputer
[-UpdateServer <IUpdateServer>]
[-All]
[<CommonParameters>] Get-WsusComputer
[-UpdateServer <IUpdateServer>]
[-NameIncludes <String>]
[-ComputerTargetGroups <StringCollection>]
[-IncludeSubgroups]
[-ComputerUpdateStatus <WsusUpdateInstallationState>]
[-ExcludedInstallationStates <UpdateInstallationStates[]>]
[-IncludedInstallationStates <UpdateInstallationStates[]>]
[-FromLastSyncTime <DateTime>]
[-ToLastSyncTime <DateTime>]
[-FromLastReportedStatusTime <DateTime>]
[-ToLastReportedStatusTime <DateTime>]
[-IncludeDownstreamComputerTargets]
[-RequestedTargetGroupNames <StringCollection>]
[<CommonParameters>] Description
The Get-WsusComputer cmdlet gets one or more Windows Server Update Services (WSUS) computers based on the specified filtering criteria such as operating system, computer name, update installation status, last reported status time, and etcetera.
If the Get-WsusServer cmdlet is run and the resulting IUpdateServer object is passed into this cmdlet, then the specified server will be used rather than the local server.
This cmdlet can be passed into the Add-WsusComputer cmdlet.
Examples
Example 1: Get all client computers
PS C:\> Get-WsusComputer -All
Computer IP Address Operating System Last Status Report
-------- ---------- ---------------- ------------------
contoso XXXX:XXXX:XX:X:XXXX:XXX:XXXX: Windows Server 2008 6/2/2010 12:00:00 AM
XXXX Enterprise Edition (full installation)This command gets all client computers.
Example 2: Get client computers that have names that contain a string
PS C:\> Get-WsusComputer -NameIncludes "contoso"
Computer IP Address Operating System Last Status Report
-------- ---------- ---------------- ------------------
contoso XXXX:XXXX:XX:X:XXXX:XXX:XXXX: Windows Server 2008 6/2/2010 12:00:00 AM
XXXX Enterprise Edition (full
installation)This command gets the client computer whose name includes contoso.
Example 3: Get client computers by specifying dates
PS C:\> Get-WsusComputer -FromLastReportedStatusTime 6/1/10 -ToLastReportedStatusTime 6/30/10
Computer IP Address Operating System Last Status Report
-------- ---------- ---------------- ------------------
contoso XXXX:XXXX:XX:X:XXXX:XXX:XXXX: Windows Server 2008 6/2/2010 12:00:00 AM
XXXX Enterprise Edition (full
installation)This command gets all client computers with a last reported status date and time between June 1, 2010 and June 30, 2010.
Parameters
-All
Specifies that all computers are to be returned. The information displayed includes the computer name, IP address, operating system, and last status report time.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerTargetGroups
Specifies the list of target group to search.
| Type: | StringCollection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerUpdateStatus
Specifies the computer update state as represented in the WSUS Console user interface. The acceptable values for this parameter are:
- FailedOrNeeded
- InstalledNotApplicableOrNoStatus
- Failed
- InstalledNotApplicable
- NoStatus
- Any
| Type: | WsusUpdateInstallationState |
| Accepted values: | NoStatus, InstalledOrNotApplicable, InstalledOrNotApplicableOrNoStatus, Failed, Needed, FailedOrNeeded, Any |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludedInstallationStates
Specifies the installation states to exclude. The acceptable values for this parameter are:
- All
- Downloaded
- Failed
- Installed
- InstalledPendingReboot
- NotApplicable
- NotInstalled
- Unknown
| Type: | UpdateInstallationStates[] |
| Accepted values: | Unknown, NotApplicable, NotInstalled, Downloaded, Installed, Failed, InstalledPendingReboot, All |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FromLastReportedStatusTime
Specifies the earliest reported status time. This parameter can be used in combination with the ToLastReportedStatusTime parameter in order to create a date range to use in the search.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FromLastSyncTime
Specifies the earliest last synchronization time for which to search. This parameter can be used in combination with the ToLastSynchTime parameter in order to create a date range to use in the search.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludedInstallationStates
Specifies the installation states to include. The acceptable values for this parameter are:
- All
- Downloaded
- Failed
- Installed
- InstalledPendingReboot
- NotApplicable
- NotInstalled
- Unknown
| Type: | UpdateInstallationStates[] |
| Accepted values: | Unknown, NotApplicable, NotInstalled, Downloaded, Installed, Failed, InstalledPendingReboot, All |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeDownstreamComputerTargets
Specifies that clients of a downstream server should be included, not clients of this server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeSubgroups
Specifies that the ComputerTargetGroups parameter should include descendant groups. This value has no impact if the ComputerTargetGroups parameter is not used.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NameIncludes
Specifies the partial name of the computer for which to search.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequestedTargetGroupNames
Specifies the list of requested target group names for which to search.
| Type: | StringCollection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ToLastReportedStatusTime
Specifies the latest reported status time. This parameter can be used in combination with the FromLastReportedStatusTime parameter in order to create a date range to use in the search.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ToLastSyncTime
Specifies the latest last synchronization time for which to search. This parameter can be used in combination with the FromLastSynchTime parameter in order to create a date range to use in the search.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpdateServer
Specifies the object that contains the WSUS server. This value is obtained by calling the Get-WsusServer cmdlet and passing the resulting IUpdateServer object into this cmdlet.
| Type: | IUpdateServer |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Microsoft.UpdateServices.Commands.IUpdateServer
Outputs
None
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for