Disable-CauClusterRole
Disable-CauClusterRole
Suspends the self-updating functionality on the specified cluster.
Syntax
Parameter Set: Default
Disable-CauClusterRole [[-ClusterName] <String> ] [-Credential <PSCredential> ] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
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.
Parameters
-ClusterName<String>
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.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the administrative credentials for the target cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
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.
PS C:\> Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force