| 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. |
Microsoft.FailoverClusters.PowerShell.dll-Help.xml |
FailoverClusters |
11/23/2022 |
2.0.0 |
Suspend-ClusterResource |
Turns on maintenance for a disk resource or CSV so that you can run a disk maintenance tool without triggering failover.
Suspend-ClusterResource [[-Name] <String>] [-VolumeName <String>] [-RedirectedAccess] [-Force]
[-InputObject <PSObject>] [-Cluster <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
The Suspend-ClusterResource cmdlet turns on maintenance for a disk resource or Cluster Shared
Volume (CSV) so that a disk maintenance tool can be run without triggering failover.
This cmdlet only applies to disks and CSVs. For Cluster Shared Volumes, turning on maintenance takes dependent resources offline, which interrupts client access. For other disks, Logical Unit Number (LUNs), in cluster storage, turning on maintenance leaves dependent resources online.
Suspend-ClusterResource -Name "Cluster Disk 2"This example turns on maintenance for CSV named Cluster Disk 2 so that you can run a disk
maintenance tool without triggering failover.
Get-ClusterSharedVolume -Name "Cluster Disk 5" | Suspend-ClusterResourceThis example turns on maintenance for all volumes on the CSV named Cluster Disk 5.
Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is
. or it is omitted, then the cmdlet runs on the local cluster.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts 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: FalseForces 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: FalseSpecifies the cluster resource, a disk or CSV, to suspend.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of the cluster resource, a disk or CSV, to suspend.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCauses CSV access to the storage device to be redirected over the network through another cluster node. This parameter is only applicable to CSVs.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: FileSystemRedirectedAccess
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of the volume to suspend. This parameter is only applicable to CSVs. If this parameter isn't specified, then the operation will be performed on all volumes on the CSV.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows 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: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.