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

Set-RMADFEDomain


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

schema: 2.0.0

SYNOPSIS

Sets the domain settings for the current RMADFE project.

SYNTAX

AnyParameters (Default)

Set-RMADFEDomain [-Domain] <String> [-Recover <Boolean>] [-AuthoritativeSysvolRestoreComputer <String>]
 [-ResetPasswords <Boolean>] [-Groups <System.Collections.Generic.List`1[System.String]>]
 [-Exclusions <System.Collections.Generic.List`1[System.String]>] [-PerformMalwareScan <Boolean>]
 [-DsrmPause <Boolean>] [-RunDsrmScriptAction <RunScriptDsrmAction>]
 [-QuarantineSysvolFilesAction <QuarantineFilesDsrmAction>]
 [-DoNotRecoverSysvolFilesAction <DoNotRecoverFilesDsrmAction>] [<CommonParameters>]

IncludeCredentials

Set-RMADFEDomain [-Domain] <String> [-Recover <Boolean>] [-AuthoritativeSysvolRestoreComputer <String>]
 -DcCredential <PSCredential> -DsrmCredential <PSCredential> -LocalCredential <PSCredential>
 [-ResetPasswords <Boolean>] [-Groups <System.Collections.Generic.List`1[System.String]>]
 [-Exclusions <System.Collections.Generic.List`1[System.String]>] [-PerformMalwareScan <Boolean>]
 [-DsrmPause <Boolean>] [-RunDsrmScriptAction <RunScriptDsrmAction>]
 [-QuarantineSysvolFilesAction <QuarantineFilesDsrmAction>]
 [-DoNotRecoverSysvolFilesAction <DoNotRecoverFilesDsrmAction>] [<CommonParameters>]

DESCRIPTION

This cmdlet sets the domain settings for the current RMADFE project.

EXAMPLES

EXAMPLE 1

PS C:\> $dcCreds = Get-Credential
$dsrmCreds = Get-Credential

Set-RMADFEDomain -Domain acme.com -Recover $true -AuthoritativeSysvolRestoreComputer dc1.acme.com -DcCredential $dcCreds -DsrmCredential $dsrmCreds

This command applies the domain settings to the acme.com domain.

EXAMPLE 2

Set-RMADFEDomain acme.com -ResetPasswords $true -Groups Group_A, Group_B, Group_C -Exclusions User_01, User_02

This command enables password resetting for domain users in the following privileged groups: Group_A, Group_B, and Group_C in the domain acme.com, except User_01 and User_02.

EXAMPLE 3

$action = (Get-RMADFEDomain -Domain acme.com).QuarantineSysvolFilesAction
$action.IsEnabled = $true
$action.MaliciousFiles = $false
$action.SpecifiedFiles = $true
$action.Filters = @("*.exe")
$action.Exclusions = @("*\scripts\config\setup\*")
$action.RenameFiles = $true
$action.RenameSuffix = "_INFECTED"
$action.MoveFiles = $false
Set-RMADFEDomain -Domain acme.com -QuarantineSysvolFiles $action

This command configures an action for domain acme.com to rename files with extension .exe in SYSVOL, except for files located in folder \scripts\config\setup.

EXAMPLE 4

$action = (Get-RMADFEDomain -Domain acme.com).DoNotRecoverSysvolFilesAction
$action.IsEnabled = $true
$action.MaliciousFiles = $true
$action.SpecifiedFiles = $false
Set-RMADFEDomain -Domain acme.com -DoNotRecoverSysvolFiles $action

This command configures an action for domain acme.com to skip restoring files in SYSVOL that were identified as malicious during an antivirus scan.

EXAMPLE 5

$action = (Get-RMADFEDomain -Domain acme.com).RunDsrmScriptAction
$action.IsEnabled = $true
$action.Script = Get-Content "C:\Scripts\ProcessSysvolFiles.ps1"
Set-RMADFEDomain -Domain acme.com -RunDsrmScriptAction $action

This command configures a PowerShell® script for domain acme.com to run in DSRM after restoring domain controllers from a backup.

PARAMETERS

-AuthoritativeSysvolRestoreComputer

This option allows you to configure the domain controller where the authoritative restore of SYSVOL will be performed.

Type: String
Parameter Sets: (All)
Aliases:

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

-DcCredential

Specifies the user name and the password with which you want Recovery Manager for Active Directory Forest Edition to access domain controllers in the selected domain in the Normal mode. Use the Get-Credential cmdlet provided by Windows PowerShell® to get the PSCredential object representing user credentials.

Type: PSCredential
Parameter Sets: IncludeCredentials
Aliases:

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

-Domain

Specifies the fully qualified domain name.

Type: String
Parameter Sets: (All)
Aliases:

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

-DoNotRecoverSysvolFilesAction

Specifies which SYSVOL files should not be recovered when restoring data from a backup.

Type: DoNotRecoverFilesDsrmAction
Parameter Sets: (All)
Aliases:

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

-DsrmCredential

Specifies the user name and the password with which you want Recovery Manager for Active Directory Forest Edition to access domain controllers in the selected domain in Directory Services Restore Mode (DSRM). Use the Get-Credential cmdlet provided by Windows PowerShell® to get the PSCredential object representing user credentials.

Type: PSCredential
Parameter Sets: IncludeCredentials
Aliases:

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

-DsrmPause

Specifies if the recovery process must be paused in DSRM to perform additional actions before rebooting to normal mode.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Exclusions

This parameter specifies one or more users (separated by commas). By default, only the domain administrator configured in your project settings is excluded from password resetting. When this parameter is specified, both the administrator and the specified user(s) are excluded.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases:

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

-Groups

This parameter specifies one or more groups of users (separated by commas). When this parameter is specified, this command ONLY resets the password for the specified groups of users in the domain instead of the predefined administrative accounts.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases:

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

-LocalCredential

Specifies local credentials for the machine.

Type: PSCredential
Parameter Sets: IncludeCredentials
Aliases:

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

-PerformMalwareScan

Specifies if the backup must be scanned with Microsoft Defender Antivirus during project verification.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-QuarantineSysvolFilesAction

Specifies which SYSVOL files should be quarantined when restoring data from a backup.

Type: QuarantineFilesDsrmAction
Parameter Sets: (All)
Aliases:

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

-Recover

This option lets you include the domain into or exclude the domain from the current RMADFE project.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-ResetPasswords

This parameter resets the password for administrative accounts in the domain during forest recovery, including members of Enterprise Admins, Domain Admins, Administrators, Account Operators, Schema Admins, Group Policy Creator Owners, Backup Operators, Server Operators, and Print Operators.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RunDsrmScriptAction

Specifies a PowerShell script to run on a domain controller after restoring Active Directory data from a backup.

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

 

Set-RMADFEGlobalOptions


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

schema: 2.0.0

SYNOPSIS

Sets global settings for recovery projects.

SYNTAX

Set-RMADFEGlobalOptions [[-ToAddress] <String>] [[-SendVerifyNotification] <Boolean>]
 [[-SendRecoveryNotification] <Boolean>] [[-CustomDriversPath] <String>]
 [[-AgentOperationAbortTimeout] <UInt32>] [[-FRPasswordComplexity] <String>] [[-FRPasswordLength] <Int32>]
 [-CheckBackupIntegrity <Boolean>] [-EnableSecureBootForVMs <Boolean>] [-Save] [<CommonParameters>]

DESCRIPTION

Sets global settings that will be applied to all recovery projects by default.

EXAMPLES

Example 1

PS C:\> Set-RMADFEGlobalOptions -ToAddress "to@domain.com" -SendVerifyNotification $true -SendRecoveryNotification $true

This command applies the specified settings to the configuration.

Example 2

PS C:\> Set-RMADFEGlobalOptions -ToAddress "to@domain.com" -Save

This command applies the specified settings to the configuration and saves the updated settings to the file.

Example 3

PS C:\> Set-RMADFEGlobalOptions -Save -FRPasswordComplexity "IncludeDigits,IncludeLowerCase" -FRPasswordLength "8"

This command applies the specified settings to the Password requirements options to the Backup and Restore of the configuration file for Forest Recovery projects.

PARAMETERS

-AgentOperationAbortTimeout

Specifies the path of a custom driver that you want to add to the Quest Recovery Environment image.

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-CheckBackupIntegrity

Enables automatic integrity check after a backup is created.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-CustomDriversPath

Specifies the path to the Quest Recovery Environment image.

Type: String
Parameter Sets: (All)
Aliases:

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

-EnableSecureBootForVMs

Specifies if Hyper-V and VMWare virtual machines will be created with secure boot enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-FRPasswordComplexity

Password complexity is set via flags with the following parameters. To use multiple flags, they must be delimited by a "," (comma).

  • IncludeDigits
  • IncludeLowerCase
  • IncludeUpperCase
  • IncludeSpecialCharacters
  • None


Type: String
Parameter Sets: (All)
Aliases:

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

-FRPasswordLength

Changes the minimum required password. The password length cannot be 0 and will default to 1.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Save

Saves the global settings to the file.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-SendRecoveryNotification

Indicates whether the email notification option is enabled for the restore process.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-SendVerifyNotification

Indicates whether the email notification option is enabled for the verification process.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-ToAddress

Specifies the recipient of email notifications.

Type: String
Parameter Sets: (All)
Aliases:

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

 

Set-RMADFEPersistenceConnection


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

schema: 2.0.0

SYNOPSIS

Sets persistence connection settings.

SYNTAX

MSSQLSecurity (Default)

Set-RMADFEPersistenceConnection [-DataSource] <String> [-Credentials] <PSCredential> [<CommonParameters>]

DisableConnection

Set-RMADFEPersistenceConnection [-Disable] [<CommonParameters>]

EnableConnection

Set-RMADFEPersistenceConnection [-Enable] [<CommonParameters>]

IntegratedSecurity

Set-RMADFEPersistenceConnection [-DataSource] <String> [-IntegratedSecurity] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

Example 1

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

This command sets persistence connection settings.

Example 2

PS C:\> Set-RMADFEPersistenceConnection -Disable
Get-RMADFEPersistenceConnection

This command disable persistence connection settings.

PARAMETERS

-Credentials

Specifies MS SQL security credentials

Type: PSCredential
Parameter Sets: MSSQLSecurity
Aliases:

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

-DataSource

Specifies MS SQL instance

Type: String
Parameter Sets: MSSQLSecurity, IntegratedSecurity
Aliases:

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

-Disable

Disables persistence connection

Type: SwitchParameter
Parameter Sets: DisableConnection
Aliases:

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

-Enable

Enables persistence connection

Type: SwitchParameter
Parameter Sets: EnableConnection
Aliases:

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

-IntegratedSecurity

Enable Windows Authentication using

Type: SwitchParameter
Parameter Sets: IntegratedSecurity
Aliases:

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

 

Set-RMADFERecoveryMode


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

schema: 2.0.0

SYNOPSIS

Sets recovery mode for the current recovery project

SYNTAX

Set-RMADFERecoveryMode [-RecoveryMode] <RecoveryMode> [[-ExcludingDomains] <String[]>] [<CommonParameters>]

DESCRIPTION

This cmdlet changes the recovery mode of the recovery project.

EXAMPLES

Example 1

PS C:\> Set-RMADFERecoveryMode -RecoveryMode SYSVOLRecovery

Sets up SYSVOL recovery mode on the recovery project

Example 2

PS C:\> Set-RMADFERecoveryMode -RecoveryMode DomainRecovery -ExcludingDomains @("domain1", "domain2")

Sets up Domain recovery mode on the recovery project and exclude "domain1" and "domain2" from recovering.

PARAMETERS

-ExcludingDomains

Specifies domains that must not be recovered when DomainRecovery mode selected.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-RecoveryMode

Specifies recovery mode which can accept one of the following values:

  1. ForestRecovery - complete forest recovery mode
  2. DomainRecovery - recover selected domains only
  3. SYSVOLRecovery - recover SYSVOL only
  4. Repromotion - recover domain controllers that were not recovered in previous recovery sessions

Type: RecoveryMode
Parameter Sets: (All)
Aliases:
Accepted values: ForestRecovery, DomainRecovery, SYSVOLRecovery, Repromotion

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating