Get-ClusterCheckpoint
Retrieves a cryptographic key checkpoint or registry checkpoint for a resource.
Syntax
Default (Default)
Get-ClusterCheckpoint
[[-ResourceName] <StringCollection>]
[-CheckpointName <String>]
[-RegistryCheckpoint]
[-CryptoCheckpoint]
[-InputObject <PSObject>]
[-Cluster <String>]
[<CommonParameters>]
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.
Examples
Example 1
Get-ClusterCheckpoint
This example retrieves all cluster checkpoints.
Example 2
Get-ClusterResource -ResourceName "Cluster Name" | Get-ClusterCheckpoint -CryptoCheckpoint
This example retrieves the cryptographic checkpoints for the resource named Cluster Name
.
Parameters
-CheckpointName
Specifies the name of checkpoints for which to search. Use of wildcard expressions is accepted.
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 |
-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 |
-CryptoCheckpoint
Specifies that cryptographic checkpoints will be retrieved.
Parameter properties
Type: | SwitchParameter |
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 to retrieve the checkpoint.
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 that registry checkpoints will be retrieved.
Parameter properties
Type: | SwitchParameter |
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 to retrieve the checkpoint.
Parameter properties
Type: | StringCollection |
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.