Restore-CARoleService

Module:

ADCSAdministration Module

Restores the CA database and private key information.

Syntax

Key

Restore-CARoleService
    [-Path] <String>
    [-Force]
    [-KeyOnly]
    [-Password <SecureString>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Database

Restore-CARoleService
    [-Path] <String>
    [-Force]
    [-DatabaseOnly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

All

Restore-CARoleService
    [-Path] <String>
    [-Force]
    [-Password <SecureString>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Restore-CARoleService cmdlet restores the certification authority (CA) database and private key information.

Examples

Example 1: Restore the CA private key and certificate

PS C:\> Restore-CARoleService -Path "C:\CABackup"

This command restores the CA private key and certificate from the specified path.

Example 2: Restore the CA database only

PS C:\> Restore-CARoleService -Path "C:\CABackup" -DatabaseOnly

This command restores the CA database from the specified path. The command does not restore the CA private key information.

Example 3: Restore the CA key only

PS C:\> Restore-CARoleService -Path "C:\CABackup" -KeyOnly

This command restores the CA private key information to the specified path. The command does not restore the CA database.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

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

-DatabaseOnly

Indicates that the cmdlet restores only the certification authority database.

Parameter properties

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

Parameter sets

Database

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

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:	SwitchParameter
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:	True
Value from remaining arguments:	False

-KeyOnly

Indicates that the cmdlet restores only the certification authority private key and certificate.

Parameter properties

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

Parameter sets

Key

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

-Password

Specifies a password, as a secure string, to access the private key and certificate information. To obtain a secure string, use the ConvertTo-SecureString cmdlet. For more information, type Get-Help ConvertTo-SecureString.

Parameter properties

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

Parameter sets

Key

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

All

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

-Path

Specifies the directory from which the cmdlet restores the CA database and private key. The cmdlet restores the database from the subdirectory named Database in the path that you specified when you backed up the CA database. The cmdlet restores the private key from the .p12 file that you backed up in the Database subdirectory in the path that you specify.

Parameter properties

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

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
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

String

SwitchParameter

SecureString

Outputs

Void

Related Links

• Backup-CARoleService