Remove-ClusterCheckpoint

Remove-ClusterCheckpoint

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

Syntax

Parameter Set: InputObject
Remove-ClusterCheckpoint [[-ResourceName] <String> ] [-CheckpointName <String> ] [-Cluster <String> ] [-CryptoCheckpoint] [-Force] [-InputObject <PSObject> ] [-RegistryCheckpoint] [-Confirm] [-WhatIf] [ <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

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CryptoCheckpoint

Specifies that cryptographic key checkpoints will be removed.


Aliases

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

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

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-RegistryCheckpoint

Specifies that registry checkpoints will be removed.


Aliases

none

Required?

false

Position?

named

Default Value

none

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

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Object

Examples

Example 1: Remove a registry checkpoint

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

 

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

Related topics

Community Additions

ADD
Show: