Chat now with support
Chat with Support

NOTICE! We are upgrading our support telephone services, implementing Genesys, starting the week of May 19, 2025

Recovery Manager for AD Forest 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 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 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-RMADStorageServer 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 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

Get-RMADFEConsoleConfigurationProjectFiles

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

schema: 2.0.0

SYNOPSIS

Returns Forest Recovery project files.

SYNTAX

Get-RMADFEConsoleConfigurationProjectFiles [<CommonParameters>]

DESCRIPTION

Returns Forest Recovery project files that are set to be backed up.

EXAMPLES

Example 1

PS C:\> Get-RMADFEConsoleConfigurationProjectFiles

Returns currently set Forest Recovery project files paths.

PARAMETERS

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

 

Get-RMADFEDnsCache

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

schema: 2.0.0

SYNOPSIS

Returns cached DNS records in the Forest Recovery project.

SYNTAX

Get-RMADFEDnsCache [<CommonParameters>]

DESCRIPTION

This cmdlet returns a list of DNS records saved in the Forest Recovery project.

EXAMPLES

Example 1

PS C:\> Get-RMADFEDnsCache

This command returns a list of DNS records saved in the Forest Recovery project.

PARAMETERS

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

 

Get-RMADFEDomain

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

schema: 2.0.0

SYNOPSIS

Retrieves the domain settings.

SYNTAX

Get-RMADFEDomain [-Domain <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet gets the domain settings for one or more domains from the RMADFE project. By default, this cmdlet retrieves the following information for each domain:

  • Domain Name
  • User Name
  • DSRM User Name
  • Password Resetting
  • Advanced Actions

EXAMPLES

EXAMPLE 1

PS C:\> Get-RMADFEDomain -Domain acme.com

Domain                             : acme.com
Recover                            : True
AuthoritativeSysvolRestoreComputer : dc1.acme.com
UserName                           : Administrator
DsrmUserName                       : Administrator
ResetPasswords                     : False
Groups                             : {}
Exclusions                         : {}
PerformMalwareScan                 : False
DsrmPause                          : False
RunDsrmScriptAction                : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.RunScriptDsrmAction
QuarantineSysvolFilesAction        : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.QuarantineFilesDsrmAction
DoNotRecoverSysvolFilesAction      : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.DoNotRecoverFilesDsrmAction

This command retrieves the domain settings for the specified domain.

EXAMPLE 2

PS C:\> Get-RMADFEDomain

Domain                             : acme.com
Recover                            : True
AuthoritativeSysvolRestoreComputer : dc1.acme.com
UserName                           : Administrator
DsrmUserName                       : Administrator
ResetPasswords                     : False
Groups                             : {}
Exclusions                         : {}
PerformMalwareScan                 : False
DsrmPause                          : False
RunDsrmScriptAction                : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.RunScriptDsrmAction
QuarantineSysvolFilesAction        : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.QuarantineFilesDsrmAction
DoNotRecoverSysvolFilesAction      : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.DoNotRecoverFilesDsrmAction

Domain                             : child.acme.com
Recover                            : True
AuthoritativeSysvolRestoreComputer : 
UserName                           : 
DsrmUserName                       : 
ResetPasswords                     : True
Groups                             : {}
Exclusions                         : {}
PerformMalwareScan                 : True
DsrmPause                          : False
RunDsrmScriptAction                : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.RunScriptDsrmAction
QuarantineSysvolFilesAction        : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.QuarantineFilesDsrmAction
DoNotRecoverSysvolFilesAction      : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.DoNotRecoverFilesDsrmAction

Domain                             : resource.acme.com
Recover                            : True
AuthoritativeSysvolRestoreComputer : dc1.acme.com
UserName                           : 
DsrmUserName                       : 
ResetPasswords                     : True
Groups                             : {Group_A, Group_B, Group_C}
Exclusions                         : {User_01, User_02}
PerformMalwareScan                 : True
DsrmPause                          : True
RunDsrmScriptAction                : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.RunScriptDsrmAction
QuarantineSysvolFilesAction        : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.QuarantineFilesDsrmAction
DoNotRecoverSysvolFilesAction      : QuestSoftware.RecoveryManager.AD.ForestRecovery.Project.DoNotRecoverFilesDsrmAction

This command retrieves information about all domains from the current RMADFE project.

PARAMETERS

-Domain

Specifies the fully qualified domain name.

Type: String
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

 

Get-RMADFEEvent

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

schema: 2.0.0

SYNOPSIS

Returns recovery events related to the entire Active Directory forest or a specific domain controller.

SYNTAX

Get-RMADFEEvent [[-ComputerName] <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet returns recovery events related to the entire Active Directory forest or a specific domain controller.

EXAMPLES

EXAMPLE 1

PS C:\> Get-RMADFEEvent -ComputerName dc5.child.acme.test | select -ExpandProperty EventDescription | Format-Table EventKind,EventMessage,MessageCode

This command returns a list of recovery events related to dc5.child.acme.test.

PARAMETERS

-ComputerName

Specifies the fully qualified domain name of the computer.

Type: String
Parameter Sets: (All)
Aliases:

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating