Chat now with support
Chat mit 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

Restore-RMADFEConsoleConfiguration


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

schema: 2.0.0

SYNOPSIS

Restores console configuration from backup.

SYNTAX

Restore-RMADFEConsoleConfiguration -Path <String> -Password <SecureString> -ProjectFilesFolder <String>
 [-BackupPath <String>] [-BackupPassword <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Restore console registered backup information, secure storage servers, cloud storages and its upload sessions, console authentication keys and Forest Recovery projects. Optionally this cmdlet also backs up current configuration before restore.

EXAMPLES

Example 1

PS C:\> $password = ConvertTo-SecureString -String "Password01!"
-AsPlainText -Force
PS C:\> Restore-RMADFEConsoleConfiguration -Path "c:\ConsoleConfig.zip"
-Password $password -RecoveryProjectsDirectory C:\ForestRecoveryProjects
-Confirm:$false

Restores console configuration from backup located to BackupServer share with restoring Forest Recovery projects to C:\ForestRecoveryProjects folder.

PARAMETERS

-BackupPassword

Backup password of backup that will be created prior to restore.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-BackupPath

Backup path of backup that will be created prior to restore.

Type: String
Parameter Sets: (All)
Aliases:

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

-Password

Password of backup to restore from.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-Path

Backup path to restore from.

Type: String
Parameter Sets: (All)
Aliases:

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

-ProjectFilesFolder

Path to the directory where Forest Recovery projects will be restored.

Type: String
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Restore-RMADObject


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

schema: 2.0.0

SYNOPSIS

Restores Active Directory objects from a backup.
This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).

SYNTAX

Default (Default)

Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
 [-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
 [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
 [-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>] [-ChangeAuditorDbCredential <PSCredential>]
 [-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
 [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]

Bkf

Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
 [-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
 [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
 [-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>] [-ChangeAuditorDbCredential <PSCredential>]
 [-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
 [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]

ADLds

Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
 [-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
 [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
 [-SQLCredential <PSCredential>] [-AdLds] -AdLdsInstance <String> [-ChangeAuditorDbName <String>]
 [-ChangeAuditorDbCredential <PSCredential>] [-RestoreUsingChangeAuditor] [-Server <String>]
 [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]

Firewall

Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
 [-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
 [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
 [-SQLCredential <PSCredential>] [-AdLds] [-ChangeAuditorDbName <String>]
 [-ChangeAuditorDbCredential <PSCredential>] [-ConfigureFirewall] [-RestoreUsingChangeAuditor]
 [-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
 [<CommonParameters>]

Agentless

Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
 [-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-UseAgentlessMethod] [-ProcessChildren]
 [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
 [-SQLCredential <PSCredential>] [-AdLds] [-ChangeAuditorDbName <String>]
 [-ChangeAuditorDbCredential <PSCredential>] [-RestoreUsingChangeAuditor] [-Server <String>]
 [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Restores the Active Directory objects that have specified parameters from a backup. You can only use this cmdlet when Windows PowerShell is started using MTA. To start Windows PowerShell using MTA, run this command: PowerShell -mta

EXAMPLES

Example 1

PS C:\> $backups = Get-RMADBackup | Sort-Object -Property date -Descending

C:\PS>$object = Get-RMADObject -Id "user1"

C:\PS>Restore-RMADObject -Id $object.ObjectInfo.Guid -Backup $backups[0] -UseAgentlessMethod -NoReport

In the first line of this example, the Get-RMADBackup cmdlet gets all registered backups and sorts them by date in the descending order. Then, the backup objects are stored in the $backups variable.

Example 2

PS C:\> $b = Get-RMADBackup -Id 1

C:\PS>Restore-RMADObject -Id "user1" -Backup $b -Attribute samAccountName,description -ReportUnchangedAttributes

Start-RMADReportViewer

In the first line of this example, the Get-RMADBackup cmdlet gets the registered backup whose ID is 1. Then, the backup object is stored in the $b variable.

PARAMETERS

-AdLds

Specifies that the AD LDS instance is used as a data storage.

Type: SwitchParameter
Parameter Sets: ADLds
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: Firewall, Agentless
Aliases:

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

-AdLdsInstance

If you restore the backed up AD LDS (ADAM) objects, you should specify the AD LDS instance whose backup you want to use.

Type: String
Parameter Sets: ADLds
Aliases: AdamInstance

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

-Attribute

Specifies the display names of the attributes to restore.
When specifying multiple display names, use a comma as a separator.

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

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

-Backup

Specifies the backup that contains the AD objects to be restored.

Type: Guid
Parameter Sets: (All)
Aliases:

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

-BackupPassword

Specifies the password to access a password-protected backup. This is the same password that is set in the computer collection properties in the Recovery Manager console.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-ChangeAuditorDbCredential

Specifies the credentials for connecting to the Change Auditor SQL database. If this parameter is omitted, the credentials of the current logged in user will be used.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-ChangeAuditorDbName

Specifies the location of the Change Auditor SQL database. If this parameter is omitted, the 'ModifyBy' cell in AD reports will be empty.

Type: String
Parameter Sets: (All)
Aliases:

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

-ChildObjectClass

Allows you to restore only those child objects that belong to the classes you specify in this parameter.

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

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

-ConfigureFirewall

Specifies whether Recovery Manager automatically configures Windows Firewall on domain controllers to allow compare and restore operations.

Type: SwitchParameter
Parameter Sets: Firewall
Aliases:

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

-Credential

The user name and password of the user account with which you want to connect, in the form of a PSCredential object. Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter. If this parameter is omitted, the credentials of current user account are used.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Id

Specifies the objects to restore. To specify an object, you can use object GUID, distinguished name (DN), sAMAccountName, or user principal name (UPN).

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

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

-IgnoreReadOnly

Allows you to perform the action in a console currently performing full replication.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-KeepBackupUnpacked

Determines whether to save the unpacked backup after the search operation. If this parameter is not set, the unpacked backup will be deleted after the search operation is completed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-NoReport

When present, specifies to not create any report about the restore operation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Partition

Specifies the AD LDS (ADAM) partition where you want to restore objects.

Type: String
Parameter Sets: (All)
Aliases:

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

-Port

Specifies the port on which to access the AD LDS (ADAM) instance where you want to restore objects.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ProcessChildren

When present, specifies to process children of the objects specified in the Id attribute.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ReportUnchangedAttributes

Includes the object attributes that have not changed since the time of the specified backup into the operation report.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ReportUnchangedObjects

Includes the objects that have not changed since the time of the specified backup into the operation report.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RestoreUsingChangeAuditor

Specifies if Change Auditor is used to restore the latest changes to the object.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Server

Specifies the domain controller or ADAM instance host on which objects are to be restored. The domain controller can be specified by its computer name, IP address, or domain name. If you specify a domain name, deleted objects are restored to any available domain controller in the specified domain. The ADAM instance host can be specified by its computer name or IP address. If this parameter is omitted, objects are restored to any available domain controller in the current domain.

Type: String
Parameter Sets: (All)
Aliases:

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

-SkipReplication

When present, specifies to skip replication during the restore operation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-SQLCredential

Specifies the user name and password of the user account with which you want to connect to SQL Server to generate a report about the performed operation. The user name and password must be in the form of a PSCredential object. When this parameter is omitted, the cmdlet uses the credentials of the account under which Management Shell is running. Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-UseAgentlessMethod

Specifies to use the agentless method to access the target domain controller. If this parameter is omitted, the target domain controller is accessed via Restore Agent.

Type: SwitchParameter
Parameter Sets: Agentless
Aliases:

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

 

Resume-RMADFEOperation


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

schema: 2.0.0

SYNOPSIS

Resumes paused recovery process operation.

SYNTAX

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

DESCRIPTION

When recovery operation is paused it can be resumed by this cmdlet

EXAMPLES

Example 1

PS C:\> Resume-RMADFEOperation -Name dc1.acme.com

This command resumes paused recovery process operation for specified computer.

Example 2

PS C:\> Resume-RMADFEOperation

This command resumes paused recovery process operations for all computers from the current RMADFE project.

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

 

Resume-RMADFERecovery


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

schema: 2.0.0

SYNOPSIS

Resumes recovery process.

SYNTAX

Resume (Default)

Resume-RMADFERecovery [-ProjectPassword] <SecureString> [-IgnoreDialogueTimeout] [-GroupPasswords <Hashtable>]
 [<CommonParameters>]

Drop

Resume-RMADFERecovery [-DropStoredSession] [<CommonParameters>]

DESCRIPTION

If some workstations have begun the restore process and failed, this cmdlet can resume the recovery process.

SQL Persistence must be properly configured on both processes. Both processes must be registered as restoring workstations.

If you chose to reset the password for domain users in privileged groups when you started a forest recovery, you need to provide passwords again using -GroupPasswords parameter because the product does not store user passwords.

EXAMPLES

Example 1

WS1:
PS C:\> Open-RMADFEProject 'c:\ActiveDirectoryRestore.frproj' (ConvertTo-SecureString "Password" -AsPlainText -Force)
Start-RmadFeRecovery  -Force

WS2:
PS C:\> Resume-RmadFeRecovery -ProjectPassword (ConvertTo-SecureString "Password" -AsPlainText -Force)

For example, there are two RMAD workstations in your environment. Both workstations must be registered as restoring workstations. Therefore, if one of them is not responding, you can run the recovery process from another workstation.

Example 2

PS C:\> Resume-RmadFeRecovery -DropStoredSession

This command cleans up the recovery session if any.

PARAMETERS

-DropStoredSession

Lead to a session drop in the persistence DB.

Type: SwitchParameter
Parameter Sets: Drop
Aliases:

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

-GroupPasswords

Resets the password for domain users in the specified privileged groups.

Type: Hashtable
Parameter Sets: Resume
Aliases:

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

-IgnoreDialogueTimeout

Allows you to proceed if another console does not answer.

Type: SwitchParameter
Parameter Sets: Resume
Aliases:

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

-ProjectPassword

The password that was configured for restore project.

Type: SecureString
Parameter Sets: Resume
Aliases:

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

 

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen