external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Renames a computer collection.
Rename-RMADCollection [-Name] <String> [-Value] <String> [-PassThru] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Rename-RMADCollection [-InputObject] <ComputerCollection> [-Value] <String> [-PassThru] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Rename-RMADCollection [-Id] <Int32> [-Value] <String> [-PassThru] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Renames a computer collection with the name you specify.
PS C:\> Rename-RMADCollection -Name "New Computer Collection" -Value Collection1
This command renames the computer collection named "New Computer Collection" to "Collection1".
PS C:\> $c = Get-RMADCollection -Name "Collection1"
C:\PS>Rename-RMADCollection -InputObject $c -Value "Collection2"
The Get-RMADCollection cmdlet retrieves the computer collection named Collection1.
This collection is then passed to the Rename-RMADCollection cmdlet that renames it to Collection2.
Specifies the name of the computer collection to be renamed.
Type: String
Parameter Sets: Name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Specifies the new name you want to assign to the computer collection.
Type: String
Parameter Sets: (All)
Aliases: NewName
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Passes the renamed collection along the pipeline.
If this parameter is omitted, the renamed collection is not passed along the pipeline.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Describes what would happen if you executed the command without actually executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts for a confirmation before executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Renames the computer collection represented by the specified collection objects.
Specify the name of the variable that contains the objects or type a command or expression that gets the objects.
Type: ComputerCollection
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True
Specifies the identifier of the computer collection you want to rename.
Type: Int32
Parameter Sets: Id
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Restores deleted Active Directory objects.
This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Restore-RMADDeletedObject [-ProcessRecycledObjects] [-Backup <Guid>] [-RestoreParent <RestoreParent>] [-Full]
[-NoReport] [-SkipReplication] [-ReportUnchangedObjects] [-ReportUnchangedAttributes] [-RestoreTo <String>]
[-KeepBackupUnpacked] [-Id] <String[]> [-ProcessChildren] [-ChildObjectClass <String[]>]
[-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Restore-RMADDeletedObject [-ProcessRecycledObjects] [-Backup <Guid>] [-BackupPassword <SecureString>]
[-NoReport] [-SkipReplication] [-SQLCredential <PSCredential>] [-ReportUnchangedObjects]
[-ReportUnchangedAttributes] [-RestoreTo <String>] [-AsJob] [-KeepBackupUnpacked] [-Id] <String[]>
[-ProcessChildren] [-ChildObjectClass <String[]>] [-AdLds] -AdLdsInstance <String>
[-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Restore-RMADDeletedObject [-ProcessRecycledObjects] -Backup <Guid> [-BackupPassword <SecureString>] [-NoReport]
[-SkipReplication] [-SQLCredential <PSCredential>] [-ReportUnchangedObjects] [-ReportUnchangedAttributes]
[-RestoreTo <String>] [-AsJob] [-KeepBackupUnpacked] [-Id] <String[]> [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor] [-Server <String>]
[-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Restore-RMADDeletedObject [-ProcessRecycledObjects] [-Backup <Guid>] [-BackupPassword <SecureString>]
[-RestoreParent <RestoreParent>] [-Full] [-NoReport] [-SkipReplication] [-SQLCredential <PSCredential>]
[-ReportUnchangedObjects] [-ReportUnchangedAttributes] [-RestoreTo <String>] [-AsJob] [-KeepBackupUnpacked]
[-Id] <String[]> [-ProcessChildren] [-ChildObjectClass <String[]>] [-AdLds] [-ChangeAuditorDbName <String>]
[-ConfigureFirewall] [-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Restore-RMADDeletedObject [-ProcessRecycledObjects] [-Backup <Guid>] [-BackupPassword <SecureString>]
[-RestoreParent <RestoreParent>] [-Full] [-NoReport] [-SkipReplication] [-SQLCredential <PSCredential>]
[-ReportUnchangedObjects] [-ReportUnchangedAttributes] [-RestoreTo <String>] [-AsJob] [-KeepBackupUnpacked]
[-Id] <String[]> [-UseAgentlessMethod] [-ProcessChildren] [-ChildObjectClass <String[]>] [-AdLds]
[-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Restores deleted Active Directory objects whose applicable tombstone lifetime or deleted object lifetime has not expired.
Depending on your settings and your environment, this cmdlet can restore deleted objects by using the following methods:
PS C:\> Restore-RMADDeletedObject -Id d8742dcb-3e6a-4b3c-b3fe-374623cdcf06 -Backup 2b509d4e-40f5-4337-82f7-458584555d0c -ProcessRecycledObjects -Server dc1.mydomain.com
Retrieves the recycled object with the specified Id (GUID) from the domain controller dc1.mydomain.com, and then restores the object from the backup with the specified GUID.
This command is only applicable to environments where Microsoft's Active Directory Recycle Bin is enabled.
In this example, the Server parameter is mandatory.
PS C:\> Restore-RMADDeletedObject -Id d8742dcb-3e6a-4b3c-b3fe-374623cdcf06 -Backup 2b509d4e-40f5-4337-82f7-458584555d0c -Server dc1.mydomain.com
Retrieves deleted object with the specified Id (GUID) from the domain controller dc1.mydomain.com, and then restores the object from the backup with the specified GUID.
In this example, the Server parameter is mandatory.
PS C:\> Restore-RMADDeletedObject -Id d8742dcb-3e6a-4b3c-b3fe-374623cdcf06 -Backup 2b509d4e-40f5-4337-82f7-458584555d0c -Server dc1.mydomain.com -WindowsServerBackup -AsJob
Retrieves deleted object with the specified Id (GUID) from the domain controller dc1.mydomain.com, and then restores the object from the backup with the specified GUID in the background job.
In this example, the Server parameter is mandatory.
Specifies to process recycled objects.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the backup that contains the deleted object you want to restore.
To specify a backup, type the backup GUID in this parameter or use the Get-RMADBackup cmdlet.
Type: Guid
Parameter Sets: Default, ADLds, Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Guid
Parameter Sets: Bkf
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Restores the deleted parents of the deleted objects being recovered.
This parameter can take one of the following values:
Type: RestoreParent
Parameter Sets: Default, Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: Prompt
Accept pipeline input: False
Accept wildcard characters: False
Specifies to restore the deleted objects with all their attributes. When this parameter is present, the cmdlet does one of the following:
Type: SwitchParameter
Parameter Sets: Default, Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies to not create any report about the restore operation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies to skip replication during the restore operation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Includes information about 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: None
Accept pipeline input: False
Accept wildcard characters: False
Includes information about 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: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a target container for the restore operation.
To specify a target container, specify the container's distinguished name (DN) in this parameter.
You can use this parameter to specify a target container if the parent container of the object you want to restore has been deleted.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the deleted 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
Specifies to process children of the objects specified in the Id attribute.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Allows you to reanimate 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
Specifies a location of the ChangeAuditor 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
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: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the domain controller or ADAM instance host from which deleted objects are to be retrieved.
The domain controller can be specified by its computer name, IP address, or domain name.
If you specify a domain name, deleted objects are retrieved from 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, deleted objects are retrieved from 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
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.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the distinguished name of the Active Directory partition from which deleted objects are to be retrieved.
If this parameter is omitted, the default naming context is used.
This parameter is required if you specify an ADAM instance host in the DirectoryHost parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the port number to be used for connection.
If this parameter is set to 0 or not specified, the default LDAP port (389) is used.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Describes what would happen if you executed the command without actually executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts for a confirmation before executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the password to access the password-protected backup that contains the deleted object you want to restore.
Type: SecureString
Parameter Sets: ADLds, Bkf, Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: ADLds, Bkf, Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Runs the command as a background job.
You can use this parameter to run commands that take a significant time to complete.
Type: SwitchParameter
Parameter Sets: ADLds, Bkf, Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies that the AD LDS instance is used as a data storage.
Type: SwitchParameter
Parameter Sets: ADLds
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Specifies whether Recovery Manager automatically configures Windows Firewall on the target Windows Server 2008-based or Windows Server 2012-based DCs to allow compare and restore operations.
Type: SwitchParameter
Parameter Sets: Firewall
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Restores a domain controller from backup.
Restore-RMADDomainController -Backup <BackupInfo> [-BackupComponents <BackupComponents>]
[-BackupPassword <SecureString>] [-ComputerName <String>] [-Credential <PSCredential>]
-DsrmCredential <PSCredential> [-ResetDsrmPassword] [-ManualRestartToDsrm] [-ManualRestartToNormal]
[-MarkSysvolPrimary] [-AsJob] [-WhatIf] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
Restore-RMADDomainController -Backup <BackupInfo> [-BackupComponents <BackupComponents>]
[-BackupPassword <SecureString>] [-ComputerName <String>] [-Credential <PSCredential>]
-DsrmCredential <PSCredential> [-ResetDsrmPassword] [-ManualRestartToDsrm] [-ManualRestartToNormal]
[-MarkSysvolPrimary] -AuthoritativeRestore <Boolean> [-AuthoritativeRestoreSubtree <String>] [-AsJob]
[-WhatIf] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Restores a domain controller from backup.
During the Restore operation, the domain controller would be rebooted to the Directory Service Restore mode.
PS C:\> {{ Add example code here }}
{{ Add example description here }}
Specifies the backup that contains the data to be restored.
Type: BackupInfo
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the components of backup to be restored.
Type: BackupComponents
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the password to access a password-protected backup.
This is the same password that is set in the properties of the computer collection in the Recovery Manager for Active Directory console.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies DNS name or IP address of the domain controller to be restored.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies credentials to access the domain controller and then deploy and connect to the Restore Agent in the Normal mode.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies credentials for the Directory Service Restore Mode.
If ResetDSRMPassword is specified, the password will be reset.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether the DSRM password will be reset to the password from the DSRMCredential parameter.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether a domain controller will be rebooted to DSRM manually.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether a domain controller will be rebooted to the Normal mode manually after the Restore operation is completed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies to mark SYSVOL as primary.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Runs a command as a background job.
You can use this parameter to run commands that take a significant amount of time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Tests the connection to the restore agent
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Performs an authoritative restore.
Type: Boolean
Parameter Sets: AuthoritativeRestore
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a subtree that will be marked as authoritative.
If this parameter is not specified, the whole Active Directory will be marked as authoritative.
Type: String
Parameter Sets: AuthoritativeRestore
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Restores Active Directory objects from a backup.
This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor]
[-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor]
[-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
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>]
[-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
[-Port <Int32>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-AdLds] [-ChangeAuditorDbName <String>] [-ConfigureFirewall]
[-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
[-Port <Int32>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-UseAgentlessMethod] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-AdLds] [-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor]
[-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
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
PS C:\> $backups = Get-RMADBackup | Sort-Object -Property date -Descending
C:\PS>$object = Get-RMADObject -Id "johndoe"
C:\PS>Restore-RMADObject -Id $o.ObjectInfo.Guid -Backup $b[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.
PS C:\> $b = Get-RMADBackup -Id 1
C:\PS>Restore-RMADObject -Id "johndoe" -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.
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
When present, specifies to not create any report about the restore operation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
When present, specifies to skip replication during the restore operation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
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
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: None
Accept pipeline input: False
Accept wildcard characters: False
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
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: None
Accept pipeline input: False
Accept wildcard characters: False
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: None
Accept pipeline input: False
Accept wildcard characters: False
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
Specifies the location of the ChangeAuditor 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
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: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
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
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
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
Specifies that the AD LDS instance is used as a data storage.
Type: SwitchParameter
Parameter Sets: ADLds
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Specifies whether Recovery Manager automatically configures Windows Firewall on target Windows Server 2008-based or Windows Server 2012-based DCs to allow compare and restore operations.
Type: SwitchParameter
Parameter Sets: Firewall
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
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.
© ALL RIGHTS RESERVED. Feedback Terms of Use Privacy Cookie Preference Center