Site icon TOSS

Backup-CARoleService

Karthik S
powershell

Backup-CARoleService is accessible with the help of adcsadministration module.

Synopsis
Backs up the CA database and private key information.

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.

-DatabaseOnly 
         Indicates that the cmdlet backs up only the certification authority database.
    Required?                    true
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

-Force <SwitchParameter>
    Forces the command to run without asking for user confirmation.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

-Incremental <SwitchParameter>
    Indicates that the cmdlet performs incremental database back up.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

-KeepLog <SwitchParameter>
    Indicates that the cmdlet does not truncate database logs.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

-KeyOnly <SwitchParameter>
    Indicates that the cmdlet backs up only the CA private key and certificate.

    Required?                    true
    Position?                    named
    Default value                
    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.

    Required?                    false
    Position?                    named
    Default value                
    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.

    Required?                    true
    Position?                    2
    Default value                
    Accept pipeline input?       True (ByValue, ByPropertyName)
    Accept wildcard characters?  false

Syntax

Backup-CARoleService [-Path]  [-Force ] [-Incremental ] [-KeepLog ] -DatabaseOnly  []

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

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

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.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Backup-CARoleService

You can also read about
Restore-CARoleService

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft

Exit mobile version