Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Backup-CARoleService

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows 8.1 Preview, Windows PowerShell 4.0, Windows Server 2012 R2

Backup-CARoleService

Backs up the CA database and private key information.

Syntax

Parameter Set: All
Backup-CARoleService [-Path] <String> [-Force] [-Incremental] [-KeepLog] [-Password <SecureString> ] [ <CommonParameters>]

Parameter Set: Database
Backup-CARoleService [-Path] <String> -DatabaseOnly [-Force] [-Incremental] [-KeepLog] [ <CommonParameters>]

Parameter Set: Key
Backup-CARoleService [-Path] <String> -KeyOnly [-Force] [-Password <SecureString> ] [ <CommonParameters>]




Detailed Description

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

Parameters

-DatabaseOnly

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Force

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Incremental

Indicates that the cmdlet performs incremental database back up.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-KeepLog

Indicates that the cmdlet does not truncate database logs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-KeyOnly

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Password<SecureString>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Path<String>

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.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

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

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


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

Example 2: Back up the CA database only

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


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

Example 3: Back up the CA key only

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


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

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.