Chat now with support
Chat with Support

Recovery Manager for AD Disaster Recovery Edition 10.3 - Management Shell Guide

Overview
About Management Shell Installing and opening Management Shell Getting Help Descriptions of PowerShell Commands
Add-RMADBackup Add-RMADCollectionItem Add-RMADFECloudStorage Add-RMADReplicationConsole Add-RMADStorageServer Add-RMADStorageServerException Backup-RMADCollection Backup-RMADFEConsoleConfiguration Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Copy-RMADFEBackup Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFECloudStorageBackup Export-RMADFECloudStorageServers Export-RMADFERecoveryCertificate Export-RMADFEResult Export-RMADSecureStorageBackup Export-RMADStorageServers Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject Get-RMADFEAvailableSubnet Get-RMADFECloudStorage Get-RMADFECloudStorageCollection Get-RMADFECloudStorageUploadSession Get-RMADFEComputer Get-RMADFEConsole Get-RMADFEConsoleConfigurationBackupSchedule Get-RMADFEConsoleConfigurationProjectFiles Get-RMADFEDnsCache Get-RMADFEDomain Get-RMADFEEvent Get-RMADFEGlobalOptions Get-RMADFEOperation Get-RMADFEPersistenceConnection Get-RMADFEProject Get-RMADFERecoveryAgent Get-RMADFESchedule 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 Get-RMADStorageServerAllowedVolumes Get-RMADStorageServerException Get-RMADStorageServerHardeningStatus Get-RMADStorageServerRetentionPolicy Import-RMADBackup Import-RMADFERecoveryCertificate Install-RMADBackupAgent Install-RMADFERecoveryAgent New-RMADCollection New-RMADFEProject New-RMADFERecoveryMedia New-RMADSchedule Open-RMADFEProject Protect-RMADSecureStorageServer Protect-RMADStorageServer Publish-RMADBackupSecurityStatus Refresh-RMADStorageServer Register-RMADSecureStorageBackups Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADFECloudStorage Remove-RMADFECloudStorageUploadSession Remove-RMADFERecoveryAgent Remove-RMADFESchedule Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADStorageServer Remove-RMADStorageServerException Remove-RMADUnpackedComponent Rename-RMADCollection Restart-RMADFECloudStorageUploadSession Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADFEConsoleConfiguration Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEConsoleConfigurationBackupSchedule Set-RMADFEConsoleConfigurationProjectFiles Set-RMADFEDnsCache Set-RMADFEDomain Set-RMADFEGlobalOptions Set-RMADFEPersistenceConnection Set-RMADFERecoveryMode Set-RMADFESchedule Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Set-RMADStorageServerAllowedVolumes Set-RMADStorageServerRetentionPolicy Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADBackup Test-RMADSecureStorageBackup Unprotect-RMADStorageServer Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Set-RMADFESchedule


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

schema: 2.0.0

SYNOPSIS

Applies settings to the verification schedule for the RMADFE project.

SYNTAX

Set-RMADFESchedule [[-Schedules] <Schedule[]>] [-Credential] <PSCredential> [[-NewCredential] <PSCredential>]
 [[-IsEnabled] <Boolean>] [<CommonParameters>]

DESCRIPTION

This cmdlet applies settings to the verification schedule for the current RMADFE project.

EXAMPLES

Example 1

PS C:\> $schedule = New-RMADFESchedule -Once -StartDate "2/20/2022 1:00"
$credential = Get-Credential
Set-RMADFESchedule -Schedules $schedule -Credential $credential -IsEnabled $true

Set a one-time schedule for the current project. Schedule is enabled and will run under the specified user account.

PARAMETERS

-Credential

Specifies credentials that will be used to run the command.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-IsEnabled

Specifies whether the schedule is enabled.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-NewCredential

Credential to change an account to. If a new credential is specified, the Credential parameter should contain the previous account credential for a task.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Schedules

Specifies schedules for project verification.

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

Required: False
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-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 [-ExchangeOAuth2 <Boolean>] [-EmailServer <String>] [-EmailSender <String>]
 [-ExtendedLogging <Boolean>] [-Properties <Hashtable>] [-IgnoreReadOnly] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Sets Recovery Manager global application settings

EXAMPLES

Example 1

PS C:\> Set-RMADGlobalOptions -ExchangeOAuth2 $False
Set-RMADGlobalOptions -EmailServer "WS.DomainName.local"
Set-RMADGlobalOptions -EmailSender "from@WS.DomainName.local"
Set-RMADGlobalOptions -ExtendedLogging $True

This command sets global email settings to use SMTP Authentication in Recovery Manager for Active Directory.

Example 2

PS C:\> $mailOptions = @{
    "Email.ExchangeOAuth2"  =$True;
    "Email.ApplicationId"   ='111-111-111';
    "Email.TenantId"        ='123-456-789';
    "Email.Thumbprint"      ='abcdefg';
    "Email.Sender"          ='from@WS.DomainName.local'
}
Set-RMADGlobalOptions -Properties $mailOptions

This command sets global email settings to use Exchange OAuth2 in Recovery Manager for Active Directory using the 'Properties' option.

Example 3

PS C:\> $mailOptions = @{
    "Email.ExchangeOAuth2"  =$False;
    "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 to use SMTP Authentication in Recovery Manager for Active Directory using the 'Properties' option.

Example 4

PS C:\> Set-RMADGlobalOptions -Properties @{"UseRestoreAgentPort" = $True; "DefaultRestoreMethod" = 0; "AgentPort" = 3845 }

This command sets Recovery Manager global settings for agent.

PARAMETERS

-EmailSender

Specifies the sender field of email notifications

Type: String
Parameter Sets: (All)
Aliases:

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

-EmailServer

Specifies the SMTP server for email notifications

Type: String
Parameter Sets: (All)
Aliases:

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

-ExchangeOAuth2

Specifies Exchange OAuth2 mode for email notifications

Type: Boolean
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

-IgnoreReadOnly

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-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_array Below 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.ExchangeOAuth2. Specifies the Exchange OAuth2 mode for email notifications
  • Email.Server. Specifies the SMTP server for email notifications
  • Email.Port. Specifies the SMTP port for email notifications
  • Email.Sender. Specifies the sender of email notifications
  • Email.ApplicationId. Specifies the application (client) ID for Exchange OAuth2 email notifications
  • Email.TenantId. Specifies the directory (tenant) ID for Exchange OAuth2 email notifications
  • Email.Thumbprint. Specifies the thumbprint for Exchange OAuth2 email 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

-Confirm

Prompts for a confirmation before executing the command.

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

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

-WhatIf

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

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

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

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

Sets the domain systems associated with the Hybrid Connector.

SYNTAX

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

DESCRIPTION

Sets the domain and associated systems used for the Hybrid Connector.

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

PARAMETERS

-Credentials

Credentials used for connecting to the system that is running the Azure Active Directory Connector.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Domain

Domain which the Hybrid Connector will be using.

Type: String
Parameter Sets: (All)
Aliases:

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

-DomainController

The domain Controller that the Azure Active Directory Connector is installed on.

Type: String
Parameter Sets: (All)
Aliases:

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

-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

Sets the domain systems associated with the Hybrid Connector.

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

Sets the domain and associated systems used in the Hybrid Connector.

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

PARAMETERS

-AADConnectCredentials

Credentials to connect to the Azure Active Directory Connector.

Type: PSCredential
Parameter Sets: AADConnect
Aliases:

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

-AADConnectHost

The host where the Azure Active Directory Connector is installed.

Type: String
Parameter Sets: AADConnect
Aliases:

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

-Enabled

Setting to confirm if the Hybrid Connector is enabled. Values can be $true or $false.

Type: Boolean
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

-RelayKey

Relay key contained in the file received from ODR. This file is down loaded from ODR when the Hybrid Connection is configured in ODR.

Type: SecureString
Parameter Sets: Relay
Aliases:

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

-RelayKeyName

Relay name contained in the file received from ODR. This file is down loaded from ODR when the Hybrid Connection is configured in ODR.

Type: String
Parameter Sets: Relay
Aliases:

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

-RelayUrl

The URL contained in the file received from ODR. This file is down loaded from ODR when the Hybrid Connection is configured in ODR.

Type: String
Parameter Sets: Relay
Aliases:

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

-SkipReplication

Configures the Hybrid Connector to perform a replication via the Azure Active Directory Connector. The values can be either $true or $false.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-UsePackedBackups

Configures the Hybrid Connector use any unpacked backups that are available. The values can be either $true or $false.

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating