Chat now with support
Chat with Support

Recovery Manager for AD 10.2.2 - Management Shell Guide

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

Set-RMADHybridRecoveryDomainOptions

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

schema: 2.0.0

SYNOPSIS

{{ Fill in the Synopsis }}

SYNTAX

Set-RMADHybridRecoveryDomainOptions -Domain <String> -DomainController <String> -Credentials <PSCredential>
 [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

Example 1

PS C:\>$password = ConvertTo-SecureString 'mypassword' -AsPlainText -Force
PS C:\>$credentials = New-Object System.Management.Automation.PSCredential ('rmad-admin', $password)
PS C:\>Set-RMADHybridRecoveryDomainOptions -Domain rmad.local -DomainController DC1.rmad.local -Credentials $credentials

Returns: Nothing on success; otherwise an error

{{ Add example description here }}

PARAMETERS

-Credentials

{{ Fill Credentials Description }}

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Domain

{{ Fill Domain Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-DomainController

{{ Fill DomainController Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-IgnoreReadOnly

{{ Fill IgnoreReadOnly Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Set-RMADHybridRecoveryOptions

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

schema: 2.0.0

SYNOPSIS

{{ Fill in the Synopsis }}

SYNTAX

Relay (Default)

Set-RMADHybridRecoveryOptions [-Enabled <Boolean>] [-RelayUrl <String>] [-RelayKeyName <String>]
 [-RelayKey <SecureString>] [-UsePackedBackups <Boolean>] [-SkipReplication <Boolean>] [-IgnoreReadOnly]
 [-WhatIf] [-Confirm] [<CommonParameters>]

AADConnect

Set-RMADHybridRecoveryOptions [-Enabled <Boolean>] -AADConnectHost <String>
 -AADConnectCredentials <PSCredential> [-UsePackedBackups <Boolean>] [-SkipReplication <Boolean>]
 [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

Example 1

PS C:\>$key = ConvertTo-SecureString 'YDrMzfQWP8EliwRj41BtvNIZ4pH7i4pRW24klu8ZRcU=' -AsPlainText -Force
PS C:\>Set-RMADHybridRecoveryOptions -Enabled $true -RelayUrl 'https://relayurl' -RelayKeyName 'listenKey' -RelayKey $key -UsePackedBackups $true -SkipReplication $true

Returns: Nothing on success; otherwise an error

{{ Add example description here }}

PARAMETERS

-AADConnectCredentials

{{ Fill AADConnectCredentials Description }}

Type: PSCredential
Parameter Sets: AADConnect
Aliases:

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

-AADConnectHost

{{ Fill AADConnectHost Description }}

Type: String
Parameter Sets: AADConnect
Aliases:

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

-Enabled

{{ Fill Enabled Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-IgnoreReadOnly

{{ Fill IgnoreReadOnly Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RelayKey

{{ Fill RelayKey Description }}

Type: SecureString
Parameter Sets: Relay
Aliases:

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

-RelayKeyName

{{ Fill RelayKeyName Description }}

Type: String
Parameter Sets: Relay
Aliases:

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

-RelayUrl

{{ Fill RelayUrl Description }}

Type: String
Parameter Sets: Relay
Aliases:

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

-SkipReplication

{{ Fill SkipReplication Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-UsePackedBackups

{{ Fill UsePackedBackups Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

None

OUTPUTS

System.Object

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

ComputerName

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

InputObject

Set-RMADReplicationConsole [-AccessCredential <PSCredential>] [-Enabled <Boolean>]
 [-FallbackCredential <PSCredential>] [-InputObject] <ReplicationConsole[]> [<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

-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

-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

-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

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> [-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/2022 10:00" -DaysInterval 1), (New-RMADSchedule -Daily -StartDate "9/20/2022 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 2022.
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

-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

-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

-Confirm

Prompts for confirmation before executing the command.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Describes what would happen if you ran the command without actually running the command.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating