Chat now with support
Chat with Support

Recovery Manager for AD Forest 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 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 Import-RMADBackup Import-RMADFERecoveryCertificate Install-RMADBackupAgent Install-RMADFERecoveryAgent New-RMADCollection New-RMADFEProject New-RMADFERecoveryMedia New-RMADSchedule Open-RMADFEProject Protect-RMADSecureStorageServer 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-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 Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Stop-RMADFECloudStorageUploadSession

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

schema: 2.0.0

SYNOPSIS

Cancel queued or running cloud storage upload session.

SYNTAX

Id

Stop-RMADFECloudStorageUploadSession [-Id] <Int32[]> [-IgnoreReadOnly] [<CommonParameters>]

InputObject

Stop-RMADFECloudStorageUploadSession [-InputObject] <UploadSession[]> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Cancel a queued or running cloud storage upload session. The copy of the backup is stopped.

EXAMPLES

Example 1

PS C:\> Stop-RMADFECloudStorageUploadSession -Id 4

Cancel cloud storage upload session with Id 4.

PARAMETERS

-Id

Specifies the upload session Id representing the upload session you want to stopped.

Type: Int32[]
Parameter Sets: Id
Aliases:

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

-IgnoreReadOnly

Allows you to perform the action in a console currently performing full replication (for internal use only).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-InputObject

Specifies the UploadSession object representing the cloud storage upload session you want to cancel.

Type: UploadSession[]
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

System.Int32[]

QuestSoftware.RecoveryManager.AD.FE.PowerShell.UploadSession[]

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Stop-RMADFEWorkflow

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

schema: 2.0.0

SYNOPSIS

Stops the verification or recovery workflow of the recovery project.

SYNTAX

Stop-RMADFEWorkflow [-ComputerName <String[]>] [<CommonParameters>]

DESCRIPTION

This cmdlet cancels the current workflow for the specified domain controllers, or the whole session if no parameters are provided.

EXAMPLES

EXAMPLE 1

PS C:\> Stop-RMADFEWorkflow

PARAMETERS

-ComputerName

Specifies the fully qualified domain name of the computer.

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

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

 

Test-RMADBackup

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 backups registered with Recovery Manager.

SYNTAX

Instance

Test-RMADBackup [-InputObject] <BackupInfo[]> [-ShareCredential <PSCredential>] [-UseStorageCredential]
 [<CommonParameters>]

Id

Test-RMADBackup [-Id] <Int32[]> [-ShareCredential <PSCredential>] [-UseStorageCredential] [<CommonParameters>]

DESCRIPTION

Checks the integrity of backups registered with Recovery Manager.
This operation calculates the checksum of the backup file and compares it with the checksum stored in the backup.

EXAMPLES

Example 1

PS C:\> Get-RMADBackup | Test-RMADBackup

Checks the integrity of all backups registered with Recovery Manager.

PARAMETERS

-Id

Specifies the identifier of the backup you want to check.

Type: Int32[]
Parameter Sets: Id
Aliases:

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

-InputObject

Accepts a backup object as input to the cmdlet. Enter a variable that contains the object or type a command or expression that gets the object.

Type: BackupInfo[]
Parameter Sets: Instance
Aliases:

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

-ShareCredential

Specifies credential for share folder that contains the backup.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-UseStorageCredential

Uses the account configured in the collection to access the remote storage. If the backup is not associated with any collection or no account is configured for the remote storage, the account specified in the -ShareCredential parameter will be used instead.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

QuestSoftware.RecoveryManager.AD.PowerShell.BackupInfo[]

System.Int32[]

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating