API Reference
Command
Get-CxWindowsUpdateComplianceSummary
Implements the Get-CxWindowsUpdateComplianceSummary cmdlet.
Examples
Example 1
Get-CxWindowsUpdateComplianceSummary -ComputerName DC01
Example 2
Get-CxWindowsUpdateComplianceSummary -ComputerName DC01 -ProviderMode Hybrid -WsusProviderServer wsus01.contoso.local -IncludeSecurityCorrelation
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
Get-CxWindowsUpdateComplianceSummary [-ComputerName <string[]>] [-EventLookbackDays <int>] [-HistoryDays <int>] [-HistoryFailureCriticalThreshold <int>] [-HistoryFailureWarningThreshold <int>] [-HistoryMaxEntries <int>] [-ImpactSeverity <Unknown|Informational|Warning|Critical>] [-ImpactTarget <string>] [-ImpactTypesAffected <int>] [-IncludeDownstreamComputerTargets <bool>] [-IncludeSecurityCorrelation] [-ProviderMode <Endpoint|Wsus|Hybrid>] [-QueryTimeoutSeconds <int>] [-SecurityAsOfMonthOffset <int>] [-SecurityCriticalCountsAsCritical <bool>] [-SecurityExploitedCountsAsCritical <bool>] [-SecurityLookbackMonths <int>] [-SecurityMissingCountWarningThreshold <int>] [-SecurityMissingCriticalThreshold <int>] [-SecurityMissingExploitedThreshold <int>] [-SecurityOsQueryTimeoutSeconds <int>] [-SecurityTopListLimit <int>] [-SkipEventTelemetry] [-TargetPriorityWeight <int>] [-TargetRole <string>] [-WsusLagCriticalHours <int>] [-WsusLagWarningHours <int>] [-WsusProviderExecutionComputerName <string>] [-WsusProviderExecutionMode <LocalApi|RemotePowerShell>] [-WsusProviderPort <int>] [-WsusProviderServer <string>] [-WsusProviderUseSsl] [-WsusQueryTimeoutSeconds <int>] [-WsusStatusStaleCriticalHours <int>] [-WsusStatusStaleWarningHours <int>] [-WsusSummaryFailedCriticalThreshold <int>] [-WsusSummaryFailedWarningThreshold <int>] [-WsusSummaryNotInstalledCriticalThreshold <int>] [-WsusSummaryNotInstalledWarningThreshold <int>] [-WsusSummaryPendingRebootCriticalThreshold <int>] [-WsusSummaryPendingRebootWarningThreshold <int>] [-WsusSummaryPreferApprovedInstallCounters <bool>] [<CommonParameters>]Parameters
- ComputerName string[]
- Target computer(s). Use '.' for local computer or provide DNS names.
- EventLookbackDays int
- Event log lookback window in days for the summary telemetry slice.
- HistoryDays int
- Number of days included in the recent-history slice. Set to 0 to disable the day cutoff.
- HistoryFailureCriticalThreshold int
- Critical threshold for failed recent-history rows. Set to 0 to disable.
- HistoryFailureWarningThreshold int
- Warning threshold for failed recent-history rows. Set to 0 to disable.
- HistoryMaxEntries int
- Maximum number of history rows retained in the summary. Set to 0 to disable the cap.
- ImpactSeverity WindowsUpdatePatchImpactSeverity
- Optional impact severity used for reusable patch-priority weighting. 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.
- ImpactTypesAffected int
- Optional count of affected impact types or dependent services used for reusable patch-priority weighting.
- IncludeDownstreamComputerTargets bool
- When true, include downstream computer targets when querying WSUS.
- IncludeSecurityCorrelation SwitchParameter
- When present, includes MSRC-based missing security-update correlation in output.
- ProviderMode WindowsUpdateProviderMode
- Correlation provider mode: Endpoint, Wsus, or Hybrid. Possible values: Endpoint, Wsus, Hybrid
- Possible values:
Endpoint,Wsus,Hybrid - QueryTimeoutSeconds int
- Per-query timeout in seconds for the summary telemetry slice.
- SecurityAsOfMonthOffset int
- Month offset used for MSRC correlation. 0 means current month, 1 means previous month, and so on.
- SecurityCriticalCountsAsCritical bool
- When true, critical updates force critical state in MSRC correlation.
- SecurityExploitedCountsAsCritical bool
- When true, exploited updates force critical state in MSRC correlation.
- SecurityLookbackMonths int
- Number of months included in MSRC gap collection, counting backward from the selected as-of month.
- SecurityMissingCountWarningThreshold int
- Missing-update count threshold used for warning state in MSRC correlation.
- SecurityMissingCriticalThreshold int
- Missing critical-update threshold used for critical-state candidate in MSRC correlation.
- SecurityMissingExploitedThreshold int
- Missing exploited-update threshold used for exploited-state candidate in MSRC correlation.
- SecurityOsQueryTimeoutSeconds int
- Optional OS detection timeout in seconds for MSRC correlation. Use 0 to keep evaluator defaults.
- SecurityTopListLimit int
- Maximum number of KB/CVE items returned in top lists for MSRC correlation.
- SkipEventTelemetry SwitchParameter
- Disables event log telemetry collection from the summary telemetry slice.
- TargetPriorityWeight int
- Optional non-negative priority weight applied to the target for patch posture scoring.
- TargetRole string
- Optional target role label used for reusable patch-priority weighting.
- WsusLagCriticalHours int
- Hybrid lag threshold in hours for critical state.
- WsusLagWarningHours int
- Hybrid lag threshold in hours for warning state.
- WsusProviderExecutionComputerName string
- Optional computer name used for remote WSUS-hosted execution in Wsus/Hybrid modes. Defaults to the WSUS host when WsusProviderExecutionMode is .
- WsusProviderExecutionMode WindowsUpdateWsusExecutionMode
- Selects how the WSUS provider query is executed for Wsus/Hybrid modes. Possible values: LocalApi, RemotePowerShell
- Possible values:
LocalApi,RemotePowerShell - WsusProviderPort int
- WSUS provider port (typically 8530 or 8531).
- WsusProviderServer string
- Optional WSUS server used for Wsus/Hybrid modes. When omitted, WSUS server auto-discovery is attempted from endpoint policy telemetry.
- WsusProviderUseSsl SwitchParameter
- When true, WSUS provider lookup uses SSL.
- WsusQueryTimeoutSeconds int
- WSUS query timeout in seconds.
- WsusStatusStaleCriticalHours int
- WSUS-only status-report age threshold in hours for critical state.
- WsusStatusStaleWarningHours int
- WSUS-only status-report age threshold in hours for warning state.
- WsusSummaryFailedCriticalThreshold int
- WSUS summary-risk critical threshold for failed updates. Set to 0 to disable.
- WsusSummaryFailedWarningThreshold int
- WSUS summary-risk warning threshold for failed updates. Set to 0 to disable.
- WsusSummaryNotInstalledCriticalThreshold int
- WSUS summary-risk critical threshold for not-installed updates. Set to 0 to disable.
- WsusSummaryNotInstalledWarningThreshold int
- WSUS summary-risk warning threshold for not-installed updates. Set to 0 to disable.
- WsusSummaryPendingRebootCriticalThreshold int
- WSUS summary-risk critical threshold for installed-pending-reboot updates. Set to 0 to disable.
- WsusSummaryPendingRebootWarningThreshold int
- WSUS summary-risk warning threshold for installed-pending-reboot updates. Set to 0 to disable.
- WsusSummaryPreferApprovedInstallCounters bool
- When true, WSUS summary risk prefers per-update approved-install counters.
Outputs
ComputerX.Updates.WindowsUpdateComplianceSummary