Skip to content

Latest commit

 

History

History
152 lines (108 loc) · 3.39 KB

File metadata and controls

152 lines (108 loc) · 3.39 KB
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
ClusterAwareUpdating.dll-Help.xml
ClusterAwareUpdating
09/27/2022
2.0.0
Disable-CauClusterRole

Disable-CauClusterRole

SYNOPSIS

Suspends the self-updating functionality on the specified cluster.

SYNTAX

Disable-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

The Disable-CauClusterRole cmdlet 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.

EXAMPLES

Example 1: Disable a CAU clustered role on the specified cluster

Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force

This command 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. Because the command specified the Force parameter, the cmdlet runs without displaying confirmation prompts.

PARAMETERS

-ClusterName

Specifies the name of the cluster on which to disable the self-updating functionality. This parameter is only required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Specifies the administrative credentials for the target cluster.

Type: PSCredential
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

None

NOTES

RELATED LINKS

Enable-CauClusterRole

Get-CauClusterRole

Remove-CauClusterRole

Set-CauClusterRole