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
 

Add-ClusterCheckpoint

Add-ClusterCheckpoint

microsoft.failoverclusters.powershell.dll

Synopsis

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

Syntax

Add-ClusterCheckpoint [-ResourceName] [-Cluster] [-CryptoCheckpointKey] [-CryptoCheckpointName] [-CryptoCheckpointType] [-InputObject] [-RegistryCheckpoint] [<CommonParameters>]

Detailed Description

The Add-ClusterCheckpoint cmdlet adds 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

-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

-CryptoCheckpointKey <String>

Specifies the key of a cryptographic key checkpoint to add.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-CryptoCheckpointName <String>

Specifies the name of a cryptographic key checkpoint to add.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-CryptoCheckpointType <String>

Specifies the type of a cryptographic key checkpoint to add. Options depend on the cryptographic provider.

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 for which the checkpoint should be added.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-RegistryCheckpoint <String>

Specifies the name of the registry checkpoint to add.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ResourceName <String>

Specifies the resource for which a checkpoint should be added.

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 adds a registry checkpoint called software\clusname for the resource named cluster name.

PS C:\>Add-ClusterCheckpoint -ResourceName "cluster name" -RegistryCheckpoint "software\clusname"
Resource                                                    Name 
--------                                                    ---- 
cluster name                                                software\clusname 

Example 2

This example adds a cryptographic checkpoint for the resource named Cluster Name.

PS C:\>Get-ClusterResource –Name "Cluster Name" | Add-ClusterCheckpoint -CryptoCheckpointName "Microsoft Base Cryptographic Provider v1.0"  -CryptoCheckpointType 1 -CryptoCheckpointKey "Crypto"
Resource                      Name                          Type                          Key 
--------                      ----                          ----                          --- 
Cluster Name                  Microsoft Base Cryptograph... 1                             Crypto 

Online Version
Get-ClusterCheckpoint
Get-ClusterResource
Remove-ClusterCheckpoint