external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Adds a secure storage server, optionally remotely installs a storage server agent.
Add-RMADStorageServer [-Name] <String> [-Port <Int32>] [-Credential <PSCredential>] [-RegisterBackups]
[-InstallAgent] [-IgnoreReadOnly] [<CommonParameters>]
Registers a secure storage server in Recovery Manager for Active Directory.
PS C:\> Add-RMADStorageServer -Name "backupsrv01.acme.test" -Port 48001
Registers the secure storage server with given name and connection port.
Server credentials used for remote agent installation. Ignored if the '-InstallAgent' switch is not set.
Type: PSCredential
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
If set, automatically installs storage server agent.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
DNS name or IP address of the server.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Port used to connect to the secure storage agent.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
If set, backups on an existing storage server will be registered.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Backs up an existing computer collection.
Backup-RMADCollection [-InputObject] <ComputerCollection> [-AsJob] [-IgnoreReadOnly] [<CommonParameters>]
Backup-RMADCollection [-Name] <String> [-AsJob] [-IgnoreReadOnly] [<CommonParameters>]
Backs up the existing computer collection that has the specified name or is represented by the specified objects.
PS C:\> Backup-RMADCollection -Name "Collection1"
Backs up the Computer Collection named Collection1.
PS C:\> Get-RMADCollection -Id 1 | Backup-RMADCollection
Gets the Computer Collection whose identifier is 1, and then backs up that Computer Collection.
PS C:\> $c = Get-RMADCollection -Name col
C:\PS>Backup-RMADCollection -InputObject $c -AsJob
In the first line of this command, the Get-RMADCollection cmdlet gets the computer collection named col.
The computer collection object is then stored in the $c variable.
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: (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
Backs up the existing Computer Collection represented by the specified collection object.
Enter a variable that contains the object or type a command or expression that gets the object.
Type: ComputerCollection
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the name of the existing Computer Collection to be backed up.
Type: String
Parameter Sets: Name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, 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.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Closes currently opened recovery project.
Close-RMADFEProject [<CommonParameters>]
This cmdlet allows you to close previously opened recovery project in the current PowerShell session.
PS C:\> Close-RMADFEProject
Closes currently opened by Open-RMADFEProject recovery project.
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:
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:* Live Active Directory objects against their versions in a backup.
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 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: 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.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center