Chat now with support
Chat with Support

Recovery Manager for AD 10.1.1 - User Guide

Overview Getting started
Permissions required to use Recovery Manager for Active Directory Recovery Manager Console Getting and using help Configuring Windows Firewall Using Computer Collections Managing Recovery Manager for Active Directory configuration Licensing
Backing up data
Permissions required for the Backup operation Managing Backup Agent Using a least-privileged user account to back up data Using Managed Service Accounts Active Directory backups vs Windows System State backups Creating BMR and Active Directory backups Using the Backup Wizard Retrying backup creation Enabling backup encryption Backing up AD LDS (ADAM) Backing up cross-domain group membership Backing up distributed file system (DFS) data Backup scheduling Setting performance options Setting advanced backup options Unpacking backups Using e-mail notification Viewing backup creation results
Restoring data
Getting started with Active Directory recovery Managing deleted or recycled objects Restoring backed up Active Directory components Integration with Change Auditor for Active Directory Using granular online restore Restoring AD LDS (ADAM) Selectively restoring Active Directory object attributes Restoring objects in an application directory partition Restoring object quotas Restoring cross-domain group membership Performing a restore without having administrator privileges Reports about objects and operations Using complete offline restore Offline restore implications Restoring SYSVOL authoritatively Performing a granular restore of SYSVOL Recovering Group Policy Restoring data from third-party backups Using the Extract Wizard Restoring passwords and SID history
Full Replication Consolidating backup registration data Monitoring Recovery Manager for Active Directory Using Management Shell Collecting diagnostic data for technical support Using Recovery Manager for Active Directory web portal Appendices
Frequently asked questions Best practices for using Computer Collections Best practices for creating backups Ports Used by Recovery Manager for Active Directory Backup Wizard Online Restore Wizard Online Restore Wizard for AD LDS (ADAM) Group Policy Restore Wizard Repair Wizard Extract Wizard Technical characteristics Events generated by Recovery Manager for Active Directory Descriptions of PowerShell commands

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>]
 [-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

InputObject

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

Id

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

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

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

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

-BackupComponents

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

-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.
  • CpuUsageLimit.
    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

-Properties

  • ConsoleSideScriptBeforeBackupEnabled.
    Determines whether to run the PowerShell script specified in ConsoleSideScriptBeforeBackup parameter on the Recovery Manager console computer before the backup creation process is started. Can take one of these values: $true, $false.
  • ConsoleSideScriptBeforeBackup.
    Specifies the PowerShell script that is executed on the Recovery Manager console machine before the backup creation process is started.
  • ConsoleSideScriptStopBackup.
    Determines whether to stop the backup process if the script specified in ConsoleSideScriptBeforeBackup parameter cannot be run without errors. Can take one of these values: $true, $false.
  • ConsoleSideScriptAfterBackupEnabled.
    Determines whether to run the PowerShell script specified in ConsoleSideScriptAfterBackup parameter on the Recovery Manager console computer after backup is created. Can take one of these values: $true, $false.
  • ConsoleSideScriptAfterBackup.
    Specifies the PowerShell script that is executed on the Recovery Manager console computer after backup is created.
  • ConsoleSideScriptFailBackup.
    If the script specified in ConsoleSideScriptAfterBackup parameter fails, the backup process will be shown as failed with error in the Recovery Manager console. Can take one of these values: $true, $false.
  • ConsoleSideScriptCredential.
    Specify an account under which the scripts will be running on the Recovery Manager console computer. By default, the account under which the Recovery Manager Management Shell is launched will be used. Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
  • AgentSideScriptBeforeBackupEnabled.
    Determines whether to run the PowerShell script specified in AgentSideScriptBeforeBackup parameter on the domain controller before the backup creation process is started. Can take one of these values: $true, $false.
  • AgentSideScriptBeforeBackup.
    Specifies the PowerShell script that is executed on the domain controller before the backup creation process is started.
  • AgentSideScriptStopBackup.
    Determines whether to stop the backup process if the script specified in AgentSideScriptBeforeBackup parameter cannot be run without errors. Can take one of these values: $true, $false.
  • AgentSideScriptAfterBackupEnabled.
    Determines whether to run the PowerShell script specified in AgentSideScriptAfterBackup parameter on the domain controller after backup is created. Can take one of these values: $true, $false.
  • AgentSideScriptAfterBackup.
    Specifies the PowerShell script that is executed on the domain controller after backup is created.
  • AgentSideScriptFailBackup.
    If the script specified in AgentSideScriptAfterBackup parameter fails, the backup process will be shown as failed with error in the Recovery Manager console. Can take one of these values: $true, $false.
  • AgentSideScriptCredential.
    Specify an account under which the scripts will be running on domain controller. This parameter is mandatory if at least one of the agent side scripts is specified using AgentSideScriptBeforeBackup and AgentSideScriptAfterBackup parameters. Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
Type: Hashtable
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

-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

-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

-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

-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

-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

-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

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

-WhatIf

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

-Confirm

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

-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

-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

-InformationAction

@{Text=}

Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

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

-InformationVariable

@{Text=}

Type: String
Parameter Sets: (All)
Aliases: iv

Required: False
Position: Named
Default value: None
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-RMADGlobalOptions


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

schema: 2.0.0

SYNOPSIS

Sets global application settings

SYNTAX

Set-RMADGlobalOptions [-EmailServer <String>] [-EmailSender <String>] [-ExtendedLogging <Boolean>]
 [-Properties <Hashtable>] [-IgnoreReadOnly] [-InformationAction <ActionPreference>]
 [-InformationVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets Recovery Manager global application settings

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-EmailServer

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

-EmailSender

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

-ExtendedLogging

Specifies diagnostic logs

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Properties

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

  • Email.Server.
    Specifies the SMTP server for e-mail notifications
  • Email.Port.
    Specifies the SMTP port for e-mail notifications
  • Email.Sender.
    Specifies the sender of e-mail notifications
    LOGGING TAB
  • ExtendedLogging.
    Specifies option "Use diagnostic logging"
  • LogsFolder.
    Specify the directory for application logs.
Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
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: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

-Confirm

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

-InformationAction

@{Text=}

Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

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

-InformationVariable

@{Text=}

Type: String
Parameter Sets: (All)
Aliases: iv

Required: False
Position: Named
Default value: None
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-RMADReplicationConsole


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

schema: 2.0.0

SYNOPSIS

Sets replication properties of consoles in the replication console list.

SYNTAX

Id

Set-RMADReplicationConsole [-AccessCredential <PSCredential>] [-Enabled <Boolean>]
 [-FallbackCredential <PSCredential>] [-Id] <Int32[]> [-InformationAction <ActionPreference>]
 [-InformationVariable <String>] [<CommonParameters>]

ComputerName

Set-RMADReplicationConsole [-AccessCredential <PSCredential>] [-Enabled <Boolean>]
 [-FallbackCredential <PSCredential>] [-ComputerName] <String[]> [-InformationAction <ActionPreference>]
 [-InformationVariable <String>] [<CommonParameters>]

InputObject

Set-RMADReplicationConsole [-AccessCredential <PSCredential>] [-Enabled <Boolean>]
 [-FallbackCredential <PSCredential>] [-InputObject] <ReplicationConsole[]>
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

Updates user credentials for connecting to a specified computer, and enables/disables the manual and scheduled replication for the console.

EXAMPLES

Example 1

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.

Example 2

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.

Example 3

PS C:\> C:\>Set-RMADReplicationConsole -ComputerName Hostname1 -FallbackCredential $([System.Management.Automation.PSCredential]::Empty)

This command removes the fallback account for the console on Hostname1.

PARAMETERS

-AccessCredential

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

-Enabled

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

-FallbackCredential

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

-Id

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

-ComputerName

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

-InputObject

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

-InformationAction

@{Text=}

Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

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

-InformationVariable

@{Text=}

Type: String
Parameter Sets: (All)
Aliases: iv

Required: False
Position: Named
Default value: None
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-RMADReplicationSchedule


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

schema: 2.0.0

SYNOPSIS

Sets replication schedules for a computer.

SYNTAX

Set-RMADReplicationSchedule [-Schedules <Schedule[]>] -Credential <PSCredential>
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Sets replication schedules with credentials for the Recovery Manager computer you specify.

EXAMPLES

Example 1

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.

Example 2

PS C:\> $credential = Get-Credential
C:\PS>Set-RMADReplicationSchedule -Credential $credential

This command updates the credentials for an existing schedule.

PARAMETERS

-Schedules

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

-Credential

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

-WhatIf

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

-Confirm

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

-InformationAction

@{Text=}

Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

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

-InformationVariable

@{Text=}

Type: String
Parameter Sets: (All)
Aliases: iv

Required: False
Position: Named
Default value: None
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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating