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


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

schema: 2.0.0

SYNOPSIS

Gets global application settings.

SYNTAX

Get-RMADFEGlobalOptions [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

Retrieves global settings that are applied to all recovery projects by default.

EXAMPLES

Example 1

PS C:\> Get-RMADFEGlobalOptions -Name "SMTPServer"

This command returns the address of SMTP server.

PARAMETERS

-Name

Specifies the name of the parameter whose value will be returned by the command.

Type: String
Parameter Sets: (All)
Aliases:

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

 

Get-RMADFEOperation


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

schema: 2.0.0

SYNOPSIS

Returns information about the progress of the recovery operations.

SYNTAX

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

DESCRIPTION

This cmdlet shows progress information for the recovery stages and steps that are applicable to the selected domain controller.

EXAMPLES

EXAMPLE 1

PS C:\> Get-RMADFEOperation -ComputerName DC1.rmad.local

This command gets the errors that occurred during the recovery session.

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

 

Get-RMADFEPersistenceConnection


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

schema: 2.0.0

SYNOPSIS

Gets persistence connection settings.

SYNTAX

Get-RMADFEPersistenceConnection [<CommonParameters>]

DESCRIPTION

Retrieves persistence connection settings that are used to store the state of Forest Recovery process.

EXAMPLES

Example 1

PS C:\> $creds = new-object PSCredential("sa",  (ConvertTo-SecureString 'Password' -asPlainText -Force))
Set-RMADFEPersistenceConnection -DataSource "ws\SQLExpress" -Credentials $creds 
Set-RMADFEPersistenceConnection -Enable
Get-RMADFEPersistenceConnection

This command retrieves persistence connection settings that are used to store the state of the Forest Recovery process.

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

OUTPUTS

NOTES

RELATED LINKS

 

Get-RMADFEProject


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

schema: 2.0.0

SYNOPSIS

Gets the current status of the RMADFE project.

SYNTAX

Get-RMADFEProject [-ProjectInfo] [<CommonParameters>]

DESCRIPTION

This cmdlet gets the current status of the RMADFE project.

EXAMPLES

EXAMPLE 1

PS C:\> Get-RMADFEProject | Format-List *

This command gets the current status of the RMADFE project.

PARAMETERS

-ProjectInfo

Specifies to return special project information container

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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