This is the built-in help made by Microsoft for the command 'Set-CauClusterRole', in PowerShell version 5 - as retrieved from
Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Sets configuration properties for the Cluster-Aware Updating (CAU) clustered role on the specified cluster.
Set-CauClusterRole [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-CauPluginArguments <Hashtable[]>] [-CauPluginName <String[]>] [-ConfigurationName <String>]
[-DaysOfWeek <Weekdays>] [-EnableFirewallRules] [-FailbackMode <FailbackType>] [-Force] [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>]
[-PostUpdateScript <String>] [-PreUpdateScript <String>] [-RebootTimeoutMinutes <Int32>] [-RequireAllNodesOnline] [-RunPluginsSerially] [-SeparateReboots] [-StartDate
<DateTime>] [-StopAfter <TimeSpan>] [-StopOnPluginFailure] [-UseDefault] [-WarnAfter <TimeSpan>] [-WeeksOfMonth <Int32[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-CauClusterRole [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-CauPluginArguments <Hashtable[]>] [-CauPluginName <String[]>] [-ConfigurationName <String>]
[-DaysOfWeek <Weekdays>] [-EnableFirewallRules] [-FailbackMode <FailbackType>] [-Force] [-IntervalWeeks <Int32>] [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>]
[-NodeOrder <String[]>] [-PostUpdateScript <String>] [-PreUpdateScript <String>] [-RebootTimeoutMinutes <Int32>] [-RequireAllNodesOnline] [-RunPluginsSerially]
[-SeparateReboots] [-StartDate <DateTime>] [-StopAfter <TimeSpan>] [-StopOnPluginFailure] [-UseDefault] [-WarnAfter <TimeSpan>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-CauClusterRole [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] [-UpdateNow] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-CauClusterRole [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] [-UseDefault] [-Confirm] [-WhatIf] [<CommonParameters>]
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.
Note: 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.
<
Online Version: http://go.microsoft.com/fwlink/p/?linkid=287673
Add-CauClusterRole
Disable-CauClusterRole
Enable-CauClusterRole
Get-CauClusterRole
Remove-CauClusterRole
<
EXAMPLE 1
PS C:\> Set-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday -WeeksOfMonth 1,2 -RebootTimeoutMinutes 10 -Force
This example 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 will allow 10 minutes for the restarting of each node, if a restart is necessary. If the restart does not
complete within this time, then the Updating Run on that node will be marked as failed. The cmdlet runs without displaying confirmation prompts.
EXAMPLE 2
PS C:\> Set-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday -WeeksInterval 2 -RebootTimeoutMinutes 10 -PostUpdateScript c:\verifyupdatesinstalled.ps1 -Force
Name Value
---- -----
ResourceGroupName CAUCAUCldy8
Status Online
StartDate 10/14/2011 3:00:00 AM
PostUpdateScript G:\verifyupdatesinstalled.ps1
RebootTimeoutMinutes 10
DaysOfWeek Tuesday
WeeksInterval 2
This example 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 will allow 10 minutes for the restarting of each node, if a restart is necessary. If the restart does not complete
within this time, then the Updating Run on that node will be 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 called verifyupdatesinstalled.ps1. The cmdlet runs without displaying
confirmation prompts.
EXAMPLE 3
PS C:\> Set-CauClusterRole -ClusterName CONTOSO-FC1 -UpdateNow -Force
This example causes the CAU clustered role to initiate an Updating Run immediately on the cluster named CONTOSO-FC1. The cmdlet runs without displaying confirmation prompts.
EXAMPLE 4
PS C:\> $warnafter = New-TimeSpan -hour 1 -minute 90 -seconds 10
PS C:\>$stopafter = New-TimeSpan -hour 2 -minute 90 -seconds 10
PS C:\>Set-CauClusterRole -ClusterName CONTOSO-FC1 -WarnAfter $warnafter -StopAfter $stopafter -StartDate 1/1/2012 -Force
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 is not completed. The earliest date that an updating run can be triggered is 1/1/2012. The cmdlet runs without displaying confirmation prompts.