Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-ClusterCheckpoint

Remove-ClusterCheckpoint

microsoft.failoverclusters.powershell.dll

Synopsis

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

Syntax

Remove-ClusterCheckpoint [-ResourceName] [-CheckpointName] [-Cluster] [-CryptoCheckpoint] [-Force] [-InputObject] [-RegistryCheckpoint] [<CommonParameters>]

Detailed 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.

Parameters

-CheckpointName <String>

Specifies the name of the checkpoint to remove.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Cluster <String>

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.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-CryptoCheckpoint <SwitchParameter>

Specifies that cryptographic key checkpoints will be removed.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

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

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

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

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-RegistryCheckpoint <SwitchParameter>

Specifies that registry checkpoints will be removed.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ResourceName <String>

Specifies the resource from which a checkpoint should be removed.

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster
Microsoft.FailoverClusters.PowerShell.ClusterResource

Return Type

System.Object

Notes

None

Examples

Example 1

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

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

Online Version
Add-ClusterCheckpoint
Get-ClusterCheckpoint