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

New-RMADCollection


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

schema: 2.0.0

SYNOPSIS

Creates a new computer collection.

SYNTAX

New-RMADCollection [[-Name] <String>] [-Temporary] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Creates a new computer collection with a default name or with the name you specify. The new computer collection is created using the default computer collection parameters set in the Recovery Manager console.

EXAMPLES

Example 1

PS C:\> New-RMADCollection -Name Collection1

This command creates a new computer collection named Collection1.

Example 2

PS C:\> New-RMADCollection Collection1 -Temporary

This command creates a new temporary computer collection from the existing collection named Collection1.

PARAMETERS

-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

-Name

Allows you to specify a name for the computer collection to be created.

Type: String
Parameter Sets: (All)
Aliases:

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

-Temporary

Creates a new temporary computer collection.

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

 

New-RMADFEProject


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

schema: 2.0.0

SYNOPSIS

Creates a new RMADFE project in the file system.

SYNTAX

AD (Default)

New-RMADFEProject -Domain <String> -Credential <PSCredential> [<CommonParameters>]

Backup

New-RMADFEProject -Backup <BackupInfo> [-BackupPassword <SecureString>] [<CommonParameters>]

DESCRIPTION

This cmdlet creates a new RMADFE project in the file system.

EXAMPLES

EXAMPLE 1

PS C:\> $backupInfo = Get-RMADBackupInfo -Path "C:\RMAD_TEMP\backup.bak"

New-RMADFEProject -Backup $backupInfo -BackupPassword (ConvertTo-SecureString "Backup Password " -AsPlainText -Force)

This example demonstrates how to create a new project from a backup.

PARAMETERS

-Backup

Specifies the backup that contains the data to be restored.

Type: BackupInfo
Parameter Sets: Backup
Aliases:

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

-BackupPassword

Specifies the password to access a password-protected backup.

Type: SecureString
Parameter Sets: Backup
Aliases:

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

-Credential

Specifies credentials to access the domain controller.

Type: PSCredential
Parameter Sets: AD
Aliases:

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

-Domain

Specifies the fully qualified domain name.

Type: String
Parameter Sets: AD
Aliases:

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

 

New-RMADFERecoveryMedia


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

schema: 2.0.0

SYNOPSIS

Creates a new Recovery Media ISO in the file system.

SYNTAX

FromWsb (Default)

New-RMADFERecoveryMedia -IsoPath <String> -WsbPath <String> [-IpAddress <String>] [-DriversFolder <String>]
 [-SubnetMask <String>] [-DefaultGateway <String>] [-AllowAddCustomDrivers <Boolean>]
 [-AllowAddCustomDriversFromBackup <Boolean>] [<CommonParameters>]

FromWim

New-RMADFERecoveryMedia -IsoPath <String> -WimPath <String> [-IpAddress <String>] [-DriversFolder <String>]
 [-SubnetMask <String>] [-DefaultGateway <String>] [-AllowAddCustomDrivers <Boolean>]
 [-AllowAddCustomDriversFromBackup <Boolean>] [<CommonParameters>]

FromBmr

New-RMADFERecoveryMedia -IsoPath <String> -BmrPath <String> [-BackupPassword <SecureString>]
 [-IpAddress <String>] [-DriversFolder <String>] [-SubnetMask <String>] [-DefaultGateway <String>]
 [-AllowAddCustomDrivers <Boolean>] [-AllowAddCustomDriversFromBackup <Boolean>] [<CommonParameters>]

DESCRIPTION

This cmdlet creates a new Recovery Media ISO in the file system.

EXAMPLES

Example 1

PS C:\> New-RMADFERecoveryMedia -WimPath C:\Recovery\WindowsRE\WinRe.wim 
-IsoPath C:\ProgramData\Quest\RecoveryMedia\QuestWinRe.iso

This example illustrates how to create the Recovery Media from the Windows Recovery Environment image.

Example 2

PS C:\> New-RMADFERecoveryMedia -WsbPath \\BackupServer\Storage\Backup1 
-IsoPath C:\ProgramData\Quest\RecoveryMedia\QuestWinRe.iso

This example illustrates how to create the Recovery Media from the Windows Server backup.

PARAMETERS

-AllowAddCustomDrivers

Turns on the ability to set up custom drivers.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-AllowAddCustomDriversFromBackup

Turns on the ability to set up custom drivers from the backup.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-BackupPassword

Specifies the password to access a password-protected backup. This is the same password that is set in the computer collection properties in the Recovery Manager console.

Type: SecureString
Parameter Sets: FromBmr
Aliases: Password

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

-BmrPath

Specifies a path to Bare Metal Recovery backup.

Type: String
Parameter Sets: FromBmr
Aliases: Bmr

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

-DefaultGateway

Specifies the preconfigured Default Gateway to be used for the generated Recovery Media Bare Metal Console.

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

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

-DriversFolder

Specifies the folder for custom drivers.

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

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

-IpAddress

Specifies the preconfigured IP Address to be used for the generated Recovery Media Bare Metal Console.

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

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

-IsoPath

Path to the output Quest Recovery Environment image file

Type: String
Parameter Sets: (All)
Aliases: Iso, Output

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

-SubnetMask

Specifies the preconfigured Subnet Mask to be used for the generated Recovery Media Bare Metal Console.

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

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

-WimPath

Path to Windows Image file

Type: String
Parameter Sets: FromWim
Aliases: Wim

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

-WsbPath

Path to Windows Server Backup

Type: String
Parameter Sets: FromWsb
Aliases: Wsb

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

 

New-RMADSchedule


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

schema: 2.0.0

SYNOPSIS

Creates a schedule for the backup creation operation you want to perform on a particular computer collection.

SYNTAX

Once

New-RMADSchedule [-Once] -StartDate <DateTime> [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>]
 [<CommonParameters>]

Daily

New-RMADSchedule [-Daily] -DaysInterval <Int32> -StartDate <DateTime> [-EndDate <DateTime>]
 [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>] [<CommonParameters>]

Weekly

New-RMADSchedule [-Weekly] -WeeksInterval <Int32> -DaysOfWeek <DaysOfTheWeek> -StartDate <DateTime>
 [-EndDate <DateTime>] [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>] [<CommonParameters>]

MonthlyDate

New-RMADSchedule [-MonthlyDate] -Day <Int32> [-Months <Months>] -StartDate <DateTime> [-EndDate <DateTime>]
 [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>] [<CommonParameters>]

MonthlyDOW

New-RMADSchedule [-MonthlyDOW] [-DaysOfWeek <DaysOfTheWeek>] [-Months <Months>] -Week <WhichWeek>
 -StartDate <DateTime> [-EndDate <DateTime>] [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>]
 [<CommonParameters>]

DESCRIPTION

Creates a schedule to perform the backup creation operation a particular computer collection. You can use the parameters of this cmdlet to set a recurring or non-recurring schedule for the backup creation operation.

EXAMPLES

Example 1

PS C:\> New-RMADSchedule -Once -StartDate "2/20/2022 1:00"

Runs the backup creation operation at 1:00 a.m. on the 20th February 2022.

Example 2

PS C:\> New-RMADSchedule -Daily -StartDate "2/20/2022 1:00" -DaysInterval 3

Runs the backup creation operation every 3 days, starting from 1:00 a.m. on the 20th February 2022.

Example 3

PS C:\> New-RMADSchedule -Weekly -StartDate "2/20/2022 1:00" -WeeksInterval 2 -DaysOfWeek Monday,Friday

Runs the backup creation operation on Monday and Friday of every second week, starting from 1:00 a.m. on the 20th February 2022.

Example 4

PS C:\> New-RMADSchedule -MonthlyDate -StartDate "2/20/2022 1:00" -Day 1

Runs the backup creation operation on every first day of each month (the Months parameter is omitted, therefore the backup creation operation is invoked each month), starting from 1:00 a.m. on the 20th February 2022.

Example 5

PS C:\> New-RMADSchedule -MonthlyDOW -StartDate "2/20/2022 1:00" -DaysOfWeek 1,5 -Week 1

Runs the backup creation operation on every first Monday and Friday of each month, starting from 1:00 a.m. on the 20th February 2022.

PARAMETERS

-Daily

Runs the backup creation operation on a daily basis.

Type: SwitchParameter
Parameter Sets: Daily
Aliases:

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

-Day

Sets the day of the month when you want to run the backup creation operation.

Type: Int32
Parameter Sets: MonthlyDate
Aliases:

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

-DaysInterval

Sets an interval (in number of days) between invocations of the backup creation operation.

Type: Int32
Parameter Sets: Daily
Aliases:

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

-DaysOfWeek

Runs the backup creation operation on particular days of week. To set the weeks when you want to run the backup creation operation, use the Weekly or MonthlyDOW parameter.

Type: DaysOfTheWeek
Parameter Sets: Weekly
Aliases:
Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: DaysOfTheWeek
Parameter Sets: MonthlyDOW
Aliases:
Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

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

-EndDate

Specifies the date when the backup creation operation schedule expires.

Type: DateTime
Parameter Sets: Daily, Weekly, MonthlyDate, MonthlyDOW
Aliases:

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

-MinutesDuration

Specifies the time period (in minutes) during which you want to repeatedly run (invoke) the backup creation operation. To set the time interval between invocations of the backup creation operation, use the MinutesInterval parameter.

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-MinutesInterval

Specifies the time interval (in minutes) between invocations of the backup creation operation. To set the time period during which you want to repeatedly run (invoke) the backup creation operation, use the MinutesDuration parameter.

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-MonthlyDate

Runs the backup creation operation on particular day of month. To set the months and day of month when you want to run the backup creation operation, use the Months and Day parameters respectively.

Type: SwitchParameter
Parameter Sets: MonthlyDate
Aliases:

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

-MonthlyDOW

Runs the backup creation operation on particular days of week in particular months. To set the months, weeks, and days of week, use the Months, Week, and DaysOfWeek parameters respectively.

Type: SwitchParameter
Parameter Sets: MonthlyDOW
Aliases:

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

-Months

Sets the months when you want to run the backup creation operation.

Type: Months
Parameter Sets: MonthlyDate, MonthlyDOW
Aliases:
Accepted values: January, February, March, April, May, June, July, August, September, October, November, December

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

-Once

Runs the backup creation operation only once.

Type: SwitchParameter
Parameter Sets: Once
Aliases:

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

-StartDate

Specifies the date when the backup creation operation schedule comes into effect.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-Week

Sets the week of the month when you want to run the backup creation operation. This parameter accepts the following values:

  • 1. Specifies the first week of the month.
  • 2. Specifies the second week of the month.
  • 3. Specifies the third week of the month.
  • 4. Specifies the fourth week of the month.
  • 5. Specifies the fifth week of the month.

Type: WhichWeek
Parameter Sets: MonthlyDOW
Aliases:
Accepted values: None, FirstWeek, SecondWeek, ThirdWeek, FourthWeek, LastWeek

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

-Weekly

Runs the backup creation operation on a weekly basis.

Type: SwitchParameter
Parameter Sets: Weekly
Aliases:

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

-WeeksInterval

Sets an interval (in number of weeks) between invocations of the backup creation operation.

Type: Int32
Parameter Sets: Weekly
Aliases:

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