Chat now with support
Chat with Support

Recovery Manager for AD Disaster Recovery Edition 10.1.1 - User Guide

Overview Getting started
Permissions required to use Recovery Manager for Active Directory Recovery Manager Console Getting and using help Configuring Windows Firewall Using Computer Collections Managing Recovery Manager for Active Directory configuration Licensing
Backing up data
Permissions required for the Backup operation Managing Backup Agent Using a least-privileged user account to back up data Using Managed Service Accounts Active Directory backups vs Windows System State backups Creating BMR and Active Directory backups Using the Backup Wizard Retrying backup creation Enabling backup encryption Backing up AD LDS (ADAM) Backing up cross-domain group membership Backing up distributed file system (DFS) data Backup scheduling Setting performance options Setting advanced backup options Using Forest Recovery Agent Unpacking backups Using e-mail notification Viewing backup creation results
Restoring data
Getting started with Active Directory recovery Managing deleted or recycled objects Restoring backed up Active Directory components Integration with Change Auditor for Active Directory Using granular online restore Restoring AD LDS (ADAM) Selectively restoring Active Directory object attributes Restoring objects in an application directory partition Restoring object quotas Restoring cross-domain group membership Performing a restore without having administrator privileges Reports about objects and operations Using complete offline restore Offline restore implications Restoring SYSVOL authoritatively Performing a granular restore of SYSVOL Recovering Group Policy Restoring data from third-party backups Using the Extract Wizard Restoring passwords and SID history
Full Replication Consolidating backup registration data Monitoring Recovery Manager for Active Directory Recovering an Active Directory forest
Forest recovery overview Deploying Recovery Manager for Active Directory Forest Edition (Disaster Recovery Edition) Permissions required to use Forest Recovery Console Forest Recovery Console Managing a recovery project Recovery methods Phased recovery Managing Forest Recovery Agent Rebooting domain controllers manually Resetting DSRM Administrator Password Purging Kerberos Tickets Managing the Global Catalog servers Managing FSMO roles Manage DNS Client Settings Configuring Windows Firewall Developing a custom forest recovery plan Backing up domain controllers Assigning a preferred DNS server during recovery Handling DNS servers during recovery Forest recovery approaches Deciding which backups to use Running custom scripts while recovering a forest Overview of steps to recover a forest Viewing forest recovery progress Viewing recovery plan Viewing a report about forest recovery or verify settings operation Handling failed domain controllers Adding a domain controller to a running recovery operation Selectively recovering domains in a forest Recovering SYSVOL Deleting domains during recovery Resuming an interrupted forest recovery Recovering read-only domain controllers (RODCs) Checking forest health Collecting diagnostic data for technical support
Restore Active Directory on Clean OS Bare metal forest recovery Using Management Shell Creating virtual test environments Using Recovery Manager for Active Directory web portal Appendices
Frequently asked questions Best practices for using Computer Collections Technical characteristics Best practices for creating backups Best practices for creating backups for forest recovery Best practices for recovering a forest Descriptions of recovery or verification steps Ports Used by Recovery Manager for Active Directory Forest Edition (Disaster Recovery Edition) Backup Wizard Online Restore Wizard Online Restore Wizard for AD LDS (ADAM) Group Policy Restore Wizard Repair Wizard Extract Wizard Events generated by Recovery Manager for Active Directory Descriptions of PowerShell commands
Add-RMADBackup Add-RMADCollectionItem Add-RMADFEComputer Add-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Create-RMADStorageManagementAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFERecoveryCertificate Export-RMADFEResult Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject Get-RMADFEComputer Get-RMADFEConsole Get-RMADFEDnsCache Get-RMADFEDomain Get-RMADFEEvent Get-RMADFEGlobalOptions Get-RMADFEOperation Get-RMADFEPersistenceConnection Get-RMADFEProject Get-RMADFERecoveryAgent Get-RMADFESchedule Get-RMADGlobalOptions 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-RMADStorageServers Import-RMADBackup Import-RMADFERecoveryCertificate Install-RMADBackupAgent Install-RMADFERecoveryAgent New-RMADCollection New-RMADFEProject New-RMADFERecoveryMedia New-RMADSchedule Open-RMADFEProject Publish-RMADBackupSecurityStatus Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADFEComputer Remove-RMADFERecoveryAgent Remove-RMADFESchedule Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADStorageServer Remove-RMADUnpackedComponent Rename-RMADCollection Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADObject Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFEComputer Set-RMADFEDnsCache Set-RMADFEDomain Set-RMADFEGlobalOptions Set-RMADFEPersistenceConnection Set-RMADFERecoveryMode Set-RMADFESchedule Set-RMADGlobalOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Start-RMADFERecovery Start-RMADFEVerification Start-RMADReplication Start-RMADReportViewer Stop-RMADFEWorkflow Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Descriptions of PowerShell commands

PowerShell cmdlets for Recovery Manager for Active Directory

Cmdlet Description
Add-RMADBackup Registers a backup in the Recovery Manager database.
Add-RMADCollectionItem Adds a new item to a Computer Collection.
Add-RMADReplicationConsole Adds a RMAD console as a replication source.
Add-RMADStorageServer Adds storage server
Backup-RMADCollection Backs up an existing computer collection.
Compare-RMADObject Compares Active Directory objects. This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Convert-RMADBackup Converts Windows Server backups into RMAD Bare Metal Recovery backups.
ConvertTo-RMADRecycledObject Recycles specific deleted Active Directory objects.
Create-RMADStorageManagementAgentSetup Creates storage server management agent setup.
Expand-RMADBackup Extracts the contents of a specified backup file.
Export-RMADBackup Exports registration information for a backup into an .xml file.
Get-RMADBackup Gets backups registered with Recovery Manager.
Get-RMADBackupAgent Retrieves objects that represent Recovery Manager Backup Agents, or discovers manually preinstalled Recovery Manager Backup Agents.
Get-RMADBackupInfo Gets the content of the backups held at a specified location.
Get-RMADBackupObject Get objects from backups
Get-RMADBackupSecurityStatus Gets security check information for a specified backup.
Get-RMADCollection Retrieves Recovery Manager computer collection objects or default computer collection settings.
Get-RMADCollectionItem Retrieves information about items added to specified Recovery Manager for Active Directory computer collections.
Get-RMADDeletedObject Retrieves deleted Active Directory objects.
Get-RMADGlobalOptions Sets global settings for the application.
Get-RMADLicenseInfo Retrieves information about the installed license key file.
Get-RMADObject Retrieves specific objects from Active Directory or certain backups registered with Recovery Manager for Active Directory.
Get-RMADReplicationConsole Gets all the RMAD consoles in the replication console list.
Get-RMADReplicationSchedule Allows you to get the replication schedule from a specified computer.
Get-RMADReplicationSession Retrieves information about replication sessions.
Get-RMADReplicationSessionItem Retrieves a list of remote consoles that are involved in the specified replication session.
Get-RMADReportObject Retrieves an object representing the online comparison or restore operation item.
Get-RMADReportObjectAttributes Retrieves an object representing the online comparison or restore operation item attributes.
Get-RMADReportObjectChildren Retrieves an object representing the online comparison or restore operation item child items.
Get-RMADReportSession Retrieves an object representing the online comparison or restore operation report.
Get-RMADSession Retrieves an object representing Recovery Manager backup sessions.
Get-RMADSessionItem Gets items from a specified backup creation session.
Get-RMADSessionItemEvent Gets events from a specified backup creation session item.
Get-RMADStorageServers Returns registered storage servers.
Import-RMADBackup Reads the backup registration information from the .xml file and returns backup descriptions in the BackupInfo objects.
Install-RMADBackupAgent Installs Recovery Manager Backup Agent on a specified computer or on each computer in a particular Computer Collection.
New-RMADCollection Creates a new computer collection.
New-RMADSchedule Creates a schedule for the backup creation operation you want to perform on a particular computer collection.
Publish-RMADBackupSecurityStatus Publishes security check information for a specified backup.
Remove-RMADBackup Allows you to selectively unregister backups from the Recovery Manager backup registration database.
Remove-RMADBackupAgent Removes Recovery Manager Backup Agent from a specified computer, or its registration information from the Recovery Manager Console.
Remove-RMADCollection Deletes specified Computer Collections.
Remove-RMADCollectionItem Removes items from a specified Computer Collection.
Remove-RMADReplicationConsole Removes an RMAD console from the replication console list.
Remove-RMADReplicationSchedule Allows you to remove the replication schedule from a specified computer.
Remove-RMADReplicationSession Deletes replication sessions from the replication history.
Remove-RMADStorageServer Removes the storage server.
Remove-RMADUnpackedComponent Allows you to delete components (data) unpacked from specified backups.
Rename-RMADCollection Renames a computer collection.
Restore-RMADDeletedObject Restores deleted Active Directory objects. This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Restore-RMADDomainController Restores a domain controller from backup.
Restore-RMADObject Restores Active Directory objects from a backup. This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Set-RMADCollection Sets properties for a computer collection.
Set-RMADGlobalOptions Sets global application settings
Set-RMADReplicationConsole Sets replication properties of consoles in the replication console list.
Set-RMADReplicationSchedule Sets replication schedules for a computer.
Start-RMADReplication Performs replication from other computers in the replication console list.
Start-RMADReportViewer Displays a report about the results of the online comparison or restore operation.
Update-RMADBackupAgent Upgrades Recovery Manager Backup Agent on a specified computer or on each computer in a particular Computer Collection.
Update-RMADLicense Updates license key file.

PowerShell cmdlets for Recovery Manager for Active Directory Forest Edition (Disaster Recovery Edition)

Cmdlet Description
Add-RMADFEComputer Add a new domain controller into the project.
Close-RMADFEProject Closes currently opened recovery project.
Export-RMADFERecoveryCertificate Exports Forest Recovery certificates.
Export-RMADFEResult Export the verification result of an RMADFE project.
Get-RMADFEComputer Retrieves a list of computer settings from the current RMADFE project.
Get-RMADFEConsole Gets all registered RMAD FE consoles.
Get-RMADFEDnsCache Returns cached DNS records in the Forest Recovery project.
Get-RMADFEDomain Retrieves the domain settings.
Get-RMADFEEvent Returns recovery events related to the entire Active Directory forest or a specific domain controller.
Get-RMADFEGlobalOptions Gets global application settings.
Get-RMADFEOperation Returns information about the progress of the recovery operations.
Get-RMADFEPersistenceConnection Gets persistence connection settings.
Get-RMADFEProject Gets the current status of the RMADFE project.
Get-RMADFERecoveryAgent Returns information about Forest Recovery Agents that are installed and registered in Forest Recovery Console.
Get-RMADFESchedule Gets a schedule for the RMADFE project verification.
Import-RMADFERecoveryCertificate Imports Forest Recovery certificates.
Install-RMADFERecoveryAgent Installs Forest Recovery Agent on a specified domain controller or on each domain controller in the forest.
New-RMADFEProject Creates a new RMADFE project in the file system.
New-RMADFERecoveryMedia Creates a new Recovery Media ISO in the file system.
Open-RMADFEProject Opens the RMADFE project.
Remove-RMADFEComputer Removes the computer form the project.
Remove-RMADFERecoveryAgent Removes Forest Recovery Agent from a specified domain controller, or its registration information from Forest Recovery Console.
Remove-RMADFESchedule Removes an existing verification schedule for the RMADFE project.
Resume-RMADFERecovery Resumes recovery process.
Save-RMADFEProject Saves the RMADFE project.
Set-RMADFEComputer Applies computer settings to the RMADFE project.
Set-RMADFEDnsCache Updates cached DNS records in the Forest Recovery project.
Set-RMADFEDomain Sets the domain settings for the current RMADFE project.
Set-RMADFEGlobalOptions Sets global settings for recovery projects.
Set-RMADFEPersistenceConnection Sets persistence connection settings.
Set-RMADFERecoveryMode Sets recovery mode for the current recovery project
Set-RMADFESchedule Applies settings to the verification schedule for the RMADFE project.
Start-RMADFERecovery Performs the restore operation for the RMADFE project.
Start-RMADFEVerification Performs verification of the RMADFE project.
Stop-RMADFEWorkflow Stops the verification or recovery workflow of the recovery project.
Update-RMADFEProject Shows the difference between the current project and live Active Directory and updates the project.

 

Add-RMADBackup


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

schema: 2.0.0

SYNOPSIS

Registers a backup in the Recovery Manager database.

SYNTAX

BackupInfo

Add-RMADBackup [-InputObject] <BackupInfo[]> [-SkipAlreadyRegistered] [-BackupPassword <SecureString>]
 [-UseLegacyEncryption] [-IgnoreReadOnly] [-InformationAction <ActionPreference>]
 [-InformationVariable <String>] [<CommonParameters>]

Bkf

Add-RMADBackup [-Path] <String[]> [-BackupPassword <SecureString>] [-UseLegacyEncryption] [-IgnoreReadOnly]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

OfflineDit

Add-RMADBackup [-Path] <String[]> [-SysvolPath <String[]>] [-ResolveIndexes <Boolean>] [-OfflineDit]
 [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

Registers specified backup in the Recovery Manager database.
Use the -InputObject parameter to specify the backup to register.

EXAMPLES

Example

PS C:\> $b = Get-ChildItem "C:\Backups" -Filter *.bkf -Recurse | Get-RMADBackupInfo

C:\PS>Add-RMADBackup $b

The first line of this example gets the backups held in the C:\Backups folder and its subfolders, and saves the backup objects in the $b variable.
The second line of this example registers the backup objects in the Recovery Manager database.

PARAMETERS

-InputObject

Accepts a backup object as input to the cmdlet.
Enter a variable that contains the objects or type a command or expression that gets the objects.

Type: BackupInfo[]
Parameter Sets: BackupInfo
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-SkipAlreadyRegistered

Do not display the error message if the backup is registered.

Type: SwitchParameter
Parameter Sets: BackupInfo
Aliases:

Required: False
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: BackupInfo, Bkf
Aliases:

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

-UseLegacyEncryption

Allows you to work with backups encrypted by the RC4 algorithm from RSA, Inc.
(Microsoft RSA Base Provider).
This algorithm is used to back up Windows Server 2003/2003 R2 domain controllers in Recovery Manager for Active Directory 8.2.x and 8.5.x.

Type: SwitchParameter
Parameter Sets: BackupInfo, Bkf
Aliases:

Required: False
Position: Named
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: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

Path to the backup file.

Type: String[]
Parameter Sets: Bkf, OfflineDit
Aliases: FullName

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-SysvolPath

Path to the SYSVOL folder.

Type: String[]
Parameter Sets: OfflineDit
Aliases:

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

-ResolveIndexes

Resolve the DIT file index.

Type: Boolean
Parameter Sets: OfflineDit
Aliases:

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

-OfflineDit

Specifies that the application registers the DIT file as a backup.

Type: SwitchParameter
Parameter Sets: OfflineDit
Aliases:

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

-InformationAction

@{Text=}

Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

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

-InformationVariable

@{Text=}

Type: String
Parameter Sets: (All)
Aliases: iv

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

 

Add-RMADCollectionItem


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

schema: 2.0.0

SYNOPSIS

Adds a new item to a Computer Collection.

SYNTAX

InputObject

Add-RMADCollectionItem [-InputObject] <ComputerCollection> [-DomainController <String>] [-Domain <String>]
 [-OU <String>] [-Container <String>] [-ADSite <String>] [-AdamSite <String>] [-AdamServer <String>]
 [-AdamHost <String>] [-Exclusions <String[]>] [-Credentials <PSCredential>] [-IgnoreReadOnly]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Name

Add-RMADCollectionItem -Name <String> [-DomainController <String>] [-Domain <String>] [-OU <String>]
 [-Container <String>] [-ADSite <String>] [-AdamSite <String>] [-AdamServer <String>] [-AdamHost <String>]
 [-Exclusions <String[]>] [-Credentials <PSCredential>] [-IgnoreReadOnly]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Id

Add-RMADCollectionItem -Id <Int32> [-DomainController <String>] [-Domain <String>] [-OU <String>]
 [-Container <String>] [-ADSite <String>] [-AdamSite <String>] [-AdamServer <String>] [-AdamHost <String>]
 [-Exclusions <String[]>] [-Credentials <PSCredential>] [-IgnoreReadOnly]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Domain

Add-RMADCollectionItem [-Domain <String>] [-Exclusions <String[]>] [-IgnoreReadOnly]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

OU

Add-RMADCollectionItem [-OU <String>] [-Exclusions <String[]>] [-Credentials <PSCredential>] [-IgnoreReadOnly]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Container

Add-RMADCollectionItem [-Container <String>] [-Exclusions <String[]>] [-Credentials <PSCredential>]
 [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

ADSite

Add-RMADCollectionItem [-ADSite <String>] [-Exclusions <String[]>] [-Credentials <PSCredential>]
 [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AdamServer

Add-RMADCollectionItem [-AdamSite <String>] [-AdamServer <String>] [-Credentials <PSCredential>]
 [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

AdamSite

Add-RMADCollectionItem [-AdamSite <String>] [-Exclusions <String[]>] [-Credentials <PSCredential>]
 [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

Adds a new item to the Computer Collection that has the specified name or is represented by the specified objects.

EXAMPLES

Example 1

PS C:\> Add-RMADCollectionItem -Name Collection1 -DomainController dc1.dom1.local

Adds the dc1.dom1.local domain controller to the computer collection named Collection1.

Example 2

PS C:\> $c = Get-RMADCollection Collection1

C:\PS>Add-RMADCollectionItem -InputObject $c -Domain dom1.local

In the first line of this example, the Get-RMADCollection cmdlet gets the computer collection object named Collection1 and saves it in the $c variable.
In the second line, the Add-RMCollection cmdlet adds the dom1.local domain to the Computer Collection object saved in the $c variable.

Example 3

PS C:\> Add-RMADCollectionItem -Name Collection1 -OU "OU=Tokens,OU=Defender,DC=prod,DC=quest,DC=corp"

Adds an OU to the Computer Collection.

Example 4

PS C:\> Add-RMADCollectionItem -Name Collection1 -Container "CN=Computers,DC=prod,DC=quest,DC=corp"

Adds a container to the Computer Collection.

Example 5

PS C:\> $dn = "CN=Default-First-Site-Name,CN=Sites,CN=Configuration,DC=prod,DC=quest,DC=corp"
Add-RMADCollectionItem -Name Collection1 -ADSite $dn -Exclusions @("ws1.prod.quest.corp:0")

Create an ADSite exclude from the domain controller (ws1.prod.quest.corp:0") and add it to the Computer Collection.

Example 6

PS C:\> $dn = "CN=Default-First-Site-Name,CN=Sites,CN=Configuration,CN={7B1308BE-06B9-4925-BEF5-C323292279F5}"
Add-RMADCollectionItem -Name Collection1 -AdamServer ws1.prod.quest.corp:389 -AdamSite dn

Create an AdamSite and add it to the Computer Collection.

PARAMETERS

-InputObject

Specifies the object representing the Computer Collections to which you want to add items.
Enter a variable that contains the objects or type a command or expression that gets the objects.

Type: ComputerCollection
Parameter Sets: InputObject
Aliases: Collection

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

-DomainController

Specifies the DNS name of the domain controller to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id
Aliases:

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

-Domain

Specifies the DNS name of the domain to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id, Domain
Aliases:

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

-OU

Specifies the distinguished name of the organizational unit to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id, OU
Aliases:

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

-Container

Specifies the distinguished name of the container to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id, Container
Aliases:

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

-ADSite

Specifies the distinguished name of the Active Directory site to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id, ADSite
Aliases:

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

-AdamSite

Specifies the distinguished name of the ADAM/AD LDS site to be added to the Computer Collection.
Use it in conjunction with AdamServer.

Type: String
Parameter Sets: InputObject, Name, Id, AdamServer, AdamSite
Aliases:

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

-AdamServer

Name of the AD LDS instance.

Type: String
Parameter Sets: InputObject, Name, Id, AdamServer
Aliases:

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

-AdamHost

Specifies the name of the server for the AD LDS instance installation.

Type: String
Parameter Sets: InputObject, Name, Id
Aliases:

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

-Exclusions

Excludes a specified domain controller from the collection items to be added.
The parameter must be used in conjunction with other paramters.

Type: String[]
Parameter Sets: InputObject, Name, Id, Domain, OU, Container, ADSite, AdamSite
Aliases:

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

-Credentials

Specifies the credentials for the account with which you want to connect.
Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.

Type: PSCredential
Parameter Sets: InputObject, Name, Id, OU, Container, ADSite, AdamServer, AdamSite
Aliases:

Required: False
Position: Named
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: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the Computer Collection to which you want to add items.

Type: String
Parameter Sets: Name
Aliases:

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

-Id

Specifies the identifier of the Computer Collection to which you want to add items.

Type: Int32
Parameter Sets: Id
Aliases:

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

-InformationAction

@{Text=}

Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

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

-InformationVariable

@{Text=}

Type: String
Parameter Sets: (All)
Aliases: iv

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

 

Add-RMADFEComputer


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

schema: 2.0.0

SYNOPSIS

Add a new domain controller into the project.

SYNTAX

Add-RMADFEComputer [-ComputerName] <String> [-Domain <String>] [-Backup <Guid>] [-BmrBackup <Guid>]
 [-BackupPassword <SecureString>] [-BmrBackupPassword <SecureString>] [-LocalCredential <PSCredential>]
 [-DcCredential <PSCredential>] [-DsrmCredential <PSCredential>] [-NetworkShareCredential <PSCredential>]
 [-BmrBackupNetworkShareCredential <PSCredential>] [-UseDomainSettings <Boolean>]
 [-RecoveryMethod <RecoveryMethod>] [-InstallFromMedia <Boolean>] [-DitPath <String>] [-LogPath <String>]
 [-SysvolPath <String>] [-RestoreAdOverBmrBackup <Boolean>] [-WipeDisks <Boolean>]
 [-PerformMalwareScan <Boolean>] [-UseOriginalTargetNetworkSettings <Boolean>] [-UseNatRouter <Boolean>]
 [-NatRouterPort <UInt32>] [-NatRouterAddress <String>] [-TargetIpAddress <String>] [-IsoIpAddress <String>]
 [-SubnetMask <String>] [-DefaultGateway <String>] [-DnsServers <String>] [-ConfigureAsGlobalCatalog <Boolean>]
 [-InstallReadOnly <Boolean>] [-RecoveryMediaPath <String>] [-RecoveryMediaShareCredential <PSCredential>]
 [-SaveRecoveryMediaOnBackupShare <Boolean>] [-TargetHardwareType <TargetHardwareType>]
 [-TargetHardwareManagementAddress <String>] [-TargetHardwareManagementProtocol <String>]
 [-TargetHardwareManagementPort <Int32>] [-TargetHardwareManagementCredential <PSCredential>]
 [-TargetHostCreateVMScript <String>] [-TargetHostBootScript <String>] [-TargetHostEjectScript <String>]
 [-CreateVM <Boolean>] [-VMName <String>] [-VMCPUNum <Int32>] [-VMMemorySize <Int64>]
 [-HypervisorHost <String>] [-HypervisorHostPlacement <String>] [-VMNetwork <String>] [-VMFolder <String>]
 [-DriversPath <String>] [-AllowAddCustomDrivers <Boolean>] [-AllowAddCustomDriversFromBackup <Boolean>]
 [-TargetHardwareBootScript <String>] [-SubscriptionId <String>] [-TenantId <String>] [-VMSize <String>]
 [-VMLocation <String>] [-VMResourceGroup <String>] [-VMSecurityGroup <String>] [-VMStorageType <String>]
 [-VMStorageSize <Int32>] [-KeepInProject <Boolean>] [-InformationAction <ActionPreference>]
 [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

The command allows add a standalone server and make a new domain controller.

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-ComputerName

Specifies the fully qualified domain name of the computer.

Type: String
Parameter Sets: (All)
Aliases: Name

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

-Domain

Specifies Domain DNS name of the computer.

Type: String
Parameter Sets: (All)
Aliases:

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

-Backup

Specifies System State backup that is used for recovery.

Type: Guid
Parameter Sets: (All)
Aliases:

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

-BmrBackup

Specifies Bare Metal Recovery backup that is used in case of Restore from Windows backup recovery.

Type: Guid
Parameter Sets: (All)
Aliases:

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

-BackupPassword

Specifies the password to access a password-protected backup.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-BmrBackupPassword

Specifies the password to access a password-protected BMR backup.

Type: SecureString
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 computer.

Type: PSCredential
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 the selected domain controllers 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: (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 the selected domain controllers 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: (All)
Aliases:

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

-NetworkShareCredential

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

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-BmrBackupNetworkShareCredential

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

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-UseDomainSettings

This option lets you use the default domain credentials to access domain controllers.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RecoveryMethod

Specified recovery method for this Domain controller.

Type: RecoveryMethod
Parameter Sets: (All)
Aliases:

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

-InstallFromMedia

This option lets to install or reinstall AD using media.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-DitPath

Specifies a path to the DIT file if the custom location is required.

Type: String
Parameter Sets: (All)
Aliases:

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

-LogPath

Specifies a path to Active Directory log files if custom location is required.

Type: String
Parameter Sets: (All)
Aliases:

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

-SysvolPath

Specifies a path to SYSVOL if the custom location is required.

Type: String
Parameter Sets: (All)
Aliases:

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

-RestoreAdOverBmrBackup

This option lets to select the RMADFE Active Directory and Registry backup to be restored over the BMR backup

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-WipeDisks

Specifies if full disk cleanup on the target machine is required before starting restore from Bare Metal Recovery backup.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-PerformMalwareScan

Specifies if the backup must be scanned for malware threats.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-UseOriginalTargetNetworkSettings

This option lets to use network settings from Bare Metal Recovery backup.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-UseNatRouter

Allows using NAT (deprecated)

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-NatRouterPort

Set NAT routing port (deprecated)

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-NatRouterAddress

Set NAT routing address (deprecated)

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetIpAddress

Specifies target IP for the computer.

Type: String
Parameter Sets: (All)
Aliases:

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

-IsoIpAddress

Specifies IP address for ISO image which is used as a boot disk.

Type: String
Parameter Sets: (All)
Aliases:

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

-SubnetMask

Specifies a subnet mask for custom Bare Metal Recovery network settings.

Type: String
Parameter Sets: (All)
Aliases:

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

-DefaultGateway

Specifies default gateway for custom Bare Metal Recovery network settings.

Type: String
Parameter Sets: (All)
Aliases:

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

-DnsServers

Specifies a DNS Servers for custom Bare Metal Recovery network settings.

Type: String
Parameter Sets: (All)
Aliases:

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

-ConfigureAsGlobalCatalog

Sets Global Catalog role for the Domain Controller.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-InstallReadOnly

Sets Read-only property for the Domain Controller.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RecoveryMediaPath

Specifies a path to ISO image which is used as a boot disk.

Type: String
Parameter Sets: (All)
Aliases:

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

-RecoveryMediaShareCredential

Specifies a credential to get access to the ISO image which is used as a boot disk.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-SaveRecoveryMediaOnBackupShare

Specifies a location of ISO image which is used as a boot disk.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-TargetHardwareType

Specifies the target platform for the new domain controller.

Type: TargetHardwareType
Parameter Sets: (All)
Aliases:

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

-TargetHardwareManagementAddress

Specifies the address of the target platform for the new domain controller.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHardwareManagementProtocol

Specifies the network protocol for communicating with the platform for the new domain controller.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHardwareManagementPort

Specifies the network port for communicating with the platform for the new domain controller.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-TargetHardwareManagementCredential

Specifies network credentials for communicating with the platform for the new domain controller.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-TargetHostCreateVMScript

Specifies the custom script to create a virtual machine on the target platform.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHostBootScript

Specifies the custom script to boot the target host.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHostEjectScript

Specifies the custom script to eject bootable disk on the target host.

Type: String
Parameter Sets: (All)
Aliases:

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

-CreateVM

Specifies if a new machine must be created on the target platform.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-VMName

Specifies the name of the virtual machine on the target platform.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMCPUNum

Specifies the number of CPU on the virtual machine.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-VMMemorySize

Specifies memory size on the virtual machine.

Type: Int64
Parameter Sets: (All)
Aliases:

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

-HypervisorHost

Specifies Hypervisor host name.

Type: String
Parameter Sets: (All)
Aliases:

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

-HypervisorHostPlacement

Specifies the placement of the virtual machine.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMNetwork

Specifies network settings for the virtual machine.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMFolder

Specifies a target folder for the virtual machine.

Type: String
Parameter Sets: (All)
Aliases:

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

-SubscriptionId

Specifies an Azure SubscriptionId.

Type: String
Parameter Sets: (All)
Aliases:

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

-TenantId

Specifies an Azure TenantId.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMSize

Specifies an Azure VM size.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMLocation

Specifies an Azure VM location.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMResourceGroup

Specifies an Azure VM resource group.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMSecurityGroup

Specifies an Azure VM security group.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMStorageType

Specifies the virtual machine storage type.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMStorageSize

Specifies the virtual machine disk size in GB.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DriversPath

Specifies a path to custom drivers.

Type: String
Parameter Sets: (All)
Aliases:

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

-AllowAddCustomDrivers

Turns on an ability to set up custom drivers.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-AllowAddCustomDriversFromBackup

Turns on the ability to set up custom drivers from the backup.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-TargetHardwareBootScript

Specifies custom script to boot the target host.

Type: String
Parameter Sets: (All)
Aliases:

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

-KeepInProject

Marks domain controller to be recovered later.
If this domain controller is removed from the Active Directory, it will not be removed from the project on updating with Active Directory changes.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-InformationAction

@{Text=}

Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

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

-InformationVariable

@{Text=}

Type: String
Parameter Sets: (All)
Aliases: iv

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating