Edit

Share via

Backup-CARoleService

  • Reference
Module:
ADCSAdministration

Backs up the CA database and private key information.

Syntax

Backup-CARoleService
      [-Path] <String>
      [-Force]
      [-KeyOnly]
      [-Password <SecureString>]
      [<CommonParameters>]
Backup-CARoleService
      [-Path] <String>
      [-Force]
      [-DatabaseOnly]
      [-Incremental]
      [-KeepLog]
      [<CommonParameters>]
Backup-CARoleService
      [-Path] <String>
      [-Force]
      [-Password <SecureString>]
      [-Incremental]
      [-KeepLog]
      [<CommonParameters>]

Description

The Backup-CARoleService cmdlet backs up the certification authority (CA) database and private key information to a specified path.

Examples

Example 1: Back up the CA database and private key information

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

This command exports the CA database and private key information to the specified path.

Example 2: Back up the CA database only

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

This command exports the CA database to the specified path. The command does not back up the CA private key information.

Example 3: Back up the CA key only

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

This command exports the CA private key information to the specified path. The command does not back up the CA database.

Parameters

-DatabaseOnly

Indicates that the cmdlet backs up only the certification authority database.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Incremental

Indicates that the cmdlet performs incremental database back up.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-KeepLog

Indicates that the cmdlet does not truncate database logs.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-KeyOnly

Indicates that the cmdlet backs up only the CA private key and certificate.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Password

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

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Path

Specifies the directory to which the cmdlet backs up the CA database and private key. If you back up the database, the cmdlet creates a new subdirectory named Database that contains the database backup. If you back up the private key, the cmdlet writes the private key to a .p12 file in the Database subdirectory in the path that you specify.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

SwitchParameter

SecureString

Outputs

Void