Table of contents
TOC
Collapse the table of content
Expand the table of content

Remove-ClusterCheckpoint

Last Updated: 3/28/2017

SYNOPSIS

Removes a cryptographic key checkpoint or registry checkpoint for a resource.

SYNTAX

Remove-ClusterCheckpoint [[-ResourceName] <String>] [-Force] [-CheckpointName <String>] [-RegistryCheckpoint]
 [-CryptoCheckpoint] [-InputObject <PSObject>] [-Cluster <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-ClusterCheckpoint cmdlet removes a cryptographic key checkpoint or registry checkpoint for a resource.

Checkpoints help provide failover support for applications that store configuration information locally instead of or in addition to storing information in the cluster configuration database. Applications might store information locally in two ways. One way is to store configuration information in the registry on the local server; another way is to use cryptographic keys on the local server.

EXAMPLES

Example 1

PS C:\> Get-ClusterResource "Cluster Name" | Remove-ClusterCheckpoint -RegistryCheckpoint



PS C:\> Remove-ClusterCheckpoint
Are you sure you want to remove registry checkpoint 'software\clusname' on resource 'Cluster Name'? 


[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"):Y

This example removes the registry checkpoint called software\clusname for the resource named Cluster Name.

PARAMETERS

-CheckpointName

Specifies the name of the checkpoint to remove.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Cluster

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: 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

-CryptoCheckpoint

Specifies that cryptographic key checkpoints will be removed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-InputObject

Specifies the cluster on which to run the cmdlet or the cluster resource from which to remove the checkpoint.

Type: PSObject
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-RegistryCheckpoint

Specifies that registry checkpoints will be removed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-ResourceName

Specifies the resource from which a checkpoint should be removed.

Type: String
Parameter Sets: (All)
Aliases: 

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not 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

Microsoft.FailoverClusters.PowerShell.Cluster

Microsoft.FailoverClusters.PowerShell.ClusterResource

OUTPUTS

System.Object

NOTES

Add-ClusterCheckpoint

Get-ClusterCheckpoint

© 2017 Microsoft