Edit

Share via


Backup-CARoleService

Backs up the CA database and private key information.

Syntax

Key

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

Database

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

All

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.

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

-Incremental

Indicates that the cmdlet performs incremental database back up.

Parameter properties

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

Parameter sets

Database
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

-KeepLog

Indicates that the cmdlet does not truncate database logs.

Parameter properties

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

Parameter sets

Database
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

-KeyOnly

Indicates that the cmdlet backs up only the CA 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 protect 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 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.

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

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