Edit

Share via

Add-ClusterCheckpoint

  • Reference
Module:
FailoverClusters

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

Syntax

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

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.

Examples

Example 1: Add registry checkpoint

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

This example adds a registry checkpoint called software\clusname for the resource named cluster name.

Example 2: Add cryptographic checkpoint

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

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

Parameters

-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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CryptoCheckpointKey

Specifies the key of a cryptographic key checkpoint to add.

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

-CryptoCheckpointName

Specifies the name of a cryptographic key checkpoint to add.

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

-CryptoCheckpointType

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

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

-InputObject

Specifies the cluster on which to run the cmdlet or the cluster resource for which the checkpoint should be added.

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

-RegistryCheckpoint

Specifies the name of the registry checkpoint to add.

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

-ResourceName

Specifies the resource for which a checkpoint should be added.

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

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Microsoft.FailoverClusters.PowerShell.ClusterResource

Outputs

Object