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

Install-RMADFERecoveryAgent

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

schema: 2.0.0

SYNOPSIS

Installs Forest Recovery Agent on a specified domain controller or on each domain controller in the forest.

SYNTAX

ProjectSpecificParameters (Default)

Install-RMADFERecoveryAgent [-ComputerName] <String> [<CommonParameters>]

ProjectlessDomain

Install-RMADFERecoveryAgent [-ComputerName] <String> -DcCredential <PSCredential> [<CommonParameters>]

ProjectlessAll

Install-RMADFERecoveryAgent [-ComputerName] <String> -DcCredential <PSCredential>
 -DsrmCredential <PSCredential> -LocalCredential <PSCredential> [<CommonParameters>]

ProjectlessDsrm

Install-RMADFERecoveryAgent [-ComputerName] <String> -DsrmCredential <PSCredential> [<CommonParameters>]

ProjectlessLocal

Install-RMADFERecoveryAgent [-ComputerName] <String> -LocalCredential <PSCredential> [<CommonParameters>]

DESCRIPTION

Allows you to install Forest Recovery Agent on a specified domain controller or on each domain controller in the forest.

EXAMPLES

EXAMPLE 1

PS C:\> Open-RMADFEProject -Path C:\rmadfe.frproj -Password (ConvertTo-SecureString "password" -AsPlainText -Force)

Install-RMADFERecoveryAgent -Name dc1.RMAD.local

Installs Forest Recovery Agent on the specified domain controller in the RMADFE project.

EXAMPLE 2

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

Install-RMADFERecoveryAgent -name dc1.RMAD.local -DcCredential $credentials -DsrmCredential $credentials

Installs Forest Recovery Agent on the specified domain controller (either in Normal or DSRM mode).
In this example, you should use only domain credentials or DSRM credentials, or both.

PARAMETERS

-ComputerName

Specifies the fully qualified domain name of the computer.

Type: String
Parameter Sets: (All)
Aliases:

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

-DcCredential

Specifies the user name and password with which you want Recovery Manager for Active Directory Forest Edition to access the selected domain controllers in the Normal mode.

Type: PSCredential
Parameter Sets: ProjectlessDomain, ProjectlessAll
Aliases:

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

-DsrmCredential

Specifies the user name and password with which you want Recovery Manager for Active Directory Forest Edition to access domain controllers in the selected domain in Directory Services Restore Mode (DSRM).

Type: PSCredential
Parameter Sets: ProjectlessAll, ProjectlessDsrm
Aliases:

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

-LocalCredential

Specifies the user name and password with which you want Recovery Manager for Active Directory Forest Edition to access standalone machines.

Type: PSCredential
Parameter Sets: ProjectlessAll, ProjectlessLocal
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-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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating