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: True
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
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 executed the command without actually executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts for a confirmation before executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Renames the computer collection represented by the specified collection objects.
Specify the name of the variable that contains the objects or type a command or expression that gets the objects.
Type: ComputerCollection[]
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: 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:\> {{ Add example code here }}
{{ Add example description here }}
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 executed the command without actually executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts for a confirmation before executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{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 replication properties of consoles in the replication console list.
Set-RMADReplicationConsole [-AccessCredential <PSCredential>] [-Enabled <Boolean>]
[-FallbackCredential <PSCredential>] [-Id] <Int32[]> [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
Set-RMADReplicationConsole [-AccessCredential <PSCredential>] [-Enabled <Boolean>]
[-FallbackCredential <PSCredential>] [-ComputerName] <String[]> [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
Set-RMADReplicationConsole [-AccessCredential <PSCredential>] [-Enabled <Boolean>]
[-FallbackCredential <PSCredential>] [-InputObject] <ReplicationConsole[]>
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Updates user credentials for connecting to a specified computer, and enables/disables the manual and scheduled replication for the console.
PS C:\> C:\>$credential = Get-Credential
C:\>Set-RMADReplicationConsole -ComputerName Hostname1 -AccessCredential $credential -Enabled $true
This command changes the credentials for accessing the console on Hostname1, and enables the replication for the console.
PS C:\> C:\>Set-RMADReplicationConsole -Id 1 -AccessCredential $credential -Enabled $true
This command changes the credentials for accessing the console with specified ID, and enables the replication for the console.
PS C:\> C:\>Set-RMADReplicationConsole -ComputerName Hostname1 -FallbackCredential $([System.Management.Automation.PSCredential]::Empty)
This command removes the fallback account for the console on Hostname1.
Specifies the user credentials to read data from the target computer.
The user must be a local Administrator on the target computer.
To obtain the user credentials, create a PSCredential object using the Get-Credential cmdlet provided by Windows PowerShell.
If you need to use the credentials of the currently logged in user, specify [System.Management.Automation.PSCredential]::Empty value for this parameter.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Set replication item enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Supplies a fallback account for replacing the account that is used by the backup schedule task.
The account must have administrator privileges on the system(s) to be backed up.
If you need to reset the fallback account, specify [System.Management.Automation.PSCredential]::Empty value for this parameter.
You can use this parameter only when Full mode is set for the console.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the ID of the replication console.
Type: Int32[]
Parameter Sets: Id
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Specifies the hostname of the replication console.
Type: String[]
Parameter Sets: ComputerName
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Specifies the replication console object you want to update.
Type: ReplicationConsole[]
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Sets replication schedules for a computer.
Set-RMADReplicationSchedule [-Schedules <Schedule[]>] -Credential <PSCredential>
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Sets replication schedules with credentials for the Recovery Manager computer you specify.
PS C:\> $credential = Get-Credential
$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-RMADReplicationSchedule -Schedule $schedule
This example illustrates how to replicate computers by using two replication schedules.
The first line of this example creates a PSCredential object.
The second line of this example creates two replication schedules and stores them in the $schedule variable.
One schedule invokes the replicate operation once in every two days at 10 a.m.
Another schedule invokes the replicate operation once in every two days at 10 p.m.
The two replication schedules become effective starting from the 20th September 2013.
The third line of this example set schedules with credentials to the computer you specify.
PS C:\> $credential = Get-Credential
C:\PS>Set-RMADReplicationSchedule -Credential $credential
This command updates the credentials for an existing schedule.
Causes the computer you specify to use the replication 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 credentials for setting the replication schedule.
The user must be a local Administrator on the target computer.
To obtain the user credentials, create a PSCredential object using the Get-Credential cmdlet provided by Windows PowerShell.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Describes what would happen if you executed the command without actually executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts for 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.
© ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center