API Reference
Command
Show-CxWindowsUpdate
Implements the Show-CxWindowsUpdate cmdlet.
Examples
Example 1
Show-CxWindowsUpdate -ReportType WsusFleet -WsusServer wsus01.contoso.local -OpenInBrowser
Example 2
Show-CxWindowsUpdate -ReportType UninstallCandidates -ComputerName DC01 -MinimumState Warning -OpenInBrowser
Example 3
Show-CxWindowsUpdate -ReportType ComplianceSummary -ComputerName DC01 -ProviderMode Hybrid -WsusProviderServer wsus01.contoso.local
Example 4
Show-CxWindowsUpdate -ReportType ClientContext -ComputerName DC01,DC02 -OpenInBrowser
Example 5
Get-CxWindowsUpdateUninstallCandidate -MinimumState Warning -OnlyUninstallable | Show-CxWindowsUpdate
Example 6
Get-CxWindowsUpdateWsusFleet -WsusServer wsus01.contoso.local | Show-CxWindowsUpdate
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Show-CxWindowsUpdate -InputObject <PSObject> [-Author <string>] [-Description <string>] [-NoExportButtons] [-OpenInBrowser] [-PageLength <int>] [-PassThru] [-ReportPath <string>] -ReportType <WsusFleet|UninstallCandidates|ComplianceSummary|ClientContext> [-Subtitle <string>] [-Title <string>] [<CommonParameters>]Parameter set:
By InputObjectParameters
- InputObject PSObject
- Optional pipeline input object. Supported types are Windows Update report models handled by the unified show cmdlet.
- Author string
- Override the report author.
- Description string
- Override the report description.
- NoExportButtons SwitchParameter
- When present, disables DataTables export buttons.
- OpenInBrowser SwitchParameter
- Open the report in a browser after generation.
- PageLength int
- DataTables page length.
- PassThru SwitchParameter
- Return source objects after report generation.
- ReportPath string
- Optional report output path (file or directory).
- ReportType WindowsUpdateReportKind
- Report kind to render. Possible values: WsusFleet, UninstallCandidates, ComplianceSummary, ClientContext
- Possible values:
WsusFleet,UninstallCandidates,ComplianceSummary,ClientContext - Subtitle string
- Override the report subtitle.
- Title string
- Override the report title.
Outputs
ComputerX.Updates.WindowsUpdateClientContext, ComputerX.Updates.WindowsUpdateComplianceSummary, ComputerX.Updates.WindowsUpdateUninstallCandidate, ComputerX.Updates.WindowsUpdateWsusFleetTelemetry, System.String
Show-CxWindowsUpdate [-ComputerName <string[]>] -ReportType <WsusFleet|UninstallCandidates|ComplianceSummary|ClientContext> [-Author <string>] [-CorrelationQueryTimeoutSeconds <int>] [-Description <string>] [-EventLookbackDays <int>] [-GroupName <string[]>] [-HistoryDays <int>] [-HistoryFailureCriticalThreshold <int>] [-HistoryFailureWarningThreshold <int>] [-HistoryMaxEntries <int>] [-ImpactSeverity <Unknown|Informational|Warning|Critical>] [-ImpactTarget <string>] [-ImpactTypesAffected <int>] [-IncludeApprovedInstallCounters] [-IncludeDownstreamComputerTargets <bool>] [-IncludeSecurityCorrelation] [-IncludeUpdateSummary <bool>] [-Kb <string[]>] [-MaxCandidates <int>] [-MaxComputers <int>] [-MinimumState <Informational|Warning|Critical>] [-NoExportButtons] [-OnlyUninstallable] [-OpenInBrowser] [-PageLength <int>] [-PassThru] [-ProviderMode <Endpoint|Wsus|Hybrid>] [-ReportPath <string>] [-RequestedGroupOnly] [-SecurityAsOfMonthOffset <int>] [-SkipCorrelation] [-SkipEventTelemetry] [-SkipHistory] [-SortByRisk] [-StatusReportStaleDays <double>] [-Subtitle <string>] [-SyncStaleDays <double>] [-TargetPriorityWeight <int>] [-TargetRole <string>] [-Title <string>] [-UpdateId <string[]>] [-WsusExecutionComputerName <string>] [-WsusExecutionMode <LocalApi|RemotePowerShell>] [-WsusPort <int>] [-WsusProviderExecutionComputerName <string>] [-WsusProviderExecutionMode <LocalApi|RemotePowerShell>] [-WsusProviderPort <int>] [-WsusProviderServer <string>] [-WsusProviderUseSsl] [-WsusQueryTimeoutSeconds <int>] [-WsusServer <string>] [-WsusUseSsl] [<CommonParameters>]Parameter set:
By ComputerName + CorrelationQueryTimeoutSecondsParameters
- ComputerName string[]
- Target computer(s) used for direct computer-scoped Windows Update report collection.
- ReportType WindowsUpdateReportKind
- Report kind to render. Possible values: WsusFleet, UninstallCandidates, ComplianceSummary, ClientContext
- Possible values:
WsusFleet,UninstallCandidates,ComplianceSummary,ClientContext - Author string
- Override the report author.
- CorrelationQueryTimeoutSeconds int
- Per-query timeout in seconds for uninstall-candidate correlation.
- Description string
- Override the report description.
- EventLookbackDays int
- Event log lookback window in days for uninstall-candidate correlation.
- GroupName string[]
- Optional WSUS group name filters.
- HistoryDays int
- Number of days included in the recent-history slice for uninstall candidates.
- HistoryFailureCriticalThreshold int
- Critical threshold for failed recent-history rows in compliance summaries.
- HistoryFailureWarningThreshold int
- Warning threshold for failed recent-history rows in compliance summaries.
- HistoryMaxEntries int
- Maximum number of recent-history rows used for uninstall-candidate enrichment.
- ImpactSeverity WindowsUpdatePatchImpactSeverity
- Optional impact severity used for reusable patch-priority weighting in compliance-summary queries. Possible values: Unknown, Informational, Warning, Critical
- Possible values:
Unknown,Informational,Warning,Critical - ImpactTarget string
- Optional impact target or owning service label used for reusable patch-priority weighting in compliance-summary queries.
- ImpactTypesAffected int
- Optional count of affected impact types or dependent services used for reusable patch-priority weighting in compliance-summary queries.
- IncludeApprovedInstallCounters SwitchParameter
- When present, includes per-update approved-install counters per computer in WSUS fleet reports.
- IncludeDownstreamComputerTargets bool
- When true, includes downstream computer targets in WSUS-backed queries.
- IncludeSecurityCorrelation SwitchParameter
- When present, includes MSRC-based security correlation in uninstall-candidate hints.
- IncludeUpdateSummary bool
- When true, includes per-computer update installation summary counters in WSUS fleet reports.
- Kb string[]
- Optional KB article identifiers to include in uninstall-candidate reports.
- MaxCandidates int
- Optional cap on returned uninstall candidates per computer. Set to 0 to disable.
- MaxComputers int
- Optional cap on returned WSUS computers. Set to 0 to disable.
- MinimumState WindowsUpdateUninstallCandidateState
- Optional minimum uninstall-candidate risk state. Possible values: Informational, Warning, Critical
- Possible values:
Informational,Warning,Critical - NoExportButtons SwitchParameter
- When present, disables DataTables export buttons.
- OnlyUninstallable SwitchParameter
- When present, only returns uninstall candidates that WUA reports as uninstallable.
- OpenInBrowser SwitchParameter
- Open the report in a browser after generation.
- PageLength int
- DataTables page length.
- PassThru SwitchParameter
- Return source objects after report generation.
- ProviderMode WindowsUpdateProviderMode
- Correlation provider mode used for optional uninstall-candidate environment hints. Possible values: Endpoint, Wsus, Hybrid
- Possible values:
Endpoint,Wsus,Hybrid - ReportPath string
- Optional report output path (file or directory).
- RequestedGroupOnly SwitchParameter
- When present, WSUS group filtering is evaluated only against the requested target group.
- SecurityAsOfMonthOffset int
- Month offset used for optional MSRC correlation.
- SkipCorrelation SwitchParameter
- Skips environment correlation enrichment for uninstall candidates.
- SkipEventTelemetry SwitchParameter
- Disables event log telemetry collection for uninstall-candidate correlation.
- SkipHistory SwitchParameter
- Skips recent WUA history enrichment for uninstall candidates.
- SortByRisk SwitchParameter
- When present, orders uninstall candidates by risk and recency instead of preserving discovery order.
- StatusReportStaleDays double
- Stale-reporting threshold in days for WSUS status report recency.
- Subtitle string
- Override the report subtitle.
- SyncStaleDays double
- Stale-reporting threshold in days for WSUS sync recency.
- TargetPriorityWeight int
- Optional non-negative priority weight applied to the target for compliance-summary patch posture scoring.
- TargetRole string
- Optional target role label used for reusable patch-priority weighting in compliance-summary queries.
- Title string
- Override the report title.
- UpdateId string[]
- Optional update identifiers to include in uninstall-candidate reports.
- WsusExecutionComputerName string
- Optional computer name used for remote WSUS-hosted execution in direct WSUS fleet reports.
- WsusExecutionMode WindowsUpdateWsusExecutionMode
- Selects how the direct WSUS fleet query is executed. Possible values: LocalApi, RemotePowerShell
- Possible values:
LocalApi,RemotePowerShell - WsusPort int
- WSUS server port used for direct WSUS fleet collection.
- WsusProviderExecutionComputerName string
- Optional computer name used for remote WSUS-hosted execution in compliance-summary queries. Defaults to the WSUS host when WsusProviderExecutionMode is .
- WsusProviderExecutionMode WindowsUpdateWsusExecutionMode
- Selects how the compliance-summary WSUS provider query is executed. Possible values: LocalApi, RemotePowerShell
- Possible values:
LocalApi,RemotePowerShell - WsusProviderPort int
- WSUS provider port used for hybrid or WSUS-backed uninstall-candidate hints.
- WsusProviderServer string
- Optional WSUS server used for hybrid or WSUS-backed uninstall-candidate hints.
- WsusProviderUseSsl SwitchParameter
- When true, uninstall-candidate WSUS provider lookup uses SSL.
- WsusQueryTimeoutSeconds int
- WSUS query timeout in seconds used by both WSUS fleet reports and uninstall-candidate WSUS-backed hints.
- WsusServer string
- WSUS server host name or endpoint URL used for direct WSUS fleet collection.
- WsusUseSsl SwitchParameter
- When present, WSUS lookup uses SSL.
Outputs
ComputerX.Updates.WindowsUpdateClientContext, ComputerX.Updates.WindowsUpdateComplianceSummary, ComputerX.Updates.WindowsUpdateUninstallCandidate, ComputerX.Updates.WindowsUpdateWsusFleetTelemetry, System.String