Get-WsusComputer
Get-WsusComputer
Gets the Windows Server Update Services (WSUS) computer object that represents the client computer.
Syntax
Parameter Set: AllComputers
Get-WsusComputer [-All] [-UpdateServer <IUpdateServer> ] [ <CommonParameters>]
Parameter Set: Scoped
Get-WsusComputer [-ComputerTargetGroups <StringCollection> ] [-ComputerUpdateStatus <WsusUpdateInstallationState> ] [-ExcludedInstallationStates <UpdateInstallationStates[]> ] [-FromLastReportedStatusTime <DateTime> ] [-FromLastSyncTime <DateTime> ] [-IncludedInstallationStates <UpdateInstallationStates[]> ] [-IncludeDownstreamComputerTargets] [-IncludeSubgroups] [-NameIncludes <String> ] [-RequestedTargetGroupNames <StringCollection> ] [-ToLastReportedStatusTime <DateTime> ] [-ToLastSyncTime <DateTime> ] [-UpdateServer <IUpdateServer> ] [ <CommonParameters>]
Detailed Description
The Get-WsusComputer cmdlet retrieves one or more 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 piped into this cmdlet, then the specified server will be used rather than the local server.
This cmdlet can be piped into the Add-WsusComputer cmdlet.
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerTargetGroups<StringCollection>
Specifies the list of target group to search.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerUpdateStatus<WsusUpdateInstallationState>
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
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ExcludedInstallationStates<UpdateInstallationStates[]>
Specifies the installation states to exclude. The acceptable values for this parameter are:
-- All
-- Downloaded
-- Failed
-- Installed
-- InstalledPendingReboot
-- NotApplicable
-- NotInstalled
-- Unknown
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FromLastReportedStatusTime<DateTime>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FromLastSyncTime<DateTime>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IncludeDownstreamComputerTargets
Specifies that clients of a downstream server should be included, not clients of this server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IncludedInstallationStates<UpdateInstallationStates[]>
Specifies the installation states to include. The acceptable values for this parameter are:
-- All
-- Downloaded
-- Failed
-- Installed
-- InstalledPendingReboot
-- NotApplicable
-- NotInstalled
-- Unknown
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NameIncludes<String>
Specifies the partial name of the computer for which to search.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RequestedTargetGroupNames<StringCollection>
Specifies the list of requested target group names for which to search.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ToLastReportedStatusTime<DateTime>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ToLastSyncTime<DateTime>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UpdateServer<IUpdateServer>
Specifies the object that contains the WSUS server. This value is obtained by calling the Get-WsusServer cmdlet and piping the resulting IUpdateServer object into this cmdlet.
Aliases |
Server |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.UpdateServices.Commands.IUpdateServer
IUpdateServer
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example gets all client computers.
PS C:\> Get-WsusComputer -All
EXAMPLE 2
This example gets the client computer whose name includes contoso.
PS C:\> Get-WsusComputer -NameIncludes contoso
EXAMPLE 3
This example gets all client computers with a last reported status date and time between June 1, 2010 and June 30, 2010.
PS C:\> Get-WsusComputer -FromLastReportedStatusTime 6/1/10 -ToLastReportedStatusTime 6/30/10