Chat now with support
Chat with Support

Recovery Manager for AD Forest Edition 10.3.1 - Management Shell Guide

Overview
About Management Shell Installing and opening Management Shell Getting Help Descriptions of PowerShell Commands
Add-RMADBackup Add-RMADCollectionItem Add-RMADFECloudStorage Add-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Backup-RMADFEConsoleConfiguration Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFECloudStorageBackup Export-RMADFECloudStorageServers Export-RMADFERecoveryCertificate Export-RMADFEResult Export-RMADSecureStorageBackup Export-RMADStorageServers Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject Get-RMADFEAvailableSubnet Get-RMADFECloudStorage Get-RMADFECloudStorageCollection Get-RMADFECloudStorageUploadSession Get-RMADFEComputer Get-RMADFEConsole Get-RMADFEConsoleConfigurationBackupSchedule Get-RMADFEDnsCache Get-RMADFEDomain Get-RMADFEEvent Get-RMADFEGlobalOptions Get-RMADFEOperation Get-RMADFEPersistenceConnection Get-RMADFEProject Get-RMADFERecoveryAgent Get-RMADFESchedule Get-RMADGlobalOptions Get-RMADHybridRecoveryDomainOptions Get-RMADHybridRecoveryOptions Get-RMADLicenseInfo Get-RMADObject Get-RMADReplicationConsole Get-RMADReplicationSchedule Get-RMADReplicationSession Get-RMADReplicationSessionItem Get-RMADReportObject Get-RMADReportObjectAttributes Get-RMADReportObjectChildren Get-RMADReportSession Get-RMADSession Get-RMADSessionItem Get-RMADSessionItemEvent Get-RMADStorageServer Import-RMADBackup Import-RMADFERecoveryCertificate Install-RMADBackupAgent Install-RMADFERecoveryAgent New-RMADCollection New-RMADFEProject New-RMADFERecoveryMedia New-RMADSchedule Open-RMADFEProject Protect-RMADSecureStorageServer Publish-RMADBackupSecurityStatus Refresh-RMADStorageServer Register-RMADSecureStorageBackups Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADFECloudStorage Remove-RMADFECloudStorageUploadSession Remove-RMADFERecoveryAgent Remove-RMADFESchedule Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADSession Remove-RMADStorageServer Remove-RMADUnpackedComponent Rename-RMADCollection Restart-RMADFECloudStorageUploadSession Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADFEConsoleConfiguration Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Send-RMADFEBackupToSecureStorage Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEConsoleConfigurationBackupSchedule Set-RMADFEDnsCache Set-RMADFEDomain Set-RMADFEGlobalOptions Set-RMADFEPersistenceConnection Set-RMADFERecoveryMode Set-RMADFESchedule Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Export-RMADFERecoveryCertificate


external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:

schema: 2.0.0

SYNOPSIS

Exports Forest Recovery certificates.

SYNTAX

Export-RMADFERecoveryCertificate [-Path] <String> [-Password] <SecureString> [<CommonParameters>]

DESCRIPTION

This cmdlet exports Forest Recovery certificates to the specified location. You must also supply the password that is used to protect the certificates.

EXAMPLES

EXAMPLE 1

PS C:\> Export-RMADFERecoveryCertificate -Path C:\Certificates\RMADFeCertificates.pfx" -Password (ConvertTo-SecureString "protection password" -AsPlainText -Force)

This command exports Forest Recovery certificates to the specified location.

PARAMETERS

-Password

Specifies the password that is used to protect the Forest Recovery certificates.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-Path

Specifies the full path to the Forest Recovery certificate file.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Export-RMADFEResult


external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:

schema: 2.0.0

SYNOPSIS

Export the verification result of an RMADFE project.

SYNTAX

Export-RMADFEResult [-Results] <ProjectSummary> [-Path] <String> [[-FileType] <ExportFileType>]
 [<CommonParameters>]

DESCRIPTION

This cmdlet exports results after verifying all the domain controllers in a recovery project.To export the verification result, get the current status of the RMADFE project first, and then specify the file path and format to save the results of export file.

EXAMPLES

Example 1

PS C:\> Open-RMADFEProject -Path C:\RMADFeProjects\SampleProject.frproj 
-Password (ConvertTo-SecureString "project password" -AsPlainText -Force)
Start-RMADFEVerification
$results = Get-RMADFEProject

Export-RMADFEResult -Results $results -Path "C:\result.xml"

Export-RMADFEResult -Results $results -Path "C:\result.html" -FileType Html

This example illustrates how to export verification results to an XML file and an HTML file. The first line of this example gets the current status of the RMADFE project. The second line of this example exports the verification results to an XML and the file path is c:\result.xml. The third line of this example exports the verification results to an HTML file and the file path is c:\result.html.

Example 2

PS C:\> Open-RMADFEProject -Path C:\RMADFeProjects\SampleProject.frproj 
-Password (ConvertTo-SecureString "project password" -AsPlainText -Force)
Start-RMADFEVerification

Get-RMADFEProject | Export-RMADFEResult -Path "c:\result.xml"

Get-RMADFEProject | Export-RMADFEResult -Path "c:\result.htm" -FileType Html

This example illustrates how to export verification results with the pipeline. The first line of this example exports verification results to an XML file and saves it to c:\result.xml with the pipeline. The second line of this example exports verification results to an HTML file and saves it to c:\result.html with the pipeline.

PARAMETERS

-FileType

Specifies the format of the exported file.
Default format is XML.

Type: ExportFileType
Parameter Sets: (All)
Aliases:
Accepted values: Xml, Html, Txt, Csv

Required: False
Position: 2
Default value: Xml
Accept pipeline input: False
Accept wildcard characters: False

-Path

Specifies the path to save the results.

Type: String
Parameter Sets: (All)
Aliases:

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

-Results

Specifies the current status of the RMADFE project.

Type: ProjectSummary
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Export-RMADSecureStorageBackup


external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:

schema: 2.0.0

SYNOPSIS

Exports a backup on a Secure Storage server to a remote network share.

SYNTAX

InputObject

Export-RMADSecureStorageBackup [-InputObject] <BackupInfo[]> [-TargetRemoteFolder] <String>
 [-TargetCredentials] <PSCredential> [-PassThru] [<CommonParameters>]

Id

Export-RMADSecureStorageBackup [-Id] <Int32[]> [-TargetRemoteFolder] <String>
 [-TargetCredentials] <PSCredential> [-PassThru] [<CommonParameters>]

DESCRIPTION

Exports a backup on a Secure Storage server to a remote network share.

EXAMPLES

Example 1

$credential = Get-Credential
$backup = Get-RMADBackup -OnlySecureStorage -ComputerName 'dc1.rmad.local' | Select-Object -First 1
Export-RMADSecureStorageBackup -InputObject $backup -TargetRemoteFolder '\\192.168.0.1\BackupsNew\Temp' -TargetCredentials $credential

Example 2

$credential = Get-Credential
Export-RMADSecureStorageBackup -Id @(2, 4, 6) -TargetRemoteFolder '\\192.168.0.1\BackupsNew\Temp' -TargetCredentials $credential

PARAMETERS

-Id

Specifies the identifiers of one or more backups to export. This parameter accepts an array of integers.

Type: Int32[]
Parameter Sets: Id
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InputObject

Accepts a backup object as input to the cmdlet. Enter a variable that contains the object or type a command or expression that gets the object.

Type: BackupInfo[]
Parameter Sets: InputObject
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PassThru

Passes the registration information for the specified backup along the pipeline. If this parameter is omitted, the registration information is not passed along the pipeline.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-TargetCredentials

Credentials to access the target network location.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetRemoteFolder

Remote network share where backup should be exported.

Type: String
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Export-RMADStorageServers


external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:

schema: 2.0.0

SYNOPSIS

Exports secure storage servers in CSV file.

SYNTAX

Export-RMADStorageServers [-Path] <String> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Exports currently registered secure storage servers and their current statuses in CSV file.

EXAMPLES

Example 1

PS C:\> Export-RMADStorageServers -Path C:\SecureStorageServers.csv

Saves all current storage servers to C:\SecureStorageServers.csv file

PARAMETERS

-IgnoreReadOnly

Allows you to perform the action in a console currently performing full replication.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Path

Path to file where to save secure storage servers information.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

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

INPUTS

System.String

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating