Chat now with support
Chat with Support

Recovery Manager for AD Disaster Recovery Edition 10.3 - 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 Backup-RMADFEConsoleConfiguration Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Copy-RMADFEBackup 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-RMADFEConsoleConfigurationProjectFiles 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-RMADFEConsoleConfiguration Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEConsoleConfigurationBackupSchedule Set-RMADFEConsoleConfigurationProjectFiles 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-RMADBackup Test-RMADSecureStorageBackup Unprotect-RMADStorageServer Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Copy-RMADFEBackup

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

schema: 2.0.0

SYNOPSIS

Copies a backup from a local storage or a network share to the secure storage server.

SYNTAX

Copy-RMADFEBackup -BackupPath <String> [-BackupAccessCredentials <PSCredential>] [-BackupTargetName <String>]
 -StorageServer <String> [-AgentPort <UInt32>] [-AsJob] [-CopyLocalFile] [<CommonParameters>]

DESCRIPTION

Copies a backup from a network share to the secure storage server. Backup is pulled from a network share by an agent running on the secure storage server.

EXAMPLES

Example 1

$credentials = New-Object PSCredential("user", (ConvertTo-SecureString "password" -asPlainText -Force) )
Copy-RMADFEBackup -StorageServer 'storage' -StorageServerBackupPath 'E:\Backups\DC1.rmad.local\2022-09-10 14-54-49.bkf' -BackupPath '\\fr\backupsnew\DC1.rmad.local\2022-09-10 14-54-49.bkf' 
-BackupAccessCredentials $credentials

PARAMETERS

-AgentPort

Secure storage agent port

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-AsJob

Runs the command as a background job.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BackupAccessCredentials

Network credentials to access the backup stored on BackupPath.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-BackupPath

Network path to the backup.

Type: String
Parameter Sets: (All)
Aliases:

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

-BackupTargetName

Alternative name that will be used to save backup on secure storage server.

Type: String
Parameter Sets: (All)
Aliases:

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

-CopyLocalFile

Read file from local storage and send it to secure storage server without using SMB.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-StorageServer

Secure storage name or IP address. Assuming that the Forest Recovery agent is already installed on secure storage server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Create-RMADStorageAgentSetup

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

schema: 2.0.0

SYNOPSIS

Creates storage server agent setup.

SYNTAX

Create-RMADStorageAgentSetup [-Path] <String> [-Port <Int32>] [<CommonParameters>]

DESCRIPTION

Create storage server agent setup bundle packed to the ZIP archive that contains required components to deploy the storage server agent.

EXAMPLES

Example 1

PS C:\> Create-RMADStorageAgentSetup -Path "C:\Setup.zip" -StorageAgentPort 48001

Creates a setup bundle and puts it in the specified file.

PARAMETERS

-Path

Path to the result file in which the setup will be created.

Type: String
Parameter Sets: (All)
Aliases:

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

-Port

Port that will be used to run storage agent on.

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

System.String

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Expand-RMADBackup

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

schema: 2.0.0

SYNOPSIS

Extracts the contents of a specified backup file.

SYNTAX

BackupInfo (Default)

Expand-RMADBackup [-InputObject] <BackupInfo[]> 
[-BackupPassword <SecureString>] [-TargetFolder] <String>
[[-Components] <BackupComponentBits>] [-AsJob] [<CommonParameters>]

Bkf

Expand-RMADBackup [-Path] <String[]> [-BackupPassword <SecureString>]
[-TargetFolder] <String> [[-Components] <BackupComponentBits>] 
[-AsJob] [<CommonParameters>]

Id

Expand-RMADBackup [-Id] <Int32[]> [-BackupPassword <SecureString>] 
[-TargetFolder] <String> [[-Components] <BackupComponentBits>] 
[-AsJob] [<CommonParameters>]

DESCRIPTION

Allows you to selectively extract the contents of a backup file created with Recovery Manager for Active Directory to the location you want.

EXAMPLES

Example 1

PS C:\> Expand-RMADBackup -InputObject (Get-RMADBackup | where {$_.Date -gt (Get-Date).AddDays(-2)}) -TargetFolder 'C:\UnpackedBackups'

This command extracts the contents of all backups created within last two days to the local folder C:\UnpackedBackups.

PARAMETERS

-AsJob

Runs the command as a background job. You can use this parameter to run commands that take a significant time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BackupPassword

If the backup is password-protected, specifies the password to open the backup. The parameter value must be a SecureString object.

Type: SecureString
Parameter Sets: (All)
Aliases: Password

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

-Components

Specifies the backup components you want to extract. When specifying multiple backup components in this parameter, use a comma as a separator. This parameter accepts the following values for backup components:

  • Sam - Specifies to extract the SAM registry hive.
  • Security - Specifies to extract the Security registry hive.
  • Software - Specifies to extract the Software registry hive.
  • System - Specifies to extract the System registry hive.
  • Default - Specifies to extract the Default registry hive.
  • NTUserDat - Specifies to extract the NTUser.dat registry hive.
  • Components - Specifies to extract the Components registry hive.
  • SchemaDat - Specifies to extract the Schema.dat
  • ActiveDirectoryDatabase - Specifies to extract the DIT database.
  • Sysvol - Specifies to extract SYSVOL.
  • EnterpriseServices - Specifies to extract the COM+ Class Registration database.
  • BootFiles - Specifies to extract the boot files.
  • IISMetabase - Specifies to extract IIS metabase.
  • PerformanceCounters - Specifies to extract performance counters.
  • CertificateServer - Specifies to extract certificate server.
  • ClusterQuorum - Specifies to extract the cluster quorum.
  • Adam - Specifies to extract all instances of AD LDS (ADAM).
  • GroupMembership - Specifies to extract cross-domain group membership information.
  • ActiveDirectory - Specifies to extract the components represented by the following parameters: ActiveDirectoryDatabase and SYSVOL.
  • Registry - Specifies to extract the components represented by the following parameters: Sam, Security, Software, System, Default, NTUserDat, Components, and SchemaDat.

Type: BackupComponentBits
Parameter Sets: (All)
Aliases:
Accepted values: Sam, Security, Software, System, Default, NTUserDat, ActiveDirectoryDatabase, Sysvol, ActiveDirectory, EnterpriseServices, BootFiles, SystemProtectedFiles, BootIni, CertificateServer, IisMetabase, PerformanceCounters, ClusterQuorum, Adam, GroupMembership, BootFilesExt, CryptoKeys, ForestRecoveryMetadata, Components, SchemaDat, Registry, VirtualImage, HardLinks

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

-Id

Specifies the identifier of the backup you want to extract.

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: BackupInfo
Aliases:

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

-Path

Path to the backup file.

Type: String[]
Parameter Sets: Bkf
Aliases: FullName

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

-TargetFolder

Specifies the target folder to which you want to extract the backup.

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-RMADBackup

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

schema: 2.0.0

SYNOPSIS

Exports registration information for a backup into an .xml file.

SYNTAX

InputObject

Export-RMADBackup [-InputObject] <BackupInfo[]> [-Path] <String> [-PassThru] [<CommonParameters>]

Id

Export-RMADBackup [-Id] <Int32[]> [-Path] <String> [-PassThru] [<CommonParameters>]

DESCRIPTION

This cmdlet exports the registration information for the specified backup into an .xml file. You can then use the Import-RMADBackup cmdlet to transform the registration information saved in the .xml file into an object.

EXAMPLES

Example 1

PS C:\> $b = Get-RMADBackup
Export-RMADBackup -Path Backups.xml -InputObject $b

Exports registration information for all backups registered in the Recovery Manager for Active Directory backup registration database located on the computer where you are using this cmdlet. The backup registration information is saved in the Backups.xml file.

Example 2

PS C:\> Export-RMADBAckup -Id 1 -Path C:\ExportedBackups

Exports the registration information of the backup whose ID 1 to an XML file in the folder C:\ExportedBackups.

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: False
Accept pipeline input: False
Accept wildcard characters: False

-Path

Specifies the path to the .xml file where you want to save registration information for the backup.

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating