Add-ClusterCheckpoint
Add-ClusterCheckpoint
Adds a cryptographic key checkpoint or registry checkpoint for a resource.
Syntax
Parameter Set: InputObject
Add-ClusterCheckpoint [[-ResourceName] <String> ] [-Cluster <String> ] [-CryptoCheckpointKey <String> ] [-CryptoCheckpointName <String> ] [-CryptoCheckpointType <String> ] [-InputObject <PSObject> ] [-RegistryCheckpoint <String> ] [ <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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
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 |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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
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"
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"