Get-ClusterCheckpoint
Get-ClusterCheckpoint
Retrieves a cryptographic key checkpoint or registry checkpoint for a resource.
Syntax
Parameter Set: InputObject
Get-ClusterCheckpoint [[-ResourceName] <StringCollection> ] [-CheckpointName <String> ] [-Cluster <String> ] [-CryptoCheckpoint] [-InputObject <PSObject> ] [-RegistryCheckpoint] [ <CommonParameters>]
Detailed Description
The Get-ClusterCheckpoint cmdlet retrieves 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
-CheckpointName<String>
Specifies the name of checkpoints for which to search. Use of wildcard expressions is accepted.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 |
-CryptoCheckpoint
Specifies that cryptographic checkpoints will be retrieved.
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 to retrieve the checkpoint.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-RegistryCheckpoint
Specifies that registry checkpoints will be retrieved.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResourceName<StringCollection>
Specifies the resource for which to retrieve the checkpoint.
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 retrieves all cluster checkpoints.
PS C:\> Get-ClusterCheckpoint
Example 2
This example retrieves the cryptographic checkpoints for the resource named Cluster Name.
PS C:\> Get-ClusterResource –ResourceName "Cluster Name" | Get-ClusterCheckpoint -CryptoCheckpoint