HelpCache/ClusterAwareUpdating.dll-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Add-CauClusterRole</command:name><maml:description><maml:para>Adds the Cluster-Aware Updating (CAU) clustered role that provides the self-updating functionality to the specified cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Add</command:verb><command:noun>CauClusterRole</command:noun><dev:version /></command:details><maml:description><maml:para>The Add-CauClusterRole cmdlet adds the Cluster-Aware Updating (CAU) clustered role that provides the self-updating functionality to the specified cluster. When the CAU clustered role has been added 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.</maml:para><maml:para>Note: To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. To do this, run the <maml:navigationLink><maml:linkText>Enable-PSRemoting</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to create the CAU clustered role. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For the Microsoft.HotfixPlugin plug-in. the following argument is required: - HotfixRootFolderPath=<Path>: 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by PreUpdateScript and PostUpdateScript) 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® ("Microsoft.PowerShell") is used.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>DaysOfWeek</maml:name><maml:description><maml:para>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. - Sunday: (0x01) - Monday: (0x02) - Tuesday: (0x04) - Wednesday: (0x08) - Thursday: (0x10) - Friday: (0x20) - Saturday: (0x40) Examples: - –DaysOfWeek: Monday, Wednesday, Friday - –DaysOfWeek: 0x02, 0x08, 0x20 - –DaysOfWeek: 0x2A </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Weekdays</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EnableFirewallRules</maml:name><maml:description><maml:para>Enables the Remote Shutdown Windows Firewall rule group on each cluster node, if it is not 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 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.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>FailbackMode</maml:name><maml:description><maml:para>Specifies the method used to bring drained workloads back to the node, at the end of updating the 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, and Policy. The default value is Immediate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FailbackType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>GroupName</maml:name><maml:description><maml:para>The NetBIOS name of the resource group for the CAU clustered role.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxFailedNodes</maml:name><maml:description><maml:para>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. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxRetriesPerNode</maml:name><maml:description><maml:para>Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. The maximum is 64 and the default is 3.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>NodeOrder</maml:name><maml:description><maml:para>Specifies the names of the cluster nodes in the order that they should be updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PostUpdateScript</maml:name><maml:description><maml:para>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 the script is always accessible to all of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PreUpdateScript</maml:name><maml:description><maml:para>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 of the cluster nodes. If a pre-update script fails, the node is not updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RebootTimeoutMinutes</maml:name><maml:description><maml:para>Specifies the time in minutes that CAU will allow for the restarting of a 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RequireAllNodesOnline</maml:name><maml:description><maml:para>Specifies that all cluster nodes must be online and reachable before updating begins.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. 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. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SeparateReboots</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StartDate</maml:name><maml:description><maml:para>Specifies the earliest date on which the Updating Run can be triggered.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. The time span can be expressed in the standard ways available in Windows PowerShell, for example, 01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. Note: If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>VirtualComputerObjectName</maml:name><maml:description><maml:para>Specifies the name of a prestaged virtual computer object that is used by the CAU clustered role. For more information, see the <maml:navigationLink><maml:linkText>Steps to create computer objects in Active Directory</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WarnAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. By default, no warning will be logged, regardless of the time taken by the Updating Run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WeeksOfMonth</maml:name><maml:description><maml:para>Specifies the weeks of the month when the Updating Run should be run. The value 5 represents the last week of the month.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Int32[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Add-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to create the CAU clustered role. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For the Microsoft.HotfixPlugin plug-in. the following argument is required: - HotfixRootFolderPath=<Path>: 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by PreUpdateScript and PostUpdateScript) 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® ("Microsoft.PowerShell") is used.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>DaysOfWeek</maml:name><maml:description><maml:para>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. - Sunday: (0x01) - Monday: (0x02) - Tuesday: (0x04) - Wednesday: (0x08) - Thursday: (0x10) - Friday: (0x20) - Saturday: (0x40) Examples: - –DaysOfWeek: Monday, Wednesday, Friday - –DaysOfWeek: 0x02, 0x08, 0x20 - –DaysOfWeek: 0x2A </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Weekdays</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EnableFirewallRules</maml:name><maml:description><maml:para>Enables the Remote Shutdown Windows Firewall rule group on each cluster node, if it is not 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 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.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>FailbackMode</maml:name><maml:description><maml:para>Specifies the method used to bring drained workloads back to the node, at the end of updating the 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, and Policy. The default value is Immediate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FailbackType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>GroupName</maml:name><maml:description><maml:para>The NetBIOS name of the resource group for the CAU clustered role.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>IntervalWeeks</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxFailedNodes</maml:name><maml:description><maml:para>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. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxRetriesPerNode</maml:name><maml:description><maml:para>Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. The maximum is 64 and the default is 3.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>NodeOrder</maml:name><maml:description><maml:para>Specifies the names of the cluster nodes in the order that they should be updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PostUpdateScript</maml:name><maml:description><maml:para>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 the script is always accessible to all of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PreUpdateScript</maml:name><maml:description><maml:para>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 of the cluster nodes. If a pre-update script fails, the node is not updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RebootTimeoutMinutes</maml:name><maml:description><maml:para>Specifies the time in minutes that CAU will allow for the restarting of a 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RequireAllNodesOnline</maml:name><maml:description><maml:para>Specifies that all cluster nodes must be online and reachable before updating begins.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. 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. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SeparateReboots</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StartDate</maml:name><maml:description><maml:para>Specifies the earliest date on which the Updating Run can be triggered.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. The time span can be expressed in the standard ways available in Windows PowerShell, for example, 01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. Note: If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>VirtualComputerObjectName</maml:name><maml:description><maml:para>Specifies the name of a prestaged virtual computer object that is used by the CAU clustered role. For more information, see the <maml:navigationLink><maml:linkText>Steps to create computer objects in Active Directory</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WarnAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. By default, no warning will be logged, regardless of the time taken by the Updating Run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For the Microsoft.HotfixPlugin plug-in. the following argument is required: - HotfixRootFolderPath=<Path>: 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue><dev:type><maml:name>Hashtable[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to create the CAU clustered role. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by PreUpdateScript and PostUpdateScript) 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® ("Microsoft.PowerShell") is used.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>DaysOfWeek</maml:name><maml:description><maml:para>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. - Sunday: (0x01) - Monday: (0x02) - Tuesday: (0x04) - Wednesday: (0x08) - Thursday: (0x10) - Friday: (0x20) - Saturday: (0x40) Examples: - –DaysOfWeek: Monday, Wednesday, Friday - –DaysOfWeek: 0x02, 0x08, 0x20 - –DaysOfWeek: 0x2A </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Weekdays</command:parameterValue><dev:type><maml:name>Weekdays</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EnableFirewallRules</maml:name><maml:description><maml:para>Enables the Remote Shutdown Windows Firewall rule group on each cluster node, if it is not 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 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.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>FailbackMode</maml:name><maml:description><maml:para>Specifies the method used to bring drained workloads back to the node, at the end of updating the 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, and Policy. The default value is Immediate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FailbackType</command:parameterValue><dev:type><maml:name>FailbackType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>GroupName</maml:name><maml:description><maml:para>The NetBIOS name of the resource group for the CAU clustered role.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>IntervalWeeks</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxFailedNodes</maml:name><maml:description><maml:para>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. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxRetriesPerNode</maml:name><maml:description><maml:para>Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. The maximum is 64 and the default is 3.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>NodeOrder</maml:name><maml:description><maml:para>Specifies the names of the cluster nodes in the order that they should be updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PostUpdateScript</maml:name><maml:description><maml:para>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 the script is always accessible to all of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PreUpdateScript</maml:name><maml:description><maml:para>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 of the cluster nodes. If a pre-update script fails, the node is not updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RebootTimeoutMinutes</maml:name><maml:description><maml:para>Specifies the time in minutes that CAU will allow for the restarting of a 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue>15</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RequireAllNodesOnline</maml:name><maml:description><maml:para>Specifies that all cluster nodes must be online and reachable before updating begins.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. 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. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SeparateReboots</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StartDate</maml:name><maml:description><maml:para>Specifies the earliest date on which the Updating Run can be triggered.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. The time span can be expressed in the standard ways available in Windows PowerShell, for example, 01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. Note: If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue><dev:type><maml:name>TimeSpan</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>VirtualComputerObjectName</maml:name><maml:description><maml:para>Specifies the name of a prestaged virtual computer object that is used by the CAU clustered role. For more information, see the <maml:navigationLink><maml:linkText>Steps to create computer objects in Active Directory</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WarnAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. By default, no warning will be logged, regardless of the time taken by the Updating Run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue><dev:type><maml:name>TimeSpan</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WeeksOfMonth</maml:name><maml:description><maml:para>Specifies the weeks of the month when the Updating Run should be run. The value 5 represents the last week of the month.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Int32[]</command:parameterValue><dev:type><maml:name>Int32[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Add-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday,Saturday -WeeksOfMonth 2,4 -MaxFailedNodes 2 -MaxRetriesPerNode 2 -PostUpdateScript \\CONTOSOFileShare\scripts\verifyupdatesinstalled.ps1 -RequireAllNodesOnline –EnableFirewallRules -Force </dev:code><dev:remarks><maml:para>This example 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 is not already enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each cluster node. The cmdlet runs without displaying confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Add-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday,Saturday -WeeksInterval 3 -MaxFailedNodes 2 -MaxRetriesPerNode 2 –EnableFirewallRules -Force </dev:code><dev:remarks><maml:para>This example 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 are not all running (as long as the cluster itself has quorum and is running). If it is not already enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each cluster node. The cmdlet runs without displaying confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 3</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Add-CauClusterRole -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ 'IncludeRecommendedUpdates' = 'True' }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName' } -StopOnPluginFailure -EnableFirewallRules -Force </dev:code><dev:remarks><maml:para>This example 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 will not be applied by Microsoft.HotfixPlugin plug-in. If it is not already enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each cluster node. The cmdlet runs without displaying confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287660</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Disable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Enable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Disable-CauClusterRole</command:name><maml:description><maml:para>Suspends the self-updating functionality on the specified cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Disable</command:verb><command:noun>CauClusterRole</command:noun><dev:version /></command:details><maml:description><maml:para>The Disable-CauClusterRole suspends the self-updating functionality on the specified cluster. The self-updating functionality of the cluster can be re-enabled with the Enable-CauClusterRole cmdlet.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Disable-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to disable the self-updating functionality. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to disable the self-updating functionality. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force </dev:code><dev:remarks><maml:para>This example prevents the CAU clustered role on the CONTOSO-FC1 cluster from performing Updating Runs. The cmdlet changes the status of the CAU clustered role to Offline. The cmdlet runs without displaying confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287661</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Enable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Enable-CauClusterRole</command:name><maml:description><maml:para>Re-enables the self-updating functionality on the specified cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Enable</command:verb><command:noun>CauClusterRole</command:noun><dev:version /></command:details><maml:description><maml:para>The Enable-CauClusterRole re-enables the self-updating functionality on the specified cluster. The self-updating functionality of the cluster can be disabled with the Disable-CauClusterRole cmdlet.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Enable-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to enable the self-updating functionality. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to enable the self-updating functionality. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Enable-CauClusterRole -ClusterName CONTOSO-FC1 -Force </dev:code><dev:remarks><maml:para>This example 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.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287662</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Disable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Export-CauReport</command:name><maml:description><maml:para>Exports one or more Updating Run reports into an HTML or CSV-formatted document.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Export</command:verb><command:noun>CauReport</command:noun><dev:version /></command:details><maml:description><maml:para>The Export-CauReport cmdlet exports one or more Updating Run reports into an HTML or CSV-formatted document. Each Run report summarizes both the node-level and cluster-level summary status for the Updating Run.</maml:para><maml:para>Pipe one or more reports from the Get-CauReport cmdlet with the Detailed parameter, and control the content in the report by specifying appropriate parameters for the Get-CauReport cmdlet. For example, the Last parameter specifies the most recent Updating Run.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Export-CauReport</maml:name><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>InputReport</maml:name><maml:description><maml:para>Specifies one or more CAU report objects, such as generated from a call to Get-CauReport with the Detailed parameter.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CauReport[]</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Format</maml:name><maml:description><maml:para>Specifies the format of the output report. The acceptable values for this parameter are: CSV or HTML.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">OutputType</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the local or complete path of the file to save the exported report.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Passes the CAU report object back through the pipeline for further processing.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TimeZone</maml:name><maml:description><maml:para>Allows formatting of the report timestamps to match the specified time zone.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeZoneInfo</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Format</maml:name><maml:description><maml:para>Specifies the format of the output report. The acceptable values for this parameter are: CSV or HTML.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">OutputType</command:parameterValue><dev:type><maml:name>OutputType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>InputReport</maml:name><maml:description><maml:para>Specifies one or more CAU report objects, such as generated from a call to Get-CauReport with the Detailed parameter.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CauReport[]</command:parameterValue><dev:type><maml:name>CauReport[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Passes the CAU report object back through the pipeline for further processing.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the local or complete path of the file to save the exported report.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TimeZone</maml:name><maml:description><maml:para>Allows formatting of the report timestamps to match the specified time zone.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeZoneInfo</command:parameterValue><dev:type><maml:name>TimeZoneInfo</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauReport</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauReport</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-CauReport -ClusterName Contoso-FC1 -Last -Detailed | Export-CauReport -Format HTML -Path C:\temp\contoso-fc1_last.html -TimeZone ([system.timezoneinfo]::Utc) </dev:code><dev:remarks><maml:para>This example gets a detailed version of the last CAU report for the cluster named Contoso-FC1, then exports that report in HTML format to the path C:\temp\contoso-fc1_last.html. The timestamps in the report are formatted in the Coordinated Universal Time (UTC) zone.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287663</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauReport</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-CauRun</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-CauClusterRole</command:name><maml:description><maml:para>Retrieves configuration properties of the Cluster-Aware Updating (CAU) clustered role on the specified cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>CauClusterRole</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-CauClusterRole cmdlet retrieves configuration properties of the Cluster-Aware Updating (CAU) clustered role on the specified cluster.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which the CAU clustered role information should be retrieved. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which the CAU clustered role information should be retrieved. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauParameter</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-CauClusterRole -ClusterName CONTOSO-FC1 Name Value ---- ----- ResourceGroupName CAUCAUCldy8 Status Online StartDate 10/14/2011 3:00:00 AM MaxFailedNodes 2 MaxRetriesPerNode 2 PostUpdateScript G:\verifyupdatesinstalled.ps1 RequireAllNodesOnline On DaysOfWeek Tuesday, Saturday WeeksOfMonth {2, 4} </dev:code><dev:remarks><maml:para>This example gets information about the CAU clustered role on the cluster called CONTOSO-FC1.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287664</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Disable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Enable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-CauPlugin</command:name><maml:description><maml:para>Retrieves information about one or more software updating plug-ins that are registered on the local computer.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>CauPlugin</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-Cauplugin cmdlet retrieves information about one or more software updating plug-ins that are registered on the local computer. A plug-in can be specified or information can be retrieved about all registered plug-ins. CAU always uses a plug-in when performing updates. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in communicates with the Windows Update agent, 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-CauPlugin</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the name of the plug-in whose information should be retrieved. If not specified, then information for all of the registered plug-ins is returned.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the name of the plug-in whose information should be retrieved. If not specified, then information for all of the registered plug-ins is returned.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauPlugin</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-CauPlugin | Format-List –Property * Name : Microsoft.WindowsUpdatePlugin BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpdating\ClusterAwareUpdating.dll ClassName : MS.Internal.ClusterAwareUpdating.WuaPlugin Name : Microsoft.HotfixPlugin BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpdating\ClusterAwareUpdating.dll ClassName : MS.Internal.ClusterAwareUpdating.HotfixPlugin </dev:code><dev:remarks><maml:para>This example gets information about the software updating plug-ins that are registered in the local CAU tool.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287665</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Format-List</maml:linkText><maml:uri></maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Register-CauPlugin</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Unregister-CauPlugin</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-CauReport</command:name><maml:description><maml:para>Retrieves the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>CauReport</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-CauReport cmdlet retrieves 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 for which to return the detailed results.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-CauReport</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to retrieve reports. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Detailed</maml:name><maml:description><maml:para>Specifies that the full results for one or more runs will be returned, instead of just summary information.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-CauReport</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to retrieve reports. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>StartDate</maml:name><maml:description><maml:para>Retrieves only the reports from Runs on or after this time.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>EndDate</maml:name><maml:description><maml:para>Retrieves only the reports for Runs before this time.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Detailed</maml:name><maml:description><maml:para>Specifies that the full results for one or more runs will be returned, instead of just summary information.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-CauReport</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to retrieve reports. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Detailed</maml:name><maml:description><maml:para>Specifies that the full results for one or more runs will be returned, instead of just summary information.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Last</maml:name><maml:description><maml:para>Retrieves only the most recent Run report.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-CauReport</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to retrieve reports. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""><maml:name>Report</maml:name><maml:description><maml:para>Retrieves detailed results for the Run represented by the specified report summary.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">CauReportSummary</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to retrieve reports. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Detailed</maml:name><maml:description><maml:para>Specifies that the full results for one or more runs will be returned, instead of just summary information.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>EndDate</maml:name><maml:description><maml:para>Retrieves only the reports for Runs before this time.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Last</maml:name><maml:description><maml:para>Retrieves only the most recent Run report.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""><maml:name>Report</maml:name><maml:description><maml:para>Retrieves detailed results for the Run represented by the specified report summary.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">CauReportSummary</command:parameterValue><dev:type><maml:name>CauReportSummary</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>StartDate</maml:name><maml:description><maml:para>Retrieves only the reports from Runs on or after this time.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauReportSummary</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauReport</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauReportSummary</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed </dev:code><dev:remarks><maml:para>This example returns a detailed list of the Updating Runs performed on the cluster called Contoso-FC1 on 01/01/2012 or later.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed </dev:code><dev:remarks><maml:para>This example returns 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.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 3</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> $CauReportSummary=Get-CauReport Contoso-FC1 -Last PS C:\>Get-CauReport Contoso-FC1 -Report $CauReportSummary </dev:code><dev:remarks><maml:para>This example uses a CAU report summary object called $CauReportSummary to return a detailed report of the last Updating Run performed on the cluster called Contoso-FC1.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287666</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Export-CauReport</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-CauRun</command:name><maml:description><maml:para>Retrieves status information about an Updating Run currently in progress.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>CauRun</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-CauRun cmdlet retrieves status information about an Updating Run currently in progress. Use this cmdlet to monitor current Updating Runs.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-CauRun</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to get the Updating Run status. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-CauRun</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to get the Updating Run status. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ShowClusterNodeState</maml:name><maml:description><maml:para>If this parameter is specified, the cmdlet retrieves the status of the WMI object that is created on each cluster node. This can be used to debug the status of leftover objects.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-CauRun</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to get the Updating Run status. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WaitForCompletion</maml:name><maml:description><maml:para>Returns after the Updating Run has finished, and writes the updated CAU run objects to the output stream as progress is recorded by the current CAU Update Coordinator.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-CauRun</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to get the Updating Run status. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WaitForStart</maml:name><maml:description><maml:para>Returns only if there is an Updating Run in progress on the specified cluster, otherwise waits for an Updating Run to begin.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to get the Updating Run status. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ShowClusterNodeState</maml:name><maml:description><maml:para>If this parameter is specified, the cmdlet retrieves the status of the WMI object that is created on each cluster node. This can be used to debug the status of leftover objects.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WaitForCompletion</maml:name><maml:description><maml:para>Returns after the Updating Run has finished, and writes the updated CAU run objects to the output stream as progress is recorded by the current CAU Update Coordinator.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WaitForStart</maml:name><maml:description><maml:para>Returns only if there is an Updating Run in progress on the specified cluster, otherwise waits for an Updating Run to begin.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauRun</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.RunState</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-CauRun -ClusterName CONTOSO-FC1 RunId : 834dd11e-584b-41f2-8d22-4c9c0471dbad RunStartTime : 10/13/2011 1:35:39 PM CurrentOrchestrator : NODE1 NodeStatusNotifications : { Node : NODE1 Status : Waiting Timestamp : 10/13/2011 1:35:49 PM } NodeResults : { Node : NODE2 Status : Succeeded ErrorRecordData : NumberOfSucceededUpdates : 0 NumberOfFailedUpdates : 0 InstallResults : Microsoft.ClusterAwareUpdating.UpdateInstallResult[] } </dev:code><dev:remarks><maml:para>This example gets status information about the Updating Run currently in progress on the cluster called CONTOSO-FC1.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287667</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-CauRun</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Stop-CauRun</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Invoke-CauRun</command:name><maml:description><maml:para>Performs a scan of cluster nodes for applicable updates and installs those updates via an Updating Run on the specified cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Invoke</command:verb><command:noun>CauRun</command:noun><dev:version /></command:details><maml:description><maml:para>The Invoke-CauRun cmdlet performs a scan of cluster nodes for applicable updates and installs those updates via 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 updates that can only be installed after the initial set of updates are installed, and saving a report of the actions taken. </maml:para><maml:para>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 <maml:navigationLink><maml:linkText>Enable-PSRemoting</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Invoke-CauRun</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to install updates.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>Specifies one or more plug-ins to use when performing 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by PreUpdateScript and PostUpdateScript) 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 ("Microsoft.PowerShell") is used.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EnableFirewallRules</maml:name><maml:description><maml:para>Enables the Remote Shutdown Windows Firewall rule group on each cluster node, if it is not 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 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.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>FailbackMode</maml:name><maml:description><maml:para>Specifies the method used to bring drained workloads back to the node, at the end of updating the 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, and Policy. The default value is Immediate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FailbackType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxFailedNodes</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxRetriesPerNode</maml:name><maml:description><maml:para>Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. The maximum is 64 and the default is 3.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>NodeOrder</maml:name><maml:description><maml:para>Specifies the names of the cluster nodes in the order that they should be updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PostUpdateScript</maml:name><maml:description><maml:para>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 of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PreUpdateScript</maml:name><maml:description><maml:para>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 of the cluster nodes. If a pre-update script fails, the node is not updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RebootTimeoutMinutes</maml:name><maml:description><maml:para>Specifies the time in minutes that CAU will allow for the restarting of a 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RequireAllNodesOnline</maml:name><maml:description><maml:para>Specifies that all cluster nodes must be online and reachable before updating begins.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. 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. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SeparateReboots</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. The time span can be expressed in the standard ways available in Windows PowerShell, for example, 01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. Note: If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WarnAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. By default, no warning will be logged, regardless of the time taken by the Updating Run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Invoke-CauRun</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to install updates.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Recover"><maml:name>ForceRecovery</maml:name><maml:description><maml:para>Recovers from a previous failed run that left the cluster in a Locked state. Note: This switch defeats the synchronization mechanism used to prevent two update coordinators from accidentally trying to update the same cluster at the same time. Use with care.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue><dev:type><maml:name>Hashtable[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>Specifies one or more plug-ins to use when performing 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to install updates.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by PreUpdateScript and PostUpdateScript) 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 ("Microsoft.PowerShell") is used.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EnableFirewallRules</maml:name><maml:description><maml:para>Enables the Remote Shutdown Windows Firewall rule group on each cluster node, if it is not 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 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.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>FailbackMode</maml:name><maml:description><maml:para>Specifies the method used to bring drained workloads back to the node, at the end of updating the 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, and Policy. The default value is Immediate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FailbackType</command:parameterValue><dev:type><maml:name>FailbackType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Recover"><maml:name>ForceRecovery</maml:name><maml:description><maml:para>Recovers from a previous failed run that left the cluster in a Locked state. Note: This switch defeats the synchronization mechanism used to prevent two update coordinators from accidentally trying to update the same cluster at the same time. Use with care.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxFailedNodes</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxRetriesPerNode</maml:name><maml:description><maml:para>Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. The maximum is 64 and the default is 3.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>NodeOrder</maml:name><maml:description><maml:para>Specifies the names of the cluster nodes in the order that they should be updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PostUpdateScript</maml:name><maml:description><maml:para>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 of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PreUpdateScript</maml:name><maml:description><maml:para>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 of the cluster nodes. If a pre-update script fails, the node is not updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RebootTimeoutMinutes</maml:name><maml:description><maml:para>Specifies the time in minutes that CAU will allow for the restarting of a 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue>15</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RequireAllNodesOnline</maml:name><maml:description><maml:para>Specifies that all cluster nodes must be online and reachable before updating begins.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. 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. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SeparateReboots</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. The time span can be expressed in the standard ways available in Windows PowerShell, for example, 01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. Note: If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue><dev:type><maml:name>TimeSpan</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WarnAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. By default, no warning will be logged, regardless of the time taken by the Updating Run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue><dev:type><maml:name>TimeSpan</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.ActivityIdMap</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.ClusterResult</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.NodeResult</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.NodeStatusNotification</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.UpdateInfo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.UpdateInstallResult</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.UpdateStagingResult</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin -MaxFailedNodes -1 -MaxRetriesPerNode 3 -RequireAllNodesOnline -Force </dev:code><dev:remarks><maml:para>This example 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. This cmdlet is performed without confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName' } -EnableFirewallRules -StopOnPluginFailure –SeparateReboots -Force </dev:code><dev:remarks><maml:para>This example 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 is not already enabled, the Remote Shutdown Windows 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 will not be applied by Microsoft.HotfixPlugin plug-in. If the installation of updates by Microsoft.WindowsUpdatePlugin requires a node to restart, the node will restart before Microsoft.HotfixPlugin plug-in installs updates. The cmdlet runs without displaying confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 3</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -ForceRecovery -Force </dev:code><dev:remarks><maml:para>This example recovers from a previous Updating Run that failed and left the cluster in a Locked state for the cluster named CONTOSO-FC1. The recovery is performed without confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287668</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauRun</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Stop-CauRun</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Invoke-CauScan</command:name><maml:description><maml:para>Performs a scan of cluster nodes for applicable updates and returns a list of the initial set of updates that would be applied to each node in a specified cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Invoke</command:verb><command:noun>CauScan</command:noun><dev:version /></command:details><maml:description><maml:para>The Invoke-CauScan cmdlet performs a scan of cluster nodes for applicable updates and returns a list of the initial set of updates that would be applied to each node in a specified cluster. Generating the list might take a few minutes.</maml:para><maml:para>Note: The preview list includes only an initial set of updates. The list does not include updates that might become applicable only after the initial updates are installed.</maml:para><maml:para>Note: If the Microsoft.HotfixPlugin plug-in is specified, the scan returns only the list of hotfix files that are discovered on the hotfix file share. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Invoke-CauScan</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster which should be scanned for applicable updates. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>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 CAU, see the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For the Microsoft.HotfixPlugin plug-in. the following argument is required: - HotfixRootFolderPath=<Path>: 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during a scan for updates, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. By default, CAU scans and stages the applicable updates for all plug-ins in parallel. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during a scan for updates, specifies that if a failure occurs during a scan on a node by any plug-in, subsequent scans on the node that are coordinated by the remaining plug-ins are stopped. By default, a failure by one plug-in does not affect the scans for updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For the Microsoft.HotfixPlugin plug-in. the following argument is required: - HotfixRootFolderPath=<Path>: 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue><dev:type><maml:name>Hashtable[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>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 CAU, see the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster which should be scanned for applicable updates. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during a scan for updates, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. By default, CAU scans and stages the applicable updates for all plug-ins in parallel. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during a scan for updates, specifies that if a failure occurs during a scan on a node by any plug-in, subsequent scans on the node that are coordinated by the remaining plug-ins are stopped. By default, a failure by one plug-in does not affect the scans for updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauUpdateInfo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Invoke-CauScan -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin -Verbose </dev:code><dev:remarks><maml:para>This example provides 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. Note that the preview list includes only an initial set of updates, and does not include updates that might become applicable only after the initial updates are installed.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>$secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force PS C:\>$cred = New-Object System.Management.Automation.PSCredential ("username", $secpasswd) PS C:\>Invoke-CauScan -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{'QueryString'="IsInstalled=0 and Type='Software' and IsHidden=0"},@{'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName’} -Credential $cred </dev:code><dev:remarks><maml:para>This example provides 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, 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.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287669</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-CauRun</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Register-CauPlugin</command:name><maml:description><maml:para>Registers a Cluster-Aware Updating (CAU) software updating plug-in on the local computer.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Register</command:verb><command:noun>CauPlugin</command:noun><dev:version /></command:details><maml:description><maml:para>The Register-CauPlugin cmdlet registers a Cluster-Aware Updating (CAU) software updating plug-in on the local computer. CAU always uses a plug-in when performing updates, although you do not need to register a plug-in because CAU uses the Microsoft.WindowsUpdatePlugin plug-in by default. This plug-in communicates 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Register-CauPlugin</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the binary that implements the plug-in. Classes that implement the plug-in interface and are decorated with the plug-in attribute, are discovered through reflection and registered.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the binary that implements the plug-in. Classes that implement the plug-in interface and are decorated with the plug-in attribute, are discovered through reflection and registered.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauPlugin</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Register-CauPlugin -Path c:\PluginDevelopment\Plugin01.dll -Force </dev:code><dev:remarks><maml:para>The example registers a plug-in called Plugin01.dll located in the C:\PluginDevelopment folder. The cmdlet runs without displaying confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287670</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauPlugin</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Unregister-CauPlugin</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Remove-CauClusterRole</command:name><maml:description><maml:para>Removes the Cluster-Aware Updating (CAU) clustered role from the specified failover cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Remove</command:verb><command:noun>CauClusterRole</command:noun><dev:version /></command:details><maml:description><maml:para>The Remove-CauClusterRole cmdlet removes the Cluster-Aware Updating (CAU) clustered role from the specified failover cluster. To run CAU from a cluster, ensure that the CAU clustered role is configured in that cluster.</maml:para><maml:para>Note: The Remove-CauClusterRole cmdlet removes the virtual computer object (VCO) in Active Directory for the CAU clustered role, unless you previously prestaged or specified the VCO by running the Add-CauClusterRole cmdlet with the VirtualComputerObjectName parameter. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Remove-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster from which to remove the CAU clustered role. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster from which to remove the CAU clustered role. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Remove-CauClusterRole -ClusterName CONTOSO-FC1 -Force </dev:code><dev:remarks><maml:para>This example removes the instance of the CAU clustered role that is configured on the cluster named CONTOSO-FC1. The example runs without displaying confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287671</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Disable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Enable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Save-CauDebugTrace</command:name><maml:description><maml:para>Saves Cluster-Aware Updating (CAU) debug tracing information to a local zip file.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Save</command:verb><command:noun>CauDebugTrace</command:noun><dev:version /></command:details><maml:description><maml:para>The Save-CauDebugTrace cmdlet saves Cluster-Aware Updating (CAU) debug tracing information to a local zip file. The tracing information is mainly intended for use by developers and support engineers. Specify the file name with the FilePath parameter.</maml:para><maml:para>Note: To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. To do this, run the <maml:navigationLink><maml:linkText>Enable-PSRemoting</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Save-CauDebugTrace</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to gather CAU debug tracing information. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>FilePath</maml:name><maml:description><maml:para>Specifies the name of the file to which to save the tracing information, such as MyTrace.zip.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Specifies that when the file specified by the FilePath parameter exists, it is overwritten without prompting for confirmation. If Force is not specified, then when the file specified by the FilePath parameter exists, the cmdlet returns an error.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunId</maml:name><maml:description><maml:para>Indicates that the cmdlet should only include debug trace files related to an Updating Run with the specified Run ID.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>FilePath</maml:name><maml:description><maml:para>Specifies the name of the file to which to save the tracing information, such as MyTrace.zip.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Specifies that when the file specified by the FilePath parameter exists, it is overwritten without prompting for confirmation. If Force is not specified, then when the file specified by the FilePath parameter exists, the cmdlet returns an error.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster for which to gather CAU debug tracing information. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunId</maml:name><maml:description><maml:para>Indicates that the cmdlet should only include debug trace files related to an Updating Run with the specified Run ID.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Save-CauDebugTrace –ClusterName CONTOSO-FC1 -FilePath C:\temp\testrun.zip </dev:code><dev:remarks><maml:para>This example saves the debug tracing information, for the cluster called CONTOSO-FC1, to a trace file called testrun.zip in the C:\temp folder.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287672</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-CauRun</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-CauClusterRole</command:name><maml:description><maml:para>Sets configuration properties for the Cluster-Aware Updating (CAU) clustered role on the specified cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>CauClusterRole</command:noun><dev:version /></command:details><maml:description><maml:para>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.</maml:para><maml:para>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 <maml:navigationLink><maml:linkText>Enable-PSRemoting</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to configure the CAU clustered role. If not specified, then the current cluster is used. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For the Microsoft.HotfixPlugin plug-in, the following argument is required: - HotfixRootFolderPath=<Path>: 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by PreUpdateScript and PostUpdateScript) 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 ("Microsoft.PowerShell") is used.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>DaysOfWeek</maml:name><maml:description><maml:para>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) - Tuesday: (0x04) - Wednesday: (0x08) - Thursday: (0x10) - Friday: (0x20) - Saturday: (0x40) Examples: - -DaysOfWeek: Monday, Wednesday, Friday - -DaysOfWeek: 0x02, 0x08, 0x20 - -DaysOfWeek: 0x2A </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Weekdays</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EnableFirewallRules</maml:name><maml:description><maml:para>Enables the Remote Shutdown Windows Firewall rule group on each cluster node, if it is not 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 the installation of an update requires a restart). If Windows Firewall is in 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.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>FailbackMode</maml:name><maml:description><maml:para>Specifies the method used to bring drained workloads back to the node, at the end of updating the 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, and Policy. The default value is Immediate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FailbackType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxFailedNodes</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxRetriesPerNode</maml:name><maml:description><maml:para>Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. The maximum is 64 and the default is 3.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>NodeOrder</maml:name><maml:description><maml:para>Specifies the names of the cluster nodes in the order that they should be updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PostUpdateScript</maml:name><maml:description><maml:para>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 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 of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PreUpdateScript</maml:name><maml:description><maml:para>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, to ensure that it is always accessible to all of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RebootTimeoutMinutes</maml:name><maml:description><maml:para>Specifies the time in minutes that CAU will allow for the restarting of a 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RequireAllNodesOnline</maml:name><maml:description><maml:para>Specifies that all cluster nodes must be online and reachable before updating begins.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. 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. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SeparateReboots</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StartDate</maml:name><maml:description><maml:para>Specifies the earliest date on which the Updating Run can be triggered.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. The time span can be expressed in the standard ways available in Windows PowerShell, for example, 01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. Note: If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>UseDefault</maml:name><maml:description><maml:para>Specifies that default values will be used for all parameters that do not have specified values.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WarnAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. By default, no warning will be logged, regardless of the time taken by the Updating Run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WeeksOfMonth</maml:name><maml:description><maml:para>Specifies the weeks of the month when the Updating Run should be run. The value 5 represents the last week of the month.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Int32[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to configure the CAU clustered role. If not specified, then the current cluster is used. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For the Microsoft.HotfixPlugin plug-in, the following argument is required: - HotfixRootFolderPath=<Path>: 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by PreUpdateScript and PostUpdateScript) 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 ("Microsoft.PowerShell") is used.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>DaysOfWeek</maml:name><maml:description><maml:para>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) - Tuesday: (0x04) - Wednesday: (0x08) - Thursday: (0x10) - Friday: (0x20) - Saturday: (0x40) Examples: - -DaysOfWeek: Monday, Wednesday, Friday - -DaysOfWeek: 0x02, 0x08, 0x20 - -DaysOfWeek: 0x2A </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Weekdays</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EnableFirewallRules</maml:name><maml:description><maml:para>Enables the Remote Shutdown Windows Firewall rule group on each cluster node, if it is not 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 the installation of an update requires a restart). If Windows Firewall is in 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.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>FailbackMode</maml:name><maml:description><maml:para>Specifies the method used to bring drained workloads back to the node, at the end of updating the 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, and Policy. The default value is Immediate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FailbackType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>IntervalWeeks</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxFailedNodes</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxRetriesPerNode</maml:name><maml:description><maml:para>Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. The maximum is 64 and the default is 3.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>NodeOrder</maml:name><maml:description><maml:para>Specifies the names of the cluster nodes in the order that they should be updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PostUpdateScript</maml:name><maml:description><maml:para>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 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 of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PreUpdateScript</maml:name><maml:description><maml:para>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, to ensure that it is always accessible to all of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RebootTimeoutMinutes</maml:name><maml:description><maml:para>Specifies the time in minutes that CAU will allow for the restarting of a 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RequireAllNodesOnline</maml:name><maml:description><maml:para>Specifies that all cluster nodes must be online and reachable before updating begins.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. 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. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SeparateReboots</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StartDate</maml:name><maml:description><maml:para>Specifies the earliest date on which the Updating Run can be triggered.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. The time span can be expressed in the standard ways available in Windows PowerShell, for example, 01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. Note: If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>UseDefault</maml:name><maml:description><maml:para>Specifies that default values will be used for all parameters that do not have specified values.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WarnAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. By default, no warning will be logged, regardless of the time taken by the Updating Run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to configure the CAU clustered role. If not specified, then the current cluster is used. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>UpdateNow</maml:name><maml:description><maml:para>Instructs the CAU clustered role to immediately initiate an Updating Run using the configured settings.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-CauClusterRole</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to configure the CAU clustered role. If not specified, then the current cluster is used. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>UseDefault</maml:name><maml:description><maml:para>Specifies that default values will be used for all parameters that do not have specified values.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginArguments</maml:name><maml:description><maml:para>Passes a set of name=value pairs (arguments) for each updating plug-in to use. For example, to specify a Domain argument for one plug-in: - @{Domain=Domain.local} You can specify multiple pairs in a set separated with semicolons. For example: - @{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 example: - @{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'='<Value>': 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 the topic about search criteria in the <maml:navigationLink><maml:linkText>Windows Update Agent (WUA) API Reference</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For the Microsoft.HotfixPlugin plug-in, the following argument is required: - HotfixRootFolderPath=<Path>: 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=<Value>: 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=<Value>: 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=<Integer>: 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>: 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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue><dev:type><maml:name>Hashtable[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CauPluginName</maml:name><maml:description><maml:para>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 the content about <maml:navigationLink><maml:linkText>Cluster-Aware Updating plug-ins</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to configure the CAU clustered role. If not specified, then the current cluster is used. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by PreUpdateScript and PostUpdateScript) 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 ("Microsoft.PowerShell") is used.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>DaysOfWeek</maml:name><maml:description><maml:para>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) - Tuesday: (0x04) - Wednesday: (0x08) - Thursday: (0x10) - Friday: (0x20) - Saturday: (0x40) Examples: - -DaysOfWeek: Monday, Wednesday, Friday - -DaysOfWeek: 0x02, 0x08, 0x20 - -DaysOfWeek: 0x2A </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Weekdays</command:parameterValue><dev:type><maml:name>Weekdays</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EnableFirewallRules</maml:name><maml:description><maml:para>Enables the Remote Shutdown Windows Firewall rule group on each cluster node, if it is not 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 the installation of an update requires a restart). If Windows Firewall is in 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.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>FailbackMode</maml:name><maml:description><maml:para>Specifies the method used to bring drained workloads back to the node, at the end of updating the 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, and Policy. The default value is Immediate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FailbackType</command:parameterValue><dev:type><maml:name>FailbackType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="f"><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>IntervalWeeks</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxFailedNodes</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MaxRetriesPerNode</maml:name><maml:description><maml:para>Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. The maximum is 64 and the default is 3.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>NodeOrder</maml:name><maml:description><maml:para>Specifies the names of the cluster nodes in the order that they should be updated.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PostUpdateScript</maml:name><maml:description><maml:para>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 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 of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PreUpdateScript</maml:name><maml:description><maml:para>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, to ensure that it is always accessible to all of the cluster nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RebootTimeoutMinutes</maml:name><maml:description><maml:para>Specifies the time in minutes that CAU will allow for the restarting of a 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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue>15</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RequireAllNodesOnline</maml:name><maml:description><maml:para>Specifies that all cluster nodes must be online and reachable before updating begins.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RunPluginsSerially</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in CauPluginName. 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. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SeparateReboots</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StartDate</maml:name><maml:description><maml:para>Specifies the earliest date on which the Updating Run can be triggered.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. The time span can be expressed in the standard ways available in Windows PowerShell, for example, 01:30:00 represents one hour and thirty minutes. By default, the Updating Run is allowed an unlimited amount of time to complete. Note: If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue><dev:type><maml:name>TimeSpan</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StopOnPluginFailure</maml:name><maml:description><maml:para>When multiple plug-ins are used during an Updating Run, specifies 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. By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. Note: The parameter is valid only when multiple plug-ins are specified in CauPluginName. If a single plug-in is specified, a warning appears.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WarnAfter</maml:name><maml:description><maml:para>Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. By default, no warning will be logged, regardless of the time taken by the Updating Run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue><dev:type><maml:name>TimeSpan</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>UpdateNow</maml:name><maml:description><maml:para>Instructs the CAU clustered role to immediately initiate an Updating Run using the configured settings.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>UseDefault</maml:name><maml:description><maml:para>Specifies that default values will be used for all parameters that do not have specified values.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>WeeksOfMonth</maml:name><maml:description><maml:para>Specifies the weeks of the month when the Updating Run should be run. The value 5 represents the last week of the month.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Int32[]</command:parameterValue><dev:type><maml:name>Int32[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Set-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday -WeeksOfMonth 1,2 -RebootTimeoutMinutes 10 -Force </dev:code><dev:remarks><maml:para>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.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>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 </dev:code><dev:remarks><maml:para>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.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 3</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Set-CauClusterRole -ClusterName CONTOSO-FC1 -UpdateNow -Force </dev:code><dev:remarks><maml:para>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.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 4</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>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 </dev:code><dev:remarks><maml:para>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.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287673</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Disable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Enable-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-CauClusterRole</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Stop-CauRun</command:name><maml:description><maml:para>Stops an Updating Run that is in progress on a cluster.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Stop</command:verb><command:noun>CauRun</command:noun><dev:version /></command:details><maml:description><maml:para>The Stop-CauRun cmdlet stops an Updating Run that is in progress on a failover cluster.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Stop-CauRun</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to stop an Updating Run that is in progress. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Wait</maml:name><maml:description><maml:para>Returns after the canceled Updating Run has completely finished. Otherwise, returns as soon as the stop request has been acknowledged by the current CAU Update Coordinator.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to stop an Updating Run that is in progress. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Wait</maml:name><maml:description><maml:para>Returns after the canceled Updating Run has completely finished. Otherwise, returns as soon as the stop request has been acknowledged by the current CAU Update Coordinator.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.Boolean</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Stop-CauRun -ClusterName CONTOSO-FC1 -Wait -Force </dev:code><dev:remarks><maml:para>This example stops the Updating Run that is being performed by the CAU Update Coordinator that is configured on the cluster named CONTOSO-FC1. The cmdlet waits to return until the canceled Updating Run has completely finished. The cmdlet runs without displaying confirmation prompts.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287674</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauRun</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-CauRun</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Test-CauSetup</command:name><maml:description><maml:para>Tests whether a cluster is properly set up to apply software updates using Cluster-Aware Updating (CAU).</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Test</command:verb><command:noun>CauSetup</command:noun><dev:version /></command:details><maml:description><maml:para>The Test-CauSetup cmdlet tests whether a failover cluster is properly set up to apply software updates using Cluster-Aware Updating (CAU). The cmdlet performs a Best Practices Analyzer (BPA) scan of the failover cluster and network environment by invoking the ClusterAwareUpdating BPA model that is installed with CAU. To view the results of a BPA scan that is performed by Test-CauSetup, including possible problems and resolution steps, run the Get-BpaResult cmdlet. </maml:para><maml:para>Note: You must run Test-CauSetup with local administrative credentials. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Test-CauSetup</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to test for proper setup. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>ClusterName</maml:name><maml:description><maml:para>Specifies the name of the cluster on which to test for proper setup. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the administrative credentials for the target cluster.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauBpaProgress</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Test-CauSetup -ClusterName CONTOSO-FC1 Test-CauSetup completed successfully. To view the results, run the "Get-BpaResult Microsoft/Windows/ClusterAwareUpdating" Windows PowerShell cmdlet. </dev:code><dev:remarks><maml:para>This example tests whether failover cluster CONTOSO-FC1 is properly set up for CAU.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287675</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-BpaModel</maml:linkText><maml:uri></maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-BpaResult</maml:linkText><maml:uri></maml:uri></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Unregister-CauPlugin</command:name><maml:description><maml:para>Removes a software updating plug-in from the list of plug-ins that are used by Cluster-Aware Updating (CAU).</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Unregister</command:verb><command:noun>CauPlugin</command:noun><dev:version /></command:details><maml:description><maml:para>The Unregister-CauPlugin cmdlet removes a software updating plug-in from the list of plug-ins that are used by Cluster-Aware Updating (CAU). The plug-in can be removed, but afterwards, it cannot be used for Updating Runs. The Microsoft.WindowsUpdatePlugin and Microsoft.HotfixPlugin plug-ins, which are installed with CAU, cannot be unregistered.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Unregister-CauPlugin</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the name of the plug-in to unregister.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the name of the plug-in to unregister.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.ClusterAwareUpdating.CauPlugin</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Unregister-CauPlugin -Name Plugin01 </dev:code><dev:remarks><maml:para>This example removes the plug-in named Plugin01 from the list of plug-ins that are used by Cluster-Aware Updating (CAU).</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287676</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-CauPlugin</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Register-CauPlugin</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |