Chat now with support
Chat with Support

Recovery Manager for AD Disaster Recovery Edition 10.3.1 - 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 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-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-RMADSession Remove-RMADStorageServer Remove-RMADStorageServerException Remove-RMADUnpackedComponent Rename-RMADCollection Restart-RMADFECloudStorageUploadSession Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADFEConsoleConfiguration Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Send-RMADFEBackupToSecureStorage Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEConsoleConfigurationBackupSchedule 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

Test-RMADSecureStorageBackup

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

schema: 2.0.0

SYNOPSIS

Checks the integrity of a backup on the secure storage server.

SYNTAX

Name

Test-RMADSecureStorageBackup [-BackupPath] <String> [-Name] <String> [<CommonParameters>]

Server

Test-RMADSecureStorageBackup [-BackupPath] <String> [-Server] <StorageServer> [<CommonParameters>]

DESCRIPTION

Checks the integrity of a backup on the secure storage server. This operation calculates the checksum
of the backup file and compares it with the checksum stored in the backup.

EXAMPLES

Example 1

Test-RMADSecureStorageBackup -Name 'storage' -BackupPath 'E:\Backups\DC1.rmad.local\2022-09-10 14-54-49.bkf'

PARAMETERS

-BackupPath

Path to the backup file stored on the secure storage server.

Type: String
Parameter Sets: (All)
Aliases:

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

-Name

Specifies the name of the secure storage server.

Type: String
Parameter Sets: Name
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Server

Specifies the target storage server. Use Get-RMADStorageServer to get server objects.

Type: StorageServer
Parameter Sets: Server
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

System.String

QuestSoftware.RecoveryManager.AD.PowerShell.Cmdlets.StorageServersManagement.StorageServer

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Unprotect-RMADStorageServer

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

schema: 2.0.0

SYNOPSIS

Disables hardening on the storage server.

SYNTAX

Unprotect-RMADStorageServer [-Force] [-Wait] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet disables hardening on the current storage server.
Unhardening includes enabling network traffic and enabling SMB on the server.

EXAMPLES

Example 1

PS C:\> Unprotect-RMADStorageServer

Disables hardening on the current storage server.

PARAMETERS

-Force

@{Text=}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Wait

@{Text=}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Update-RMADBackupAgent

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

schema: 2.0.0

SYNOPSIS

Upgrades Recovery Manager Backup Agent on a specified computer or on each computer in a particular Computer Collection.

SYNTAX

DC

Update-RMADBackupAgent [-Computer] <String> [[-Credentials] <PSCredential>] [[-ConfigureFirewall] <Boolean>]
 [-IgnoreReadOnly] [<CommonParameters>]

Collection

Update-RMADBackupAgent [[-Credentials] <PSCredential>] [[-ConfigureFirewall] <Boolean>]
 [-CollectionName] <String> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Allows you to upgrade Recovery Manager Backup Agent on a specified computer or on each computer in a particular Computer Collection.

EXAMPLES

Example 1

PS C:\> Update-RMADBackupAgent -CollectionName "New Computer Collection"

This code upgrades Recovery Manager Backup Agent on each computer in a collection named "New Computer Collection".

Example 2

PS C:\> $credential = Get-Credential
Update-RMADBackupAgent -Computer dc1 -Credentials $credential

This code connects to the computer "dc1" under the user represented by the "credential" object and upgrades Recovery Manager Backup Agent there.

PARAMETERS

-CollectionName

Specifies the name of the Computer Collection that includes the computers on which Backup Agent should be upgraded.

Type: String
Parameter Sets: Collection
Aliases:

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

-Computer

Specifies the name of the computer on which to upgrade a Recovery Manager Backup Agent.

Type: String
Parameter Sets: DC
Aliases:

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

-ConfigureFirewall

Specifies whether Recovery Manager automatically configures Windows Firewall on domain controllers to allow backup operations.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Credentials

Specifies the user name and the password of the user account to use for connecting to the target computer and upgrading Backup Agent. Use the Get-Credential cmdlet provided by Windows PowerShell to get the PSCredential object representing user credentials.
Notes:

  • The user should be a local Administrator on the target computer.
  • If you omit this parameter, Backup Agent will be upgraded under the current user account.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
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

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

 

Update-RMADFEProject

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

schema: 2.0.0

SYNOPSIS

Shows the difference between the current project and live Active Directory and updates the project.

SYNTAX

Update-RMADFEProject [-ForestName] <String> [-Credential] <PSCredential> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

This cmdlet shows the difference between the currently opened recovery project and live Active Directory. The confirmation will be requested before applying changes to the project.

EXAMPLES

Example 1

PS C:\> $credentials = New-Object PSCredential(".\Administrator", (ConvertTo-SecureString 'Password' -AsPlainText -Force))

Update-RMADFEProject -ForestName "acme.test" -Credential $credential -WhatIf

Shows the difference between the current recovery project and the forest "acme.test".

Example 2

PS C:\> $credentials = New-Object PSCredential(".\Administrator", (ConvertTo-SecureString 'Password' -AsPlainText -Force))

Update-RMADFEProject -ForestName "acme.test" -Credential $credential -Confirm:$true

Save-RMADFEProject -Path "UpdatedProject.frproj" -Password (ConvertTo-SecureString "protection password" -AsPlainText -Force)

Checks and shows the difference between the current project and the forest "acme.test", and then applies the changes to the project. To keep the project updated, you have to save it.

PARAMETERS

-Credential

Credentials that are used to connect to the target Active Directory to retrieve infrastructure information.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-ForestName

Name of the target Active Directory forest.

Type: String
Parameter Sets: (All)
Aliases:

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

-Confirm

Automatically confirms the update of the recovery project.

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

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

-WhatIf

If specified, this parameter shows difference only and does not apply any changes to the recovery project.

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