Chat now with support
Chat mit Support

Recovery Manager for AD Disaster Recovery Edition 10.2.2 - 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 Add-RMADStorageServerException Backup-RMADCollection Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Copy-RMADFEBackup Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFECloudStorageBackup Export-RMADFERecoveryCertificate Export-RMADFEResult Export-RMADSecureStorageBackup 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-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 Get-RMADStorageServerAllowedVolumes Get-RMADStorageServerException Get-RMADStorageServerHardeningStatus Get-RMADStorageServerRetentionPolicy Import-RMADBackup Import-RMADFERecoveryCertificate Install-RMADBackupAgent Install-RMADFERecoveryAgent New-RMADCollection New-RMADFEProject New-RMADFERecoveryMedia New-RMADSchedule Open-RMADFEProject Protect-RMADSecureStorageServer Protect-RMADStorageServer 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-RMADStorageServer Remove-RMADStorageServerException Remove-RMADUnpackedComponent Rename-RMADCollection Restart-RMADFECloudStorageUploadSession Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEDnsCache Set-RMADFEDomain Set-RMADFEGlobalOptions Set-RMADFEPersistenceConnection Set-RMADFERecoveryMode Set-RMADFESchedule Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Set-RMADStorageServerAllowedVolumes Set-RMADStorageServerRetentionPolicy Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADSecureStorageBackup Unprotect-RMADStorageServer 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

QuestSoftware.RecoveryManager.AD.PowerShell.BackupInfo[]

System.Int32[]

System.String

QuestSoftware.RecoveryManager.AD.PowerShell.Cmdlets.StorageServersManagement.StorageServer

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Get-RMADBackup


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

schema: 2.0.0

SYNOPSIS

Gets backups registered with Recovery Manager.

SYNTAX

Id (Default)

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [[-Id] <Int32[]>] [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-AfterModifiedDate <DateTime>] [-First <Int32>]
 [-Skip <Int32>] [-SourceConsole <String>] [<CommonParameters>]

Id_IncludeSecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-Id] <Int32[]> [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-IncludeSecureStorage]
 [-AfterModifiedDate <DateTime>] [-First <Int32>] [-Skip <Int32>] [-SourceConsole <String>]
 [<CommonParameters>]

Id_OnlySecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-Id] <Int32[]> [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-OnlySecureStorage] [-AfterModifiedDate <DateTime>]
 [-First <Int32>] [-Skip <Int32>] [-SourceConsole <String>] [<CommonParameters>]

Guid

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [[-Guid] <Guid[]>] [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-AfterModifiedDate <DateTime>] [-First <Int32>]
 [-Skip <Int32>] [-SourceConsole <String>] [<CommonParameters>]

Guid_IncludeSecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-Guid] <Guid[]> [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-IncludeSecureStorage]
 [-AfterModifiedDate <DateTime>] [-First <Int32>] [-Skip <Int32>] [-SourceConsole <String>]
 [<CommonParameters>]

Guid_OnlySecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-Guid] <Guid[]> [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-OnlySecureStorage] [-AfterModifiedDate <DateTime>]
 [-First <Int32>] [-Skip <Int32>] [-SourceConsole <String>] [<CommonParameters>]

IncludeSecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-ComputerName <String>] [-MaxDate <DateTime>]
 [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>] [-BackupComponents <BackupComponents>]
 [-IncludeDeleted] [-IncludeSecureStorage] [-AfterModifiedDate <DateTime>] [-First <Int32>] [-Skip <Int32>]
 [-SourceConsole <String>] [<CommonParameters>]

OnlySecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-ComputerName <String>] [-MaxDate <DateTime>]
 [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>] [-BackupComponents <BackupComponents>]
 [-IncludeDeleted] [-OnlySecureStorage] [-AfterModifiedDate <DateTime>] [-First <Int32>] [-Skip <Int32>]
 [-SourceConsole <String>] [<CommonParameters>]

DESCRIPTION

Retrieves the backup object for the backups registered in the Recovery Manager backup registration database.

EXAMPLES

Example 1

PS C:\> Get-RMADBackup | Where-Object {$_.ComputerName -eq "dc1.dom1.local"}

This command retrieves all backup objects and passes them to the Where-Object cmdlet.
The Where-Object cmdlet outputs the backup objects whose ComputerName property value is dc1.dom1.local.

Example 2

PS C:\> Get-RMADBackup -Id 12345

Retrieves the backup whose identifier is 12345.

Example 3

PS C:\> Get-RMADBackup | Where-Object {($_.Date -gt (Get-Date).AddDays(-5)) -and ($_.Path -like "*Toronto*")}

This command retrieves objects that represent backups created by Recovery Manager for Active Directory in the last 5 days.
The command retrieves only those backups whose file path includes the word "Toronto".

Example 4

PS C:\> Get-RMADBackup -Skip 10 -First 100

This command skips the first 10 backups and starts retrieving 100 backups from the 11th one.

PARAMETERS

-AfterModifiedDate

Retrieves the backup objects that were last modified after this date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-All

When this parameter is present, the cmdlet gets all backup objects registered in the Recovery Manager backup registration database, including those whose file is physically missing.
When this parameter is omitted, the cmdlet gets only those backup objects registered in the Recovery Manager backup registration database whose file is physically present.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BackupComponents

Retrieves the backup objects with the specified components only.
If this parameter is not specified, all backup objects are retrieved from the Recovery Manager backup registration database.

Type: BackupComponents
Parameter Sets: (All)
Aliases:
Accepted values: None, ActiveDirectory, Adam, BootFiles, CertificateServer, ClusterQuorum, EnterpriseServices, ForestRecoveryMetadata, GroupMembership, IisMetabase, PerformanceCounters, Registry, CryptoKeys, All

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

-CollectionId

Retrieves the backup objects for the specified collection only.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ComputerName

Retrieves the backup objects from the specified computer only.

Type: String
Parameter Sets: (All)
Aliases:

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

-Domain

Retrieves the backup objects for the specified domain only.
If this parameter is not specified, all backup objects are retrieved from the Recovery Manager backup registration database.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Guid

Specifies the GUID of the backup to get.

Type: Guid[]
Parameter Sets: Guid
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Guid[]
Parameter Sets: Guid_IncludeSecureStorage, Guid_OnlySecureStorage
Aliases:

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

-Id

Specifies the identifier of the backup to get.

Type: Int32[]
Parameter Sets: Id
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Int32[]
Parameter Sets: Id_IncludeSecureStorage, Id_OnlySecureStorage
Aliases:

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

-IncludeDeleted

When this parameter is present, the cmdlet gets all backup objects from the Recovery Manager backup registration database, including those objects whose status has been marked as Deleted or Unregistered.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-IncludeSecureStorage

When this parameter is present, the cmdlet gets all backup objects from the Recovery Manager backup registration database, including backups stored on Secure Storage servers.

Type: SwitchParameter
Parameter Sets: Id_IncludeSecureStorage, Guid_IncludeSecureStorage
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: IncludeSecureStorage
Aliases:

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

-MaxDate

Retrieves the backup objects after the specified date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-MinDate

Retrieves the backup objects before the specified date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-MinimumId

Retrieves backups with identifier greater than a specified number.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-OnlySecureStorage

Return backups stored on a Secure Storage servers.

Type: SwitchParameter
Parameter Sets: Id_OnlySecureStorage, Guid_OnlySecureStorage
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: OnlySecureStorage
Aliases:

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

-Site

Retrieves the backup objects from the specified AD site

Type: String
Parameter Sets: (All)
Aliases:

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

-SourceConsole

Retrieves backups replicated from a specified console.

Type: String
Parameter Sets: (All)
Aliases:

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

-Skip

Specifies the number of backups to skip before starting retrieving.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-First

Specifies the number of backups to retrieve.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
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

 

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen