立即与支持人员聊天
与支持团队交流

Recovery Manager for AD 10.3 - Management Shell Guide

Overview
About Management Shell Installing and opening Management Shell Getting Help Descriptions of PowerShell Commands
Add-RMADBackup Add-RMADCollectionItem Add-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADSecureStorageBackup Export-RMADStorageServers Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject Get-RMADGlobalOptions Get-RMADHybridRecoveryDomainOptions Get-RMADHybridRecoveryOptions Get-RMADLicenseInfo Get-RMADObject Get-RMADReplicationConsole Get-RMADReplicationSchedule Get-RMADReplicationSession Get-RMADReplicationSessionItem Get-RMADReportObject Get-RMADReportObjectAttributes Get-RMADReportObjectChildren Get-RMADReportSession Get-RMADSession Get-RMADSessionItem Get-RMADSessionItemEvent Get-RMADStorageServer Import-RMADBackup Install-RMADBackupAgent New-RMADCollection New-RMADSchedule Protect-RMADSecureStorageServer Publish-RMADBackupSecurityStatus Refresh-RMADStorageServer Register-RMADSecureStorageBackups Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADStorageServer Remove-RMADUnpackedComponent Rename-RMADCollection Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADObject Set-RMADCollection Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADLicense

Restore-RMADDeletedObject


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

schema: 2.0.0

SYNOPSIS

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

SYNTAX

Default (Default)

Restore-RMADDeletedObject [-ProcessRecycledObjects] [-Backup <Guid>] [-RestoreParent <RestoreParent>] [-Full]
 [-NoReport] [-SkipReplication] [-ReportUnchangedObjects] [-ReportUnchangedAttributes] [-RestoreTo <String>]
 [-KeepBackupUnpacked] [-Id] <String[]> [-ProcessChildren] [-ChildObjectClass <String[]>]
 [-ChangeAuditorDbName <String>] [-ChangeAuditorDbCredential <PSCredential>] [-RestoreUsingChangeAuditor]
 [-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
 [-WhatIf] [-Confirm] [<CommonParameters>]

ADLds

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>] [-ChangeAuditorDbCredential <PSCredential>] [-RestoreUsingChangeAuditor]
 [-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Bkf

Restore-RMADDeletedObject [-ProcessRecycledObjects] -Backup <Guid> [-BackupPassword <SecureString>] [-NoReport]
 [-SkipReplication] [-SQLCredential <PSCredential>] [-ReportUnchangedObjects] [-ReportUnchangedAttributes]
 [-RestoreTo <String>] [-AsJob] [-KeepBackupUnpacked] [-Id] <String[]> [-ProcessChildren]
 [-ChildObjectClass <String[]>] [-ChangeAuditorDbName <String>] [-ChangeAuditorDbCredential <PSCredential>]
 [-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
 [-Port <Int32>] [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

Firewall

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>]
 [-ChangeAuditorDbCredential <PSCredential>] [-ConfigureFirewall] [-RestoreUsingChangeAuditor]
 [-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Agentless

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>] [-ChangeAuditorDbCredential <PSCredential>] [-RestoreUsingChangeAuditor]
 [-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

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:

  • Restore deleted objects from Microsoft's Active Directory Recycle Bin (provided that it is available in your environment).
  • Restore deleted objects from a backup registered with Recovery Manager for Active Directory.
  • Reanimate object's tombstones.

You can only use this cmdlet when Windows PowerShell is started using MTA. To start Windows PowerShell using MTA, run this command: PowerShell -mta

EXAMPLES

Example 1

PS C:\> 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.

Example 2

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.

Example 3

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.

PARAMETERS

-AdLds

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

Type: SwitchParameter
Parameter Sets: ADLds
Aliases:

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

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

-AdLdsInstance

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

Type: String
Parameter Sets: ADLds
Aliases: AdamInstance

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

-AsJob

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: False
Accept pipeline input: False
Accept wildcard characters: False

-Backup

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

-BackupPassword

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

-ChangeAuditorDbCredential

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

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-ChangeAuditorDbName

Specifies 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

-ChildObjectClass

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

-ConfigureFirewall

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

-Credential

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

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Full

Specifies to restore the deleted objects with all their attributes. When this parameter is present, the cmdlet does one of the following:

  • Restores the deleted objects from Microsoft's Active Directory Recycle Bin. This occurs only if the Recycle Bin is available and if you do not specify to restore the deleted objects from a backup.
  • Restores the deleted object from the backup whose GUID you specify in the BackupGuid parameter. When this parameter is omitted, the cmdlet does one of the following:
  • If Microsoft's Active Directory Recycle Bin is available, the cmdlet completely undeletes the deleted objects from the Recycle Bin.
  • If Microsoft's Active Directory Recycle Bin is disabled or not supported, the cmdlet reanimates the objects' tombstones.

Type: SwitchParameter
Parameter Sets: Default, Firewall, Agentless
Aliases:

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

-Id

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

-IgnoreReadOnly

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-KeepBackupUnpacked

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-NoReport

Specifies to not create any report about the restore operation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Partition

Specifies the 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

-Port

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

-ProcessChildren

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

-ProcessRecycledObjects

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

-ReportUnchangedAttributes

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: False
Accept pipeline input: False
Accept wildcard characters: False

-ReportUnchangedObjects

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: False
Accept pipeline input: False
Accept wildcard characters: False

-RestoreParent

Restores the deleted parents of the deleted objects being recovered.
This parameter can take one of the following values:

  • Never - Specifies to not restore deleted parents.
  • Always - Specifies to always restore deleted parents.
  • Prompt - Prompts you for action.

Type: RestoreParent
Parameter Sets: Default, Firewall, Agentless
Aliases:
Accepted values: Never, Always, Prompt

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

-RestoreTo

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

-RestoreUsingChangeAuditor

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Server

Specifies the domain controller or ADAM instance host 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

-SkipReplication

Specifies to skip replication during the restore operation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-SQLCredential

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

Type: PSCredential
Parameter Sets: ADLds, Bkf, Firewall, Agentless
Aliases:

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

-UseAgentlessMethod

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

Type: SwitchParameter
Parameter Sets: Agentless
Aliases:

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

-Confirm

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

-WhatIf

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

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

 

Restore-RMADDomainController


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

schema: 2.0.0

SYNOPSIS

Restores a domain controller from backup.

SYNTAX

Default (Default)

Restore-RMADDomainController -Backup <BackupInfo> [-BackupComponents <BackupComponents>]
 [-BackupPassword <SecureString>] [-ComputerName <String>] [-Credential <PSCredential>]
 -DsrmCredential <PSCredential> [-ResetDsrmPassword] [-ManualRestartToDsrm] [-ManualRestartToNormal]
 [-MarkSysvolPrimary] [-AsJob] [-WhatIf] [<CommonParameters>]

AuthoritativeRestore

Restore-RMADDomainController -Backup <BackupInfo> [-BackupComponents <BackupComponents>]
 [-BackupPassword <SecureString>] [-ComputerName <String>] [-Credential <PSCredential>]
 -DsrmCredential <PSCredential> [-ResetDsrmPassword] [-ManualRestartToDsrm] [-ManualRestartToNormal]
 [-MarkSysvolPrimary] -AuthoritativeRestore <Boolean> [-AuthoritativeRestoreSubtree <String>] [-AsJob]
 [-WhatIf] [<CommonParameters>]

DESCRIPTION

Restores a domain controller from backup. During the Restore operation, the domain controller would be rebooted to the Directory Service Restore mode.

EXAMPLES

Example 1

PS C:\> $backup =  (Get-RMADBackup -ComputerName 'DC.Domain.local')[-1]                                                                                  
$dsrmCredential = New-Object PSCredential(".\Administrator", (ConvertTo-SecureString 'DsrmPassword' -AsPlainText -Force))
$job = Restore-RMADDomainController -ComputerName "DC.Domain.local" -Backup $backup -BackupComponents ActiveDirectory -DsrmCredential $dsrmCredential -AsJob
$job | Format-List

This command restores a domain controller from backup.

PARAMETERS

-AsJob

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: False
Accept pipeline input: False
Accept wildcard characters: False

-AuthoritativeRestore

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

-AuthoritativeRestoreSubtree

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

-Backup

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

-BackupComponents

Specifies the components of backup to be restored.

Type: BackupComponents
Parameter Sets: (All)
Aliases:
Accepted values: None, ActiveDirectory, Adam, BootFiles, CertificateServer, ClusterQuorum, EnterpriseServices, ForestRecoveryMetadata, GroupMembership, IisMetabase, PerformanceCounters, Registry, CryptoKeys, All

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 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

-ComputerName

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

-Credential

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

-DsrmCredential

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

-ManualRestartToDsrm

Specifies whether a domain controller will be rebooted to DSRM manually.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ManualRestartToNormal

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: False
Accept pipeline input: False
Accept wildcard characters: False

-MarkSysvolPrimary

Specifies to mark SYSVOL as primary.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ResetDsrmPassword

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: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Tests the connection to the restore agent

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Restore-RMADObject


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

schema: 2.0.0

SYNOPSIS

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

SYNTAX

Default (Default)

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

Bkf

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

ADLds

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

Firewall

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

Agentless

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

DESCRIPTION

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

EXAMPLES

Example 1

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

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

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

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

Example 2

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

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

Start-RMADReportViewer

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

PARAMETERS

-AdLds

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

Type: SwitchParameter
Parameter Sets: ADLds
Aliases:

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

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

-AdLdsInstance

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

Type: String
Parameter Sets: ADLds
Aliases: AdamInstance

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

-Attribute

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

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

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

-Backup

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

Type: Guid
Parameter Sets: (All)
Aliases:

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

-BackupPassword

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

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-ChangeAuditorDbCredential

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

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-ChangeAuditorDbName

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

Type: String
Parameter Sets: (All)
Aliases:

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

-ChildObjectClass

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

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

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

-ConfigureFirewall

Specifies whether Recovery Manager automatically configures Windows Firewall on 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

-Credential

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

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Id

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

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

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

-IgnoreReadOnly

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-KeepBackupUnpacked

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-NoReport

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Partition

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

Type: String
Parameter Sets: (All)
Aliases:

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

-Port

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

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ProcessChildren

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ReportUnchangedAttributes

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ReportUnchangedObjects

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RestoreUsingChangeAuditor

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Server

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

Type: String
Parameter Sets: (All)
Aliases:

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

-SkipReplication

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-SQLCredential

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

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-UseAgentlessMethod

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

Type: SwitchParameter
Parameter Sets: Agentless
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Set-RMADCollection


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

schema: 2.0.0

SYNOPSIS

Sets properties for a computer collection.

SYNTAX

Name (Default)

Set-RMADCollection [-Name] <String[]> [-BackupComponents <BackupComponents>] [-Properties <Hashtable>]
 [-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>] [-AgentCredentialEnabled <Boolean>]
 [-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>] [-StorageCredential <PSCredential>]
 [-ConsoleStorageCredential <PSCredential>] [-SecondaryStorageCredential <PSCredential>]
 [-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf]
 [-Confirm] [<CommonParameters>]

InputObject

Set-RMADCollection [-InputObject] <ComputerCollection[]> [-BackupComponents <BackupComponents>]
 [-Properties <Hashtable>] [-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>]
 [-AgentCredentialEnabled <Boolean>] [-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>]
 [-StorageCredential <PSCredential>] [-ConsoleStorageCredential <PSCredential>]
 [-SecondaryStorageCredential <PSCredential>] [-RetentionPolicyEnabled <Boolean>]
 [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

Id

Set-RMADCollection [-Id] <Int32[]> [-BackupComponents <BackupComponents>] [-Properties <Hashtable>]
 [-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>] [-AgentCredentialEnabled <Boolean>]
 [-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>] [-StorageCredential <PSCredential>]
 [-ConsoleStorageCredential <PSCredential>] [-SecondaryStorageCredential <PSCredential>]
 [-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets properties for the Recovery Manager computer collection you specify.

EXAMPLES

Example 1

PS C:\> Set-RMADCollection -Name Collection1 -BackupComponents ActiveDirectory,Registry,GroupMembership,ForestRecoveryMetadata

This command sets properties for the computer collection named Collection1.

Example 2

PS C:\> Set-RMADCollection * -RetentionPolicyEnabled $false

This command disables all backup retention policies for all existing computer collections.

Example 3

PS C:\> $c = Get-RMADCollection | Where-Object { $_.AgentCredentialEnabled -eq $true }

C:\PS>$cred = Get-Credential

C:\PS>Set-RMADCollection -InputObject $c -AgentCredential $cred

The first command in this example gets objects representing the computer collections whose properties are set to access Backup Agent and backup files with a specific user account. Then the command saves the computer collection objects in the $c variable.

Example 4

PS C:\> $a = Get-RMADCollection -Name "Collection1"

C:\PS>Set-RMADCollection -InputObject $a[1] -Properties @{BackupComponents="ActiveDirectory","BootFiles"; UsePreinstalledAgent=$true}

In the first line of this example, the Get-RMADCollection cmdlet gets the Computer Collection whose name is Collection1 and saves it to the $a variable. In the second line of this example, the Set-RMADCollection cmdlet sets the components to be backed up (that is, Active Directory and boot files) and specifies to use preinstalled Backup Agent for backup operations. For a complete list of items you can include in the braces, see the description of the Properties parameter.

Example 5

PS C:\> $schedule=(New-RMADSchedule -Daily -StartDate "9/20/2022 10:00" -DaysInterval 1), (New-RMADSchedule -Daily -StartDate "9/20/2022 22:00" -DaysInterval 1)

C:\PS>Set-RMADCollection -InputObject $col -Properties @{EnableEmailLog=$true; EmailLogTo="administrator@mydomain.com"; EmailLogLevel="Everything"}

This example illustrates how to back up a Computer Collection by using two backup schedules. The first line of this example creates two backup creation schedules and stores them in the $schedule variable. One schedule invokes the backup operation once in every two days at 10 a.m. Another schedule invokes the backup operation once in every two days at 10 p.m. The two backup schedules become effective starting from the 20th September 2022. The second line of this example enables e-mail notifications for the Computer Collection. The recipient address for e-mail notifications is administrator@mydomain.com. The e-mail notifications provide information about all backup events.

Example 6

PS C:\> $cred = Get-Credential

C:\PS>Set-RMADCollection -Name MyCollection -Properties @{AgentSideScriptBeforeBackupEnabled = $true; AgentSideScriptBeforeBackup = 'Set-Disk -Number 5 -IsOffline $false'; AgentSideScriptAfterBackupEnabled = $true; AgentSideScriptAfterBackup = 'Set-Disk -Number 5 -IsOffline $true'; AgentSideScriptCredential = $cred}

This example illustrates how to customize your environment by running PowerShell scripts on the domain controller before and after creating a backup.

PARAMETERS

-AgentCredential

Specifies the credentials for the account you want to use to access Backup Agent installed on the DCs in the computer collection and locations where backup files for the computer collection will be saved. TO enable using the account whose credentials you supply in this parameter, use the AgentCredentialEnabled parameter.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-AgentCredentialEnabled

Specifies to use a particular account to access Backup Agent installed on the DCs in the computer collection and locations where backup files for the computer collection will be saved. To specify the credentials for the account, use the AgentCredential parameter.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-BackupComponents

Use this parameter to specify the names of the System State components you want to back up.

Type: BackupComponents
Parameter Sets: (All)
Aliases:
Accepted values: None, ActiveDirectory, Adam, BootFiles, CertificateServer, ClusterQuorum, EnterpriseServices, ForestRecoveryMetadata, GroupMembership, IisMetabase, PerformanceCounters, Registry, CryptoKeys, All

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

-ConsoleStorageCredential

Specifies the credentials for the account you want to use to access local (console) backup files for the computer collection.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Id

Specifies the identifier of the computer collection whose properties you want to set.

Type: Int32[]
Parameter Sets: Id
Aliases:

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

-IgnoreReadOnly

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-InputObject

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: False

-Name

Specifies the name of the computer collection whose properties you want to set.

Type: String[]
Parameter Sets: Name
Aliases:

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

-PassThru

Passes the computer collection whose properties you have set along the pipeline. If this parameter is omitted, the computer collection is not passed along the pipeline.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Properties

Allows you to modify the Computer Collection properties.
To specify the properties you want to modify, use an associative array or hash table. For more information, see the Windows PowerShell help topic on associative arrays (hash tables). To open the topic, at the PoweShell command prompt enter the following: help about_associative_arrayBelow are the properties you can modify by using this parameter. The properties are grouped by the names of tabs in the "Computer Collection Properties" dialog box, because each property corresponds to an option on these tabs. To assign a new value to a property, use the following format: PropertyName=Value

  • UseAlternateStoragePath - Specifies whether to store a copy of each backup in an alternate location. Can take one of these values: $true, $false.
  • AlternateStoragePath - Specifies a storage path format for the alternate location. Surround the path with double quotes.
  • AgentCredentialEnabled - Causes the Recovery Manager console to use a specified user account to access the Backup Agent and backup files on target computers. Can take one of these values: $true, $false.
  • AgentCredential - Specifies the account under which the Recovery Manager console accesses the Backup Agent and backup files, in the form of a PSCredential object. Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
  • ConfigureFirewall - Specifies whether Recovery Manager automatically configures Windows Firewall on target Windows Server 2008-based or Windows Server 2012-based DCs to allow backup operations. Can take one of these values: $true, $false.
  • UsePreinstalledAgent - Specifies whether Recovery Manager automatically preinstalls the Backup Agent. Can take one of these values: $true, $false.
  • DeployForestRecoveryAgent - Specifies whether Recovery Manager verifies that the Forest Recovery Agent is installed on each domain controller in the Computer Collection. Can take one of these values: $true, $false.
  • BackupDescription - Specifies a description for the backups to be created for the Computer Collection. The description may include expressions, such as %COMPUTERNAME% and %DATETIME%.
  • BackupPasswordEnabled - Specifies whether to protect the backups with a password. Can take one of these values: $true, $false.
  • BackupPassword - Specifies a password to protect the backups. The value must be a SecureString object.
  • ConsoleSideBackupEnabled - Specifies to store backups on the Recovery Manager computer or on a Universal Naming Convention (UNC) share. Can take one of these values: $true, $false.
  • ConsoleSideBackupPath - Specifies a storage path format for backup files. The path format can include expressions, such as %COMPUTERNAME% and %DATETIME%. Surround the path format with double quotes.
  • ConsoleSideRetentionPolicyEnabled - Specifies whether to apply a retention policy to backups stored at the path provided in the ConsoleSideBackupPath parameter. Can take one of these values: $true, $false.
  • ConsoleSideRetentioPolicyCount - Specifies the number of the most recent backups to retain. Other backups are automatically deleted.
  • AgentSideBackupEnabled - Specifies to store backups on the backed-up DC or on a Universal Naming Convention (UNC) share. Can take one of these values: $true, $false.
  • AgentSideBackupPath - Specifies a storage path format for backup files. The path format can include expressions, such as %COMPUTERNAME% and %DATETIME%. Surround the path format with double quotes.
  • AgentSideRetentionPolicyEnabled - Specifies whether to apply a retention policy to backups stored at the path provided in the ConsoleSideBackupPath parameter. Can take one of these values: $true, $false.
  • AgentSideRetentionPolicyCount - Specifies the number of the most recent backups to retain. Other backups are automatically deleted.
  • StorageCredentialEnabled - Causes the Recovery Manager console to use a specified user account to access backup files on target computers. Can take one of these values: $true, $false.
  • StorageCredential - Specifies the account under which the Recovery Manager Backup Agent accesses the backup files, in the form of a PSCredential object. Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
  • EnableEmailLog - Specifies whether to send information about backup creation sessions by e-mail. Can take one of these values: $true, $false.
  • EnableEmailLogOnlyOnErrors - Specifies to send information over e-mail only when an error occurs. Can take one of these values: $true, $false.
  • EmailLogLevel - Specifies the type of information to send over e-mail. Possible values: "Everything", "ErrorsOnly".
  • EmailLogTo - Specifies the recipient's e-mail address to send the information about backup creation sessions.
  • EnableApplicationLog - Specifies whether to write information about backup creation sessions to the Windows application log on the Recovery Manager computer. Can take one of these values: $true, $false.
  • EnableApplicationLogOnlyOnErrors - Specifies whether to create an Application log event only upon backup creation session errors or warnings. Can take one of these values: $true, $false.
  • ApplicationLogLevel - Specifies the type of information to write to the Application log. Possible values: "Everything", "ErrorsOnly".
  • EnableLogFile - Specifies whether to write information about backup creation sessions to the additional text file you specify. Can take one of these values: $true, $false.
  • EnableLogFileOnlyOnErrors - Specifies whether to write information to the additional text file only upon backup creation session errors or warnings. Can take one of these values: $true, $false.
  • LogFileLevel - Specifies the type of information to write to the additional text file. Possible values: "Everything", "ErrorsOnly".
  • LogFileName - Specifies a path and name for the additional text file.
  • LogFileAppend - Specifies whether to append information to the additional text file. Can take one of these values: "True", "False".
  • ExtendedLogging - Specifies the logging settings for DCs in the collection. Can take one of these values: Use global (default) - use settings from the root node: Recovery Manager for Active Directory->Settings…>Logging, Yes - for all DCs in the current collection: for logs will be used the "Trace" option, No - for all DCs in the current collection: in logs will be only Warnings and Error messages.
  • CompressionMethod - Specifies a method to compress the backups to be created. Can take one of these values: "None", "Fast", "Normal", "Maximum".
  • ParallelBackups - Specifies the maximum number of computers serviced in parallel when creating backups. Increasing this number can speed the backup creation, however, this may result in network saturation and slow network response.
  • EnableTransferRateLimit - Specifies whether to limit the total bandwidth used by the Backup Agent when transferring data over the network. Use this property to prevent the Backup Agent from generating excessive network traffic. Can take one of these values: $true, $false.
  • TransferRaleLimit - Specifies the bandwidth limit in Mbits/sec for the Backup Agent.
  • EnableCpuUsageLimit - Specifies whether to limit the CPU processing time used by the Backup Agent on each computer. Can take one of these values: $true, $false.
  • CpuUsageLimit88 - Specifies the CPU processing limit in percent.
  • ScheduleEnabled - Specifies whether to enable backup creation schedule. Can take one of these values: $true, $false.
  • Schedule - Sets up a backup creation schedule. To set up a schedule, use the New-RMADSchedule cmdlet.
  • ScheduleCredential - Specify the user account under which the Task Scheduler performs backup creation tasks, in the form of a PSCredential object. Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
  • BackupComponents - Specifies the system state components to back up. Possible values: "All", "None", "ActiveDirectory", "Adam", "BootFiles", "CertificateServer", "ClusterQuorum", "EnterpriseServices", "ForestRecoveryMetadata", "GroupMembership", "IisMetabase", "PerformanceCounters", "Registry". When specifying multiple values, use a comma as a separator.
  • CollectGroupMembership - Specifies whether to back up group membership data stored on Global Catalog servers. Can take one of these values: $true, $false.
  • CollectForestRecoveryMetadata - Specifies whether to create backups that can be used to recover the Active Directory forest. Can take one of these values: $true, $false.
  • OverrideDefaultBackupUnpackSettings - Specifies whether to override the global settings for unpacking backups for the Computer Collection. Can take one of these values: $true, $false.
  • UnpackBackupsUponCreation - Specifies whether to unpack each backup upon its creation. Can take one of these values: $true, $false.
  • UnpackedBackupsToKeep - Specifies the number of the most recent unpacked backups to retain. Other unpacked backups are automatically deleted.
  • IsUnpackOnlySelected - Specifies whether to keep unpacked backups only for a list of selected domain controllers. Can take one of these values: $true, $false.
  • SelectedDCsToUnpack - Specifies the names (separated by comma) of domain controllers you want to keep unpacked backups for.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-RetentionPolicyCount

Specifies the number of latest backups you want to keep for each DC in the computer collection. To enable the deletion of obsolete backups, use the RetentionPolicyEnabled parameter.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-RetentionPolicyEnabled

Specifies to delete obsolete backups for particular computer collection. To set the number of latest backups you want to keep for each DC in the computer collection, use the RetentionPolicyCount parameter.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Schedule

Causes the computer collection you specify to use the backup creation schedule you set by using the New-RMADSchedule cmdlet.

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

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

-ScheduleCredential

Specifies the user account under which the scheduled backup creation task will be run. This account must have sufficient permissions to back up the computer collection you specify.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-SecondaryStorageCredential

Specifies the credentials for the account you want to use to Tier 1 remote storage to copy backups to the secondary storage like Secure Storage Server or Cloud Storage.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-StorageCredential

Specifies the credentials for the account you want to use to access locations where backup files for the computer collection will be saved. To enable using the account whose credentials you supply in this parameter, use the StorageCredentialEnabled parameter.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-StorageCredentialEnabled

Specifies to use a particular account to access locations where backup files for the computer collection will be saved. To specify the credentials for the account, use the StorageCredential parameter.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Confirm

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

-WhatIf

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

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

 

相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级