Edit

Share via

Add-ClusterCheckpoint

Module:
FailoverClusters Module

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

Syntax

Default (Default) 

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

Add-ClusterCheckpoint -ResourceName "Cluster Name" -RegistryCheckpoint "software\clusname"

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

Example 2: Add cryptographic checkpoint

$parameters = @{
    CryptoCheckpointName = 'Microsoft Base Cryptographic Provider v1.0'
    CryptoCheckpointType = '1'
    CryptoCheckpointKey = 'Crypto'
}
Get-ClusterResource -Name "Cluster Name" | Add-ClusterCheckpoint @parameters

This example adds a cryptographic checkpoint for the resource named Cluster Name. This example uses splatting to pass parameter values from the $Parameters variable to the command. Learn more about Splatting.

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CryptoCheckpointKey

Specifies the key of a cryptographic key checkpoint to add.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CryptoCheckpointName

Specifies the name of a cryptographic key checkpoint to add.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CryptoCheckpointType

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-RegistryCheckpoint

Specifies the name of the registry checkpoint to add.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceName

Specifies the resource for which a checkpoint should be added.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Microsoft.FailoverClusters.PowerShell.ClusterResource

Outputs

Object