description | external help file | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
Microsoft.FailoverClusters.PowerShell.dll-Help.xml |
FailoverClusters |
11/22/2022 |
2.0.0 |
Add-ClusterCheckpoint |
Adds a cryptographic key checkpoint or registry checkpoint for a resource.
Add-ClusterCheckpoint [[-ResourceName] <String>] [-CryptoCheckpointName <String>]
[-CryptoCheckpointType <String>] [-CryptoCheckpointKey <String>] [-RegistryCheckpoint <String>]
[-InputObject <PSObject>] [-Cluster <String>] [<CommonParameters>]
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.
Add-ClusterCheckpoint -ResourceName "Cluster Name" -RegistryCheckpoint "software\clusname"
This example adds a registry checkpoint called software\clusname
for the resource named cluster
name.
$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.
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the key of a cryptographic key checkpoint to add.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the name of a cryptographic key checkpoint to add.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the type of a cryptographic key checkpoint to add. Options depend on the cryptographic provider.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the cluster on which to run the cmdlet or the cluster resource for which the checkpoint should be added.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the name of the registry checkpoint to add.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the resource for which a checkpoint should be added.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.