external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Restores a domain controller from backup.
Restore-RMADDomainController -Backup <BackupInfo> [-BackupComponents <BackupComponents>]
[-BackupPassword <SecureString>] [-ComputerName <String>] [-Credential <PSCredential>]
-DsrmCredential <PSCredential> [-ResetDsrmPassword] [-ManualRestartToDsrm] [-ManualRestartToNormal]
[-MarkSysvolPrimary] [-AsJob] [-WhatIf] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
Restore-RMADDomainController -Backup <BackupInfo> [-BackupComponents <BackupComponents>]
[-BackupPassword <SecureString>] [-ComputerName <String>] [-Credential <PSCredential>]
-DsrmCredential <PSCredential> [-ResetDsrmPassword] [-ManualRestartToDsrm] [-ManualRestartToNormal]
[-MarkSysvolPrimary] -AuthoritativeRestore <Boolean> [-AuthoritativeRestoreSubtree <String>] [-AsJob]
[-WhatIf] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Restores a domain controller from backup.
During the Restore operation, the domain controller would be rebooted to the Directory Service Restore mode.
PS C:\> $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.
Specifies the backup that contains the data to be restored.
Type: BackupInfo
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the components of backup to be restored.
Type: BackupComponents
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the password to access a password-protected backup.
This is the same password that is set in the properties of the computer collection in the Recovery Manager for Active Directory console.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies DNS name or IP address of the domain controller to be restored.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies credentials to access the domain controller and then deploy and connect to the Restore Agent in the Normal mode.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies credentials for the Directory Service Restore Mode.
If ResetDSRMPassword is specified, the password will be reset.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether the DSRM password will be reset to the password from the DSRMCredential parameter.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether a domain controller will be rebooted to DSRM manually.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether a domain controller will be rebooted to the Normal mode manually after the Restore operation is completed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies to mark SYSVOL as primary.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Runs a command as a background job.
You can use this parameter to run commands that take a significant amount of time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Tests the connection to the restore agent
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Performs an authoritative restore.
Type: Boolean
Parameter Sets: AuthoritativeRestore
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a subtree that will be marked as authoritative.
If this parameter is not specified, the whole Active Directory will be marked as authoritative.
Type: String
Parameter Sets: AuthoritativeRestore
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Restores Active Directory objects from a backup.
This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor]
[-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor]
[-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-AdLds] -AdLdsInstance <String> [-ChangeAuditorDbName <String>]
[-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
[-Port <Int32>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-AdLds] [-ChangeAuditorDbName <String>] [-ConfigureFirewall]
[-RestoreUsingChangeAuditor] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
[-Port <Int32>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Restore-RMADObject [-Attribute <String[]>] [-NoReport] [-SkipReplication] [-KeepBackupUnpacked]
[-Id] <String[]> -Backup <Guid> [-BackupPassword <SecureString>] [-UseAgentlessMethod] [-ProcessChildren]
[-ChildObjectClass <String[]>] [-ReportUnchangedAttributes] [-ReportUnchangedObjects]
[-SQLCredential <PSCredential>] [-AdLds] [-ChangeAuditorDbName <String>] [-RestoreUsingChangeAuditor]
[-Server <String>] [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Restores the Active Directory objects that have specified parameters from a backup.
You can only use this cmdlet when Windows PowerShell is started using MTA.
To start Windows PowerShell using MTA, run this command:
PowerShell -mta
PS C:\> $backups = Get-RMADBackup | Sort-Object -Property date -Descending
C:\PS>$object = Get-RMADObject -Id "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.
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.
Specifies the display names of the attributes to restore.
When specifying multiple display names, use a comma as a separator.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
When present, specifies to not create any report about the restore operation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
When present, specifies to skip replication during the restore operation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Determines whether to save the unpacked backup after the search operation.
If this parameter is not set, the unpacked backup will be deleted after the search operation is completed.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the objects to restore.
To specify an object, you can use object GUID, distinguished name (DN), sAMAccountName, or user principal name (UPN).
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the backup that contains the AD objects to be restored.
Type: Guid
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the password to access a password-protected backup.
This is the same password that is set in the computer collection properties in the Recovery Manager console.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
When present, specifies to process children of the objects specified in the Id attribute.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Allows you to restore only those child objects that belong to the classes you specify in this parameter.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Includes the object attributes that have not changed since the time of the specified backup into the operation report.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Includes the objects that have not changed since the time of the specified backup into the operation report.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the user name and password of the user account with which you want to connect to SQL Server to generate a report about the performed operation.
The user name and password must be in the form of a PSCredential object.
When this parameter is omitted, the cmdlet uses the credentials of the account under which Management Shell is running.
Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the location of the ChangeAuditor SQL database.
If this parameter is omitted, the 'ModifyBy' cell in AD reports will be empty.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies if Change Auditor is used to restore the latest changes to the object.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the domain controller or ADAM instance host on which objects are to be restored.
The domain controller can be specified by its computer name, IP address, or domain name.
If you specify a domain name, deleted objects are restored to any available domain controller in the specified domain.
The ADAM instance host can be specified by its computer name or IP address.
If this parameter is omitted, objects are restored to any available domain controller in the current domain.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The user name and password of the user account with which you want to connect, in the form of a PSCredential object.
Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
If this parameter is omitted, the credentials of current user account are used.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the AD LDS (ADAM) partition where you want to restore objects.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the port on which to access the AD LDS (ADAM) instance where you want to restore objects.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Allows you to perform the action in a console currently performing full replication.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies that the AD LDS instance is used as a data storage.
Type: SwitchParameter
Parameter Sets: ADLds
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: Firewall, Agentless
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
If you restore the backed up AD LDS (ADAM) objects, you should specify the AD LDS instance whose backup you want to use.
Type: String
Parameter Sets: ADLds
Aliases: AdamInstance
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether Recovery Manager automatically configures Windows Firewall on target Windows Server 2008-based or Windows Server 2012-based DCs to allow compare and restore operations.
Type: SwitchParameter
Parameter Sets: Firewall
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies to use the agentless method to access the target domain controller.
If this parameter is omitted, the target domain controller is accessed via Restore Agent.
Type: SwitchParameter
Parameter Sets: Agentless
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Sets properties for a computer collection.
Set-RMADCollection [-Name] <String[]> [-BackupComponents <BackupComponents>] [-Properties <Hashtable>]
[-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>] [-AgentCredentialEnabled <Boolean>]
[-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>] [-StorageCredential <PSCredential>]
[-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-RMADCollection [-InputObject] <ComputerCollection[]> [-BackupComponents <BackupComponents>]
[-Properties <Hashtable>] [-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>]
[-AgentCredentialEnabled <Boolean>] [-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>]
[-StorageCredential <PSCredential>] [-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>]
[-PassThru] [-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-RMADCollection [-Id] <Int32[]> [-BackupComponents <BackupComponents>] [-Properties <Hashtable>]
[-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>] [-AgentCredentialEnabled <Boolean>]
[-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>] [-StorageCredential <PSCredential>]
[-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Sets properties for the Recovery Manager computer collection you specify.
PS C:\> Set-RMADCollection -Name Collection1 -BackupComponents ActiveDirectory,Registry,GroupMembership,ForestRecoveryMetadata
This command sets properties for the computer collection named Collection1.
PS C:\> Set-RMADCollection * -RetentionPolicyEnabled $false
This command disables all backup retention policies for all existing computer collections.
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.
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.
PS C:\> $schedule=(New-RMADSchedule -Daily -StartDate "9/20/2013 10:00" -DaysInterval 1), (New-RMADSchedule -Daily -StartDate "9/20/2013 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 2013.
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.
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.
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
Use this parameter to specify the names of the System State components you want to back up.
Type: BackupComponents
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
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
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
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
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
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
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
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: None
Accept pipeline input: False
Accept wildcard characters: False
Allows you to perform the action in a console currently performing full replication.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Describes what would happen if you ran the command without actually running the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts for a confirmation before executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Renames the computer collection represented by the specified collection objects.
Specify the name of the variable that contains the objects or type a command or expression that gets the objects.
Type: ComputerCollection[]
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
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
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Sets global application settings
Set-RMADGlobalOptions [-EmailServer <String>] [-EmailSender <String>] [-ExtendedLogging <Boolean>]
[-Properties <Hashtable>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Sets Recovery Manager global application settings
PS C:\> Set-RMADGlobalOptions -EmailServer "WS.DomainName.local"
Set-RMADGlobalOptions -EmailSender "from@WS.DomainName.local"
Set-RMADGlobalOptions -ExtendedLogging $True
This command sets global email settings in Recovery Manager for Active Directory.
PS C:\> $mailOptions = @{
"Email.Server" ='WS.DomainName.local';
"Email.UseSSL" =$True;
"Email.Sender" ='from@WS.DomainName.local';
"Email.AuthRequired" =$True;
"Email.UserName" ='SmtpAccount';
"Email.Password" ='Password'
}
Set-RMADGlobalOptions -Properties $mailOptions
This command sets global email settings in Recovery Manager for Active Directory using the 'Properties' option.
PS C:\> Set-RMADGlobalOptions -Properties @{"UseRestoreAgentPort" = $True; "DefaultRestoreMethod" = 0; "AgentPort" = 3845 }
This command sets Recovery Manager global settings for agent.
Specifies the SMTP server for e-mail notifications
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the sender field of e-mail notifications
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies diagnostic logs
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Allows you to modify the application settings.
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 E-MAIL TAB
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Allows you to perform the action in a console currently performing full replication.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Describes what would happen if you ran the command without actually running the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts for a confirmation before executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Termini di utilizzo Privacy Cookie Preference Center