From d078052f97997304e37c4493cc5cd21e828796bd Mon Sep 17 00:00:00 2001 From: Pat Altimore Date: Tue, 1 Feb 2022 14:41:09 -0800 Subject: [PATCH 01/15] Add missing cmdlets and parameters --- .../Add-CauClusterRole.md | 245 +++++++++++++----- .../ClusterAwareUpdating.md | 8 +- .../Get-CauDeviceInfoForFeatureUpdates.md | 105 ++++++++ .../clusterawareupdating/Invoke-CauRun.md | 137 +++++++++- .../clusterawareupdating/Invoke-CauScan.md | 39 ++- .../Save-CauDebugTrace.md | 17 +- .../Set-CauClusterRole.md | 133 +++++++++- 7 files changed, 607 insertions(+), 77 deletions(-) create mode 100644 docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index 0e8ae12be0..46b4a7b34e 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -18,29 +18,37 @@ Adds the CAU clustered role that provides the self-updating functionality to the ### MonthlyDayOfWeek (Default) ``` -Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] - [-StartDate ] [-DaysOfWeek ] [-WeeksOfMonth ] - [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] - [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] - [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] - [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] - [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] - [-SuspendClusterNodeTimeoutMinutes ] [[-ClusterName] ] [[-Credential] ] - [-Force] [-WhatIf] [-Confirm] [] +Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-StartDate ] + [-DaysOfWeek ] [-WeeksOfMonth ] [-CauPluginName ] + [-CauPluginArguments ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] + [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] [-ConfigurationName ] + [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] + [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] + [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] + [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] + [] ``` ### Weekly ``` -Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] - [-StartDate ] [-DaysOfWeek ] [-IntervalWeeks ] - [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] - [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] - [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] - [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] - [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] - [-SuspendClusterNodeTimeoutMinutes ] [[-ClusterName] ] [[-Credential] ] - [-Force] [-WhatIf] [-Confirm] [] +Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-StartDate ] + [-DaysOfWeek ] [-IntervalWeeks ] [-CauPluginName ] + [-CauPluginArguments ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] + [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] [-ConfigurationName ] + [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] + [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] + [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] + [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +### DefaultParamSet +``` +Add-CauClusterRole [-AttemptSoftReboot] [[-ClusterName] ] [[-Credential] ] [-Force] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -146,6 +154,24 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ## PARAMETERS +### -AttemptSoftReboot +Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster. + +KSR bypasses BIOS/firmware initialization. +You can only use KSR for updates that do not require a BIOS/firmware initialization. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CauPluginArguments Specifies an array of name=value pairs (arguments) for each updating plug-in to use. @@ -195,8 +221,8 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: ```yaml Type: Hashtable[] -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -216,8 +242,8 @@ Server Update Services (WSUS) server. For more information about how plug-ins wo ```yaml Type: String[] -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -254,8 +280,8 @@ built into Windows PowerShell® is used. ```yaml Type: String -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -313,8 +339,8 @@ The acceptable values for this parameter are: ```yaml Type: Weekdays -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Accepted values: None, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday Required: False @@ -338,8 +364,8 @@ conflict with Group Policy settings that are configured for Windows Firewall. ```yaml Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -364,8 +390,8 @@ The default value is Immediate. ```yaml Type: FailbackType -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Accepted values: NoFailback, Immediate, Policy Required: False @@ -391,14 +417,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForcePauseAndDrain +Indicates that the CAU cluster role forces cluster nodes to pause and drain roles. + +A forced drain moves the roles off of the draining node even if the group cannot move. +A group might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseDrainAndReboot +Indicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart. + +A forced drain moves the roles off of the draining node even if the group cannot move. +A group might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseNoDrain +Indicates that the CAU cluster role forces cluster nodes to pause. +The nodes are not drained. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GroupName Specifies the NetBIOS name of the resource group for the CAU clustered role. ```yaml Type: String -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -434,8 +512,8 @@ The default for most clusters is approximately one-third of the number of nodes. ```yaml Type: Int32 -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -453,8 +531,8 @@ The maximum is 64 and the default is 3. ```yaml Type: Int32 -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -469,7 +547,7 @@ Specifies an array of cluster node names in the order that they should be update ```yaml Type: String[] -Parameter Sets: (All) +Parameter Sets: MonthlyDayOfWeek, Weekly Aliases: Required: False @@ -479,6 +557,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OsRollingUpgrade +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PostUpdateScript Specifies the path and file name for a Windows PowerShell script to run on each node after updating @@ -489,8 +582,8 @@ available network share, to ensure that the script is always accessible to all t ```yaml Type: String -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -510,8 +603,8 @@ pre-update script fails, the node isn't updated. ```yaml Type: String -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -527,8 +620,8 @@ complete within this time, then the Updating Run on that node will be marked as ```yaml Type: Int32 -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -544,8 +637,8 @@ begins. ```yaml Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -567,8 +660,8 @@ If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -589,7 +682,7 @@ If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: MonthlyDayOfWeek, Weekly Aliases: Required: False @@ -599,14 +692,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteAwareUpdatingOrder +Specifies the order in which the CAU cluster role updates cluster nodes. + +By default, CAU selects the order of nodes to update based on the level of activity. + +```yaml +Type: String[] +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipUpdateChecks +Indicates that the CAU cluster role skips update checks. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StartDate Specifies the earliest date on which the Updating Run can be triggered. ```yaml Type: DateTime -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -627,8 +752,8 @@ performing updates must be complete within this time limit. ```yaml Type: TimeSpan -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -646,8 +771,8 @@ a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -670,8 +795,8 @@ for this value for every node in the cluster in the worst case. ```yaml Type: Int32 -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -691,8 +816,8 @@ computer object in Active Directory. ```yaml Type: String -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named @@ -709,8 +834,8 @@ regardless of the time taken by the Updating Run. ```yaml Type: TimeSpan -Parameter Sets: (All) -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: Required: False Position: Named diff --git a/docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md b/docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md index 365bc997f0..d0dc4a2f3a 100644 --- a/docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md +++ b/docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md @@ -31,9 +31,11 @@ Exports one or more Updating Run reports into an HTML or CSV-formatted document. ### [Get-CauClusterRole](./Get-CauClusterRole.md) Gets configuration properties of the CAU clustered role on the specified cluster. -### [Get-CauPlugin](./Get-CauPlugin.md) -Gets information about one or more software updating plug-ins that are registered on the local -computer. +### [Get-CauDeviceInfoForFeatureUpdates](Get-CauDeviceInfoForFeatureUpdates.md) +Gets device information for feature updates to use with CAU. + +### [Get-CauPlugin](Get-CauPlugin.md) +Gets information about one or more software updating plug-ins that are registered on the local computer. ### [Get-CauReport](./Get-CauReport.md) Gets the Updating Run reports for all known Updating Runs, or all Updating Runs that match the diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md new file mode 100644 index 0000000000..4ca8b96ff9 --- /dev/null +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md @@ -0,0 +1,105 @@ +--- +description: The Get-CauDeviceInfoForFeatureUpdates cmdlet gets device information for feature updates to use with Cluster-Aware Updating (CAU). +external help file: ClusterAwareUpdating.dll-Help.xml +Module Name: ClusterAwareUpdating +ms.date: 09/17/2021 +online version: https://docs.microsoft.com/powershell/module/clusterawareupdating/get-caudeviceinfoforfeatureupdates?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-CauDeviceInfoForFeatureUpdates +--- + +# Get-CauDeviceInfoForFeatureUpdates + +## SYNOPSIS +Gets device information for feature updates to use with CAU. + +## SYNTAX + +``` +Get-CauDeviceInfoForFeatureUpdates [[-ClusterName] ] [-Credential ] + -PathToDirectory [] +``` + +## DESCRIPTION +The **Get-CauDeviceInfoForFeatureUpdates** cmdlet gets device information for feature updates to use with Cluster-Aware Updating (CAU). + +## EXAMPLES + +### Example 1: Get device information +```powershell +Get-CauDeviceInfoForFeatureUpdates -ClusterName "CONTOSO-FC1" -PathToDirectory "C:\temp\contoso-device-info" +``` + +This example gets device information for CAU for the specified cluster. + +## PARAMETERS + +### -ClusterName +Specifies the name of the cluster fow which to get device information. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies the administrative credentials for the target cluster. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PathToDirectory +Specifies a directory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +### Microsoft.ClusterAwareUpdating.ActivityIdMap + +## NOTES + +## RELATED LINKS + +[Get-CauClusterRole](Get-CauClusterRole.md) + +[Get-CauPlugin](Get-CauPlugin.md) + +[Get-CauReport](Get-CauReport.md) + +[Get-CauRun](Get-CauRun.md) diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md index 972c4c784d..f8347ff06c 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md @@ -20,12 +20,20 @@ Performs a scan of cluster nodes for applicable updates and installs those updat ``` Invoke-CauRun [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] [-ConfigurationName ] - [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] - [-RebootTimeoutMinutes ] [-SeparateReboots] [-EnableFirewallRules] - [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-Force] [[-ClusterName] -] [[-CauPluginName] ] [[-Credential] ] - [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] [-WhatIf] - [-Confirm] [] + [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] + [-SeparateReboots] [-EnableFirewallRules] [-FailbackMode ] + [-SuspendClusterNodeTimeoutMinutes ] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] [[-ClusterName] ] + [[-CauPluginName] ] [[-Credential] ] [-CauPluginArguments ] + [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade] [-AttemptSoftReboot] [-WhatIf] [-Confirm] + [] +``` + +### RecoverParamSet +``` +Invoke-CauRun [-ForceRecovery] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] + [-SkipUpdateChecks] [[-ClusterName] ] [[-Credential] ] [-WhatIf] [-Confirm] + [] ``` ### RecoverParamSet @@ -123,6 +131,24 @@ recovery is performed without confirmation prompts. ## PARAMETERS +### -AttemptSoftReboot +Indicates that command attempts a Kernel Soft Reboot (KSR) for the failover cluster. + +KSR bypasses BIOS/firmware initialization. +You can only use KSR for updates that do not require a BIOS/firmware initialization. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CauPluginArguments Specifies a set of name=value pairs for each updating plug-in to use. @@ -336,6 +362,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForcePauseAndDrain +Indicates that the command forces cluster nodes to pause and drain roles. + +A forced drain moves the roles off of the draining node even if the group cannot move. +A group might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseDrainAndReboot +Indicates that the command forces cluster nodes to pause, drain roles, and restart. + +A forced drain moves the roles off of the draining node even if the group cannot move. +A group might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseNoDrain +Indicates that the command forces cluster nodes to pause. +The nodes are not drained. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ForceRecovery Indicates that the cmdlet recovers from a previous failed run that left the cluster in a Locked @@ -399,6 +477,21 @@ Specifies an array of cluster nodes names in the order that they are updated. ```yaml Type: String[] Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsRollingUpgrade +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet Aliases: Required: False @@ -527,6 +620,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteAwareUpdatingOrder +Specifies the order in which the command updates cluster nodes. + +By default, CAU selects the order of nodes to update based on the level of activity. + +```yaml +Type: String[] +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipUpdateChecks +Indicates that the command skips update checks. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StopAfter Specifies the time in minutes after which the updating run is canceled if it hasn't completed. The diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md index 13a4fda860..d4b1857fb9 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md @@ -17,9 +17,9 @@ updates that are applied to each node in a specified cluster. ## SYNTAX ``` -Invoke-CauScan [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] -] [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] - [] +Invoke-CauScan [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] ] + [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade] + [-AttemptSoftReboot] [] ``` ## DESCRIPTION @@ -78,6 +78,24 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ## PARAMETERS +### -AttemptSoftReboot +Indicates that command assumes a Kernel Soft Reboot (KSR) for the failover cluster. + +KSR bypasses BIOS/firmware initialization. +You can only use KSR for updates that do not require a BIOS/firmware initialization. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CauPluginArguments Specifies a set of name=value pairs for each updating plug-in to use. @@ -195,6 +213,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OsRollingUpgrade +Indicates that the CAU cluster role scans for upgrades to the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RunPluginsSerially Indicates that CAU scans each cluster node for applicable updates and stages the updates for each diff --git a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md index 9b6af814d9..c9c79bc50a 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md +++ b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md @@ -17,7 +17,7 @@ Saves CAU debug tracing information to a local zip file. ``` Save-CauDebugTrace [[-ClusterName] ] [[-FilePath] ] [-Credential ] - [-RunId ] [-Force] [] + [-RunId ] [-Force] [-FeatureUpdateLogs ] [] ``` ## DESCRIPTION @@ -68,6 +68,21 @@ Specifies the administrative credentials for the target cluster. ```yaml Type: PSCredential Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureUpdateLogs +Specifies feature update logs. + +```yaml +Type: FeatureUpdateLogs +Parameter Sets: (All) Aliases: Required: False diff --git a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md index 9a90b2dade..2504f7d8b7 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md @@ -25,8 +25,9 @@ Set-CauClusterRole [-UseDefault] [-StartDate ] [-DaysOfWeek [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] - [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] - [] + [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] + [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### UpdateNow @@ -53,8 +54,15 @@ Set-CauClusterRole [-UseDefault] [-StartDate ] [-DaysOfWeek [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] - [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] - [] + [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] + [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] +``` + +### DefaultParamSet +``` +Set-CauClusterRole [-AttemptSoftReboot] [[-ClusterName] ] [[-Credential] ] [-Force] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -166,6 +174,24 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ## PARAMETERS +### -AttemptSoftReboot +Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster. + +KSR bypasses BIOS/firmware initialization. +You can only use KSR for updates that do not require a BIOS/firmware initialization. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CauPluginArguments Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. @@ -409,6 +435,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForcePauseAndDrain +Indicates that the CAU cluster role forces cluster nodes to pause and drain roles. + +A forced drain moves the roles off of the draining node even if the group cannot move. +A group might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseDrainAndReboot +Indicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart. + +A forced drain moves the roles off of the draining node even if the group cannot move. +A group might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseNoDrain +Indicates that the CAU cluster role forces cluster nodes to pause. +The nodes are not drained. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IntervalWeeks Specifies the interval between weeks when the task will be triggered. @@ -470,6 +548,21 @@ Specifies an array of cluster node names in the order that they should be update ```yaml Type: String[] Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsRollingUpgrade +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly Aliases: Required: False @@ -599,6 +692,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteAwareUpdatingOrder +Specifies the order in which the CAU cluster role updates cluster nodes. + +By default, CAU selects the order of nodes to update based on the level of activity. + +```yaml +Type: String[] +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipUpdateChecks +Indicates that the CAU cluster role skips update checks. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StartDate Specifies the earliest date on which the updating run can be triggered. From 400e672b42ac47c8db419db325555af3b3f8e063 Mon Sep 17 00:00:00 2001 From: Pat Altimore Date: Tue, 1 Feb 2022 14:42:17 -0800 Subject: [PATCH 02/15] Remove special character --- .../clusterawareupdating/Add-CauClusterRole.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index 46b4a7b34e..bea2fb8870 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -271,12 +271,17 @@ Accept wildcard characters: False ``` ### -ConfigurationName +<<<<<<< HEAD Specifies the Windows PowerShell session configuration that defines the session in which scripts, specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and can limit the cmdlets that are available to be run. If either a pre-update or post-update script is specified but a configuration name isn't specified, then the default session configuration that is built into Windows PowerShell® is used. +======= +Specifies the Windows PowerShell session configuration that defines the session in which scripts, specified by the *PreUpdateScript* and *PostUpdateScript* parameters, and cmdlets are run, and can limit the cmdlets that are available to be run. +If either a pre-update or post-update script is specified but a configuration name is not specified, then the default session configuration that is built into Windows PowerShell® is used. +>>>>>>> f65c35cc7 (Remove special character) ```yaml Type: String From 560610689253f33f5e841bd7cc76a08e1ec5ad74 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 21 Jun 2022 23:35:35 +0100 Subject: [PATCH 03/15] Build validation fixes and additional parameters --- .../Add-CauClusterRole.md | 59 ++++++-- .../clusterawareupdating/Invoke-CauRun.md | 57 +++++--- .../clusterawareupdating/Invoke-CauScan.md | 26 +++- .../Save-CauDebugTrace.md | 4 +- .../Set-CauClusterRole.md | 129 ++++++++++++------ 5 files changed, 198 insertions(+), 77 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index bea2fb8870..a8eb576a6b 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -26,8 +26,8 @@ Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [ [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] - [-OsRollingUpgrade] [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] - [] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Weekly @@ -41,14 +41,21 @@ Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [ [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] - [-OsRollingUpgrade] [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] - [] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` -### DefaultParamSet +### Once ``` -Add-CauClusterRole [-AttemptSoftReboot] [[-ClusterName] ] [[-Credential] ] [-Force] - [-WhatIf] [-Confirm] [] +Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-RunOnce] + [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] + [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] + [-ConfigurationName ] [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] + [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] + [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] + [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] + [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] + [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -271,17 +278,12 @@ Accept wildcard characters: False ``` ### -ConfigurationName -<<<<<<< HEAD Specifies the Windows PowerShell session configuration that defines the session in which scripts, specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and can limit the cmdlets that are available to be run. If either a pre-update or post-update script is specified but a configuration name isn't specified, then the default session configuration that is -built into Windows PowerShell® is used. -======= -Specifies the Windows PowerShell session configuration that defines the session in which scripts, specified by the *PreUpdateScript* and *PostUpdateScript* parameters, and cmdlets are run, and can limit the cmdlets that are available to be run. -If either a pre-update or post-update script is specified but a configuration name is not specified, then the default session configuration that is built into Windows PowerShell® is used. ->>>>>>> f65c35cc7 (Remove special character) +built into Windows PowerShell is used. ```yaml Type: String @@ -618,6 +620,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RebootMode +{{ Fill RebootMode Description }} + +```yaml +Type: RebootType +Parameter Sets: (All) +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RebootTimeoutMinutes Specifies the time in minutes that CAU allows for the restarting of a node. If the restart doesn't @@ -652,6 +670,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RunOnce +{{ Fill RunOnce Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RunPluginsSerially Indicates that the cmdlet CAU scans each cluster node for applicable updates and stages the updates diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md index f8347ff06c..9010e1ee02 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md @@ -23,24 +23,17 @@ Invoke-CauRun [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] - [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] [[-ClusterName] ] - [[-CauPluginName] ] [[-Credential] ] [-CauPluginArguments ] - [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade] [-AttemptSoftReboot] [-WhatIf] [-Confirm] - [] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [-SiteAwareUpdatingOrder ] + [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] ] + [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade] + [-AttemptSoftReboot] [-RebootMode ] [-WhatIf] [-Confirm] [] ``` ### RecoverParamSet ``` -Invoke-CauRun [-ForceRecovery] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] - [-SkipUpdateChecks] [[-ClusterName] ] [[-Credential] ] [-WhatIf] [-Confirm] - [] -``` - -### RecoverParamSet - -``` -Invoke-CauRun [-ForceRecovery] [-Force] [[-ClusterName] ] [[-Credential] ] - [-WhatIf] [-Confirm] [] +Invoke-CauRun [-ForceRecovery] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [[-ClusterName] ] + [[-Credential] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -164,8 +157,9 @@ For instance: For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following arguments are optional: -- **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. -If not specified, the default value is **'False'**. +- **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates + will be applied in addition to important updates on each node. If not specified, the default value + is **'False'**. -- A standard Windows Update Agent query string that specifies criteria used by the Windows Update Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the @@ -434,6 +428,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForceSelfUpdate +{{ Fill ForceSelfUpdate Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaxFailedNodes Specifies the maximum number of nodes on which updating can fail. @@ -542,6 +551,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RebootMode +{{ Fill RebootMode Description }} + +```yaml +Type: RebootType +Parameter Sets: DefaultParamSet +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RebootTimeoutMinutes Specifies the time in minutes that CAU allows for the restarting of a node. If the restart doesn't diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md index d4b1857fb9..f977753073 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md @@ -18,8 +18,8 @@ updates that are applied to each node in a specified cluster. ``` Invoke-CauScan [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] ] - [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade] - [-AttemptSoftReboot] [] + [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [] ``` ## DESCRIPTION @@ -228,6 +228,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RebootMode +{{ Fill RebootMode Description }} + +```yaml +Type: RebootType +Parameter Sets: (All) +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RunPluginsSerially Indicates that CAU scans each cluster node for applicable updates and stages the updates for each @@ -284,7 +300,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.ClusterAwareUpdating.CauUpdateInfo +### Microsoft.ClusterAwareUpdating.UpdateInfo + +### Microsoft.ClusterAwareUpdating.ActivityIdMap + +### Microsoft.ClusterAwareUpdating.UpgradeSetupInfo ## NOTES diff --git a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md index c9c79bc50a..247e5e2f6c 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md +++ b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md @@ -154,7 +154,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### Microsoft.ClusterAwareUpdating.ActivityIdMap + +### System.IO.FileInfo ## NOTES diff --git a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md index 2504f7d8b7..5e909e554a 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md @@ -26,8 +26,9 @@ Set-CauClusterRole [-UseDefault] [-StartDate ] [-DaysOfWeek [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] - [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [[-ClusterName] ] - [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] + [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [-AttemptSoftReboot] + [-RebootMode ] [[-ClusterName] ] [[-Credential] ] [-Force] + [-WhatIf] [-Confirm] [] ``` ### UpdateNow @@ -55,14 +56,23 @@ Set-CauClusterRole [-UseDefault] [-StartDate ] [-DaysOfWeek [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] - [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [[-ClusterName] ] - [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] + [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [-AttemptSoftReboot] + [-RebootMode ] [[-ClusterName] ] [[-Credential] ] [-Force] + [-WhatIf] [-Confirm] [] ``` -### DefaultParamSet +### Once ``` -Set-CauClusterRole [-AttemptSoftReboot] [[-ClusterName] ] [[-Credential] ] [-Force] - [-WhatIf] [-Confirm] [] +Set-CauClusterRole [-UseDefault] [-RunOnce] [-CauPluginName ] + [-CauPluginArguments ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] + [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] + [-ConfigurationName ] [-RequireAllNodesOnline] [-WarnAfter ] + [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] + [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] + [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -385,8 +395,8 @@ settings that are configured for Windows Firewall. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -408,8 +418,8 @@ another node. The acceptable values for this parameter are: ```yaml Type: FailbackType -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Accepted values: NoFailback, Immediate, Policy Required: False @@ -443,7 +453,7 @@ A group might not be able to move because no other node can host the group or th ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -461,7 +471,7 @@ A group might not be able to move because no other node can host the group or th ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -477,7 +487,7 @@ The nodes are not drained. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -514,8 +524,8 @@ The default for most clusters is approximately one-third of the number of nodes. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -531,8 +541,8 @@ post-update scripts, is retried per node. The maximum is 64and the default is 3. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -547,7 +557,7 @@ Specifies an array of cluster node names in the order that they should be update ```yaml Type: String[] -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -562,8 +572,8 @@ Indicates that the CAU cluster role upgrades the operating system of the cluster ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -582,8 +592,8 @@ the cluster nodes. ```yaml Type: String -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -612,6 +622,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RebootMode +{{ Fill RebootMode Description }} + +```yaml +Type: RebootType +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RebootTimeoutMinutes Specifies the time in minutes that CAU will allow for the restarting of a node. If the restart doesn't @@ -619,8 +645,8 @@ complete within this time, then the updating run on that node is marked as faile ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -635,8 +661,23 @@ Indicates that all cluster nodes must be online and reachable before updating be ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOnce +{{ Fill RunOnce Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Once +Aliases: Required: False Position: Named @@ -660,8 +701,8 @@ single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -682,8 +723,8 @@ If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -699,7 +740,7 @@ By default, CAU selects the order of nodes to update based on the level of activ ```yaml Type: String[] -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -714,7 +755,7 @@ Indicates that the CAU cluster role skips update checks. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -752,8 +793,8 @@ performing updates must be complete within this time limit. ```yaml Type: TimeSpan -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -773,8 +814,8 @@ If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -798,8 +839,8 @@ for this value for every node in the cluster in the worst case. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -831,8 +872,8 @@ Indicates that default values are used for all parameters that don't have specif ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, UseDefault, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, UseDefault, Weekly, Once +Aliases: Required: False Position: Named @@ -849,8 +890,8 @@ of the time taken by the updating run. ```yaml Type: TimeSpan -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: Required: False Position: Named @@ -906,7 +947,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### System.Object ## NOTES From 6e404dedc90f97ec92cd1ae63ef9a9e139791bf2 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 6 Jul 2022 16:45:16 +0100 Subject: [PATCH 04/15] Updated formatting --- .../Add-CauClusterRole.md | 40 +++++++++---------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index a8eb576a6b..567ed4121b 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -11,7 +11,7 @@ title: Add-CauClusterRole # Add-CauClusterRole ## SYNOPSIS -Adds the CAU clustered role that provides the self-updating functionality to the specified cluster. +Adds the Cluster Aware Updating (CAU) clustered role that provides the self-updating functionality to the specified cluster. ## SYNTAX @@ -72,7 +72,6 @@ Mode (HTTP-In) firewall exception is enabled on each node. ## EXAMPLES ### Example 1: Add a CAU clustered role on the specified cluster at a specific interval - ```powershell $parameters = @{ ClusterName = 'CONTOSO-FC1' @@ -164,8 +163,8 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ### -AttemptSoftReboot Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster. -KSR bypasses BIOS/firmware initialization. -You can only use KSR for updates that do not require a BIOS/firmware initialization. +KSR bypasses BIOS/firmware initialization. You can only use KSR for updates that do not require a +BIOS/firmware initialization. ```yaml Type: SwitchParameter @@ -245,7 +244,7 @@ values separated with commas. The default is the Microsoft.WindowsUpdatePlugin p coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see -[How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +[How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: String[] @@ -280,9 +279,9 @@ Accept wildcard characters: False ### -ConfigurationName Specifies the Windows PowerShell session configuration that defines the session in which scripts, -specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and can -limit the cmdlets that are available to be run. If either a pre-update or post-update script is -specified but a configuration name isn't specified, then the default session configuration that is +specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and +can limit the cmdlets that are available to be run. If either a pre-update or post-update script is +specified but a configuration name is not specified, then the default session configuration that is built into Windows PowerShell is used. ```yaml @@ -336,13 +335,13 @@ Multiple values can be specified either separated with commas or as a hexadecima The acceptable values for this parameter are: -- **Sunday:** (0x01) -- **Monday:** (0x02) -- **Tuesday:** (0x04) -- **Wednesday:** (0x08) -- **Thursday:** (0x10) -- **Friday:** (0x20) -- **Saturday:** (0x40) +- `Sunday` or 0x01 +- `Monday` or 0x02 +- `Tuesday` or 0x04 +- `Wednesday` or 0x08 +- `Thursday` or 0x10 +- `Friday` or 0x20 +- `Saturday` or 0x40 ```yaml Type: Weekdays @@ -389,11 +388,11 @@ another node. The acceptable values for this parameter are: -- NoFailback -- Immediate -- Policy +- `NoFailback` +- `Immediate` +- `Policy` -The default value is Immediate. +The default value is `Immediate`. ```yaml Type: FailbackType @@ -820,7 +819,6 @@ Accept wildcard characters: False ``` ### -SuspendClusterNodeTimeoutMinutes - Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNode` cmdlet to succeed if the underlying clustered space is in degraded condition. @@ -847,7 +845,7 @@ Accept wildcard characters: False Specifies the name of a pre-staged virtual computer object that is used by the CAU clustered role. For more information, see -[Steps to create computer objects in Active Directory](https://go.microsoft.com/fwlink/p/?LinkId=237624). +[Steps to create computer objects in Active Directory](/windows-server/failover-clustering/configure-ad-accounts). If not specified, then a virtual computer object is created using a generated name. Generating a name automatically requires the cluster name object to have permissions to create the virtual computer object in Active Directory. From f20a65cbc186cbc7cb8d79b8f2dd1477038232b6 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 13 Jul 2022 12:00:24 +0100 Subject: [PATCH 05/15] Formatting and metadata updates --- .../Add-CauClusterRole.md | 61 ++++++++++--------- .../Disable-CauClusterRole.md | 1 - .../Enable-CauClusterRole.md | 5 +- .../clusterawareupdating/Export-CauReport.md | 1 - .../Get-CauClusterRole.md | 1 - .../Get-CauDeviceInfoForFeatureUpdates.md | 16 ++++- .../clusterawareupdating/Get-CauPlugin.md | 1 - .../clusterawareupdating/Get-CauReport.md | 23 +++---- .../clusterawareupdating/Get-CauRun.md | 1 - .../clusterawareupdating/Invoke-CauRun.md | 11 ++-- .../clusterawareupdating/Invoke-CauScan.md | 8 ++- .../Register-CauPlugin.md | 4 +- .../Remove-CauClusterRole.md | 1 - .../Save-CauDebugTrace.md | 1 - .../Set-CauClusterRole.md | 28 ++++----- .../clusterawareupdating/Stop-CauRun.md | 1 - .../clusterawareupdating/Test-CauSetup.md | 1 - .../Unregister-CauPlugin.md | 1 - 18 files changed, 85 insertions(+), 81 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index 567ed4121b..9f77043412 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -18,44 +18,48 @@ Adds the Cluster Aware Updating (CAU) clustered role that provides the self-upda ### MonthlyDayOfWeek (Default) ``` -Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-StartDate ] - [-DaysOfWeek ] [-WeeksOfMonth ] [-CauPluginName ] - [-CauPluginArguments ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] - [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] [-ConfigurationName ] - [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] - [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] - [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] - [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] - [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] - [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] +Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] +[-StartDate ] [-DaysOfWeek ] [-WeeksOfMonth ] +[-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] +[-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] +[-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] +[-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] +[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] +[-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] +[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] +[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] +[[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Weekly ``` -Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-StartDate ] - [-DaysOfWeek ] [-IntervalWeeks ] [-CauPluginName ] - [-CauPluginArguments ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] - [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] [-ConfigurationName ] - [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] - [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] - [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] - [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] - [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] - [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] +Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] +[-StartDate ] [-DaysOfWeek ] [-IntervalWeeks ] +[-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] +[-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] +[-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] +[-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] +[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] +[-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] +[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] +[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] +[[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Once + ``` Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-RunOnce] - [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] - [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] - [-ConfigurationName ] [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] - [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] - [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] - [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] - [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] - [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] +[-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] +[-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] +[-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] +[-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] +[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] +[-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] +[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] +[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] +[[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -72,6 +76,7 @@ Mode (HTTP-In) firewall exception is enabled on each node. ## EXAMPLES ### Example 1: Add a CAU clustered role on the specified cluster at a specific interval + ```powershell $parameters = @{ ClusterName = 'CONTOSO-FC1' diff --git a/docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md index 54013402ce..b45def11c8 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md @@ -124,7 +124,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md index c4cb36bb1b..3149e9f77a 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md @@ -35,8 +35,8 @@ Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force ``` This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating -Runs. The cmdlet changes the status of the CAU clustered role to Running. Because the command -specified the **Force** parameter, the cmdlet runs without displaying confirmation prompts. +Runs. The cmdlet changes the status of the CAU clustered role to Running. The cmdlet runs without +displaying confirmation prompts, as the **Force** parameter was used. ## PARAMETERS @@ -124,7 +124,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md b/docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md index 7a4d0b3068..e1322574c3 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md +++ b/docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md @@ -179,7 +179,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauClusterRole.md index f65df26cff..d1153cda3e 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauClusterRole.md @@ -71,7 +71,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md index 4ca8b96ff9..7673d5a738 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md @@ -26,11 +26,18 @@ The **Get-CauDeviceInfoForFeatureUpdates** cmdlet gets device information for fe ## EXAMPLES ### Example 1: Get device information + ```powershell -Get-CauDeviceInfoForFeatureUpdates -ClusterName "CONTOSO-FC1" -PathToDirectory "C:\temp\contoso-device-info" +$Parameters = @{ + ClusterName = 'CONTOSO-FC1' + PathToDirectory = 'C:\temp\contoso-device-info' +} +Get-CauDeviceInfoForFeatureUpdates $Parameters ``` -This example gets device information for CAU for the specified cluster. +This example gets device information for CAU for the specified cluster. This example uses +splatting to pass parameter values from the `$Parameters` variable to the command. Learn more about +[Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). ## PARAMETERS @@ -80,7 +87,10 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauPlugin.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauPlugin.md index f5c80a68db..e6fd6b5f4e 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauPlugin.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauPlugin.md @@ -63,7 +63,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md index 7596f4fc77..a9c976a799 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md @@ -19,38 +19,40 @@ specified dates or other specified parameters. ### AllParamsSet (Default) ``` -Get-CauReport [[-ClusterName] ] [-Detailed] [-Credential ] [] +Get-CauReport [[-ClusterName] ] [-Detailed] [-Credential ] +[] ``` ### RangeParamSet ``` -Get-CauReport [[-ClusterName] ] [[-StartDate] ] [[-EndDate] ] [-Detailed] - [-Credential ] [] +Get-CauReport [[-ClusterName] ] [[-StartDate] ] [[-EndDate] ] +[-Detailed] [-Credential ] [] ``` ### LastParamSet ``` -Get-CauReport [[-ClusterName] ] [-Last] [-Detailed] [-Credential ] [] +Get-CauReport [[-ClusterName] ] [-Last] [-Detailed] [-Credential ] +[] ``` ### SpecificReportParamSet ``` Get-CauReport [[-ClusterName] ] [-Report ] [-Credential ] - [] +[] ``` ## DESCRIPTION The `Get-CauReport` cmdlet gets the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters. This cmdlet can return a -list of all Updating Run reports between the specified **StartDate** and **EndDate** parameters, or if -the **Last** parameter is specified instead of dates, then the cmdlet returns the most recent Updating -Run report. By default, the report contains summaries only, but more detail can be obtained with the -**Detailed** parameter or by using the **Report** parameter and specifying a Cluster-Aware Updating -(CAU) report summary object. +list of all Updating Run reports between the specified **StartDate** and **EndDate** parameters, or +if the **Last** parameter is specified instead of dates, then the cmdlet returns the most recent +Updating Run report. By default, the report contains summaries only, but more detail can be obtained +with the **Detailed** parameter or by using the **Report** parameter and specifying a Cluster-Aware +Updating (CAU) report summary object. ## EXAMPLES @@ -202,7 +204,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md index 2c1e0ae6a8..6170d73c00 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md @@ -166,7 +166,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md index 9010e1ee02..e0b03f4073 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md @@ -160,11 +160,11 @@ The following arguments are optional: - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is **'False'**. --- A standard Windows Update Agent query string that specifies criteria used by the Windows Update -Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and -for a value, enclose the full query in quotation marks. If not specified, then the -**Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` +- A standard Windows Update Agent query string that specifies criteria used by the Windows Update + Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and + for a value, enclose the full query in quotation marks. If not specified, then the + **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: + - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see @@ -782,7 +782,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md index f977753073..dec03d52a8 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md @@ -110,6 +110,7 @@ For instance: - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. + The following arguments are optional: - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value @@ -118,7 +119,7 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` + - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see @@ -163,7 +164,9 @@ Specifies one or more plug-ins to use when performing scans. You can specify mul separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This plug-in coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows -Server Update Services (WSUS) server. For more information about how plug-ins work with +Server Update Services (WSUS) server. + +For more information about how plug-ins work with Cluster-Aware Updating (CAU), see [Cluster-Aware Updating plug-ins](https://go.microsoft.com/fwlink/p/?LinkId=235333). @@ -288,7 +291,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md b/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md index 18b955519b..92bd0623d4 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md +++ b/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md @@ -40,8 +40,8 @@ Register-CauPlugin -Path "C:\PluginDevelopment\Plugin01.dll" -Force ``` The command registers a plug-in called Plugin01.dll located in the C:\PluginDevelopment folder. -Because the command specifies the **Force** parameter, the cmdlet runs without displaying confirmation -prompts. +Because the command specifies the **Force** parameter, the cmdlet runs without displaying +confirmation prompts. ## PARAMETERS diff --git a/docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md index e14961750c..94160caf59 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md @@ -128,7 +128,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md index 247e5e2f6c..622d967a0f 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md +++ b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md @@ -142,7 +142,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md index 5e909e554a..108e0a7b2c 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md @@ -224,10 +224,11 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more - information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the - criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). + - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` + +For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in +and the criteria such as IsInstalled that can be included in the query strings, see +[IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a @@ -389,9 +390,9 @@ Indicates that this cmdlet enables the **Remote Shutdown** Windows Firewall rule cluster node, if it isn't already enabled, each time the CAU clustered role performs an Updating Run. Enabling this rule group permits inbound communication to each cluster node during each Updating Run that allows CAU to shut down and restart the node remotely. If Windows Firewall is in -use on the cluster nodes and the rule group isn't enabled, the updating run will fail. The **Remote -Shutdown** Windows Firewall rule group isn't enabled when it will conflict with Group Policy -settings that are configured for Windows Firewall. +use on the cluster nodes and the rule group is not enabled, the updating run will fail. The +**Remote Shutdown** Windows Firewall rule group is not enabled when it will conflict with Group +Policy settings that are configured for Windows Firewall. ```yaml Type: SwitchParameter @@ -498,10 +499,8 @@ Accept wildcard characters: False ``` ### -IntervalWeeks - -Specifies the interval between weeks when the task will be triggered. -An interval of 1 produces a weekly schedule. -An interval of 2 produces an every-other week schedule. +Specifies the interval between weeks when the task will be triggered. An interval of 1 produces a +weekly schedule. An interval of 2 produces an every-other week schedule. ```yaml Type: Int32 @@ -689,15 +688,15 @@ Accept wildcard characters: False ### -RunPluginsSerially Indicates that CAU scans each cluster node for applicable updates and stage the updates for each -plug-in in the plug-in order passed into the*CauPluginName* parameter, when multiple plug-ins are +plug-in in the plug-in order passed into the**CauPluginName** parameter, when multiple plug-ins are used during an updating run. By default, CAU scans and stages the applicable updates for all plug-ins in parallel. Regardless of the configuration of this parameter, CAU installs the applicable updates for each plug-in sequentially. -The parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter. If a -single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter. +If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -935,7 +934,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Stop-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Stop-CauRun.md index 825862afaf..9fe872bb79 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Stop-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Stop-CauRun.md @@ -108,7 +108,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Test-CauSetup.md b/docset/winserver2022-ps/clusterawareupdating/Test-CauSetup.md index 40418c7e25..d454ca1497 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Test-CauSetup.md +++ b/docset/winserver2022-ps/clusterawareupdating/Test-CauSetup.md @@ -76,7 +76,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Unregister-CauPlugin.md b/docset/winserver2022-ps/clusterawareupdating/Unregister-CauPlugin.md index bb4ee98a39..18830dc142 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Unregister-CauPlugin.md +++ b/docset/winserver2022-ps/clusterawareupdating/Unregister-CauPlugin.md @@ -88,7 +88,6 @@ Accept wildcard characters: False ``` ### CommonParameters - This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see From 8c32009155e98bcea9163389ce8b44c5ae29393e Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 13 Jul 2022 15:54:47 +0100 Subject: [PATCH 06/15] Updated outputs --- .../Add-CauClusterRole.md | 48 +++++++++---------- .../Enable-CauClusterRole.md | 2 +- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index 9f77043412..65a93a1168 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -375,7 +375,7 @@ conflict with Group Policy settings that are configured for Windows Firewall. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -401,7 +401,7 @@ The default value is `Immediate`. ```yaml Type: FailbackType -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Accepted values: NoFailback, Immediate, Policy @@ -436,7 +436,7 @@ A group might not be able to move because no other node can host the group or th ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -454,7 +454,7 @@ A group might not be able to move because no other node can host the group or th ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -470,7 +470,7 @@ The nodes are not drained. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -486,7 +486,7 @@ Specifies the NetBIOS name of the resource group for the CAU clustered role. ```yaml Type: String -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -523,7 +523,7 @@ The default for most clusters is approximately one-third of the number of nodes. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -542,7 +542,7 @@ The maximum is 64 and the default is 3. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -558,8 +558,8 @@ Specifies an array of cluster node names in the order that they should be update ```yaml Type: String[] -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -614,7 +614,7 @@ pre-update script fails, the node isn't updated. ```yaml Type: String -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -647,7 +647,7 @@ complete within this time, then the Updating Run on that node will be marked as ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -664,7 +664,7 @@ begins. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -702,7 +702,7 @@ If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -724,8 +724,8 @@ If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly -Aliases: +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -741,7 +741,7 @@ By default, CAU selects the order of nodes to update based on the level of activ ```yaml Type: String[] -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -756,7 +756,7 @@ Indicates that the CAU cluster role skips update checks. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -794,7 +794,7 @@ performing updates must be complete within this time limit. ```yaml Type: TimeSpan -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -813,7 +813,7 @@ a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -836,7 +836,7 @@ for this value for every node in the cluster in the worst case. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -857,7 +857,7 @@ computer object in Active Directory. ```yaml Type: String -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -875,7 +875,7 @@ regardless of the time taken by the Updating Run. ```yaml Type: TimeSpan -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: (All) Aliases: Required: False @@ -932,7 +932,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### System.Object ## NOTES diff --git a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md index 3149e9f77a..7f19e6d1d4 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md @@ -135,7 +135,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### System.Object ## NOTES From 0c65f2b639255fafcda8c76e939048554c6d40ec Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 19 Oct 2022 00:19:50 +0100 Subject: [PATCH 07/15] Fixing formatting --- .../Add-CauClusterRole.md | 68 +++++++++++-------- .../Disable-CauClusterRole.md | 1 + .../Enable-CauClusterRole.md | 1 + .../clusterawareupdating/Export-CauReport.md | 1 + .../Get-CauClusterRole.md | 1 + .../Get-CauDeviceInfoForFeatureUpdates.md | 7 +- .../clusterawareupdating/Get-CauPlugin.md | 1 + .../clusterawareupdating/Get-CauReport.md | 9 +-- .../clusterawareupdating/Get-CauRun.md | 1 + .../clusterawareupdating/Invoke-CauRun.md | 11 +++ .../clusterawareupdating/Invoke-CauScan.md | 4 ++ .../Remove-CauClusterRole.md | 1 + .../Save-CauDebugTrace.md | 2 + .../Set-CauClusterRole.md | 13 ++++ .../clusterawareupdating/Stop-CauRun.md | 1 + .../clusterawareupdating/Test-CauSetup.md | 1 + .../Unregister-CauPlugin.md | 1 + 17 files changed, 90 insertions(+), 34 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index 65a93a1168..f7fea7b583 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -19,47 +19,47 @@ Adds the Cluster Aware Updating (CAU) clustered role that provides the self-upda ``` Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] -[-StartDate ] [-DaysOfWeek ] [-WeeksOfMonth ] -[-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] -[-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] -[-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] -[-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] -[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] -[-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] -[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] -[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] -[[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] + [-StartDate ] [-DaysOfWeek ] [-WeeksOfMonth ] + [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] + [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] + [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] + [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] + [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] + [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Weekly ``` Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] -[-StartDate ] [-DaysOfWeek ] [-IntervalWeeks ] -[-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] -[-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] -[-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] -[-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] -[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] -[-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] -[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] -[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] -[[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] + [-StartDate ] [-DaysOfWeek ] [-IntervalWeeks ] + [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] + [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] + [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] + [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] + [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] + [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Once ``` Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-RunOnce] -[-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] -[-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] -[-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] -[-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] -[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] -[-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] -[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] -[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] -[[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] + [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] + [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] + [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] + [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] + [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] + [-SuspendClusterNodeTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -166,6 +166,7 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ## PARAMETERS ### -AttemptSoftReboot + Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster. KSR bypasses BIOS/firmware initialization. You can only use KSR for updates that do not require a @@ -429,6 +430,7 @@ Accept wildcard characters: False ``` ### -ForcePauseAndDrain + Indicates that the CAU cluster role forces cluster nodes to pause and drain roles. A forced drain moves the roles off of the draining node even if the group cannot move. @@ -447,6 +449,7 @@ Accept wildcard characters: False ``` ### -ForcePauseDrainAndReboot + Indicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart. A forced drain moves the roles off of the draining node even if the group cannot move. @@ -465,6 +468,7 @@ Accept wildcard characters: False ``` ### -ForcePauseNoDrain + Indicates that the CAU cluster role forces cluster nodes to pause. The nodes are not drained. @@ -569,6 +573,7 @@ Accept wildcard characters: False ``` ### -OsRollingUpgrade + Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. ```yaml @@ -625,6 +630,7 @@ Accept wildcard characters: False ``` ### -RebootMode + {{ Fill RebootMode Description }} ```yaml @@ -675,6 +681,7 @@ Accept wildcard characters: False ``` ### -RunOnce + {{ Fill RunOnce Description }} ```yaml @@ -735,6 +742,7 @@ Accept wildcard characters: False ``` ### -SiteAwareUpdatingOrder + Specifies the order in which the CAU cluster role updates cluster nodes. By default, CAU selects the order of nodes to update based on the level of activity. @@ -752,6 +760,7 @@ Accept wildcard characters: False ``` ### -SkipUpdateChecks + Indicates that the CAU cluster role skips update checks. ```yaml @@ -824,6 +833,7 @@ Accept wildcard characters: False ``` ### -SuspendClusterNodeTimeoutMinutes + Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNode` cmdlet to succeed if the underlying clustered space is in degraded condition. diff --git a/docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md index b45def11c8..54013402ce 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md @@ -124,6 +124,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md index 7f19e6d1d4..7634c34aa0 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md @@ -124,6 +124,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md b/docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md index e1322574c3..7a4d0b3068 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md +++ b/docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md @@ -179,6 +179,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauClusterRole.md index d1153cda3e..f65df26cff 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauClusterRole.md @@ -71,6 +71,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md index 7673d5a738..59bfe3bf4a 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md @@ -21,7 +21,8 @@ Get-CauDeviceInfoForFeatureUpdates [[-ClusterName] ] [-Credential ] [-Detailed] [-Credential ] -[] + [] ``` ### RangeParamSet ``` Get-CauReport [[-ClusterName] ] [[-StartDate] ] [[-EndDate] ] -[-Detailed] [-Credential ] [] + [-Detailed] [-Credential ] [] ``` ### LastParamSet ``` Get-CauReport [[-ClusterName] ] [-Last] [-Detailed] [-Credential ] -[] + [] ``` ### SpecificReportParamSet ``` Get-CauReport [[-ClusterName] ] [-Report ] [-Credential ] -[] + [] ``` ## DESCRIPTION @@ -204,6 +204,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md index 6170d73c00..2c1e0ae6a8 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md @@ -166,6 +166,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md index e0b03f4073..2a07458316 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md @@ -30,6 +30,7 @@ Invoke-CauRun [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder ``` ### RecoverParamSet + ``` Invoke-CauRun [-ForceRecovery] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [[-ClusterName] ] @@ -125,6 +126,7 @@ recovery is performed without confirmation prompts. ## PARAMETERS ### -AttemptSoftReboot + Indicates that command attempts a Kernel Soft Reboot (KSR) for the failover cluster. KSR bypasses BIOS/firmware initialization. @@ -357,6 +359,7 @@ Accept wildcard characters: False ``` ### -ForcePauseAndDrain + Indicates that the command forces cluster nodes to pause and drain roles. A forced drain moves the roles off of the draining node even if the group cannot move. @@ -375,6 +378,7 @@ Accept wildcard characters: False ``` ### -ForcePauseDrainAndReboot + Indicates that the command forces cluster nodes to pause, drain roles, and restart. A forced drain moves the roles off of the draining node even if the group cannot move. @@ -393,6 +397,7 @@ Accept wildcard characters: False ``` ### -ForcePauseNoDrain + Indicates that the command forces cluster nodes to pause. The nodes are not drained. @@ -429,6 +434,7 @@ Accept wildcard characters: False ``` ### -ForceSelfUpdate + {{ Fill ForceSelfUpdate Description }} ```yaml @@ -496,6 +502,7 @@ Accept wildcard characters: False ``` ### -OsRollingUpgrade + Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. ```yaml @@ -552,6 +559,7 @@ Accept wildcard characters: False ``` ### -RebootMode + {{ Fill RebootMode Description }} ```yaml @@ -646,6 +654,7 @@ Accept wildcard characters: False ``` ### -SiteAwareUpdatingOrder + Specifies the order in which the command updates cluster nodes. By default, CAU selects the order of nodes to update based on the level of activity. @@ -663,6 +672,7 @@ Accept wildcard characters: False ``` ### -SkipUpdateChecks + Indicates that the command skips update checks. ```yaml @@ -782,6 +792,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md index dec03d52a8..190c4148a3 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md @@ -79,6 +79,7 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ## PARAMETERS ### -AttemptSoftReboot + Indicates that command assumes a Kernel Soft Reboot (KSR) for the failover cluster. KSR bypasses BIOS/firmware initialization. @@ -217,6 +218,7 @@ Accept wildcard characters: False ``` ### -OsRollingUpgrade + Indicates that the CAU cluster role scans for upgrades to the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. ```yaml @@ -232,6 +234,7 @@ Accept wildcard characters: False ``` ### -RebootMode + {{ Fill RebootMode Description }} ```yaml @@ -291,6 +294,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md index 94160caf59..e14961750c 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md @@ -128,6 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md index 622d967a0f..c471a63977 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md +++ b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md @@ -78,6 +78,7 @@ Accept wildcard characters: False ``` ### -FeatureUpdateLogs + Specifies feature update logs. ```yaml @@ -142,6 +143,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md index 108e0a7b2c..861d5dfb12 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md @@ -62,6 +62,7 @@ Set-CauClusterRole [-UseDefault] [-StartDate ] [-DaysOfWeek ``` ### Once + ``` Set-CauClusterRole [-UseDefault] [-RunOnce] [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] @@ -112,6 +113,7 @@ This example uses splatting to pass parameter values from the `$parameters` vari Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). ### Example 2: Configure settings for a CAU cluster role on the specified cluster on the second week of the month + ```powershell $parameters = @{ ClusterName = 'CONTOSO-FC1' @@ -185,6 +187,7 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ## PARAMETERS ### -AttemptSoftReboot + Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster. KSR bypasses BIOS/firmware initialization. @@ -447,6 +450,7 @@ Accept wildcard characters: False ``` ### -ForcePauseAndDrain + Indicates that the CAU cluster role forces cluster nodes to pause and drain roles. A forced drain moves the roles off of the draining node even if the group cannot move. @@ -465,6 +469,7 @@ Accept wildcard characters: False ``` ### -ForcePauseDrainAndReboot + Indicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart. A forced drain moves the roles off of the draining node even if the group cannot move. @@ -483,6 +488,7 @@ Accept wildcard characters: False ``` ### -ForcePauseNoDrain + Indicates that the CAU cluster role forces cluster nodes to pause. The nodes are not drained. @@ -499,6 +505,7 @@ Accept wildcard characters: False ``` ### -IntervalWeeks + Specifies the interval between weeks when the task will be triggered. An interval of 1 produces a weekly schedule. An interval of 2 produces an every-other week schedule. @@ -567,6 +574,7 @@ Accept wildcard characters: False ``` ### -OsRollingUpgrade + Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. ```yaml @@ -622,6 +630,7 @@ Accept wildcard characters: False ``` ### -RebootMode + {{ Fill RebootMode Description }} ```yaml @@ -671,6 +680,7 @@ Accept wildcard characters: False ``` ### -RunOnce + {{ Fill RunOnce Description }} ```yaml @@ -733,6 +743,7 @@ Accept wildcard characters: False ``` ### -SiteAwareUpdatingOrder + Specifies the order in which the CAU cluster role updates cluster nodes. By default, CAU selects the order of nodes to update based on the level of activity. @@ -750,6 +761,7 @@ Accept wildcard characters: False ``` ### -SkipUpdateChecks + Indicates that the CAU cluster role skips update checks. ```yaml @@ -934,6 +946,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Stop-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Stop-CauRun.md index 9fe872bb79..825862afaf 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Stop-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Stop-CauRun.md @@ -108,6 +108,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Test-CauSetup.md b/docset/winserver2022-ps/clusterawareupdating/Test-CauSetup.md index d454ca1497..40418c7e25 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Test-CauSetup.md +++ b/docset/winserver2022-ps/clusterawareupdating/Test-CauSetup.md @@ -76,6 +76,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/clusterawareupdating/Unregister-CauPlugin.md b/docset/winserver2022-ps/clusterawareupdating/Unregister-CauPlugin.md index 18830dc142..bb4ee98a39 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Unregister-CauPlugin.md +++ b/docset/winserver2022-ps/clusterawareupdating/Unregister-CauPlugin.md @@ -88,6 +88,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see From afcaccb1b009fdf4c364cb667ae41afe5b5cb711 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Tue, 2 Jul 2024 16:53:17 -0400 Subject: [PATCH 08/15] Updated new CAU cmdlets & parameters --- .../Add-CauClusterRole.md | 377 +++++++++++--- .../Get-CauDeviceInfoForFeatureUpdates.md | 133 +++++ .../Get-ClusterlessCauRun.md | 103 ++++ .../clusterawareupdating/Invoke-CauRun.md | 460 ++++++++++++++---- .../clusterawareupdating/Invoke-CauScan.md | 134 +++-- .../Invoke-ClusterlessCauRun.md | 454 +++++++++++++++++ .../Save-CauDebugTrace.md | 37 +- .../Set-CauClusterRole.md | 412 ++++++++++++---- 8 files changed, 1785 insertions(+), 325 deletions(-) create mode 100644 docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md create mode 100644 docset/winserver2025-ps/clusterawareupdating/Get-ClusterlessCauRun.md create mode 100644 docset/winserver2025-ps/clusterawareupdating/Invoke-ClusterlessCauRun.md diff --git a/docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md index 76b7ae0a82..41b408ea08 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterAwareUpdating.dll-Help.xml Module Name: ClusterAwareUpdating -ms.date: 09/27/2022 +ms.date: 07/01/2024 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/add-cauclusterrole?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-CauClusterRole @@ -23,10 +23,14 @@ Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] - [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] - [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] - [-SuspendClusterNodeTimeoutMinutes ] [[-ClusterName] ] [[-Credential] ] - [-Force] [-WhatIf] [-Confirm] [] + [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] + [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] + [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] + [-SuspendRetriesPerNode ] [-WaitForStorageRepairTimeoutMinutes ] [-ForcePauseNoDrain] + [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] + [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [-AttemptSoftReboot] + [-RebootMode ] [[-ClusterName] ] [[-Credential] ] [-Force] + [-WhatIf] [-Confirm] [] ``` ### Weekly @@ -39,8 +43,27 @@ Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] - [-SuspendClusterNodeTimeoutMinutes ] [[-ClusterName] ] [[-Credential] ] - [-Force] [-WhatIf] [-Confirm] [] + [-SuspendClusterNodeTimeoutMinutes ] [-SuspendRetriesPerNode ] + [-WaitForStorageRepairTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] +``` + +### Once + +``` +Add-CauClusterRole [-VirtualComputerObjectName ] [-GroupName ] [-RunOnce] + [-CauPluginName ] [-CauPluginArguments ] [-MaxFailedNodes ] + [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] + [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] + [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] + [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] + [-SuspendClusterNodeTimeoutMinutes ] [-SuspendRetriesPerNode ] + [-WaitForStorageRepairTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -50,9 +73,9 @@ the self-updating functionality to the specified cluster. When the CAU clustered to a cluster, the failover cluster can update itself on the schedule that is specified by the user, without requiring an external computer to coordinate the cluster updating process. -To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. To do this, run the -`Enable-PSRemoting` cmdlet. In addition, ensure that the Windows Remote Management - Compatibility -Mode (HTTP-In) firewall exception is enabled on each node. +To run this cmdlet, Windows PowerShell remoting must be enabled on each node. To do this, run the +`Enable-PSRemoting` cmdlet. In addition, ensure that the **Windows Remote Management - Compatibility +Mode (HTTP-In)** firewall exception is enabled on each node. ## EXAMPLES @@ -75,14 +98,14 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. +This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`. The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays on the -second and fourth weeks of each month. In an Updating Run, the maximum number of failed nodes is two -and the maximum number of retries per node is two. A script called verifyupdatesinstalled.ps1 runs -on each node after it has been fully updated. Before an Updating Run can begin, all the nodes of -that cluster must be running. If it isn't already enabled, the Remote Shutdown Windows Firewall -rule group will be enabled on each cluster node. Because the command uses the **Force** parameter, the -cmdlet runs without displaying confirmation prompts. +second and fourth weeks of each month. In an Updating Run, the maximum number of failed nodes is +two and the maximum number of retries per node is two. A script called `verifyupdatesinstalled.ps1` +runs on each node after it has been fully updated. Before an Updating Run can begin, all the nodes +of that cluster must be running. If it isn't already enabled, the Remote Shutdown Windows Firewall +rule group will be enabled on each cluster node. Because the command uses the **Force** parameter, +the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -103,7 +126,7 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. +This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`. The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays at an interval of every three weeks. In an Updating Run, the maximum number of failed nodes is two and the maximum number of retries per node is two. Updating Runs can begin even when the nodes of the @@ -131,9 +154,9 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. +This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`. The CAU clustered role is configured to perform updates using the **Microsoft.WindowsUpdatePlugin** -plug-in with the optional **IncludeRecommendedUpdates** parameter set to True, and using the +plug-in with the optional **IncludeRecommendedUpdates** parameter set to `True`, and using the **Microsoft.HotfixPlugin plug-in** using the hotfix root folder `\\CauHotfixSrv\shareName` and the default hotfix configuration file. If a failure occurs during the installation of updates on a node by **Microsoft.WindowsUpdatePlugin**, updates are applied by **Microsoft.HotfixPlugin plug-in**. If @@ -146,9 +169,29 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ## PARAMETERS +### -AttemptSoftReboot + +Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster. + +KSR bypasses BIOS/firmware initialization. You can only use KSR for updates that do not require a +BIOS/firmware initialization. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CauPluginArguments -Specifies an array of name=value pairs (arguments) for each updating plug-in to use. +Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + For instance, to specify a Domain argument for one plug-in: - `@{Domain=Domain.local}` You can specify multiple pairs in a set separated with semicolons. @@ -171,10 +214,9 @@ The following arguments are optional: - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). + [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). -For the **Microsoft.HotfixPlugin** plug-in. -the following argument is required: +For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file @@ -183,15 +225,15 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled for either SMB signing or SMB Encryption. -- **DisableAclChecks=\**: Boolean value to indicate that the plug-in checks for sufficient - permissions on the hotfix root folder and the hotfix configuration file. If not specified, the - default value is False. +- **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for + sufficient permissions on the hotfix root folder and the hotfix configuration file. If not + specified, the default value is False. - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfigFile.xml is used. For more information about required and optional + default name DefaultHotfixConfig.xml is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see - [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] @@ -212,7 +254,7 @@ values separated with commas. The default is the Microsoft.WindowsUpdatePlugin p coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see -[How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +[How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: String[] @@ -247,10 +289,10 @@ Accept wildcard characters: False ### -ConfigurationName Specifies the Windows PowerShell session configuration that defines the session in which scripts, -specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and can -limit the cmdlets that are available to be run. If either a pre-update or post-update script is +specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and +can limit the cmdlets that are available to be run. If either a pre-update or post-update script is specified but a configuration name isn't specified, then the default session configuration that is -built into Windows PowerShell® is used. +built into Windows PowerShell is used. ```yaml Type: String @@ -275,7 +317,7 @@ Aliases: cf Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -298,8 +340,8 @@ Accept wildcard characters: False ### -DaysOfWeek -Specifies the days of the week on which the updating task will be triggered. -Multiple values can be specified either separated with commas or as a hexadecimal sum. +Specifies the days of the week on which the updating task will be triggered. Multiple values can be +specified either separated with commas or as a hexadecimal sum. The acceptable values for this parameter are: @@ -313,7 +355,7 @@ The acceptable values for this parameter are: ```yaml Type: Weekdays -Parameter Sets: (All) +Parameter Sets: MonthlyDayOfWeek, Weekly Aliases: Accepted values: None, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday @@ -326,15 +368,17 @@ Accept wildcard characters: False ### -EnableFirewallRules -Indicates that the cmdlet enables the Remote Shutdown Windows Firewall rule group on each cluster -node, if it isn't already enabled. If the **EnableFirewallRules** parameter is specified, CAU will -also automatically re-enable the Remote Shutdown rule group each time the CAU clustered role -performs an Updating Run, in case the rules are disabled manually in the intervening time. Enabling -this rule group permits inbound communication to each cluster node during each Updating Run that -allows CAU to shut down and restart the node remotely (if the installation of an update requires a -restart). If Windows Firewall is in use on the cluster nodes and the rule group isn't enabled, the -Updating Run will fail. The Remote Shutdown Windows Firewall rule group isn't enabled when it will -conflict with Group Policy settings that are configured for Windows Firewall. +Indicates that the cmdlet enables the **Remote Shutdown** Windows Firewall rule group on each +cluster node, if it isn't already enabled. If the **EnableFirewallRules** parameter is specified, +CAU will also automatically re-enable the **Remote Shutdown** rule group each time the CAU +clustered role performs an Updating Run, in case the rules are disabled manually in the intervening +time. + +Enabling this rule group permits inbound communication to each cluster node during each Updating +Run that allows CAU to shut down and restart the node remotely (if the installation of an update +requires a restart). If Windows Firewall is in use on the cluster nodes and the rule group isn't +enabled, the Updating Run will fail. The Remote Shutdown Windows Firewall rule group isn't enabled +when it will conflict with Group Policy settings that are configured for Windows Firewall. ```yaml Type: SwitchParameter @@ -360,7 +404,7 @@ The acceptable values for this parameter are: - Immediate - Policy -The default value is Immediate. +The default value is **Immediate**. ```yaml Type: FailbackType @@ -391,6 +435,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForcePauseAndDrain + +Indicates that the CAU cluster role forces cluster nodes to pause and drain roles. + +A forced drain moves the roles off of the draining node even if the group cannot move. A group +might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseDrainAndReboot + +Indicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart. + +A forced drain moves the roles off of the draining node even if the group cannot move. A group +might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseNoDrain + +Indicates that the CAU cluster role forces cluster nodes to pause. The nodes are not drained. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GroupName Specifies the NetBIOS name of the resource group for the CAU clustered role. @@ -409,9 +507,8 @@ Accept wildcard characters: False ### -IntervalWeeks -Specifies the interval between weeks when the task will be triggered. -An interval of 1 produces a weekly schedule. -An interval of 2 produces an every-other week schedule. +Specifies the interval between weeks when the task will be triggered. An interval of 1 produces a +weekly schedule. An interval of 2 produces an every-other week schedule. ```yaml Type: Int32 @@ -427,10 +524,9 @@ Accept wildcard characters: False ### -MaxFailedNodes -Specifies the maximum number of nodes on which updating can fail. -If one more than this number of nodes fails, then the Updating Run is stopped. -The range is from 0 through 1, less than the number of cluster nodes. -The default for most clusters is approximately one-third of the number of nodes. +Specifies the maximum number of nodes on which updating can fail. If one more than this number of +nodes fails, then the Updating Run is stopped. The range is from 0 through 1, less than the number +of cluster nodes. The default for most clusters is approximately one-third of the number of nodes. ```yaml Type: Int32 @@ -446,10 +542,9 @@ Accept wildcard characters: False ### -MaxRetriesPerNode -Specifies the maximum number of times that the update process attempts to run. -This includes any pre-update and post-update scripts. -The update process is retried per node. -The maximum is 64 and the default is 3. +Specifies the maximum number of times that the update process attempts to run. This includes any +pre-update and post-update scripts. The update process is retried per node. The maximum is **64** +and the default is **3**. ```yaml Type: Int32 @@ -479,11 +574,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OsRollingUpgrade + +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without +stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PostUpdateScript Specifies the path and file name for a Windows PowerShell script to run on each node after updating finishes, and just after the node is brought out of Maintenance mode. The file name extension must -be .ps1 and the total length of the path plus the file name must be no longer than 260 characters. +be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that the script is always accessible to all the cluster nodes. @@ -502,7 +614,7 @@ Accept wildcard characters: False ### -PreUpdateScript Specifies the path and file name for a Windows PowerShell script to run on each node before updating -begins, and before the node is put into Maintenance mode. The file name extension must be .ps1 and +begins, and before the node is put into Maintenance mode. The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that the script is always accessible to all the cluster nodes. If a @@ -520,6 +632,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RebootMode + +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- ClusProp +- FullReboot +- SoftReboot +- PluginCustomReboot +- OrchestratorDefault + +```yaml +Type: RebootType +Parameter Sets: (All) +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RebootTimeoutMinutes Specifies the time in minutes that CAU allows for the restarting of a node. If the restart doesn't @@ -554,6 +690,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RunOnce + +Specifies that the CAU run should only be performed once, rather than on a recurring schedule. This +can be useful if you only need to perform a one-time update of your cluster nodes. + +```yaml +Type: SwitchParameter +Parameter Sets: Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RunPluginsSerially Indicates that the cmdlet CAU scans each cluster node for applicable updates and stages the updates @@ -599,13 +752,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteAwareUpdatingOrder + +Specifies the order in which the CAU cluster role updates cluster nodes. + +By default, CAU selects the order of nodes to update based on the level of activity. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipUpdateChecks + +Indicates that the CAU cluster role skips update checks. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StartDate Specifies the earliest date on which the Updating Run can be triggered. ```yaml Type: DateTime -Parameter Sets: (All) +Parameter Sets: MonthlyDayOfWeek, Weekly Aliases: Required: False @@ -640,9 +827,10 @@ Accept wildcard characters: False ### -StopOnPluginFailure Indicates that this cmdlet coordinates subsequent updates on the node when plug-ins are stopped. -When multiple plug-ins are used during an updating run, by default, a failure by one plug-in doesn't affect the application of updates on a node by other plug-ins. This parameter is valid only when -multiple plug-ins are specified in the **CauPluginName** parameter. If a single plug-in is specified, -a warning appears. +When multiple plug-ins are used during an updating run, by default, a failure by one plug-in +doesn't affect the application of updates on a node by other plug-ins. This parameter is valid only +when multiple plug-ins are specified in the **CauPluginName** parameter. If a single plug-in is +specified, a warning appears. ```yaml Type: SwitchParameter @@ -662,8 +850,8 @@ Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNod succeed if the underlying clustered space is in degraded condition. If `Suspend-ClusterNode` fails with ERROR_CLUSTER_SPACE_DEGRADED error, CAU will keep retrying for -**SuspendClusterNodeTimeoutMinutes** or suspend the call if the command succeeds. The retries for this -error don't count towards the **MaxRetriesPerNode** parameter set by the user. +**SuspendClusterNodeTimeoutMinutes** or suspend the call if the command succeeds. The retries for +this error don't count towards the **MaxRetriesPerNode** parameter set by the user. The timeout value is per cluster node. So CAU could potentially spend the amount of time specified for this value for every node in the cluster in the worst case. @@ -680,6 +868,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SuspendRetriesPerNode + +Specifies the number of times to retry suspending a node before moving on to the next node. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VirtualComputerObjectName Specifies the name of a pre-staged virtual computer object that is used by the CAU clustered role. @@ -701,6 +905,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WaitForStorageRepairTimeoutMinutes + +Specifies the amount of time in minutes to wait for storage to be repaired on a node before +continuing with an update. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WarnAfter Specifies the time in minutes after which a warning will be logged if the Updating Run (including @@ -721,8 +942,8 @@ Accept wildcard characters: False ### -WeeksOfMonth -Specifies the weeks of the month when the Updating Run should be run. -The value `5` represents the last week of the month. +Specifies the weeks of the month when the Updating Run should be run. The value `5` represents the +last week of the month. ```yaml Type: Int32[] @@ -738,8 +959,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet isn't run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -748,7 +968,7 @@ Aliases: wi Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -758,7 +978,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -766,19 +986,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### System.Object ## NOTES ## RELATED LINKS -[Disable-CauClusterRole](./Disable-CauClusterRole.md) - -[Enable-CauClusterRole](./Enable-CauClusterRole.md) +[Disable-CauClusterRole](disable-cauclusterrole.md) -[Get-CauClusterRole](./Get-CauClusterRole.md) +[Enable-CauClusterRole](enable-cauclusterrole.md) -[Remove-CauClusterRole](./Remove-CauClusterRole.md) +[Get-CauClusterRole](get-cauclusterrole.md) -[Set-CauClusterRole](./Set-CauClusterRole.md) +[Remove-CauClusterRole](remove-cauclusterrole.md) +[Set-CauClusterRole](set-cauclusterrole.md) diff --git a/docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md b/docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md new file mode 100644 index 0000000000..d912749f08 --- /dev/null +++ b/docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md @@ -0,0 +1,133 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: ClusterAwareUpdating.dll-Help.xml +Module Name: ClusterAwareUpdating +ms.date: 07/01/2024 +online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caudeviceinfoforfeatureupdates?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-CauDeviceInfoForFeatureUpdates +--- + +# Get-CauDeviceInfoForFeatureUpdates + +## SYNOPSIS +Retrieves device information for feature updates from a specified directory. + +## SYNTAX + +``` +Get-CauDeviceInfoForFeatureUpdates [[-ClusterName] ] [-Credential ] + -PathToDirectory [-PathToDeploymentCab ] [] +``` + +## DESCRIPTION + +The `Get-CauDeviceInfoForFeatureUpdates` cmdlet retrieves device information for feature updates +from a specified directory. + +## EXAMPLES + +### Example 1 + +```powershell +$parameters = @{ +ClusterName = "CONTOSO-FC1" +PathToDirectory = "C:\Updates" +PathToDeploymentCab = "C:\Deployment\FeatureUpdate.cab" +} +Get-CauDeviceInfoForFeatureUpdates $parameters +``` + +This command retrieves device information for feature updates from the `C:\Updates` directory for +the cluster named `CONTOSO-FC1`. It also specifies the path to the deployment cab file that will be +created for the update in `C:\Deployment\FeatureUpdate.cab`. + +## PARAMETERS + +### -ClusterName + +Specifies the name of the cluster on which to create the CAU clustered role. This parameter is only +required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to reference +a failover cluster different from where the cmdlet is run. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the administrative credentials for the target cluster. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PathToDeploymentCab + +Specifies the path to the deployment cab file that will be created for the update. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PathToDirectory + +Specifies the path to the directory that contains the device information files. This parameter is +required. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +### Microsoft.ClusterAwareUpdating.ActivityIdMap + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/clusterawareupdating/Get-ClusterlessCauRun.md b/docset/winserver2025-ps/clusterawareupdating/Get-ClusterlessCauRun.md new file mode 100644 index 0000000000..4f2abaeaf9 --- /dev/null +++ b/docset/winserver2025-ps/clusterawareupdating/Get-ClusterlessCauRun.md @@ -0,0 +1,103 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: ClusterAwareUpdating.dll-Help.xml +Module Name: ClusterAwareUpdating +ms.date: 07/01/2024 +online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-clusterlesscaurun?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-ClusterlessCauRun +--- + +# Get-ClusterlessCauRun + +## SYNOPSIS +Retrieves information about a Cluster-Aware Updating (CAU) run not associated with a cluster. + +## SYNTAX + +### DefaultParamSet (Default) + +``` +Get-ClusterlessCauRun [-Credential ] [] +``` + +### ShowClusterNodeState + +``` +Get-ClusterlessCauRun [-Credential ] [-ShowClusterNodeState] [] +``` + +## DESCRIPTION + +The `Get-ClusterlessCauRun` cmdlet retrieves information about a Cluster-Aware Updating (CAU) run +that is not associated with a cluster. + +## EXAMPLES + +### Example 1 + +```powershell +Get-ClusterlessCauRun +``` + +This example displays information about the current CAU run, including the status of each node that +is being updated. + +## PARAMETERS + +### -Credential + +Specifies the administrative credentials for the target cluster. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowClusterNodeState + +Displays detailed information about the state of each node in the CAU run. + +```yaml +Type: SwitchParameter +Parameter Sets: ShowClusterNodeState +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.ClusterAwareUpdating.CauWmiObject + +### Microsoft.ClusterAwareUpdating.ClusterlessCauRun + +### Microsoft.ClusterAwareUpdating.RunState + +## NOTES + +## RELATED LINKS + +[Invoke-ClusterlessCauRun](invoke-clusterlesscaurun.md) diff --git a/docset/winserver2025-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2025-ps/clusterawareupdating/Invoke-CauRun.md index 6a185b4894..835a3d20fc 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2025-ps/clusterawareupdating/Invoke-CauRun.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterAwareUpdating.dll-Help.xml Module Name: ClusterAwareUpdating -ms.date: 09/27/2022 +ms.date: 07/01/2024 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/invoke-caurun?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Invoke-CauRun @@ -11,7 +11,7 @@ title: Invoke-CauRun # Invoke-CauRun ## SYNOPSIS -Performs a scan of cluster nodes for applicable updates and installs those updates through an updating run on the specified cluster. +Performs a scan of cluster nodes for applicable updates and installs those updates through an Updating Run on the specified cluster. ## SYNTAX @@ -22,41 +22,62 @@ Invoke-CauRun [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder [-PreUpdateScript ] [-PostUpdateScript ] [-ConfigurationName ] [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-EnableFirewallRules] - [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-Force] [[-ClusterName] -] [[-CauPluginName] ] [[-Credential] ] - [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] [-WhatIf] - [-Confirm] [] + [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] + [-SuspendRetriesPerNode ] [-WaitForStorageRepairTimeoutMinutes ] [-Force] + [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] + [-ForceSelfUpdate] [-SiteAwareUpdatingOrder ] [[-ClusterName] ] + [-AttemptSoftReboot] [-CauPluginName ] [-Credential ] + [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] + [-OsRollingUpgrade] [-RebootMode ] [-WhatIf] [-Confirm] [] ``` ### RecoverParamSet ``` -Invoke-CauRun [-ForceRecovery] [-Force] [[-ClusterName] ] [[-Credential] ] - [-WhatIf] [-Confirm] [] +Invoke-CauRun [-ForceRecovery] [-ClearCorruptReports] [-Force] [-ForcePauseNoDrain] + [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] + [[-ClusterName] ] [-Credential ] [-WhatIf] [-Confirm] [] +``` + +### SuspendNodeParamSet + +``` +Invoke-CauRun -SuspendNode [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [[-ClusterName] ] + [-Credential ] [-WhatIf] [-Confirm] [] +``` + +### ResumeNodeParamSet + +``` +Invoke-CauRun -ResumeNode [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [[-ClusterName] ] + [-Credential ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION The `Invoke-CauRun` cmdlet performs a scan of cluster nodes for applicable updates and installs -those updates through an updating run on the specified cluster. The updating run process includes +those updates through an Updating Run on the specified cluster. The Updating Run process includes the following: + - Scanning for and downloading applicable updates on each cluster node. - Moving currently running clustered roles off each cluster node. - Installing the updates on each cluster node. - Restarting cluster nodes if required by the installed updates. - Moving the clustered roles back to the original nodes. -- The updating run process also includes ensuring that quorum is maintained, checking for additional +- The Updating Run process also includes ensuring that quorum is maintained, checking for additional updates that can only be installed after the initial set of updates are installed, and saving a report of the actions taken. -To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameter, Windows PowerShell -remoting must be enabled on each node. To do this, run the `Enable-PSRemoting` cmdlet. In -addition, ensure that the **Windows Remote Management - Compatibility Mode (HTTP-In)** firewall +To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameter, Windows +PowerShell remoting must be enabled on each node. To do this, run the `Enable-PSRemoting` cmdlet. +In addition, ensure that the **Windows Remote Management - Compatibility Mode (HTTP-In)** firewall exception is enabled on each node. ## EXAMPLES -### Example 1: Preform a scan and a full updating run on the specified cluster +### Example 1: Perform a scan and a full Updating Run on the specified cluster ```powershell $parameters = @{ @@ -70,17 +91,17 @@ $parameters = @{ Invoke-CauRun @parameters ``` -This command performs a scan and a full updating run on the cluster named CONTOSO-FC1. This cmdlet -uses the **Microsoft.WindowsUpdatePlugin** plug-in and requires that all cluster nodes be online -before the running this cmdlet. In addition, this cmdlet allows no more than three retries per node -before marking the node as failed, and allows no more than one node to fail before marking the -entire updating run as failed. Because the command specifies the **Force** parameter, the cmdlet runs -without displaying confirmation prompts. +This command performs a scan and a full Updating Run on the cluster named `CONTOSO-FC1`. This +cmdlet uses the **Microsoft.WindowsUpdatePlugin** plug-in and requires that all cluster nodes be +online before the running this cmdlet. In addition, this cmdlet allows no more than three retries +per node before marking the node as failed, and allows no more than one node to fail before marking +the entire Updating Run as failed. Because the command specifies the **Force** parameter, the +cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). -### Example 2: Preform a scan and a full updating run on the specified cluster using multiple plug-ins +### Example 2: Perform a scan and full Updating Run on the specified cluster using multiple plug-ins ```powershell $parameters = @{ @@ -97,11 +118,11 @@ $parameters = @{ Invoke-CauRun @parameters ``` -This command performs a scan and a full updating run on the cluster named CONTOSO-FC1. This cmdlet +This command performs a scan and a full Updating Run on the cluster named `CONTOSO-FC1`. This cmdlet uses the **Microsoft.WindowsUpdatePlugin** plug-in with the default configuration, and the **Microsoft.HotfixPlugin** plug-in using the hotfix root folder `\\CauHotfixSrv\shareName` and the default hotfix configuration file. If it isn't already enabled, the **Remote Shutdown** Windows -Firewall rule group is enabled on each cluster node before the updating run. If a failure occurs +Firewall rule group is enabled on each cluster node before the Updating Run. If a failure occurs during the installation of updates on a node by **Microsoft.WindowsUpdatePlugin**, updates aren't applied by **Microsoft.HotfixPlugin plug-in**. If the installation of updates by **Microsoft.WindowsUpdatePlugin** requires a node to restart, the node restarts before @@ -111,64 +132,83 @@ parameter, the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). -### Example 3: Recover from a previous updating run that failed on the specified cluster +### Example 3: Recover from a previous Updating Run that failed on the specified cluster ```powershell -Invoke-CauRun -ClusterName "CONTOSO-FC1"-ForceRecovery -Force +Invoke-CauRun -ClusterName "CONTOSO-FC1" -ForceRecovery -Force ``` -This command recovers from a previous updating run that failed and left the cluster in a Locked -state for the cluster named CONTOSO-FC1. Because the command specifies the **Force** parameter, the -recovery is performed without confirmation prompts. +This command recovers from a previous Updating Run that failed and left the cluster in a Locked +state for the cluster named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, +the recovery is performed without confirmation prompts. ## PARAMETERS +### -AttemptSoftReboot + +Indicates that command attempts a Kernel Soft Reboot (KSR) for the failover cluster. + +KSR bypasses BIOS/firmware initialization. You can only use KSR for updates that do not require a +BIOS/firmware initialization. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CauPluginArguments -Specifies a set of name=value pairs for each updating plug-in to use. +Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + For instance, to specify a Domain argument for one plug-in: - `@{Domain=Domain.local}` You can specify multiple pairs in a set separated with semicolons. For instance: - `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** that you specify. If you specify arguments for more than one plug-in, provide - the sets of name=value pairs in the order that you pass values in **CauPluginName**, separated by - commas. For instance: + **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, + provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, + separated by commas. For instance: - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following arguments are optional: -- **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. -If not specified, the default value is **'False'**. --- A standard Windows Update Agent query string that specifies criteria used by the Windows Update -Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and -for a value, enclose the full query in quotation marks. If not specified, then the -**Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` - -For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in -and the criteria such as IsInstalled that can be included in the query strings, see -[IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). +- **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates + will be applied in addition to important updates on each node. If not specified, the default value + is False. +- A standard Windows Update Agent query string that specifies criteria used by the Windows Update + Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and + for a value, enclose the full query in quotation marks. If not specified, then the + **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more + information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the + criteria such as IsInstalled that can be included in the query strings, see + [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: -- **HotfixRootFolderPath**: The UNC path to a hotfix root folder in an SMB share with a structure - that contains the updates to apply and that contains the hotfix configuration file. +- **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a + structure that contains the updates to apply and that contains the hotfix configuration file The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: -- **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption is enforced for - data accessed from the SMB share. If not specified, the default value is False. To ensure the +- **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced + for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled for either SMB signing or SMB Encryption. -- **DisableAclChecks=\**: Boolean value to indicate that the plug-in checks for sufficient - permissions on the hotfix root folder and the hotfix configuration file. If not specified, the - default value is False. +- **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for + sufficient permissions on the hotfix root folder and the hotfix configuration file. If not + specified, the default value is False. - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. -- **HotfixConfigFileName=\**: Name for the hotfix configuration file. -If not specified, the default name DefaultHotfixConfig.xml is used. - -For more information about required and optional arguments for the **Microsoft.HotfixPlugin** -plug-in, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +- **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the + default name DefaultHotfixConfig.xml is used. For more information about required and optional + arguments for the **Microsoft.HotfixPlugin** plug-in, see + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] @@ -189,7 +229,7 @@ separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see -[How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +[How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: String[] @@ -197,7 +237,24 @@ Parameter Sets: DefaultParamSet Aliases: Required: False -Position: 1 +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClearCorruptReports + +Specifies whether to clear any corrupt reports that were generated during a previous run of the +Cluster-Aware Updating (CAU) tool to recover from a failed or interrupted update run. + +```yaml +Type: SwitchParameter +Parameter Sets: RecoverParamSet +Aliases: + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -250,7 +307,7 @@ Aliases: cf Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -265,7 +322,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -275,13 +332,14 @@ Accept wildcard characters: False Enables the **Remote Shutdown** Windows Firewall rule group on each cluster node, if it isn't already enabled. If the **EnableFirewallRules** parameter is specified, CAU automatically re-enables -the **Remote Shutdown** rule group each time the CAU clustered role performs an updating run, in -case the rules are disabled manually in the intervening time. Enabling this rule group permits -inbound communication to each cluster node during each updating run that allows CAU to shut down and -restart the node remotely (if the installation of an update requires a restart). If Windows Firewall -is in use on the cluster nodes and the rule group isn't enabled, the updating run will fail. The -**Remote Shutdown** Windows Firewall rule group isn't enabled when it will conflict with Group -Policy settings that are configured for Windows Firewall. +the **Remote Shutdown** rule group each time the CAU clustered role performs an Updating Run, in +case the rules are disabled manually in the intervening time. + +Enabling this rule group permits inbound communication to each cluster node during each updating +run that allows CAU to shut down and restart the node remotely (if the installation of an update +requires a restart). If Windows Firewall is in use on the cluster nodes and the rule group isn't +enabled, the Updating Run will fail. The **Remote Shutdown** Windows Firewall rule group isn't +enabled when it will conflict with Group Policy settings that are configured for Windows Firewall. ```yaml Type: SwitchParameter @@ -305,7 +363,7 @@ another node. The acceptable values for this parameter are: - Immediate - Policy -The default value is Immediate. +The default value is **Immediate**. ```yaml Type: FailbackType @@ -336,6 +394,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForcePauseAndDrain + +Indicates that the command forces cluster nodes to pause and drain roles. + +A forced drain moves the roles off of the draining node even if the group cannot move. A group +might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseDrainAndReboot + +Indicates that the command forces cluster nodes to pause, drain roles, and restart. + +A forced drain moves the roles off of the draining node even if the group cannot move. A group +might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseNoDrain + +Indicates that the command forces cluster nodes to pause. The nodes are not drained. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ForceRecovery Indicates that the cmdlet recovers from a previous failed run that left the cluster in a Locked @@ -356,12 +468,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForceSelfUpdate + +Specifies whether to update the CAU plugin on the local computer before running the update. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaxFailedNodes -Specifies the maximum number of nodes on which updating can fail. -If one more than this number of nodes fails, then the updating run is stopped. -The range is from zero (0) through 1 less than the number of cluster nodes. -The default for most clusters is approximately one-third of the number of nodes. +Specifies the maximum number of nodes on which updating can fail. If one more than this number of +nodes fails, then the Updating Run is stopped. The range is from zero (0) through 1 less than the +number of cluster nodes. The default for most clusters is approximately one-third of the number of +nodes. ```yaml Type: Int32 @@ -378,7 +506,7 @@ Accept wildcard characters: False ### -MaxRetriesPerNode Specifies the maximum number of times that the update process (including any pre-update and -post-update scripts) is retried per node. The maximum is 64 and the default is 3. +post-update scripts) is retried per node. The maximum is **64** and the default is **3**. ```yaml Type: Int32 @@ -408,11 +536,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OsRollingUpgrade + +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without +stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PostUpdateScript Specifies the path and file name for a Windows PowerShell script to run on each node after updating finishes, and just after the node is brought out of Maintenance mode. The file name extension must -be .ps1 and the total length of the path plus the file name must be no longer than 260 characters. +be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that it is always accessible to all the cluster nodes. @@ -431,7 +576,7 @@ Accept wildcard characters: False ### -PreUpdateScript Specifies the path and file name for a Windows PowerShell script to run on each node before updating -begins, and before the node is put into Maintenance mode. The file name extension must be .ps1 and +begins, and before the node is put into Maintenance mode. The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that the script is always accessible to all the cluster nodes. If a @@ -449,10 +594,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RebootMode + +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- ClusProp +- FullReboot +- SoftReboot +- PluginCustomReboot +- OrchestratorDefault + +```yaml +Type: RebootType +Parameter Sets: DefaultParamSet +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RebootTimeoutMinutes Specifies the time in minutes that CAU allows for the restarting of a node. If the restart doesn't -complete within this time, then the updating run on that node is marked as failed. +complete within this time, then the Updating Run on that node is marked as failed. ```yaml Type: Int32 @@ -482,16 +651,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResumeNode + +Specifies the name of a node in the cluster to resume updating if it was previously suspended. + +```yaml +Type: String +Parameter Sets: ResumeNodeParamSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RunPluginsSerially Indicates that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed into the **CauPluginName** parameter when multiple plug-ins are -used during an updating run. By default, CAU scans and stages the applicable updates for all +used during an Updating Run. By default, CAU scans and stages the applicable updates for all plug-ins in parallel. Regardless of the configuration of this parameter, CAU installs the applicable updates for each plug-in sequentially. -The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -509,11 +694,11 @@ Accept wildcard characters: False Indicates that CAU will shut down and restart a cluster node after each plug-in installs updates on the node, if the installation of an update by a plug-in requires a restart when multiple plug-ins -are used during an updating run. By default, during an updating run, all plug-ins complete the +are used during an Updating Run. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time. -The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -527,11 +712,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteAwareUpdatingOrder + +Specifies the order in which the command updates cluster nodes. + +By default, CAU selects the order of nodes to update based on the level of activity. + +```yaml +Type: String[] +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipUpdateChecks + +Indicates that the command skips update checks. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StopAfter -Specifies the time in minutes after which the updating run is canceled if it hasn't completed. The +Specifies the time in minutes after which the Updating Run is canceled if it hasn't completed. The time span can be expressed in the standard ways available in Windows PowerShell, for instance, -01:30:00 represents one hour and thirty minutes. By default, the updating run is allowed an +01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. If pre-update or post-update scripts are specified, then the entire process of running scripts and @@ -553,11 +772,11 @@ Accept wildcard characters: False Indicates that if a failure occurs during the application of updates on a node by any plug-in, subsequent updates on the node that are coordinated by the remaining plug-ins are stopped when -multiple plug-ins are used during an updating run. By default, a failure by one plug-in doesn't +multiple plug-ins are used during an Updating Run. By default, a failure by one plug-in doesn't affect the application of updates on a node by other plug-ins. -The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -596,11 +815,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SuspendNode + +Specifies the name of a node in the cluster to suspend updating. + +```yaml +Type: String +Parameter Sets: SuspendNodeParamSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuspendRetriesPerNode + +Specifies the number of times to retry suspending a node before moving on to the next node. + +```yaml +Type: Int32 +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitForStorageRepairTimeoutMinutes + +Specifies the amount of time in minutes to wait for storage to be repaired on a node before +continuing with an update. + +```yaml +Type: Int32 +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WarnAfter -Specifies the time in minutes after which a warning is logged if the updating run, including any +Specifies the time in minutes after which a warning is logged if the Updating Run, including any pre-update and post-update scripts, hasn't completed. By default, no warning is logged, regardless -of the time taken by the updating run. +of the time taken by the Updating Run. ```yaml Type: TimeSpan @@ -616,8 +884,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet isn't run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -626,7 +893,7 @@ Aliases: wi Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -636,7 +903,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -654,17 +921,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.ClusterAwareUpdating.UpdateInfo -### Microsoft.ClusterAwareUpdating.UpdateInstallResult - ### Microsoft.ClusterAwareUpdating.UpdateStagingResult ## NOTES ## RELATED LINKS -[Add-CauClusterRole](./Add-CauClusterRole.md) +[Add-CauClusterRole](add-cauclusterrole.md) -[Get-CauRun](./Get-CauRun.md) +[Get-CauRun](get-caurun.md) -[Stop-CauRun](./Stop-CauRun.md) +[Invoke-CauScan](invoke-causcan.md) +[Stop-CauRun](stop-caurun.md) diff --git a/docset/winserver2025-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2025-ps/clusterawareupdating/Invoke-CauScan.md index 2e2af36bd6..59bd53ff87 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2025-ps/clusterawareupdating/Invoke-CauScan.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterAwareUpdating.dll-Help.xml Module Name: ClusterAwareUpdating -ms.date: 09/27/2022 +ms.date: 07/01/2024 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/invoke-causcan?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Invoke-CauScan @@ -11,15 +11,14 @@ title: Invoke-CauScan # Invoke-CauScan ## SYNOPSIS -Performs a scan of cluster nodes for applicable updates and gets a list of the initial set of -updates that are applied to each node in a specified cluster. +Performs a scan of cluster nodes for applicable updates and gets a list of the initial set of updates that are applied to each node in a specified cluster. ## SYNTAX ``` -Invoke-CauScan [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] -] [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] - [] +Invoke-CauScan [[-ClusterName] ] [-AttemptSoftReboot] [-CauPluginName ] + [-Credential ] [-CauPluginArguments ] [-RunPluginsSerially] + [-StopOnPluginFailure] [-OsRollingUpgrade] [-RebootMode ] [] ``` ## DESCRIPTION @@ -43,7 +42,7 @@ Invoke-CauScan -ClusterName "CONTOSO-FC1" -CauPluginName "Microsoft.WindowsUpdat ``` This command gets a detailed list of the initial set of updates that would currently be applied to -each node in the cluster named CONTOSO-FC1. The list is based on the updates that would be applied +each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied by the **Microsoft.WindowsUpdatePlugin** plug-in, which is the default plug-in. The preview list includes only an initial set of updates, and doesn't include updates that might become applicable only after the initial updates are installed. @@ -67,28 +66,48 @@ Invoke-CauScan $parameters -Credential $Cred ``` This example gets a detailed list of the initial set of updates that would currently be applied to -each node in the cluster named CONTOSO-FC1. The list is based on the updates that would be applied +each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied by the **Microsoft.WindowsUpdatePlugin** plug-in, using a specified query string, and the **Microsoft.HotfixPlugin**, after the necessary hotfixes and the hotfix configuration file have been downloaded to `\\CauHotfixSrv\shareName`. This example also shows how to pass the administrative -credentials for cluster CONTOSO-FC1 to the cmdlet. +credentials for cluster `CONTOSO-FC1` to the cmdlet. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). ## PARAMETERS +### -AttemptSoftReboot + +Indicates that command assumes a Kernel Soft Reboot (KSR) for the failover cluster. + +KSR bypasses BIOS/firmware initialization. You can only use KSR for updates that do not require a +BIOS/firmware initialization. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CauPluginArguments -Specifies a set of name=value pairs for each updating plug-in to use. -For instance, to specify a **Domain** argument for one plug-in: +Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + +For instance, to specify a Domain argument for one plug-in: - `@{Domain=Domain.local}` You can specify multiple pairs in a set separated with semicolons. For instance: - `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values into the **CauPluginName** - parameter, separated by commas. For instance: + provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, + separated by commas. For instance: - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. @@ -100,14 +119,12 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more + information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the + criteria such as IsInstalled that can be included in the query strings, see + [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). -For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in -and the criteria such as IsInstalled that can be included in the query strings, see -[IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). - -For the **Microsoft.HotfixPlugin** plug-in. -the following argument is required: +For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file @@ -122,10 +139,9 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfig.xml is used. - -For more information about required and optional arguments for the **Microsoft.HotfixPlugin** -plug-in, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). + default name DefaultHotfixConfig.xml is used. For more information about required and optional + arguments for the **Microsoft.HotfixPlugin** plug-in, see + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] @@ -147,7 +163,7 @@ coordinates the Windows Update Agent software resident on each cluster node, the is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with Cluster-Aware Updating (CAU), see -[Cluster-Aware Updating plug-ins](https://go.microsoft.com/fwlink/p/?LinkId=235333). +[How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: String[] @@ -155,7 +171,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -189,7 +205,48 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsRollingUpgrade + +Indicates that the CAU cluster role scans for upgrades to the operating system of the cluster nodes +without stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RebootMode + +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- ClusProp +- FullReboot +- SoftReboot +- PluginCustomReboot +- OrchestratorDefault + +```yaml +Type: RebootType +Parameter Sets: (All) +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -199,11 +256,11 @@ Accept wildcard characters: False Indicates that CAU scans each cluster node for applicable updates and stages the updates for each plug-in in the plug-in order passed into the **CauPluginName** parameter then multiple plug-ins are -used during a scan for updates +used during a scan for updates. -By default, CAU scans and stages the applicable updates for all plug-ins in parallel. -This parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +By default, CAU scans and stages the applicable updates for all plug-ins in parallel. This +parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter. If +a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -243,7 +300,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -251,11 +308,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.ClusterAwareUpdating.CauUpdateInfo +### Microsoft.ClusterAwareUpdating.ActivityIdMap + +### Microsoft.ClusterAwareUpdating.UpdateInfo + +### Microsoft.ClusterAwareUpdating.UpgradeSetupInfo ## NOTES ## RELATED LINKS -[Invoke-CauRun](./Invoke-CauRun.md) +[Add-CauClusterRole](add-cauclusterrole.md) + +[Get-CauRun](get-caurun.md) + +[Invoke-CauRun](invoke-caurun.md) +[Stop-CauRun](stop-caurun.md) diff --git a/docset/winserver2025-ps/clusterawareupdating/Invoke-ClusterlessCauRun.md b/docset/winserver2025-ps/clusterawareupdating/Invoke-ClusterlessCauRun.md new file mode 100644 index 0000000000..7b4cce9751 --- /dev/null +++ b/docset/winserver2025-ps/clusterawareupdating/Invoke-ClusterlessCauRun.md @@ -0,0 +1,454 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: ClusterAwareUpdating.dll-Help.xml +Module Name: ClusterAwareUpdating +ms.date: 07/01/2024 +online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/invoke-clusterlesscaurun?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Invoke-ClusterlessCauRun +--- + +# Invoke-ClusterlessCauRun + +## SYNOPSIS +Performs a Cluster-Aware Updating (CAU) run on a set of nodes that are not associated with a cluster. + +## SYNTAX + +### DefaultParamSet (Default) + +``` +Invoke-ClusterlessCauRun [-MaxRetries ] [-RebootTimeoutMinutes ] + [-EnableFirewallRules] [-PreUpdateScript ] [-PostUpdateScript ] + [-ConfigurationName ] [-Force] [-CauPluginName ] [-Credential ] + [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] + [-OsRollingUpgrade] [-RebootMode ] [-WhatIf] [-Confirm] [] +``` + +### RecoverParamSet + +``` +Invoke-ClusterlessCauRun [-ForceRecovery] [-Force] [-Credential ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The `Invoke-ClusterlessCauRun` cmdlet performs a CAU run on a set of nodes that are not associated +with a cluster. This cmdlet can be used to update standalone servers or groups of servers that are +not part of a cluster. + +## EXAMPLES + +### Example 1 + +```powershell +Invoke-ClusterlessCauRun -MaxRetries 3 +``` + +This example performs a CAU run on the specified nodes, with a maximum of 3 retries for each node +that fails to update. + +## PARAMETERS + +### -CauPluginArguments + +Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + +For instance, to specify a Domain argument for one plug-in: +- `@{Domain=Domain.local}` +You can specify multiple pairs in a set separated with semicolons. +For instance: +- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the + **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, + provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, + separated by commas. For instance: +- `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` + +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. +The following arguments are optional: +- **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates + will be applied in addition to important updates on each node. If not specified, the default value + is False. +- A standard Windows Update Agent query string that specifies criteria used by the Windows Update + Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and + for a value, enclose the full query in quotation marks. If not specified, then the + **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more + information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the + criteria such as IsInstalled that can be included in the query strings, see + [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). + +For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: +- **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a + structure that contains the updates to apply and that contains the hotfix configuration file + +The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: +- **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced + for accessing data from the SMB share. If not specified, the default value is False. To ensure the + integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled + for either SMB signing or SMB Encryption. +- **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for + sufficient permissions on the hotfix root folder and the hotfix configuration file. If not + specified, the default value is False. +- **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in + allows the hotfix installer process to return. If not specified, the default value is 30 minutes. +- **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the + default name DefaultHotfixConfig.xml is used. For more information about required and optional + arguments for the **Microsoft.HotfixPlugin** plug-in, see + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). + +```yaml +Type: Hashtable[] +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CauPluginName + +Specifies one or more plug-ins to use when performing scans. You can specify multiple values +separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This plug-in +coordinates the Windows Update Agent software resident on each cluster node, the same software that +is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows +Server Update Services (WSUS) server. For more information about how plug-ins work with +Cluster-Aware Updating (CAU), see +[How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). + +```yaml +Type: String[] +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationName + +Specifies the Windows PowerShell session configuration that defines the session in which scripts, +specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and +can limit the cmdlets that are available to be run. If either a pre-update or post-update script is +specified but a configuration name isn't specified, then the default session configuration that is +built into Windows PowerShell is used. + +```yaml +Type: String +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the administrative credentials for the target cluster. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFirewallRules + +Enables the **Remote Shutdown** Windows Firewall rule group on each cluster node, if it isn't +already enabled. If the **EnableFirewallRules** parameter is specified, CAU automatically re-enables +the **Remote Shutdown** rule group each time the CAU clustered role performs an Updating Run, in +case the rules are disabled manually in the intervening time. + +Enabling this rule group permits inbound communication to each cluster node during each updating +run that allows CAU to shut down and restart the node remotely (if the installation of an update +requires a restart). If Windows Firewall is in use on the cluster nodes and the rule group isn't +enabled, the Updating Run will fail. The **Remote Shutdown** Windows Firewall rule group isn't +enabled when it will conflict with Group Policy settings that are configured for Windows Firewall. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the command to run without asking for user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: f + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceRecovery + +Indicates that the cmdlet recovers from a previous failed run that left the cluster in a Locked +state. + +This switch defeats the synchronization mechanism used to prevent two update coordinators from +accidentally updating the same cluster at the same time. Use with care. + +```yaml +Type: SwitchParameter +Parameter Sets: RecoverParamSet +Aliases: Recover + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxRetries + +Specifies the maximum number of times that a node should be retried if an update fails. This can be +useful if you want to ensure that all nodes are updated. + +```yaml +Type: Int32 +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsRollingUpgrade + +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without +stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostUpdateScript + +Specifies the path and file name for a Windows PowerShell script to run on each node after updating +finishes, and just after the node is brought out of Maintenance mode. The file name extension must +be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. +As a best practice, the script should be located on a disk in cluster storage, or at a highly +available network share, to ensure that it is always accessible to all the cluster nodes. + +```yaml +Type: String +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreUpdateScript + +Specifies the path and file name for a Windows PowerShell script to run on each node before updating +begins, and before the node is put into Maintenance mode. The file name extension must be `.ps1` and +the total length of the path plus the file name must be no longer than 260 characters. As a best +practice, the script should be located on a disk in cluster storage, or at a highly available +network share, to ensure that the script is always accessible to all the cluster nodes. If a +pre-update script fails, the node isn't updated. + +```yaml +Type: String +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RebootMode + +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- ClusProp +- FullReboot +- SoftReboot +- PluginCustomReboot +- OrchestratorDefault + +```yaml +Type: RebootType +Parameter Sets: DefaultParamSet +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RebootTimeoutMinutes + +Specifies the time in minutes that CAU allows for the restarting of a node. If the restart doesn't +complete within this time, then the Updating Run on that node will be marked as failed. + +```yaml +Type: Int32 +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunPluginsSerially + +Indicates that CAU will scan each cluster node for applicable updates and stage the updates for each +plug-in in the plug-in order passed into the **CauPluginName** parameter when multiple plug-ins are +used during an Updating Run. By default, CAU scans and stages the applicable updates for all +plug-ins in parallel. Regardless of the configuration of this parameter, CAU installs the applicable +updates for each plug-in sequentially. + +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopOnPluginFailure + +Indicates that if a failure occurs during the application of updates on a node by any plug-in, +subsequent updates on the node that are coordinated by the remaining plug-ins are stopped when +multiple plug-ins are used during an Updating Run. By default, a failure by one plug-in doesn't +affect the application of updates on a node by other plug-ins. + +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultParamSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.ClusterAwareUpdating.ActivityIdMap + +### Microsoft.ClusterAwareUpdating.NodeResult + +### Microsoft.ClusterAwareUpdating.NodeStatusNotification + +### Microsoft.ClusterAwareUpdating.UpdateInfo + +### Microsoft.ClusterAwareUpdating.UpdateInstallResult + +### Microsoft.ClusterAwareUpdating.UpdateStagingResult + +## NOTES + +## RELATED LINKS + +[Get-ClusterlessCauRun](get-clusterlesscaurun.md) diff --git a/docset/winserver2025-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2025-ps/clusterawareupdating/Save-CauDebugTrace.md index 4cb73b6224..4120300ecc 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Save-CauDebugTrace.md +++ b/docset/winserver2025-ps/clusterawareupdating/Save-CauDebugTrace.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterAwareUpdating.dll-Help.xml Module Name: ClusterAwareUpdating -ms.date: 09/27/2022 +ms.date: 07/01/2024 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/save-caudebugtrace?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Save-CauDebugTrace @@ -17,7 +17,7 @@ Saves CAU debug tracing information to a local zip file. ``` Save-CauDebugTrace [[-ClusterName] ] [[-FilePath] ] [-Credential ] - [-RunId ] [-Force] [] + [-RunId ] [-Force] [-FeatureUpdateLogs {None | FailedSetup | All}] [] ``` ## DESCRIPTION @@ -38,8 +38,8 @@ Compatibility Mode (HTTP-In)** firewall exception is enabled on each node. Save-CauDebugTrace -ClusterName "CONTOSO-FC1" -FilePath "C:\temp\testrun.zip" ``` -This command saves the debug tracing information for the cluster named CONTOSO-FC1, to a trace file -called `testrun.zip` in the `C:\temp` folder. +This command saves the debug tracing information for the cluster named `CONTOSO-FC1`, to a trace +file called `testrun.zip` in the `C:\temp` folder. ## PARAMETERS @@ -77,6 +77,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FeatureUpdateLogs + +Specifies the level of detail to include in the debug trace for feature updates. The acceptable +values for this parameter are: + +- **None**: No feature update logs will be included in the debug trace. +- **FailedSetup**: Only logs related to failed feature updates will be included in the debug trace. +- **All**: All feature update logs will be included in the debug trace. + +```yaml +Type: FeatureUpdateLogs +Parameter Sets: (All) +Aliases: +Accepted values: None, FailedSetup, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FilePath Specifies the name of the file to which to save the tracing information, such as `MyTrace.zip`. @@ -131,7 +153,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -139,11 +161,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### Microsoft.ClusterAwareUpdating.ActivityIdMap + +### System.IO.FileInfo ## NOTES ## RELATED LINKS [Invoke-CauRun](./Invoke-CauRun.md) - diff --git a/docset/winserver2025-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2025-ps/clusterawareupdating/Set-CauClusterRole.md index 8e48358c3a..35334f34a9 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2025-ps/clusterawareupdating/Set-CauClusterRole.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterAwareUpdating.dll-Help.xml Module Name: ClusterAwareUpdating -ms.date: 09/27/2022 +ms.date: 07/01/2024 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/set-cauclusterrole?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-CauClusterRole @@ -25,8 +25,11 @@ Set-CauClusterRole [-UseDefault] [-StartDate ] [-DaysOfWeek [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] - [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] - [] + [-SuspendRetriesPerNode ] [-WaitForStorageRepairTimeoutMinutes ] [-ForcePauseNoDrain] + [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] + [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [-AttemptSoftReboot] + [-RebootMode ] [[-ClusterName] ] [[-Credential] ] [-Force] + [-WhatIf] [-Confirm] [] ``` ### UpdateNow @@ -53,19 +56,38 @@ Set-CauClusterRole [-UseDefault] [-StartDate ] [-DaysOfWeek [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] - [[-ClusterName] ] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] - [] + [-SuspendRetriesPerNode ] [-WaitForStorageRepairTimeoutMinutes ] [-ForcePauseNoDrain] + [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] + [-SiteAwareUpdatingOrder ] [-OsRollingUpgrade] [-AttemptSoftReboot] + [-RebootMode ] [[-ClusterName] ] [[-Credential] ] [-Force] + [-WhatIf] [-Confirm] [] +``` + +### Once + +``` +Set-CauClusterRole [-UseDefault] [-RunOnce] [-CauPluginName ] + [-CauPluginArguments ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] + [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] + [-ConfigurationName ] [-RequireAllNodesOnline] [-WarnAfter ] + [-StopAfter ] [-RebootTimeoutMinutes ] [-SeparateReboots] [-RunPluginsSerially] + [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode ] + [-SuspendClusterNodeTimeoutMinutes ] [-SuspendRetriesPerNode ] + [-WaitForStorageRepairTimeoutMinutes ] [-ForcePauseNoDrain] [-ForcePauseAndDrain] + [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder ] + [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [[-ClusterName] ] + [[-Credential] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION The `Set-CauClusterRole` cmdlet sets configuration properties for the Cluster-Aware Updating (CAU) clustered role on the specified cluster. This cmdlet can specify properties such as the updating -schedule and updating run parameters. +schedule and Updating Run parameters. -To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameters, Windows PowerShell -remoting must be enabled on each node. To do this, use the `Enable-PSRemoting` cmdlet. In -addition, ensure that the **Windows Remote Management - Compatibility Mode (HTTP-In)** firewall +To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameters, Windows +PowerShell remoting must be enabled on each node. To do this, use the `Enable-PSRemoting` cmdlet. +In addition, ensure that the **Windows Remote Management - Compatibility Mode (HTTP-In)** firewall exception is enabled on each node. ## EXAMPLES @@ -83,17 +105,18 @@ $parameters = @{ Set-CauClusterRole $parameters ``` -This command configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. The -CAU clustered role is configured to perform updating runs on Tuesdays on the first and second weeks +This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The +CAU clustered role is configured to perform Updating Runs on Tuesdays on the first and second weeks of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a -restart is necessary. If the restart doesn't complete within this time, then the updating run on -that node is marked as failed. Because the command specifies the **Force** parameter, the cmdlet runs -without displaying confirmation prompts. +restart is necessary. If the restart doesn't complete within this time, then the Updating Run on +that node is marked as failed. Because the command specifies the **Force** parameter, the cmdlet +runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). ### Example 2: Configure settings for a CAU cluster role on the specified cluster on the second week of the month + ```powershell $parameters = @{ ClusterName = 'CONTOSO-FC1' @@ -101,7 +124,7 @@ $parameters = @{ WeeksOfMonth = '1,2' IntervalWeeks = '2' RebootTimeoutMinutes = '10' - PostUpdateScript = 'c:\verifyupdatesinstalled.ps1' + PostUpdateScript = 'G:\verifyupdatesinstalled.ps1' Force = $true } Set-CauClusterRole $parameters @@ -119,27 +142,27 @@ DaysOfWeek Tuesday WeeksInterval 2 ``` -This command configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. The -CAU clustered role is configured to perform updating runs on Tuesdays on the second week of each +This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The +CAU clustered role is configured to perform Updating Runs on Tuesdays on the second week of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart is -necessary. If the restart doesn't complete within this time, then the updating run on that node is -marked as failed. The CAU clustered role runs a script after updating completes, just after the node -leaves Maintenance mode. The script is located at the root of drive G: in clustered storage and is -named verifyupdatesinstalled.ps1. Because the command specifies the **Force** parameter, the cmdlet -runs without displaying confirmation prompts. +necessary. If the restart doesn't complete within this time, then the Updating Run on that node is +marked as failed. The CAU clustered role runs a script after updating completes, just after the +node leaves Maintenance mode. The script is located at the root of drive **G:** in clustered storage +and is named `verifyupdatesinstalled.ps1`. Because the command specifies the **Force** parameter, +the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). -### Example 3: Initiate an updating run on the specified cluster +### Example 3: Initiate an Updating Run on the specified cluster ```powershell Set-CauClusterRole -ClusterName "CONTOSO-FC1" -UpdateNow -Force ``` -This command causes the CAU clustered role to initiate an updating run immediately on the cluster -named CONTOSO-FC1. Because the command specifies the **Force** parameter, the cmdlet runs without -displaying confirmation prompts +This command causes the CAU clustered role to initiate an Updating Run immediately on the cluster +named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, the cmdlet runs without +displaying confirmation prompts. ### Example 4: Configure settings for a CAU cluster role on the specified cluster @@ -156,9 +179,9 @@ $parameters = @{ Set-CauClusterRole @parameters ``` -This example configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. Time -spans are specified for logging a warning or canceling the updating run if it isn't completed. The -earliest date that an updating run can be triggered is 1/1/2012. Because the command specifies the +This example configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. Time +spans are specified for logging a warning or canceling the Updating Run if it isn't completed. The +earliest date that an Updating Run can be triggered is `1/1/2012`. Because the command specifies the **Force** parameter, the cmdlet runs without displaying confirmation prompts This example uses splatting to pass parameter values from the `$parameters` variable to the command. @@ -166,9 +189,29 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/ ## PARAMETERS +### -AttemptSoftReboot + +Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster. + +KSR bypasses BIOS/firmware initialization. You can only use KSR for updates that do not require a +BIOS/firmware initialization. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CauPluginArguments Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + For instance, to specify a Domain argument for one plug-in: - `@{Domain=Domain.local}` You can specify multiple pairs in a set separated with semicolons. @@ -191,7 +234,7 @@ The following arguments are optional: - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). + [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a @@ -210,11 +253,11 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the default name DefaultHotfixConfig.xml is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see - [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -227,15 +270,15 @@ Accept wildcard characters: False ### -CauPluginName Specifies one or more plug-ins to use when performing scans or updates. You can specify multiple -values separated with commas. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in -coordinates the Windows Update Agent software resident on each cluster node, the same software that -is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows -Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see -[How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +values separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This +plug-in coordinates the Windows Update Agent software resident on each cluster node, the same +software that is used when updates are downloaded from Windows Update or Microsoft Update, or from +a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with +CAU, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). ```yaml Type: String[] -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -267,14 +310,14 @@ Accept wildcard characters: False ### -ConfigurationName Specifies the Windows PowerShell session configuration that defines the session in which scripts, -specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and can -limit the cmdlets that are available to be run. If either a pre-update or post-update script is +specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and +can limit the cmdlets that are available to be run. If either a pre-update or post-update script is specified but a configuration name isn't specified, then the default session configuration that is built into Windows PowerShell is used. ```yaml Type: String -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -295,7 +338,7 @@ Aliases: cf Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -318,8 +361,8 @@ Accept wildcard characters: False ### -DaysOfWeek -Specifies the days of the week on which the task will be triggered. -Multiple values can be specified either separated with commas or as a hexadecimal sum. +Specifies the days of the week on which the task will be triggered. Multiple values can be +specified either separated with commas or as a hexadecimal sum. - **Sunday:** (0x01) - **Monday:** (0x02) @@ -329,11 +372,6 @@ Multiple values can be specified either separated with commas or as a hexadecima - **Friday:** (0x20) - **Saturday:** (0x40) -**Examples:** -- **-DaysOfWeek:** Monday, Wednesday, Friday -- **-DaysOfWeek:** 0x02, 0x08, 0x20 -- **-DaysOfWeek:** 0x2A - ```yaml Type: Weekdays Parameter Sets: MonthlyDayOfWeek, Weekly @@ -353,13 +391,13 @@ Indicates that this cmdlet enables the **Remote Shutdown** Windows Firewall rule cluster node, if it isn't already enabled, each time the CAU clustered role performs an Updating Run. Enabling this rule group permits inbound communication to each cluster node during each Updating Run that allows CAU to shut down and restart the node remotely. If Windows Firewall is in -use on the cluster nodes and the rule group isn't enabled, the updating run will fail. The **Remote +use on the cluster nodes and the rule group isn't enabled, the Updating Run will fail. The **Remote Shutdown** Windows Firewall rule group isn't enabled when it will conflict with Group Policy settings that are configured for Windows Firewall. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -378,11 +416,12 @@ another node. The acceptable values for this parameter are: - NoFailback - Immediate - Policy - The default value is Immediate. + +The default value is **Immediate**. ```yaml Type: FailbackType -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Accepted values: NoFailback, Immediate, Policy @@ -409,11 +448,64 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForcePauseAndDrain + +Indicates that the CAU cluster role forces cluster nodes to pause and drain roles. + +A forced drain moves the roles off of the draining node even if the group cannot move. A group +might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseDrainAndReboot + +Indicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart. + +A forced drain moves the roles off of the draining node even if the group cannot move. A group +might not be able to move because no other node can host the group or the group is locked. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForcePauseNoDrain + +Indicates that the CAU cluster role forces cluster nodes to pause. The nodes are not drained. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IntervalWeeks -Specifies the interval between weeks when the task will be triggered. -An interval of 1 produces a weekly schedule. -An interval of 2 produces an every-other week schedule. +Specifies the interval between weeks when the task will be triggered. An interval of 1 produces a +weekly schedule. An interval of 2 produces an every-other week schedule. ```yaml Type: Int32 @@ -429,14 +521,13 @@ Accept wildcard characters: False ### -MaxFailedNodes -Specifies the maximum number of nodes on which updating can fail. -If one more than this number of nodes fails, then the Updating Run is stopped. -The range is from 0 through 1 less than the number of cluster nodes. -The default for most clusters is approximately one-third of the number of nodes. +Specifies the maximum number of nodes on which updating can fail. If one more than this number of +nodes fails, then the Updating Run is stopped. The range is from 0 through 1 less than the number +of cluster nodes. The default for most clusters is approximately one-third of the number of nodes. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -449,11 +540,11 @@ Accept wildcard characters: False ### -MaxRetriesPerNode Specifies the maximum number of times that the update process, which includes any pre-update and -post-update scripts, is retried per node. The maximum is 64and the default is 3. +post-update scripts, is retried per node. The maximum is **64** and the default is **3**. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -469,7 +560,24 @@ Specifies an array of cluster node names in the order that they should be update ```yaml Type: String[] -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsRollingUpgrade + +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without +stopping the Hyper-V or the Scale-Out File Server workloads. + +```yaml +Type: SwitchParameter +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -482,14 +590,14 @@ Accept wildcard characters: False ### -PostUpdateScript Specifies the path and file name for a Windows PowerShell script to run after updating completes, -just after the node leaves Maintenance mode. The file name extension must be .ps1 and the total +just after the node leaves Maintenance mode. The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, to ensure that it is always accessible to all the cluster nodes. ```yaml Type: String -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -502,14 +610,14 @@ Accept wildcard characters: False ### -PreUpdateScript Specifies the path and file name for a Windows PowerShell script to run on each node before updating -begins, and before the node is put into Maintenance mode. The file name extension must be .ps1 and +begins, and before the node is put into Maintenance mode. The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, to ensure that it is always accessible to all the cluster nodes. ```yaml Type: String -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -519,14 +627,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RebootMode + +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- ClusProp +- FullReboot +- SoftReboot +- PluginCustomReboot +- OrchestratorDefault + +```yaml +Type: RebootType +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RebootTimeoutMinutes -Specifies the time in minutes that CAU will allow for the restarting of a node. If the restart doesn't -complete within this time, then the updating run on that node is marked as failed. +Specifies the time in minutes that CAU will allow for the restarting of a node. If the restart +doesn't complete within this time, then the Updating Run on that node is marked as failed. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -542,7 +674,24 @@ Indicates that all cluster nodes must be online and reachable before updating be ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOnce + +Specifies that the CAU run should only be performed once, rather than on a recurring schedule. This +can be useful if you only need to perform a one-time update of your cluster nodes. + +```yaml +Type: SwitchParameter +Parameter Sets: Once Aliases: Required: False @@ -555,19 +704,19 @@ Accept wildcard characters: False ### -RunPluginsSerially Indicates that CAU scans each cluster node for applicable updates and stage the updates for each -plug-in in the plug-in order passed into the*CauPluginName* parameter, when multiple plug-ins are -used during an updating run. +plug-in in the plug-in order passed into the **CauPluginName** parameter, when multiple plug-ins are +used during an Updating Run. By default, CAU scans and stages the applicable updates for all plug-ins in parallel. Regardless of the configuration of this parameter, CAU installs the applicable updates for each plug-in sequentially. -The parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter. If a -single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified in the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -582,14 +731,30 @@ Accept wildcard characters: False Indicates that CAU shuts down and restart a cluster node after each plug-in installs updates on the node, if the installation of an update by a plug-in requires a restart that CAU will shut down and restart a cluster node after each plug-in installs updates on the node, if the installation of an -update by a plug-in requires a restart +update by a plug-in requires a restart. The parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter. If a single plug-in is specified, a warning appears. +```yaml +Type: String[] +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipUpdateChecks + +Indicates that the CAU cluster role skips update checks. + ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -601,7 +766,7 @@ Accept wildcard characters: False ### -StartDate -Specifies the earliest date on which the updating run can be triggered. +Specifies the earliest date on which the Updating Run can be triggered. ```yaml Type: DateTime @@ -617,9 +782,9 @@ Accept wildcard characters: False ### -StopAfter -Specifies the time in minutes after which the updating run is canceled if it hasn't completed. The +Specifies the time in minutes after which the Updating Run is canceled if it hasn't completed. The time span can be expressed in the standard ways available in Windows PowerShell, for instance, -`01:30:00` represents one hour and thirty minutes. By default, the updating run is allowed an +`01:30:00` represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. If pre-update or post-update scripts are specified, then the entire process of running scripts and @@ -627,7 +792,7 @@ performing updates must be complete within this time limit. ```yaml Type: TimeSpan -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -641,14 +806,14 @@ Accept wildcard characters: False Indicates that if a failure occurs during the application of updates on a node by any plug-in, subsequent updates on the node that are coordinated by the remaining plug-ins are stopped when -multiple plug-ins are used during an updating run. +multiple plug-ins are used during an Updating Run. -The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -660,8 +825,8 @@ Accept wildcard characters: False ### -SuspendClusterNodeTimeoutMinutes -Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNode` cmdlet to succeed if -the underlying clustered space is in degraded condition. +Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNode` cmdlet to +succeed if the underlying clustered space is in degraded condition. If `Suspend-ClusterNode` fails with ERROR_CLUSTER_SPACE_DEGRADED error, CAU will keep retrying for **SuspendClusterNodeTimeoutMinutes** or suspend the call if the command succeeds. @@ -673,7 +838,23 @@ for this value for every node in the cluster in the worst case. ```yaml Type: Int32 -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuspendRetriesPerNode + +Specifies the number of times to retry suspending a node before moving on to the next node. + +```yaml +Type: Int32 +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -685,7 +866,7 @@ Accept wildcard characters: False ### -UpdateNow -Instructs the CAU clustered role to immediately initiate an updating run using the configured +Instructs the CAU clustered role to immediately initiate an Updating Run using the configured settings. ```yaml @@ -706,7 +887,24 @@ Indicates that default values are used for all parameters that don't have specif ```yaml Type: SwitchParameter -Parameter Sets: MonthlyDayOfWeek, UseDefault, Weekly +Parameter Sets: MonthlyDayOfWeek, UseDefault, Weekly, Once +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitForStorageRepairTimeoutMinutes + +Specifies the amount of time in minutes to wait for storage to be repaired on a node before +continuing with an update. + +```yaml +Type: Int32 +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -718,13 +916,13 @@ Accept wildcard characters: False ### -WarnAfter -Specifies the time in minutes after which a warning is logged if the updating run, including any +Specifies the time in minutes after which a warning is logged if the Updating Run, including any pre-update and post-update scripts, hasn't completed. By default, no warning is logged, regardless -of the time taken by the updating run. +of the time taken by the Updating Run. ```yaml Type: TimeSpan -Parameter Sets: MonthlyDayOfWeek, Weekly +Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: Required: False @@ -736,8 +934,8 @@ Accept wildcard characters: False ### -WeeksOfMonth -Specifies the weeks of the month when the Updating Run should be run. -The value 5 represents the last week of the month. +Specifies the weeks of the month when the Updating Run should be run. The value 5 represents the +last week of the month. ```yaml Type: Int32[] @@ -753,8 +951,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet isn't run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -763,7 +960,7 @@ Aliases: wi Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -773,7 +970,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -781,19 +978,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### None +### System.Object ## NOTES ## RELATED LINKS -[Add-CauClusterRole](./Add-CauClusterRole.md) - -[Disable-CauClusterRole](./Disable-CauClusterRole.md) +[Add-CauClusterRole](add-cauclusterrole.md) -[Enable-CauClusterRole](./Enable-CauClusterRole.md) +[Disable-CauClusterRole](disable-cauclusterrole.md) -[Get-CauClusterRole](./Get-CauClusterRole.md) +[Enable-CauClusterRole](enable-cauclusterrole.md) -[Remove-CauClusterRole](./Remove-CauClusterRole.md) +[Get-CauClusterRole](get-cauclusterrole.md) +[Remove-CauClusterRole](remove-cauclusterrole.md) From 26b3086e09cd40f7552f37c752f4a818363b1509 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 15 Jul 2024 11:24:55 -0400 Subject: [PATCH 09/15] 2nd pass --- .../Add-CauClusterRole.md | 29 ++-- .../ClusterAwareUpdating.md | 2 - .../Enable-CauClusterRole.md | 42 +++-- .../Get-CauDeviceInfoForFeatureUpdates.md | 13 +- .../clusterawareupdating/Get-CauReport.md | 17 +-- .../clusterawareupdating/Invoke-CauRun.md | 115 +++++++------- .../clusterawareupdating/Invoke-CauScan.md | 69 +++++---- .../Register-CauPlugin.md | 41 +++-- .../Save-CauDebugTrace.md | 9 +- .../Set-CauClusterRole.md | 144 +++++++++--------- 10 files changed, 258 insertions(+), 223 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index f7fea7b583..b074052396 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -229,7 +229,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the default name DefaultHotfixConfigFile.xml is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see - [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). + [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] @@ -631,13 +631,20 @@ Accept wildcard characters: False ### -RebootMode -{{ Fill RebootMode Description }} +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType Parameter Sets: (All) Aliases: -Accepted values: ClusProp, FullReboot, SoftReboot +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault Required: False Position: Named @@ -682,7 +689,8 @@ Accept wildcard characters: False ### -RunOnce -{{ Fill RunOnce Description }} +Specifies that the CAU run should only be performed once, rather than on a recurring schedule. This +can be useful if you only need to perform a one-time update of your cluster nodes. ```yaml Type: SwitchParameter @@ -934,7 +942,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -948,13 +956,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Disable-CauClusterRole](./Disable-CauClusterRole.md) - -[Enable-CauClusterRole](./Enable-CauClusterRole.md) +[Disable-CauClusterRole](disable-cauclusterrole.md) -[Get-CauClusterRole](./Get-CauClusterRole.md) +[Enable-CauClusterRole](enable-cauclusterrole.md) -[Remove-CauClusterRole](./Remove-CauClusterRole.md) +[Get-CauClusterRole](get-cauclusterrole.md) -[Set-CauClusterRole](./Set-CauClusterRole.md) +[Remove-CauClusterRole](remove-cauclusterrole.md) +[Set-CauClusterRole](set-cauclusterrole.md) diff --git a/docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md b/docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md index d0dc4a2f3a..21cd1c8819 100644 --- a/docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md +++ b/docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md @@ -72,5 +72,3 @@ Tests whether a cluster is properly set up to apply software updates using CAU. ### [Unregister-CauPlugin](./Unregister-CauPlugin.md) Removes a software updating plug-in from the list of plug-ins that are used by CAU. - - diff --git a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md index 7634c34aa0..bddf7addce 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md @@ -34,7 +34,7 @@ cluster. The self-updating functionality of the cluster can be disabled with the Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force ``` -This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating +This command enables the CAU clustered role on the `CONTOSO-FC1` cluster to begin performing Updating Runs. The cmdlet changes the status of the CAU clustered role to Running. The cmdlet runs without displaying confirmation prompts, as the **Force** parameter was used. @@ -58,28 +58,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Credential -Prompts you for confirmation before running the cmdlet. +Specifies the administrative credentials for the target cluster. ```yaml -Type: SwitchParameter +Type: PSCredential Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential +### -Force -Specifies the administrative credentials for the target cluster. +Forces the command to run without asking for user confirmation. ```yaml -Type: PSCredential +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -90,26 +90,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Confirm -Forces the command to run without asking for user confirmation. +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet isn't run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: SwitchParameter @@ -128,7 +127,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -142,13 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Add-CauClusterRole](./Add-CauClusterRole.md) - -[Disable-CauClusterRole](./Disable-CauClusterRole.md) +[Add-CauClusterRole](add-cauclusterrole.md) -[Get-CauClusterRole](./Get-CauClusterRole.md) +[Disable-CauClusterRole](disable-cauclusterrole.md) -[Remove-CauClusterRole](./Remove-CauClusterRole.md) +[Get-CauClusterRole](get-cauclusterrole.md) -[Set-CauClusterRole](./Set-CauClusterRole.md) +[Remove-CauClusterRole](remove-cauclusterrole.md) +[Set-CauClusterRole](set-cauclusterrole.md) diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md index 59bfe3bf4a..fffdccf441 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md @@ -22,7 +22,8 @@ Get-CauDeviceInfoForFeatureUpdates [[-ClusterName] ] [-Credential ] [-Last] [-Detailed] [-Credential ] [-Report ] [-Credential ] - [] +Get-CauReport [[-ClusterName] ] [-Report ] + [-Credential ] [] ``` ## DESCRIPTION @@ -62,8 +62,8 @@ Updating (CAU) report summary object. Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed ``` -This command gets a detailed list of the updating runs performed on the cluster named Contoso-FC1 on -01/01/2012 or later. +This command gets a detailed list of the updating runs performed on the cluster named `Contoso-FC1` +on 01/01/2012 or later. ### Example 2: Get a detailed list of updating runs from a date span from the specified cluster @@ -71,7 +71,7 @@ This command gets a detailed list of the updating runs performed on the cluster Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed ``` -This command gets a detailed list of the updating runs performed on the cluster called Contoso-FC1 +This command gets a detailed list of the updating runs performed on the cluster called `Contoso-FC1` starting with updating runs on 01/01/2012 and ending with updating runs on 04/01/2012. ### Example 3: Get the last updating run summary from the specified cluster @@ -81,7 +81,7 @@ $CauReportSummary = Get-CauReport "Contoso-FC1" -Last Get-CauReport "Contoso-FC1" -Report $CauReportSummary ``` -The first command gets the last updating run report summary from the cluster named Contoso-FC1 and +The first command gets the last updating run report summary from the cluster named `Contoso-FC1` and stores the result in the variable named `$CauReportSummary`. The second command gets the detailed report from the information stored in the `$CauReportSummary` @@ -208,7 +208,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -224,5 +224,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-CauReport](./Export-CauReport.md) - +[Export-CauReport](export-caureport.md) diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md index 2a07458316..20aa940ffd 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md @@ -20,13 +20,13 @@ Performs a scan of cluster nodes for applicable updates and installs those updat ``` Invoke-CauRun [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder ] [-PreUpdateScript ] [-PostUpdateScript ] [-ConfigurationName ] - [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] [-RebootTimeoutMinutes ] - [-SeparateReboots] [-EnableFirewallRules] [-FailbackMode ] - [-SuspendClusterNodeTimeoutMinutes ] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] - [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [-SiteAwareUpdatingOrder ] - [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] ] - [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade] - [-AttemptSoftReboot] [-RebootMode ] [-WhatIf] [-Confirm] [] + [-RequireAllNodesOnline] [-WarnAfter ] [-StopAfter ] + [-RebootTimeoutMinutes ] [-SeparateReboots] [-EnableFirewallRules] + [-FailbackMode ] [-SuspendClusterNodeTimeoutMinutes ] [-Force] + [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] + [-ForceSelfUpdate] [-SiteAwareUpdatingOrder ] [[-ClusterName] ] + [[-CauPluginName] ] [[-Credential] ] [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade] [-AttemptSoftReboot] + [-RebootMode ] [-WhatIf] [-Confirm] [] ``` ### RecoverParamSet @@ -42,18 +42,19 @@ Invoke-CauRun [-ForceRecovery] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrai The `Invoke-CauRun` cmdlet performs a scan of cluster nodes for applicable updates and installs those updates through an updating run on the specified cluster. The updating run process includes the following: -- Scanning for and downloading applicable updates on each cluster node. -- Moving currently running clustered roles off each cluster node. -- Installing the updates on each cluster node. -- Restarting cluster nodes if required by the installed updates. -- Moving the clustered roles back to the original nodes. + +- Scanning for and downloading applicable updates on each cluster node. +- Moving currently running clustered roles off each cluster node. +- Installing the updates on each cluster node. +- Restarting cluster nodes if required by the installed updates. +- Moving the clustered roles back to the original nodes. - The updating run process also includes ensuring that quorum is maintained, checking for additional updates that can only be installed after the initial set of updates are installed, and saving a report of the actions taken. -To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameter, Windows PowerShell -remoting must be enabled on each node. To do this, run the `Enable-PSRemoting` cmdlet. In -addition, ensure that the **Windows Remote Management - Compatibility Mode (HTTP-In)** firewall +To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameter, Windows +PowerShell remoting must be enabled on each node. To do this, run the `Enable-PSRemoting` cmdlet. +In addition, ensure that the **Windows Remote Management - Compatibility Mode (HTTP-In)** firewall exception is enabled on each node. ## EXAMPLES @@ -72,12 +73,12 @@ $parameters = @{ Invoke-CauRun @parameters ``` -This command performs a scan and a full updating run on the cluster named CONTOSO-FC1. This cmdlet -uses the **Microsoft.WindowsUpdatePlugin** plug-in and requires that all cluster nodes be online -before the running this cmdlet. In addition, this cmdlet allows no more than three retries per node -before marking the node as failed, and allows no more than one node to fail before marking the -entire updating run as failed. Because the command specifies the **Force** parameter, the cmdlet runs -without displaying confirmation prompts. +This command performs a scan and a full updating run on the cluster named `CONTOSO-FC1`. This +cmdlet uses the **Microsoft.WindowsUpdatePlugin** plug-in and requires that all cluster nodes be +online before the running this cmdlet. In addition, this cmdlet allows no more than three retries +per node before marking the node as failed, and allows no more than one node to fail before marking +the entire updating run as failed. Because the command specifies the **Force** parameter, the +cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -99,7 +100,7 @@ $parameters = @{ Invoke-CauRun @parameters ``` -This command performs a scan and a full updating run on the cluster named CONTOSO-FC1. This cmdlet +This command performs a scan and a full updating run on the cluster named `CONTOSO-FC1`. This cmdlet uses the **Microsoft.WindowsUpdatePlugin** plug-in with the default configuration, and the **Microsoft.HotfixPlugin** plug-in using the hotfix root folder `\\CauHotfixSrv\shareName` and the default hotfix configuration file. If it isn't already enabled, the **Remote Shutdown** Windows @@ -120,8 +121,8 @@ Invoke-CauRun -ClusterName "CONTOSO-FC1"-ForceRecovery -Force ``` This command recovers from a previous updating run that failed and left the cluster in a Locked -state for the cluster named CONTOSO-FC1. Because the command specifies the **Force** parameter, the -recovery is performed without confirmation prompts. +state for the cluster named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, +the recovery is performed without confirmation prompts. ## PARAMETERS @@ -147,10 +148,10 @@ Accept wildcard characters: False ### -CauPluginArguments Specifies a set of name=value pairs for each updating plug-in to use. -For instance, to specify a Domain argument for one plug-in: +For instance, to specify a Domain argument for one plug-in: - `@{Domain=Domain.local}` You can specify multiple pairs in a set separated with semicolons. -For instance: +For instance: - `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the **CauPluginName** that you specify. If you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, separated by @@ -158,7 +159,7 @@ For instance: - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +The following arguments are optional: - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is **'False'**. @@ -170,13 +171,13 @@ The following arguments are optional: For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see -[IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). -For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: +For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - **HotfixRootFolderPath**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file. -The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: +The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption is enforced for data accessed from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -187,10 +188,10 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. -If not specified, the default name DefaultHotfixConfig.xml is used. +If not specified, the default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** -plug-in, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +plug-in, see [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] @@ -211,7 +212,7 @@ separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see -[How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +[How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: String[] @@ -323,9 +324,9 @@ Specifies the method used to bring drained workloads back to the node, at the en node. Drained workloads are workloads that were previously run on the node, but were moved to another node. The acceptable values for this parameter are: -- NoFailback -- Immediate -- Policy +- `NoFailback` +- `Immediate` +- `Policy` The default value is Immediate. @@ -435,7 +436,7 @@ Accept wildcard characters: False ### -ForceSelfUpdate -{{ Fill ForceSelfUpdate Description }} +Specifies whether to update the CAU plugin on the local computer before running the update. ```yaml Type: SwitchParameter @@ -503,7 +504,8 @@ Accept wildcard characters: False ### -OsRollingUpgrade -Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without +stopping the Hyper-V or the Scale-Out File Server workloads. ```yaml Type: SwitchParameter @@ -540,7 +542,7 @@ Accept wildcard characters: False ### -PreUpdateScript Specifies the path and file name for a Windows PowerShell script to run on each node before updating -begins, and before the node is put into Maintenance mode. The file name extension must be .ps1 and +begins, and before the node is put into Maintenance mode. The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that the script is always accessible to all the cluster nodes. If a @@ -560,13 +562,20 @@ Accept wildcard characters: False ### -RebootMode -{{ Fill RebootMode Description }} +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType Parameter Sets: DefaultParamSet Aliases: -Accepted values: ClusProp, FullReboot, SoftReboot +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault Required: False Position: Named @@ -616,8 +625,8 @@ used during an updating run. By default, CAU scans and stages the applicable upd plug-ins in parallel. Regardless of the configuration of this parameter, CAU installs the applicable updates for each plug-in sequentially. -The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -638,8 +647,8 @@ the node, if the installation of an update by a plug-in requires a restart when are used during an updating run. By default, during an updating run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time. -The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -716,8 +725,8 @@ subsequent updates on the node that are coordinated by the remaining plug-ins ar multiple plug-ins are used during an updating run. By default, a failure by one plug-in doesn't affect the application of updates on a node by other plug-ins. -The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +The parameter is valid only when multiple plug-ins are specified for the **CauPluginName** +parameter. If a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -776,8 +785,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet isn't run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: SwitchParameter @@ -796,7 +804,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -822,9 +830,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Add-CauClusterRole](./Add-CauClusterRole.md) +[Add-CauClusterRole](add-cauclusterrole.md) -[Get-CauRun](./Get-CauRun.md) +[Get-CauRun](get-caurun.md) -[Stop-CauRun](./Stop-CauRun.md) +[Invoke-CauScan](invoke-causcan.md) +[Stop-CauRun](stop-caurun.md) diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md index 190c4148a3..5840b69a76 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md @@ -17,9 +17,10 @@ updates that are applied to each node in a specified cluster. ## SYNTAX ``` -Invoke-CauScan [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] ] - [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] - [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] [] +Invoke-CauScan [[-ClusterName] ] [[-CauPluginName] ] + [[-Credential] ] [-CauPluginArguments ] [-RunPluginsSerially] + [-StopOnPluginFailure] [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode ] + [] ``` ## DESCRIPTION @@ -43,7 +44,7 @@ Invoke-CauScan -ClusterName "CONTOSO-FC1" -CauPluginName "Microsoft.WindowsUpdat ``` This command gets a detailed list of the initial set of updates that would currently be applied to -each node in the cluster named CONTOSO-FC1. The list is based on the updates that would be applied +each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied by the **Microsoft.WindowsUpdatePlugin** plug-in, which is the default plug-in. The preview list includes only an initial set of updates, and doesn't include updates that might become applicable only after the initial updates are installed. @@ -67,11 +68,11 @@ Invoke-CauScan $parameters -Credential $Cred ``` This example gets a detailed list of the initial set of updates that would currently be applied to -each node in the cluster named CONTOSO-FC1. The list is based on the updates that would be applied +each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied by the **Microsoft.WindowsUpdatePlugin** plug-in, using a specified query string, and the **Microsoft.HotfixPlugin**, after the necessary hotfixes and the hotfix configuration file have been downloaded to `\\CauHotfixSrv\shareName`. This example also shows how to pass the administrative -credentials for cluster CONTOSO-FC1 to the cmdlet. +credentials for cluster `CONTOSO-FC1` to the cmdlet. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -100,19 +101,23 @@ Accept wildcard characters: False ### -CauPluginArguments Specifies a set of name=value pairs for each updating plug-in to use. -For instance, to specify a **Domain** argument for one plug-in: +For instance, to specify a **Domain** argument for one plug-in: + - `@{Domain=Domain.local}` You can specify multiple pairs in a set separated with semicolons. -For instance: +For instance: + - `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order that you pass values into the **CauPluginName** parameter, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +The following arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -124,14 +129,13 @@ The following arguments are optional: For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see -[IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). -For the **Microsoft.HotfixPlugin** plug-in. -the following argument is required: +For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a - structure that contains the updates to apply and that contains the hotfix configuration file + structure that contains the updates to apply and that contains the hotfix configuration file. -The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: +The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -142,10 +146,10 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfig.xml is used. + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** -plug-in, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +plug-in, see [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] @@ -169,7 +173,7 @@ Server Update Services (WSUS) server. For more information about how plug-ins work with Cluster-Aware Updating (CAU), see -[Cluster-Aware Updating plug-ins](https://go.microsoft.com/fwlink/p/?LinkId=235333). +[Cluster-Aware Updating plug-ins](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: String[] @@ -219,7 +223,8 @@ Accept wildcard characters: False ### -OsRollingUpgrade -Indicates that the CAU cluster role scans for upgrades to the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. +Indicates that the CAU cluster role scans for upgrades to the operating system of the cluster nodes +without stopping the Hyper-V or the Scale-Out File Server workloads. ```yaml Type: SwitchParameter @@ -235,13 +240,20 @@ Accept wildcard characters: False ### -RebootMode -{{ Fill RebootMode Description }} +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType -Parameter Sets: (All) +Parameter Sets: DefaultParamSet Aliases: -Accepted values: ClusProp, FullReboot, SoftReboot +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault Required: False Position: Named @@ -256,9 +268,9 @@ Indicates that CAU scans each cluster node for applicable updates and stages the plug-in in the plug-in order passed into the **CauPluginName** parameter then multiple plug-ins are used during a scan for updates -By default, CAU scans and stages the applicable updates for all plug-ins in parallel. -This parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter. -If a single plug-in is specified, a warning appears. +By default, CAU scans and stages the applicable updates for all plug-ins in parallel. This +parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter. If +a single plug-in is specified, a warning appears. ```yaml Type: SwitchParameter @@ -298,7 +310,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -316,5 +328,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Invoke-CauRun](./Invoke-CauRun.md) +[Add-CauClusterRole](add-cauclusterrole.md) + +[Get-CauRun](get-caurun.md) + +[Invoke-CauRun](invoke-caurun.md) +[Stop-CauRun](stop-caurun.md) diff --git a/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md b/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md index 92bd0623d4..c0bddf2c4b 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md +++ b/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md @@ -29,7 +29,7 @@ because CAU uses the **Microsoft.WindowsUpdatePlugin** plug-in by default. This with the Windows Update Agent software resident on each node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work in CAU, see -[How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +[How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ## EXAMPLES @@ -45,22 +45,6 @@ confirmation prompts. ## PARAMETERS -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Path Specifies the path to the binary that implements the plug-in. Classes that implement the plug-in @@ -79,6 +63,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. @@ -101,7 +101,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -115,7 +115,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CauPlugin](./Get-CauPlugin.md) - -[Unregister-CauPlugin](./Unregister-CauPlugin.md) +[Get-CauPlugin](get-cauplugin.md) +[Unregister-CauPlugin](unregister-cauplugin.md) diff --git a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md index c471a63977..652a5d2283 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md +++ b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md @@ -38,8 +38,8 @@ Compatibility Mode (HTTP-In)** firewall exception is enabled on each node. Save-CauDebugTrace -ClusterName "CONTOSO-FC1" -FilePath "C:\temp\testrun.zip" ``` -This command saves the debug tracing information for the cluster named CONTOSO-FC1, to a trace file -called `testrun.zip` in the `C:\temp` folder. +This command saves the debug tracing information for the cluster named `CONTOSO-FC1`, to a trace +file called `testrun.zip` in the `C:\temp` folder. ## PARAMETERS @@ -147,7 +147,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -163,5 +163,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Invoke-CauRun](./Invoke-CauRun.md) - +[Invoke-CauRun](invoke-caurun.md) diff --git a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md index 861d5dfb12..563bd01e43 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md @@ -82,9 +82,9 @@ The `Set-CauClusterRole` cmdlet sets configuration properties for the Cluster-Aw clustered role on the specified cluster. This cmdlet can specify properties such as the updating schedule and updating run parameters. -To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameters, Windows PowerShell -remoting must be enabled on each node. To do this, use the `Enable-PSRemoting` cmdlet. In -addition, ensure that the **Windows Remote Management - Compatibility Mode (HTTP-In)** firewall +To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameters, Windows +PowerShell remoting must be enabled on each node. To do this, use the `Enable-PSRemoting` cmdlet. +In addition, ensure that the **Windows Remote Management - Compatibility Mode (HTTP-In)** firewall exception is enabled on each node. ## EXAMPLES @@ -102,12 +102,12 @@ $parameters = @{ Set-CauClusterRole $parameters ``` -This command configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. The +This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The CAU clustered role is configured to perform updating runs on Tuesdays on the first and second weeks of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart is necessary. If the restart doesn't complete within this time, then the updating run on -that node is marked as failed. Because the command specifies the **Force** parameter, the cmdlet runs -without displaying confirmation prompts. +that node is marked as failed. Because the command specifies the **Force** parameter, the cmdlet +runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -139,14 +139,14 @@ DaysOfWeek Tuesday WeeksInterval 2 ``` -This command configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. The +This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The CAU clustered role is configured to perform updating runs on Tuesdays on the second week of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart is necessary. If the restart doesn't complete within this time, then the updating run on that node is -marked as failed. The CAU clustered role runs a script after updating completes, just after the node -leaves Maintenance mode. The script is located at the root of drive G: in clustered storage and is -named verifyupdatesinstalled.ps1. Because the command specifies the **Force** parameter, the cmdlet -runs without displaying confirmation prompts. +marked as failed. The CAU clustered role runs a script after updating completes, just after the +node leaves Maintenance mode. The script is located at the root of drive G: in clustered storage +and is named `verifyupdatesinstalled.ps1`. Because the command specifies the **Force** parameter, +the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -158,7 +158,7 @@ Set-CauClusterRole -ClusterName "CONTOSO-FC1" -UpdateNow -Force ``` This command causes the CAU clustered role to initiate an updating run immediately on the cluster -named CONTOSO-FC1. Because the command specifies the **Force** parameter, the cmdlet runs without +named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, the cmdlet runs without displaying confirmation prompts ### Example 4: Configure settings for a CAU cluster role on the specified cluster @@ -176,10 +176,10 @@ $parameters = @{ Set-CauClusterRole @parameters ``` -This example configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. Time +This example configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. Time spans are specified for logging a warning or canceling the updating run if it isn't completed. The earliest date that an updating run can be triggered is 1/1/2012. Because the command specifies the -**Force** parameter, the cmdlet runs without displaying confirmation prompts +**Force** parameter, the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -208,10 +208,10 @@ Accept wildcard characters: False ### -CauPluginArguments Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. -For instance, to specify a Domain argument for one plug-in: +For instance, to specify a Domain argument for one plug-in: - `@{Domain=Domain.local}` You can specify multiple pairs in a set separated with semicolons. -For instance: +For instance: - `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, @@ -219,7 +219,7 @@ For instance: - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +The following arguments are optional: - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -231,13 +231,13 @@ The following arguments are optional: For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see -[IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). -For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: +For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a - structure that contains the updates to apply and that contains the hotfix configuration file + structure that contains the updates to apply and that contains the hotfix configuration file. -The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: +The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -248,9 +248,9 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfig.xml is used. For more information about required and optional + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see - [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). + [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] @@ -267,11 +267,11 @@ Accept wildcard characters: False ### -CauPluginName Specifies one or more plug-ins to use when performing scans or updates. You can specify multiple -values separated with commas. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in +values separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This plug-in coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see -[How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +[How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: String[] @@ -307,8 +307,8 @@ Accept wildcard characters: False ### -ConfigurationName Specifies the Windows PowerShell session configuration that defines the session in which scripts, -specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and can -limit the cmdlets that are available to be run. If either a pre-update or post-update script is +specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and +can limit the cmdlets that are available to be run. If either a pre-update or post-update script is specified but a configuration name isn't specified, then the default session configuration that is built into Windows PowerShell is used. @@ -324,22 +324,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Credential Specifies the administrative credentials for the target cluster. @@ -359,15 +343,15 @@ Accept wildcard characters: False ### -DaysOfWeek Specifies the days of the week on which the task will be triggered. -Multiple values can be specified either separated with commas or as a hexadecimal sum. +Multiple values can be specified either separated with commas or as a hexadecimal sum. -- **Sunday:** (0x01) -- **Monday:** (0x02) -- **Tuesday:** (0x04) -- **Wednesday:** (0x08) -- **Thursday:** (0x10) -- **Friday:** (0x20) -- **Saturday:** (0x40) +- **Sunday:** (0x01) +- **Monday:** (0x02) +- **Tuesday:** (0x04) +- **Wednesday:** (0x08) +- **Thursday:** (0x10) +- **Friday:** (0x20) +- **Saturday:** (0x40) **Examples:** - **-DaysOfWeek:** Monday, Wednesday, Friday @@ -575,7 +559,8 @@ Accept wildcard characters: False ### -OsRollingUpgrade -Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads. +Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without +stopping the Hyper-V or the Scale-Out File Server workloads. ```yaml Type: SwitchParameter @@ -592,7 +577,7 @@ Accept wildcard characters: False ### -PostUpdateScript Specifies the path and file name for a Windows PowerShell script to run after updating completes, -just after the node leaves Maintenance mode. The file name extension must be .ps1 and the total +just after the node leaves Maintenance mode. The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, to ensure that it is always accessible to all the cluster nodes. @@ -612,7 +597,7 @@ Accept wildcard characters: False ### -PreUpdateScript Specifies the path and file name for a Windows PowerShell script to run on each node before updating -begins, and before the node is put into Maintenance mode. The file name extension must be .ps1 and +begins, and before the node is put into Maintenance mode. The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. As a best practice, the script should be located on a disk in cluster storage, to ensure that it is always accessible to all the cluster nodes. @@ -631,13 +616,20 @@ Accept wildcard characters: False ### -RebootMode -{{ Fill RebootMode Description }} +Specifies the type of reboot to use for each node in the cluster during the update. The available +values are: + +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType Parameter Sets: MonthlyDayOfWeek, Weekly, Once Aliases: -Accepted values: ClusProp, FullReboot, SoftReboot +Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault Required: False Position: Named @@ -648,8 +640,8 @@ Accept wildcard characters: False ### -RebootTimeoutMinutes -Specifies the time in minutes that CAU will allow for the restarting of a node. If the restart doesn't -complete within this time, then the updating run on that node is marked as failed. +Specifies the time in minutes that CAU will allow for the restarting of a node. If the restart +doesn't complete within this time, then the updating run on that node is marked as failed. ```yaml Type: Int32 @@ -681,7 +673,8 @@ Accept wildcard characters: False ### -RunOnce -{{ Fill RunOnce Description }} +Specifies that the CAU run should only be performed once, rather than on a recurring schedule. This +can be useful if you only need to perform a one-time update of your cluster nodes. ```yaml Type: SwitchParameter @@ -837,8 +830,8 @@ Accept wildcard characters: False ### -SuspendClusterNodeTimeoutMinutes -Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNode` cmdlet to succeed if -the underlying clustered space is in degraded condition. +Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNode` cmdlet to +succeed if the underlying clustered space is in degraded condition. If `Suspend-ClusterNode` fails with ERROR_CLUSTER_SPACE_DEGRADED error, CAU will keep retrying for **SuspendClusterNodeTimeoutMinutes** or suspend the call if the command succeeds. @@ -928,6 +921,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. @@ -950,7 +959,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -964,13 +973,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Add-CauClusterRole](./Add-CauClusterRole.md) - -[Disable-CauClusterRole](./Disable-CauClusterRole.md) +[Add-CauClusterRole](add-cauclusterrole.md) -[Enable-CauClusterRole](./Enable-CauClusterRole.md) +[Disable-CauClusterRole](disable-cauclusterrole.md) -[Get-CauClusterRole](./Get-CauClusterRole.md) +[Enable-CauClusterRole](enable-cauclusterrole.md) -[Remove-CauClusterRole](./Remove-CauClusterRole.md) +[Get-CauClusterRole](get-cauclusterrole.md) +[Remove-CauClusterRole](remove-cauclusterrole.md) From 7e9c82b789c553ac175d7740da3f4160f0ee41fb Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 15 Jul 2024 12:31:57 -0400 Subject: [PATCH 10/15] Update formatting --- .../Add-CauClusterRole.md | 77 ++++++++++--------- .../Enable-CauClusterRole.md | 6 +- .../clusterawareupdating/Get-CauReport.md | 6 +- .../clusterawareupdating/Invoke-CauRun.md | 4 +- .../clusterawareupdating/Invoke-CauScan.md | 10 +-- .../Register-CauPlugin.md | 2 +- .../Save-CauDebugTrace.md | 2 +- .../Set-CauClusterRole.md | 8 +- 8 files changed, 58 insertions(+), 57 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index b074052396..c5e486e10d 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -70,8 +70,8 @@ to a cluster, the failover cluster can update itself on the schedule that is spe without requiring an external computer to coordinate the cluster updating process. To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. To do this, run the -`Enable-PSRemoting` cmdlet. In addition, ensure that the Windows Remote Management - Compatibility -Mode (HTTP-In) firewall exception is enabled on each node. +`Enable-PSRemoting` cmdlet. In addition, ensure that the **Windows Remote Management - Compatibility +Mode (HTTP-In)** firewall exception is enabled on each node. ## EXAMPLES @@ -94,14 +94,14 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. -The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays on the -second and fourth weeks of each month. In an Updating Run, the maximum number of failed nodes is two -and the maximum number of retries per node is two. A script called verifyupdatesinstalled.ps1 runs -on each node after it has been fully updated. Before an Updating Run can begin, all the nodes of -that cluster must be running. If it isn't already enabled, the Remote Shutdown Windows Firewall -rule group will be enabled on each cluster node. Because the command uses the **Force** parameter, the -cmdlet runs without displaying confirmation prompts. +This command adds the CAU clustered role, using a default name, on the cluster called +**CONTOSO-FC1**. The CAU clustered role is configured to perform Updating Runs on Tuesdays and +Saturdays on the second and fourth weeks of each month. In an Updating Run, the maximum number of +failed nodes is two and the maximum number of retries per node is two. A script called +`verifyupdatesinstalled.ps1` runs on each node after it has been fully updated. Before an Updating +Run can begin, all the nodes of that cluster must be running. If it isn't already enabled, the +Remote Shutdown Windows Firewall rule group will be enabled on each cluster node. Because the +command uses the **Force** parameter, the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -122,7 +122,7 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. +This command adds the CAU clustered role, using a default name, on the cluster called **CONTOSO-FC1**. The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays at an interval of every three weeks. In an Updating Run, the maximum number of failed nodes is two and the maximum number of retries per node is two. Updating Runs can begin even when the nodes of the @@ -150,7 +150,7 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. +This command adds the CAU clustered role, using a default name, on the cluster called **CONTOSO-FC1**. The CAU clustered role is configured to perform updates using the **Microsoft.WindowsUpdatePlugin** plug-in with the optional **IncludeRecommendedUpdates** parameter set to True, and using the **Microsoft.HotfixPlugin plug-in** using the hotfix root folder `\\CauHotfixSrv\shareName` and the @@ -187,10 +187,10 @@ Accept wildcard characters: False ### -CauPluginArguments Specifies an array of name=value pairs (arguments) for each updating plug-in to use. -For instance, to specify a Domain argument for one plug-in: +For instance, to specify a Domain argument for one plug-in: - `@{Domain=Domain.local}` You can specify multiple pairs in a set separated with semicolons. -For instance: +For instance: - `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, @@ -198,7 +198,7 @@ For instance: - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +The following arguments are optional: - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -209,14 +209,14 @@ The following arguments are optional: - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304). + [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in. -the following argument is required: +the following argument is required: - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file -The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: +The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -246,10 +246,11 @@ Accept wildcard characters: False ### -CauPluginName Specifies one or more plug-ins to use when performing scans or updates. You can specify multiple -values separated with commas. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in -coordinates the Windows Update Agent software resident on each cluster node, the same software that -is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows -Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see +values separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This +plug-in coordinates the Windows Update Agent software resident on each cluster node, the same +software that is used when updates are downloaded from Windows Update or Microsoft Update, or from +a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with +CAU, see [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml @@ -302,22 +303,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Credential Specifies the administrative credentials for the target cluster. @@ -920,6 +905,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. diff --git a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md index bddf7addce..6300b41950 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Enable-CauClusterRole.md @@ -34,9 +34,9 @@ cluster. The self-updating functionality of the cluster can be disabled with the Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force ``` -This command enables the CAU clustered role on the `CONTOSO-FC1` cluster to begin performing Updating -Runs. The cmdlet changes the status of the CAU clustered role to Running. The cmdlet runs without -displaying confirmation prompts, as the **Force** parameter was used. +This command enables the CAU clustered role on the **CONTOSO-FC1** cluster to begin performing +Updating Runs. The cmdlet changes the status of the CAU clustered role to Running. The cmdlet runs +without displaying confirmation prompts, as the **Force** parameter was used. ## PARAMETERS diff --git a/docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md b/docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md index 7c92d1b951..e0b02d78a6 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md +++ b/docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md @@ -62,7 +62,7 @@ Updating (CAU) report summary object. Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed ``` -This command gets a detailed list of the updating runs performed on the cluster named `Contoso-FC1` +This command gets a detailed list of the updating runs performed on the cluster named **Contoso-FC1** on 01/01/2012 or later. ### Example 2: Get a detailed list of updating runs from a date span from the specified cluster @@ -71,7 +71,7 @@ on 01/01/2012 or later. Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed ``` -This command gets a detailed list of the updating runs performed on the cluster called `Contoso-FC1` +This command gets a detailed list of the updating runs performed on the cluster called **Contoso-FC1** starting with updating runs on 01/01/2012 and ending with updating runs on 04/01/2012. ### Example 3: Get the last updating run summary from the specified cluster @@ -81,7 +81,7 @@ $CauReportSummary = Get-CauReport "Contoso-FC1" -Last Get-CauReport "Contoso-FC1" -Report $CauReportSummary ``` -The first command gets the last updating run report summary from the cluster named `Contoso-FC1` and +The first command gets the last updating run report summary from the cluster named **Contoso-FC1** and stores the result in the variable named `$CauReportSummary`. The second command gets the detailed report from the information stored in the `$CauReportSummary` diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md index 20aa940ffd..d39211794a 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md @@ -100,7 +100,7 @@ $parameters = @{ Invoke-CauRun @parameters ``` -This command performs a scan and a full updating run on the cluster named `CONTOSO-FC1`. This cmdlet +This command performs a scan and a full updating run on the cluster named **CONTOSO-FC1**. This cmdlet uses the **Microsoft.WindowsUpdatePlugin** plug-in with the default configuration, and the **Microsoft.HotfixPlugin** plug-in using the hotfix root folder `\\CauHotfixSrv\shareName` and the default hotfix configuration file. If it isn't already enabled, the **Remote Shutdown** Windows @@ -121,7 +121,7 @@ Invoke-CauRun -ClusterName "CONTOSO-FC1"-ForceRecovery -Force ``` This command recovers from a previous updating run that failed and left the cluster in a Locked -state for the cluster named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, +state for the cluster named **CONTOSO-FC1**. Because the command specifies the **Force** parameter, the recovery is performed without confirmation prompts. ## PARAMETERS diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md index 5840b69a76..7bde753146 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md @@ -44,10 +44,10 @@ Invoke-CauScan -ClusterName "CONTOSO-FC1" -CauPluginName "Microsoft.WindowsUpdat ``` This command gets a detailed list of the initial set of updates that would currently be applied to -each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied -by the **Microsoft.WindowsUpdatePlugin** plug-in, which is the default plug-in. The preview list -includes only an initial set of updates, and doesn't include updates that might become applicable -only after the initial updates are installed. +each node in the cluster named **CONTOSO-FC1**. The list is based on the updates that would be +applied by the **Microsoft.WindowsUpdatePlugin** plug-in, which is the default plug-in. The preview +list includes only an initial set of updates, and doesn't include updates that might become +applicable only after the initial updates are installed. ### Example 2: Get a detailed list of the initial set of updates on the specified cluster using a query string @@ -68,7 +68,7 @@ Invoke-CauScan $parameters -Credential $Cred ``` This example gets a detailed list of the initial set of updates that would currently be applied to -each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied +each node in the cluster named **CONTOSO-FC1**. The list is based on the updates that would be applied by the **Microsoft.WindowsUpdatePlugin** plug-in, using a specified query string, and the **Microsoft.HotfixPlugin**, after the necessary hotfixes and the hotfix configuration file have been downloaded to `\\CauHotfixSrv\shareName`. This example also shows how to pass the administrative diff --git a/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md b/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md index c0bddf2c4b..a760e339b6 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md +++ b/docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md @@ -39,7 +39,7 @@ Services (WSUS) server. For more information about how plug-ins work in CAU, see Register-CauPlugin -Path "C:\PluginDevelopment\Plugin01.dll" -Force ``` -The command registers a plug-in called Plugin01.dll located in the C:\PluginDevelopment folder. +The command registers a plug-in called **Plugin01.dll** located in the `C:\PluginDevelopment` folder. Because the command specifies the **Force** parameter, the cmdlet runs without displaying confirmation prompts. diff --git a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md index 652a5d2283..8138d08c2a 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md +++ b/docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md @@ -38,7 +38,7 @@ Compatibility Mode (HTTP-In)** firewall exception is enabled on each node. Save-CauDebugTrace -ClusterName "CONTOSO-FC1" -FilePath "C:\temp\testrun.zip" ``` -This command saves the debug tracing information for the cluster named `CONTOSO-FC1`, to a trace +This command saves the debug tracing information for the cluster named **CONTOSO-FC1**, to a trace file called `testrun.zip` in the `C:\temp` folder. ## PARAMETERS diff --git a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md index 563bd01e43..bd4834d5e9 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md @@ -102,7 +102,7 @@ $parameters = @{ Set-CauClusterRole $parameters ``` -This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The +This command configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. The CAU clustered role is configured to perform updating runs on Tuesdays on the first and second weeks of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart is necessary. If the restart doesn't complete within this time, then the updating run on @@ -139,7 +139,7 @@ DaysOfWeek Tuesday WeeksInterval 2 ``` -This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The +This command configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. The CAU clustered role is configured to perform updating runs on Tuesdays on the second week of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart is necessary. If the restart doesn't complete within this time, then the updating run on that node is @@ -158,7 +158,7 @@ Set-CauClusterRole -ClusterName "CONTOSO-FC1" -UpdateNow -Force ``` This command causes the CAU clustered role to initiate an updating run immediately on the cluster -named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, the cmdlet runs without +named **CONTOSO-FC1**. Because the command specifies the **Force** parameter, the cmdlet runs without displaying confirmation prompts ### Example 4: Configure settings for a CAU cluster role on the specified cluster @@ -176,7 +176,7 @@ $parameters = @{ Set-CauClusterRole @parameters ``` -This example configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. Time +This example configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. Time spans are specified for logging a warning or canceling the updating run if it isn't completed. The earliest date that an updating run can be triggered is 1/1/2012. Because the command specifies the **Force** parameter, the cmdlet runs without displaying confirmation prompts. From 8f0c2370775b7d0cdaebc78cf9ce58ef06be3227 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 15 Jul 2024 14:03:25 -0400 Subject: [PATCH 11/15] Update formatting --- .../Add-CauClusterRole.md | 151 ++++++++++-------- .../Get-CauDeviceInfoForFeatureUpdates.md | 4 +- .../clusterawareupdating/Invoke-CauRun.md | 94 ++++++----- .../clusterawareupdating/Invoke-CauScan.md | 58 ++++--- .../Invoke-ClusterlessCauRun.md | 78 +++++---- .../Save-CauDebugTrace.md | 10 +- .../Set-CauClusterRole.md | 124 +++++++------- 7 files changed, 280 insertions(+), 239 deletions(-) diff --git a/docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md index 41b408ea08..e37893cc03 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2025-ps/clusterawareupdating/Add-CauClusterRole.md @@ -98,14 +98,14 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`. -The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays on the -second and fourth weeks of each month. In an Updating Run, the maximum number of failed nodes is -two and the maximum number of retries per node is two. A script called `verifyupdatesinstalled.ps1` -runs on each node after it has been fully updated. Before an Updating Run can begin, all the nodes -of that cluster must be running. If it isn't already enabled, the Remote Shutdown Windows Firewall -rule group will be enabled on each cluster node. Because the command uses the **Force** parameter, -the cmdlet runs without displaying confirmation prompts. +This command adds the CAU clustered role, using a default name, on the cluster called +**CONTOSO-FC1**. The CAU clustered role is configured to perform Updating Runs on Tuesdays and +Saturdays on the second and fourth weeks of each month. In an Updating Run, the maximum number of +failed nodes is two and the maximum number of retries per node is two. A script called +`verifyupdatesinstalled.ps1` runs on each node after it has been fully updated. Before an Updating +Run can begin, all the nodes of that cluster must be running. If it isn't already enabled, the +Remote Shutdown Windows Firewall rule group will be enabled on each cluster node. Because the +command uses the **Force** parameter, the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -126,14 +126,14 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`. -The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays at an -interval of every three weeks. In an Updating Run, the maximum number of failed nodes is two and the -maximum number of retries per node is two. Updating Runs can begin even when the nodes of the -cluster aren't all running (if the cluster itself has quorum and is running). If it isn't already -enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each cluster node. -Because the command uses the **Force** parameter, the cmdlet runs without displaying confirmation -prompts. +This command adds the CAU clustered role, using a default name, on the cluster called +**CONTOSO-FC1**. The CAU clustered role is configured to perform Updating Runs on Tuesdays and +Saturdays at an interval of every three weeks. In an Updating Run, the maximum number of failed +nodes is two and the maximum number of retries per node is two. Updating Runs can begin even when +the nodes of the cluster aren't all running (if the cluster itself has quorum and is running). If +it isn't already enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each +cluster node. Because the command uses the **Force** parameter, the cmdlet runs without displaying +confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -154,15 +154,15 @@ $parameters = @{ Add-CauClusterRole @parameters ``` -This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`. -The CAU clustered role is configured to perform updates using the **Microsoft.WindowsUpdatePlugin** -plug-in with the optional **IncludeRecommendedUpdates** parameter set to `True`, and using the -**Microsoft.HotfixPlugin plug-in** using the hotfix root folder `\\CauHotfixSrv\shareName` and the -default hotfix configuration file. If a failure occurs during the installation of updates on a node -by **Microsoft.WindowsUpdatePlugin**, updates are applied by **Microsoft.HotfixPlugin plug-in**. If -it isn't already enabled, the Remote Shutdown Windows Firewall rule group is enabled on each -cluster node. Because the command uses the **Force** parameter, the cmdlet runs without displaying -confirmation prompts. +This command adds the CAU clustered role, using a default name, on the cluster called +**CONTOSO-FC1**. The CAU clustered role is configured to perform updates using the +**Microsoft.WindowsUpdatePlugin** plug-in with the optional **IncludeRecommendedUpdates** parameter +set to `True`, and using the **Microsoft.HotfixPlugin plug-in** using the hotfix root folder +`\\CauHotfixSrv\shareName` and the default hotfix configuration file. If a failure occurs during +the installation of updates on a node by **Microsoft.WindowsUpdatePlugin**, updates are applied by +**Microsoft.HotfixPlugin plug-in**. If it isn't already enabled, the Remote Shutdown Windows +Firewall rule group is enabled on each cluster node. Because the command uses the **Force** +parameter, the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -193,17 +193,22 @@ Accept wildcard characters: False Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. For instance, to specify a Domain argument for one plug-in: + - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, - separated by commas. For instance: + +You can specify multiple pairs in a set separated with semicolons. For instance: + +- `@{name1=value1;name2=value2;name3=value3}` + +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -211,16 +216,19 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more - information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the - criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` + +For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in +and the criteria such as IsInstalled that can be included in the query strings, see +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: + - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a - structure that contains the updates to apply and that contains the hotfix configuration file + structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: + - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -231,7 +239,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfig.xml is used. For more information about required and optional + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). @@ -250,10 +258,11 @@ Accept wildcard characters: False ### -CauPluginName Specifies one or more plug-ins to use when performing scans or updates. You can specify multiple -values separated with commas. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in -coordinates the Windows Update Agent software resident on each cluster node, the same software that -is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows -Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see +values separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This +plug-in coordinates the Windows Update Agent software resident on each cluster node, the same +software that is used when updates are downloaded from Windows Update or Microsoft Update, or from +a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with +CAU, see [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml @@ -306,22 +315,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Credential Specifies the administrative credentials for the target cluster. @@ -400,9 +393,9 @@ another node. The acceptable values for this parameter are: -- NoFailback -- Immediate -- Policy +- `NoFailback` +- `Immediate` +- `Policy` The default value is **Immediate**. @@ -543,8 +536,8 @@ Accept wildcard characters: False ### -MaxRetriesPerNode Specifies the maximum number of times that the update process attempts to run. This includes any -pre-update and post-update scripts. The update process is retried per node. The maximum is **64** -and the default is **3**. +pre-update and post-update scripts. The update process is retried per node. The maximum is 64 +and the default is 3. ```yaml Type: Int32 @@ -637,11 +630,11 @@ Accept wildcard characters: False Specifies the type of reboot to use for each node in the cluster during the update. The available values are: -- ClusProp -- FullReboot -- SoftReboot -- PluginCustomReboot -- OrchestratorDefault +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType @@ -888,7 +881,7 @@ Accept wildcard characters: False Specifies the name of a pre-staged virtual computer object that is used by the CAU clustered role. For more information, see -[Steps to create computer objects in Active Directory](https://go.microsoft.com/fwlink/p/?LinkId=237624). +[Steps for prestaging the cluster name account](/windows-server/failover-clustering/configure-ad-accounts#steps-for-prestaging-the-cluster-name-account). If not specified, then a virtual computer object is created using a generated name. Generating a name automatically requires the cluster name object to have permissions to create the virtual computer object in Active Directory. @@ -942,7 +935,7 @@ Accept wildcard characters: False ### -WeeksOfMonth -Specifies the weeks of the month when the Updating Run should be run. The value `5` represents the +Specifies the weeks of the month when the Updating Run should be run. The value 5 represents the last week of the month. ```yaml @@ -957,6 +950,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md b/docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md index d912749f08..7705540fcf 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md +++ b/docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md @@ -39,8 +39,8 @@ Get-CauDeviceInfoForFeatureUpdates $parameters ``` This command retrieves device information for feature updates from the `C:\Updates` directory for -the cluster named `CONTOSO-FC1`. It also specifies the path to the deployment cab file that will be -created for the update in `C:\Deployment\FeatureUpdate.cab`. +the cluster named **CONTOSO-FC1**. It also specifies the path to the deployment cab file that will +be created for the update in `C:\Deployment\FeatureUpdate.cab`. ## PARAMETERS diff --git a/docset/winserver2025-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2025-ps/clusterawareupdating/Invoke-CauRun.md index 835a3d20fc..1b44570c08 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2025-ps/clusterawareupdating/Invoke-CauRun.md @@ -91,7 +91,7 @@ $parameters = @{ Invoke-CauRun @parameters ``` -This command performs a scan and a full Updating Run on the cluster named `CONTOSO-FC1`. This +This command performs a scan and a full Updating Run on the cluster named **CONTOSO-FC1**. This cmdlet uses the **Microsoft.WindowsUpdatePlugin** plug-in and requires that all cluster nodes be online before the running this cmdlet. In addition, this cmdlet allows no more than three retries per node before marking the node as failed, and allows no more than one node to fail before marking @@ -118,8 +118,8 @@ $parameters = @{ Invoke-CauRun @parameters ``` -This command performs a scan and a full Updating Run on the cluster named `CONTOSO-FC1`. This cmdlet -uses the **Microsoft.WindowsUpdatePlugin** plug-in with the default configuration, and the +This command performs a scan and a full Updating Run on the cluster named **CONTOSO-FC1**. This +cmdlet uses the **Microsoft.WindowsUpdatePlugin** plug-in with the default configuration, and the **Microsoft.HotfixPlugin** plug-in using the hotfix root folder `\\CauHotfixSrv\shareName` and the default hotfix configuration file. If it isn't already enabled, the **Remote Shutdown** Windows Firewall rule group is enabled on each cluster node before the Updating Run. If a failure occurs @@ -139,7 +139,7 @@ Invoke-CauRun -ClusterName "CONTOSO-FC1" -ForceRecovery -Force ``` This command recovers from a previous Updating Run that failed and left the cluster in a Locked -state for the cluster named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, +state for the cluster named **CONTOSO-FC1**. Because the command specifies the **Force** parameter, the recovery is performed without confirmation prompts. ## PARAMETERS @@ -168,17 +168,22 @@ Accept wildcard characters: False Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. For instance, to specify a Domain argument for one plug-in: + - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, - separated by commas. For instance: + +You can specify multiple pairs in a set separated with semicolons. For instance: + +- `@{name1=value1;name2=value2;name3=value3}` + +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -186,16 +191,19 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more - information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the - criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` + +For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in +and the criteria such as IsInstalled that can be included in the query strings, see +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: + - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a - structure that contains the updates to apply and that contains the hotfix configuration file + structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: + - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -206,7 +214,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfig.xml is used. For more information about required and optional + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). @@ -296,22 +304,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Credential Specifies the administrative credentials for the target cluster. @@ -359,11 +351,11 @@ Specifies the method used to bring drained workloads back to the node, at the en node. Drained workloads are workloads that were previously run on the node, but were moved to another node. The acceptable values for this parameter are: -- NoFailback -- Immediate -- Policy +- `NoFailback` +- `Immediate` +- `Policy` -The default value is **Immediate**. +The default value is `Immediate`. ```yaml Type: FailbackType @@ -599,11 +591,11 @@ Accept wildcard characters: False Specifies the type of reboot to use for each node in the cluster during the update. The available values are: -- ClusProp -- FullReboot -- SoftReboot -- PluginCustomReboot -- OrchestratorDefault +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType @@ -882,6 +874,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/docset/winserver2025-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2025-ps/clusterawareupdating/Invoke-CauScan.md index 59bd53ff87..36b3bd5c89 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2025-ps/clusterawareupdating/Invoke-CauScan.md @@ -42,10 +42,10 @@ Invoke-CauScan -ClusterName "CONTOSO-FC1" -CauPluginName "Microsoft.WindowsUpdat ``` This command gets a detailed list of the initial set of updates that would currently be applied to -each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied -by the **Microsoft.WindowsUpdatePlugin** plug-in, which is the default plug-in. The preview list -includes only an initial set of updates, and doesn't include updates that might become applicable -only after the initial updates are installed. +each node in the cluster named **CONTOSO-FC1**. The list is based on the updates that would be +applied by the **Microsoft.WindowsUpdatePlugin** plug-in, which is the default plug-in. The preview +list includes only an initial set of updates, and doesn't include updates that might become +applicable only after the initial updates are installed. ### Example 2: Get a detailed list of the initial set of updates on the specified cluster using a query string @@ -66,11 +66,11 @@ Invoke-CauScan $parameters -Credential $Cred ``` This example gets a detailed list of the initial set of updates that would currently be applied to -each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied +each node in the cluster named **CONTOSO-FC1**. The list is based on the updates that would be applied by the **Microsoft.WindowsUpdatePlugin** plug-in, using a specified query string, and the **Microsoft.HotfixPlugin**, after the necessary hotfixes and the hotfix configuration file have been downloaded to `\\CauHotfixSrv\shareName`. This example also shows how to pass the administrative -credentials for cluster `CONTOSO-FC1` to the cmdlet. +credentials for cluster **CONTOSO-FC1** to the cmdlet. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -101,17 +101,22 @@ Accept wildcard characters: False Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. For instance, to specify a Domain argument for one plug-in: + - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, - separated by commas. For instance: + +You can specify multiple pairs in a set separated with semicolons. For instance: + +- `@{name1=value1;name2=value2;name3=value3}` + +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -119,16 +124,19 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more - information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the - criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` + +For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in +and the criteria such as IsInstalled that can be included in the query strings, see +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: + - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a - structure that contains the updates to apply and that contains the hotfix configuration file + structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: + - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -139,7 +147,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfig.xml is used. For more information about required and optional + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). @@ -233,11 +241,11 @@ Accept wildcard characters: False Specifies the type of reboot to use for each node in the cluster during the update. The available values are: -- ClusProp -- FullReboot -- SoftReboot -- PluginCustomReboot -- OrchestratorDefault +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType diff --git a/docset/winserver2025-ps/clusterawareupdating/Invoke-ClusterlessCauRun.md b/docset/winserver2025-ps/clusterawareupdating/Invoke-ClusterlessCauRun.md index 7b4cce9751..709dc6a4d7 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Invoke-ClusterlessCauRun.md +++ b/docset/winserver2025-ps/clusterawareupdating/Invoke-ClusterlessCauRun.md @@ -56,17 +56,22 @@ that fails to update. Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. For instance, to specify a Domain argument for one plug-in: + - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, - separated by commas. For instance: + +You can specify multiple pairs in a set separated with semicolons. For instance: + +- `@{name1=value1;name2=value2;name3=value3}` + +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -74,16 +79,19 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more - information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the - criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` + +For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in +and the criteria such as IsInstalled that can be included in the query strings, see +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: + - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a - structure that contains the updates to apply and that contains the hotfix configuration file + structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: + - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -94,7 +102,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfig.xml is used. For more information about required and optional + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). @@ -152,22 +160,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Credential Specifies the administrative credentials for the target cluster. @@ -325,11 +317,11 @@ Accept wildcard characters: False Specifies the type of reboot to use for each node in the cluster during the update. The available values are: -- ClusProp -- FullReboot -- SoftReboot -- PluginCustomReboot -- OrchestratorDefault +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType @@ -406,6 +398,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/docset/winserver2025-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2025-ps/clusterawareupdating/Save-CauDebugTrace.md index 4120300ecc..a485e8cd57 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Save-CauDebugTrace.md +++ b/docset/winserver2025-ps/clusterawareupdating/Save-CauDebugTrace.md @@ -38,7 +38,7 @@ Compatibility Mode (HTTP-In)** firewall exception is enabled on each node. Save-CauDebugTrace -ClusterName "CONTOSO-FC1" -FilePath "C:\temp\testrun.zip" ``` -This command saves the debug tracing information for the cluster named `CONTOSO-FC1`, to a trace +This command saves the debug tracing information for the cluster named **CONTOSO-FC1**, to a trace file called `testrun.zip` in the `C:\temp` folder. ## PARAMETERS @@ -82,9 +82,9 @@ Accept wildcard characters: False Specifies the level of detail to include in the debug trace for feature updates. The acceptable values for this parameter are: -- **None**: No feature update logs will be included in the debug trace. -- **FailedSetup**: Only logs related to failed feature updates will be included in the debug trace. -- **All**: All feature update logs will be included in the debug trace. +- `None`: No feature update logs will be included in the debug trace. +- `FailedSetup`: Only logs related to failed feature updates will be included in the debug trace. +- `All`: All feature update logs will be included in the debug trace. ```yaml Type: FeatureUpdateLogs @@ -169,4 +169,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Invoke-CauRun](./Invoke-CauRun.md) +[Invoke-CauRun](invoke-caurun.md) diff --git a/docset/winserver2025-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2025-ps/clusterawareupdating/Set-CauClusterRole.md index 35334f34a9..1926b424ee 100644 --- a/docset/winserver2025-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2025-ps/clusterawareupdating/Set-CauClusterRole.md @@ -105,9 +105,9 @@ $parameters = @{ Set-CauClusterRole $parameters ``` -This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The -CAU clustered role is configured to perform Updating Runs on Tuesdays on the first and second weeks -of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a +This command configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. +The CAU clustered role is configured to perform Updating Runs on Tuesdays on the first and second +weeks of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart is necessary. If the restart doesn't complete within this time, then the Updating Run on that node is marked as failed. Because the command specifies the **Force** parameter, the cmdlet runs without displaying confirmation prompts. @@ -142,14 +142,14 @@ DaysOfWeek Tuesday WeeksInterval 2 ``` -This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The -CAU clustered role is configured to perform Updating Runs on Tuesdays on the second week of each -month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart is -necessary. If the restart doesn't complete within this time, then the Updating Run on that node is -marked as failed. The CAU clustered role runs a script after updating completes, just after the -node leaves Maintenance mode. The script is located at the root of drive **G:** in clustered storage -and is named `verifyupdatesinstalled.ps1`. Because the command specifies the **Force** parameter, -the cmdlet runs without displaying confirmation prompts. +This command configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. +The CAU clustered role is configured to perform Updating Runs on Tuesdays on the second week of +each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart +is necessary. If the restart doesn't complete within this time, then the Updating Run on that node +is marked as failed. The CAU clustered role runs a script after updating completes, just after the +node leaves Maintenance mode. The script is located at the root of drive **G:** in clustered +storage and is named `verifyupdatesinstalled.ps1`. Because the command specifies the **Force** +parameter, the cmdlet runs without displaying confirmation prompts. This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -161,8 +161,8 @@ Set-CauClusterRole -ClusterName "CONTOSO-FC1" -UpdateNow -Force ``` This command causes the CAU clustered role to initiate an Updating Run immediately on the cluster -named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, the cmdlet runs without -displaying confirmation prompts. +named **CONTOSO-FC1**. Because the command specifies the **Force** parameter, the cmdlet runs +without displaying confirmation prompts. ### Example 4: Configure settings for a CAU cluster role on the specified cluster @@ -179,10 +179,10 @@ $parameters = @{ Set-CauClusterRole @parameters ``` -This example configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. Time -spans are specified for logging a warning or canceling the Updating Run if it isn't completed. The -earliest date that an Updating Run can be triggered is `1/1/2012`. Because the command specifies the -**Force** parameter, the cmdlet runs without displaying confirmation prompts +This example configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. +Time spans are specified for logging a warning or canceling the Updating Run if it isn't completed. +The earliest date that an Updating Run can be triggered is `1/1/2012`. Because the command +specifies the **Force** parameter, the cmdlet runs without displaying confirmation prompts This example uses splatting to pass parameter values from the `$parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). @@ -213,17 +213,22 @@ Accept wildcard characters: False Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. For instance, to specify a Domain argument for one plug-in: + - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, - separated by commas. For instance: + +You can specify multiple pairs in a set separated with semicolons. For instance: + +- `@{name1=value1;name2=value2;name3=value3}` + +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -231,16 +236,19 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more - information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the - criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` + +For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in +and the criteria such as IsInstalled that can be included in the query strings, see +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: + - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a - structure that contains the updates to apply and that contains the hotfix configuration file + structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: + - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -251,7 +259,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfig.xml is used. For more information about required and optional + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). @@ -274,7 +282,7 @@ values separated with commas. The default is the **Microsoft.WindowsUpdatePlugin plug-in coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with -CAU, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333). +CAU, see [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: String[] @@ -327,22 +335,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Credential Specifies the administrative credentials for the target cluster. @@ -413,11 +405,11 @@ Specifies the method used to bring drained workloads back to the node, at the en node. Drained workloads are workloads that were previously running on the node, but were moved to another node. The acceptable values for this parameter are: -- NoFailback -- Immediate -- Policy +- `NoFailback` +- `Immediate` +- `Policy` -The default value is **Immediate**. +The default value is `Immediate`. ```yaml Type: FailbackType @@ -540,7 +532,7 @@ Accept wildcard characters: False ### -MaxRetriesPerNode Specifies the maximum number of times that the update process, which includes any pre-update and -post-update scripts, is retried per node. The maximum is **64** and the default is **3**. +post-update scripts, is retried per node. The maximum is 64 and the default is 3. ```yaml Type: Int32 @@ -632,11 +624,11 @@ Accept wildcard characters: False Specifies the type of reboot to use for each node in the cluster during the update. The available values are: -- ClusProp -- FullReboot -- SoftReboot -- PluginCustomReboot -- OrchestratorDefault +- `ClusProp` +- `FullReboot` +- `SoftReboot` +- `PluginCustomReboot` +- `OrchestratorDefault` ```yaml Type: RebootType @@ -949,6 +941,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. From 69533f45a94d4e052391b4cf5d7a62efc4bbaa05 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 15 Jul 2024 16:13:15 -0400 Subject: [PATCH 12/15] Update formatting --- .../Add-CauClusterRole.md | 50 +++++++++++-------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md index c5e486e10d..b3782210f1 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md @@ -186,19 +186,25 @@ Accept wildcard characters: False ### -CauPluginArguments -Specifies an array of name=value pairs (arguments) for each updating plug-in to use. +Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + For instance, to specify a Domain argument for one plug-in: + - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, - separated by commas. For instance: + +You can specify multiple pairs in a set separated with semicolons. For instance: + +- `@{name1=value1;name2=value2;name3=value3}` + +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -206,30 +212,32 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: -- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more - information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the - criteria such as IsInstalled that can be included in the query strings, see - [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` + +For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in +and the criteria such as IsInstalled that can be included in the query strings, see +[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). + +For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: -For the **Microsoft.HotfixPlugin** plug-in. -the following argument is required: - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a - structure that contains the updates to apply and that contains the hotfix configuration file + structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: + - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled for either SMB signing or SMB Encryption. -- **DisableAclChecks=\**: Boolean value to indicate that the plug-in checks for sufficient - permissions on the hotfix root folder and the hotfix configuration file. If not specified, the - default value is False. +- **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for + sufficient permissions on the hotfix root folder and the hotfix configuration file. If not + specified, the default value is False. - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name DefaultHotfixConfigFile.xml is used. For more information about required and optional + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see - [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] From 54091ae0a728d7d83badccac24339306d8ab5ef2 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 15 Jul 2024 16:14:53 -0400 Subject: [PATCH 13/15] Update formatting --- .../clusterawareupdating/Invoke-CauRun.md | 53 +++++++++++-------- 1 file changed, 30 insertions(+), 23 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md index d39211794a..814b4739b9 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md @@ -147,51 +147,58 @@ Accept wildcard characters: False ### -CauPluginArguments -Specifies a set of name=value pairs for each updating plug-in to use. +Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + For instance, to specify a Domain argument for one plug-in: + - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** that you specify. If you specify arguments for more than one plug-in, provide - the sets of name=value pairs in the order that you pass values in **CauPluginName**, separated by - commas. For instance: + +You can specify multiple pairs in a set separated with semicolons. For instance: + +- `@{name1=value1;name2=value2;name3=value3}` + +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value - is **'False'**. + is False. - A standard Windows Update Agent query string that specifies criteria used by the Windows Update Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: - - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: -- **HotfixRootFolderPath**: The UNC path to a hotfix root folder in an SMB share with a structure - that contains the updates to apply and that contains the hotfix configuration file. + +- **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a + structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: -- **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption is enforced for - data accessed from the SMB share. If not specified, the default value is False. To ensure the + +- **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced + for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled for either SMB signing or SMB Encryption. -- **DisableAclChecks=\**: Boolean value to indicate that the plug-in checks for sufficient - permissions on the hotfix root folder and the hotfix configuration file. If not specified, the - default value is False. +- **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for + sufficient permissions on the hotfix root folder and the hotfix configuration file. If not + specified, the default value is False. - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. -- **HotfixConfigFileName=\**: Name for the hotfix configuration file. -If not specified, the default name `DefaultHotfixConfig.xml` is used. - -For more information about required and optional arguments for the **Microsoft.HotfixPlugin** -plug-in, see [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). +- **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional + arguments for the **Microsoft.HotfixPlugin** plug-in, see + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] From 4c66e491d94bef8fc9107f4a6cd82bcf68f5370c Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 15 Jul 2024 16:15:49 -0400 Subject: [PATCH 14/15] Update formatting --- .../clusterawareupdating/Invoke-CauScan.md | 34 ++++++++++--------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md index 7bde753146..bf29331ebd 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md +++ b/docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md @@ -100,23 +100,24 @@ Accept wildcard characters: False ### -CauPluginArguments -Specifies a set of name=value pairs for each updating plug-in to use. -For instance, to specify a **Domain** argument for one plug-in: +Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + +For instance, to specify a Domain argument for one plug-in: - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values into the **CauPluginName** - parameter, separated by commas. For instance: +You can specify multiple pairs in a set separated with semicolons. For instance: -- `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` +- `@{name1=value1;name2=value2;name3=value3}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + +- `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value @@ -125,17 +126,19 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: - - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: + - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: + - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -146,10 +149,9 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. If not specified, the default value is 30 minutes. - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the - default name `DefaultHotfixConfig.xml` is used. - -For more information about required and optional arguments for the **Microsoft.HotfixPlugin** -plug-in, see [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). + default name `DefaultHotfixConfig.xml` is used. For more information about required and optional + arguments for the **Microsoft.HotfixPlugin** plug-in, see + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[] From b5592bebd18a55b43ac80653b849299bbcdaadbd Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 15 Jul 2024 16:16:40 -0400 Subject: [PATCH 15/15] Update formatting --- .../Set-CauClusterRole.md | 28 ++++++++++++------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md index bd4834d5e9..0e9a56042f 100644 --- a/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md +++ b/docset/winserver2022-ps/clusterawareupdating/Set-CauClusterRole.md @@ -208,18 +208,24 @@ Accept wildcard characters: False ### -CauPluginArguments Specifies a set of name=value pairs, as arguments, for each updating plug-in to use. + For instance, to specify a Domain argument for one plug-in: + - `@{Domain=Domain.local}` -You can specify multiple pairs in a set separated with semicolons. -For instance: -- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the - **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in, - provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, - separated by commas. For instance: + +You can specify multiple pairs in a set separated with semicolons. For instance: + +- `@{name1=value1;name2=value2;name3=value3}` + +These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If +you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order +that you pass values in **CauPluginName**, separated by commas. For instance: + - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: +For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following +arguments are optional: + - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. If not specified, the default value is False. @@ -227,17 +233,19 @@ The following arguments are optional: Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and for a value, enclose the full query in quotation marks. If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: - - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` +- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see [IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search). For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: + - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file. The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: + - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. If not specified, the default value is False. To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled @@ -250,7 +258,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - **HotfixConfigFileName=\**: Name for the hotfix configuration file. If not specified, the default name `DefaultHotfixConfig.xml` is used. For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see - [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). + [How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins). ```yaml Type: Hashtable[]