external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Sets the domain settings for the current RMADFE project.
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>]
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>]
This cmdlet sets the domain settings for the current RMADFE project.
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.
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.
$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.
$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.
$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.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Sets global settings for recovery projects.
Set-RMADFEGlobalOptions [[-SmtpServer] <String>] [[-SmtpPort] <Int32>] [[-SmtpUserName] <String>]
[[-SmtpUserPassword] <SecureString>] [[-FromAddress] <String>] [[-ToAddress] <String>]
[[-SendVerifyNotification] <Boolean>] [[-SendRecoveryNotification] <Boolean>] [[-SmtpEnableSsl] <Boolean>]
[[-SmtpAuthRequired] <Boolean>] [[-CustomDriversPath] <String>] [[-AgentOperationAbortTimeout] <UInt32>]
[-Save] [<CommonParameters>]
Sets global settings that will be applied to all recovery projects by default.
PS C:\> Set-RMADFEGlobalOptions -SmtpServer "server" -SmtpPort 587 -SmtpEnableSsl $true -FromAddress "from@domain.com" -ToAddress "to@domain.com" -SmtpAuthRequired $true -SmtpUserName "username" -SmtpUserPassword "password"
This command applies the specified settings to the configuration.
PS C:\> Set-RMADFEGlobalOptions -FromAddress "from@domain.com" -ToAddress "to@domain.com" -Save
This command applies the specified settings to the configuration and saves the updated settings to the file.
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
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
Specifies the sender of email notifications.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
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
Indicates whether a SMTP server requires authentication.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether Secure Sockets Layer (SSL) is used to encrypt the connection with SMTP server.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the SMTP server port.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the address of the SMTP server.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the name of the SMTP server.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the password that is used to access the SMTP server.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Sets persistence connection settings.
Set-RMADFEPersistenceConnection [-DataSource] <String> [-Credentials] <PSCredential> [<CommonParameters>]
Set-RMADFEPersistenceConnection [-Disable] [<CommonParameters>]
Set-RMADFEPersistenceConnection [-Enable] [<CommonParameters>]
Set-RMADFEPersistenceConnection [-DataSource] <String> [-IntegratedSecurity] [<CommonParameters>]
Sets persistence connection settings that are used to store the Forest Recovery process state.
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.
PS C:\> Set-RMADFEPersistenceConnection -Disable
Get-RMADFEPersistenceConnection
This command disable persistence connection settings.
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
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
Disables persistence connection
Type: SwitchParameter
Parameter Sets: DisableConnection
Aliases:
Required: True
Position: 0
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Enables persistence connection
Type: SwitchParameter
Parameter Sets: EnableConnection
Aliases:
Required: True
Position: 0
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Sets recovery mode for the current recovery project
Set-RMADFERecoveryMode [-RecoveryMode] <RecoveryMode> [[-ExcludingDomains] <String[]>] [<CommonParameters>]
This cmdlet changes the recovery mode of the recovery project.
PS C:\> Set-RMADFERecoveryMode -RecoveryMode SYSVOLRecovery
Sets up SYSVOL recovery mode on the recovery project
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.
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
Specifies recovery mode which can accept one of the following values:
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center