external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Compares Active Directory objects. This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Compare-RMADObject [-ProcessRecycledObjects] [-Attribute <String[]>] [-Server <String>]
[-Credential <PSCredential>] [-Backup <Guid>] [-Backup1 <Guid>] [-Backup2 <Guid>]
[-Backup1Password <SecureString>] [-Backup2Password <SecureString>] [-KeepBackupUnpacked] [-Id] <String[]>
[-ProcessChildren] [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>] [-ChangeAuditorDbCredential <PSCredential>]
[-RestoreUsingChangeAuditor] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Compare-RMADObject [-ProcessRecycledObjects] [-Attribute <String[]>] [-Server <String>]
[-Credential <PSCredential>] -Backup <Guid> [-BackupPassword <SecureString>] [-KeepBackupUnpacked]
[-Id] <String[]> [-ProcessChildren] [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes]
[-ReportUnchangedObjects] [-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>]
[-ChangeAuditorDbCredential <PSCredential>] [-RestoreUsingChangeAuditor] [-Partition <String>] [-Port <Int32>]
[-IgnoreReadOnly] [<CommonParameters>]
Compare-RMADObject [-ProcessRecycledObjects] [-Attribute <String[]>] [-Server <String>]
[-Credential <PSCredential>] [-Backup <Guid>] [-BackupPassword <SecureString>] [-KeepBackupUnpacked]
[-Id] <String[]> [-ProcessChildren] [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes]
[-ReportUnchangedObjects] [-SQLCredential <PSCredential>] [-AdLds] -AdLdsInstance <String>
[-ChangeAuditorDbName <String>] [-ChangeAuditorDbCredential <PSCredential>] [-RestoreUsingChangeAuditor]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Compare-RMADObject [-ProcessRecycledObjects] [-Attribute <String[]>] [-Server <String>]
[-Credential <PSCredential>] [-Backup <Guid>] [-BackupPassword <SecureString>] [-KeepBackupUnpacked]
[-Id] <String[]> [-ProcessChildren] [-ChildObjectClass <String[]>] [-ReportUnchangedAttributes]
[-ReportUnchangedObjects] [-SQLCredential <PSCredential>] [-AdLds] [-ChangeAuditorDbName <String>]
[-ChangeAuditorDbCredential <PSCredential>] [-ConfigureFirewall] [-RestoreUsingChangeAuditor]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Compare-RMADObject [-ProcessRecycledObjects] [-Attribute <String[]>] [-Server <String>]
[-Credential <PSCredential>] [-Backup <Guid>] [-BackupPassword <SecureString>] [-KeepBackupUnpacked]
[-Id] <String[]> [-UseAgentlessMethod] [-ProcessChildren] [-ChildObjectClass <String[]>]
[-ReportUnchangedAttributes] [-ReportUnchangedObjects] [-SQLCredential <PSCredential>] [-AdLds]
[-ChangeAuditorDbName <String>] [-ChangeAuditorDbCredential <PSCredential>] [-RestoreUsingChangeAuditor]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Compare-RMADObject [-ProcessRecycledObjects] [-Attribute <String[]>] [-Server <String>]
[-Credential <PSCredential>] -Backup1 <Guid> -Backup2 <Guid> [-Backup1Password <SecureString>]
[-Backup2Password <SecureString>] [-KeepBackupUnpacked] [-Id] <String[]> [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>] [-ChangeAuditorDbCredential <PSCredential>]
[-RestoreUsingChangeAuditor] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Allows you to compare the following:
To fill in the 'ModifyBy' field for a report, use the ChangeAuditorDbName parameter. To view a report about the compare operation performed by this cmdlet, use the Start-RMADReportViewer cmdlet. 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:\> $b = (Get-RMADBackup -Domain dom1.local | Sort-Object -Property Date)[-1]
C:\PS>Compare-RMADObject -Backup $b.Path -Id "ou=ou1,dc=dom1,dc=local"
-ProcessChildren -ChangeAuditorDbName ".\ChangeAuditor"
In this example, the Get-RMADBackup cmdlet gets all backups existing for the dom1.local domain.
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
If you compare the object changes in AD LDS (ADAM), you should specify the AD LDS (ADAM) 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 the display names of the object attributes to compare. 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
Specifies the backup that contains the AD objects to be compared. Use this parameter if you want to compare AD objects in a backup with their counterparts in Active Directory.
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: ADAndBackup
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the first backup that contains the AD objects to be compared. Use this parameter if you want to compare AD objects held in backups. The backup specified in this parameter must be registered in the Recovery Manager database.
Type: Guid
Parameter Sets: Default
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Guid
Parameter Sets: TwoBackups
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the password to access the first backup, if the backup is password-protected. This is the same password that is set for the backup in the Recovery Manager console.
Type: SecureString
Parameter Sets: Default, TwoBackups
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the second backup that contains the AD objects to be compared. Use this parameter if you want to compare AD objects held in backups. The backup specified in this parameter must be registered in the Recovery Manager database.
Type: Guid
Parameter Sets: Default
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Guid
Parameter Sets: TwoBackups
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the password to access the second backup, if the backup is password-protected. This is the same password that is set for the backup in the Recovery Manager console.
Type: SecureString
Parameter Sets: Default, TwoBackups
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 computer collection properties in the Recovery Manager console.
Type: SecureString
Parameter Sets: ADAndBackup, ADLds, Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Specifies a 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
Specifies the child object classes to process. When specifying multiple classes, 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
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
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. Use this parameter if you want to compare AD objects in a backup with their counterparts in Active Directory. If this parameter is omitted, the credentials of current user account are used. This parameter is ignored if you compare AD objects in a backup with their counterparts in another backup.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the objects to compare. 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
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
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
Specifies the AD LDS (ADAM) partition where you want to compare 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 that hosts the objects you want to compare.
Type: Int32
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: False
Accept pipeline input: False
Accept wildcard characters: False
When present, specifies to process recycled objects.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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: False
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: False
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: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies the domain controller or ADAM instance host from which 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, 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
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 compare 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 to use the agentless method to access a domain controller. Use this parameter if you want to compare AD objects in a backup with their counterparts in Active Directory. If this parameter is omitted, the domain controller is accessed by using Restore Agent. This parameter is ignored if you compare AD objects in a backup with their counterparts in another backup.
Type: SwitchParameter
Parameter Sets: Agentless
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
The Backup 1 and Backup 2 parameters must specify backups for the same domain controller. In the DomainController parameter, you must specify the same domain controller whose backup you specified in the Backup parameter.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Converts Windows Server backups into RMAD Bare Metal Recovery backups.
Convert-RMADBackup [-WindowsServerBackupLocation] <String> [-BareMetalRecoveryPath] <String> [-AsJob]
[<CommonParameters>]
Converts Windows Server Backups into RMAD Bare Metal Recovery backups.
PS C:\> Convert-RMADBackup \\backup_srv01\wsb\WindowsImageBackup \\backup_srv01\rmad\bmr.vhdx
Synchronously starts the conversion of the Windows Server backup to the bmr.vhdx file located on the network share.
PS C:\> Convert-RMADBackup \\backup_srv01\wsb\WindowsImageBackup \\backup_srv01\rmad\bmr.vhdx | Add-RMADBackup
Synchronously starts the conversion of the Windows Server backup located at the remote network share, puts the result into the bmr.vhdx file, and then registers the resulting backup.
PS C:\> $job = Convert-RMADBackup D:\WindowsImageBackup D:\bmr.vhdx
-AsJob $job.StatusMessage
Runs conversion as a background job and shows the current status message.
Runs the conversion process as a background job.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies the full path to the RMAD Bare Metal Recovery backup file.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the full path to the Windows Server backup. You must specify the path including the WindowsImageBackup folder.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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:
Recycles specific deleted Active Directory objects.
ConvertTo-RMADRecycledObject -Name <String[]> [-Force] [-Server <String>] [-Credential <PSCredential>]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]
Allows you to manually recycle specific deleted Active Directory objects held in Microsoft's Active Directory Recycle Bin in the forest where Recovery Manager is installed. This cmdlet overrides the deleted object lifetime setting that applies to the deleted objects being recycled. You can only use this cmdlet if Microsoft's Active Directory Recycle Bin feature is enabled in the forest where Recovery Manager is installed.
PS C:\> (Get-RMADDeletedObject dc1.dom1.lab.local) |
Where-Object { $_.objectclass -contains "user" } |
Foreach-Object { ConvertTo-RMADRecycledObject -Name $_.Name -Server dc1.dom1.lab.local }
This example shows how to recycle all user objects held in Microsoft's Active Directory Recycle Bin. The Get-RMADDeletedObject cmdlet gets all deleted objects from Microsoft's Active Directory Recycle Bin by connecting to the dc1.dom1.lab.local domain controller. Then the Get-RMADDeletedObject cmdlet pipes the objects to the Where-Object cmdlet that filters out user objects. Then, the Foreach-Object cmdlet uses the ConvertTo-RMADRecycledObject cmdlet to transfer each user object to the recycled state.
PS C:\> ConvertTo-RMADRecycledObject -Name "User 1\0ADEL:7dbac5c7-f38d-4270-8ac2-7a0674bc246b"
Converts the deleted object "User 1\0ADEL:7dbac5c7-f38d-4270-8ac2-7a0674bc246b" to recycled state.
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
Suppresses the cmdlet prompt for confirmation. When this parameter is omitted, the cmdlet prompts you for confirmation before recycling objects.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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: False
Accept pipeline input: False
Accept wildcard characters: False
Allows you to specify the deleted object you want to recycle. To specify a deleted object, enter the value of the object's Name attribute in this parameter. The Name attribute provides the object's relative distinguished name (RDN) that looks similar to the following: User 1\0ADEL:7dbac5c7-f38d-4270-8ac2-7a0674bc246b
To view the value of the Name attribute for a deleted object, you can use the Get-RMADDeletedObject cmdlet.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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
Specifies the Active Directory domain, domain controller, or AD LDS (ADAM) instance host from which you want the cmdlet to retrieve objects. If this parameter is omitted, the cmdlet retrieves objects from any available domain controller in the current domain. To specify a domain controller or AD LDS (ADAM) instance host, use the computer name or IP address. If you specify an Active Directory domain name in this parameter, the cmdlet retrieves objects from any available domain controller in the specified domain.
Type: String
Parameter Sets: (All)
Aliases:
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: False
Accept pipeline input: False
Accept wildcard characters: False
Describes what would happen if you ran the command without actually running the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Creates storage server agent setup.
Create-RMADStorageAgentSetup [-Path] <String> [-Port <Int32>] [<CommonParameters>]
Create storage server agent setup bundle packed to the ZIP archive that contains required components to deploy the storage server agent.
PS C:\> Create-RMADStorageAgentSetup -Path "C:\Setup.zip" -StorageAgentPort 48001
Creates a setup bundle and puts it in the specified file.
Path to the result file in which the setup will be created.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Port that will be used to run storage agent on.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center