Chat now with support
Chat with Support

We are currently experiencing issues on our phone support and are working diligently to restore services. For support, please sign in and create a case or email supportadmin@quest.com for assistance

Recovery Manager for AD Disaster Recovery Edition 10.2.2 - 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 Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Copy-RMADFEBackup Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFECloudStorageBackup Export-RMADFERecoveryCertificate Export-RMADFEResult Export-RMADSecureStorageBackup 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-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-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer 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-RMADSecureStorageBackup Unprotect-RMADStorageServer Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Installing Management Shell

To install Management Shell
  1. Run the Setup.exe file included with the Recovery Manager for Active Directory installation package, and follow the instructions in the Setup Wizard.

  2. To install Recovery Manager for Active Directory with default parameters (this includes installing the Management Shell component), click Express, and then follow the provided instructions to complete the Setup Wizard.

 

Opening Management Shell

You can open the Management Shell by using either of the following procedures. Each procedure loads the Recovery Manager for Active Directory Management Shell snap-in into Windows PowerShell®. If you do not load the Recovery Manager for Active Directory Management Shell snap-in before you run a command (cmdlet) provided by that snap-in, you will receive an error.

Note

Verify that the user account under which you run Recovery Manager for Active Directory Management Shell console has the Write permission to the %ProgramData%\Quest\Recovery Manager for Active Directory folder. Otherwise, you will get warning messages when you run the snap-in cmdlets.

To open the Management Shell
  1. Start Windows PowerShell®.

    You can do so by running the powershell command at a command prompt (Cmd.exe).

  2. At the Windows PowerShell® prompt, enter the following command: Add-PSSnapin Quest.RecoveryManager.AD.*

Alternatively, you can complete the following steps related to your version of Windows:

On the Start screen, click the Management Shell tile.

Upon the shell start, the console may present you with a message stating that a certain file published by Quest® is not trusted on your system. This security message indicates that the certificate the file is digitally signed with is not trusted on your computer, so the console requires you to enable trust for the certificate issuer before the file can be run. Press either R (Run once) or A (Always run). To prevent this message from appearing in the future, it is advisable to choose the second option (A).

 

Getting Help

The Recovery Manager for Active Directory Management Shell uses the Windows PowerShell® help cmdlets to assist you in finding the appropriate information to accomplish your task. The following table provides some examples of how to use the Get-Help and Get-Command cmdlets to access the help information that is available for each cmdlet in the Recovery Manager for Active Directory Management Shell.

Get-Help

When you use Get-Help without any parameters, you are presented with basic instructions on how to use the help system in Windows PowerShell®, including Help for the Recovery Manager for Active Directory Management Shell.

Get-Help

When you use Get-Help with the name of a cmdlet as an argument, you are presented with the help information for that cmdlet. For example, to retrieve the help information for the Get-RMADCollection cmdlet, use the following command:

Get-Help Get-RMADCollection

Get-Command

Get-Command without any parameters lists all the cmdlets that are available to the shell. You can use the Get-Command cmdlet with the Format-List or Format- Table cmdlet to provide a more readable display. For example, use Get-Command | Format-List to display the output in a list format. To display a list of all the Recovery Manager for Active Directory Management Shell cmdlets that are available to the shell, use the following syntax:

Get-Command *RMAD*

Get-Command

When you use Get-Command with the name of a cmdlet as an argument, you are presented with information about the parameters and other components of that cmdlet. The <Cmdlet> entry allows for wildcard character expansion. For example, to retrieve information about the cmdlets with the names ending in Member, you can use the following command:

Get-Command *Member

 

Descriptions of PowerShell Commands

PowerShell cmdlets for Recovery Manager for Active Directory

Cmdlet Description
Add-RMADBackup Registers a backup in the Recovery Manager database.
Add-RMADCollectionItem Adds a new item to a Computer Collection.
Add-RMADReplicationConsole Adds a RMAD console as a replication source.
Add-RMADStorageServer Adds a secure storage server, optionally remotely installs a storage server agent.
Backup-RMADCollection Backs up an existing computer collection.
Compare-RMADObject Compares Active Directory objects. This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Convert-RMADBackup Converts Windows Server backups into RMAD Bare Metal Recovery backups.
ConvertTo-RMADRecycledObject Recycles specific deleted Active Directory objects.
Create-RMADStorageAgentSetup Creates storage server agent setup.
Expand-RMADBackup Extracts the contents of a specified backup file.
Export-RMADBackup Exports registration information for a backup into an .xml file.
Export-RMADSecureStorageBackup Exports a backup on a Secure Storage server to a remote network share.
Get-RMADBackup Gets backups registered with Recovery Manager.
Get-RMADBackupAgent Retrieves objects that represent Recovery Manager Backup Agents, or discovers manually preinstalled Recovery Manager Backup Agents.
Get-RMADBackupInfo Gets the content of the backups held at a specified location.
Get-RMADBackupObject Get objects from backups
Get-RMADBackupSecurityStatus Gets security check information for a specified backup.
Get-RMADCollection Retrieves Recovery Manager computer collection objects or default computer collection settings.
Get-RMADCollectionItem Retrieves information about items added to specified Recovery Manager for Active Directory computer collections.
Get-RMADDeletedObject Retrieves deleted Active Directory objects.
Get-RMADGlobalOptions Sets global settings for the application.
Get-RMADHybridRecoveryDomainOptions {{ Fill in the Synopsis }}
Get-RMADHybridRecoveryOptions {{ Fill in the Synopsis }}
Get-RMADLicenseInfo Retrieves information about the installed license key file.
Get-RMADObject Retrieves specific objects from Active Directory or certain backups registered with Recovery Manager for Active Directory.
Get-RMADReplicationConsole Gets all the RMAD consoles in the replication console list.
Get-RMADReplicationSchedule Allows you to get the replication schedule from a specified computer.
Get-RMADReplicationSession Retrieves information about replication sessions.
Get-RMADReplicationSessionItem Retrieves a list of remote consoles that are involved in the specified replication session.
Get-RMADReportObject Retrieves an object representing the online comparison or restore operation item.
Get-RMADReportObjectAttributes Retrieves an object representing the online comparison or restore operation item attributes.
Get-RMADReportObjectChildren Retrieves an object representing the online comparison or restore operation item child items.
Get-RMADReportSession Retrieves an object representing the online comparison or restore operation report.
Get-RMADSession Retrieves an object representing Recovery Manager backup sessions.
Get-RMADSessionItem Gets items from a specified backup creation session.
Get-RMADSessionItemEvent Gets events from a specified backup creation session item.
Get-RMADStorageServer Returns a list of registered secure storage servers.
Import-RMADBackup Reads the backup registration information from the .xml file and returns backup descriptions in the BackupInfo objects.
Install-RMADBackupAgent Installs Recovery Manager Backup Agent on a specified computer or on each computer in a particular Computer Collection.
New-RMADCollection Creates a new computer collection.
New-RMADSchedule Creates a schedule for the backup creation operation you want to perform on a particular computer collection.
Protect-RMADSecureStorageServer Enables storage server hardening.
Publish-RMADBackupSecurityStatus Publishes security check information for a specified backup.
Refresh-RMADStorageServer Refreshes current information of the secure storage server.
Register-RMADSecureStorageBackups Registers backups on an existing secure storage server in a Recovery Manager database.
Remove-RMADBackup Allows you to selectively unregister backups from the Recovery Manager backup registration database.
Remove-RMADBackupAgent Removes Recovery Manager Backup Agent from a specified computer, or its registration information from the Recovery Manager Console.
Remove-RMADCollection Deletes specified Computer Collections.
Remove-RMADCollectionItem Removes items from a specified Computer Collection.
Remove-RMADReplicationConsole Removes an RMAD console from the replication console list.
Remove-RMADReplicationSchedule Allows you to remove the replication schedule from a specified computer.
Remove-RMADReplicationSession Deletes replication sessions from the replication history.
Remove-RMADStorageServer Removes the secure storage server.
Remove-RMADUnpackedComponent Allows you to delete components (data) unpacked from specified backups.
Rename-RMADCollection Renames a computer collection.
Restore-RMADDeletedObject Restores deleted Active Directory objects. This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Restore-RMADDomainController Restores a domain controller from backup.
Restore-RMADObject Restores Active Directory objects from a backup. This cmdlet requires Windows PowerShell to be started using a multi-threaded apartment (MTA).
Set-RMADCollection Sets properties for a computer collection.
Set-RMADGlobalOptions Sets global application settings
Set-RMADHybridRecoveryDomainOptions {{ Fill in the Synopsis }}
Set-RMADHybridRecoveryOptions {{ Fill in the Synopsis }}
Set-RMADReplicationConsole Sets replication properties of consoles in the replication console list.
Set-RMADReplicationSchedule Sets replication schedules for a computer.
Start-RMADHybridRecoveryDiscovery {{ Fill in the Synopsis }}
Start-RMADReplication Performs replication from other computers in the replication console list.
Start-RMADReportViewer Displays a report about the results of the online comparison or restore operation.
Test-RMADSecureStorageBackup Checks the integrity of a backup on the secure storage server.
Update-RMADBackupAgent Upgrades Recovery Manager Backup Agent on a specified computer or on each computer in a particular Computer Collection.
Update-RMADLicense Updates license key file.

PowerShell cmdlets for Recovery Manager for Active Directory Forest Edition (Disaster Recovery Edition)

Cmdlet Description
Add-RMADFECloudStorage Registers a cloud storage in the Recovery Manager for Active Directory database, allowing backups to be copied to cloud storage.
Close-RMADFEProject Closes currently opened recovery project.
Copy-RMADFEBackup Copies a backup from a network share to the secure storage server.
Export-RMADFECloudStorageBackup Download a backup file from cloud storage and save it locally.
Export-RMADFERecoveryCertificate Exports Forest Recovery certificates.
Export-RMADFEResult Export the verification result of an RMADFE project.
Get-RMADFEAvailableSubnet For internal use only.
Get-RMADFECloudStorage Returns cloud storage registered in Recovery Manager for Active Directory.
Get-RMADFECloudStorageCollection Returns computer collections for the cloud storage registered in Recovery Manager for Active Directory.
Get-RMADFECloudStorageUploadSession Retrieves the cloud storage upload session details.
Get-RMADFEComputer Retrieves a list of computer settings from the current RMADFE project.
Get-RMADFEConsole Gets all registered RMAD FE consoles.
Get-RMADFEDnsCache Returns cached DNS records in the Forest Recovery project.
Get-RMADFEDomain Retrieves the domain settings.
Get-RMADFEEvent Returns recovery events related to the entire Active Directory forest or a specific domain controller.
Get-RMADFEGlobalOptions Gets global application settings.
Get-RMADFEOperation Returns information about the progress of the recovery operations.
Get-RMADFEPersistenceConnection Gets persistence connection settings.
Get-RMADFEProject Gets the current status of the RMADFE project.
Get-RMADFERecoveryAgent Returns information about Forest Recovery Agents that are installed and registered in Forest Recovery Console.
Get-RMADFESchedule Gets a schedule for the RMADFE project verification.
Import-RMADFERecoveryCertificate Imports Forest Recovery certificates.
Install-RMADFERecoveryAgent Installs Forest Recovery Agent on a specified domain controller or on each domain controller in the forest.
New-RMADFEProject Creates a new RMADFE project in the file system.
New-RMADFERecoveryMedia Creates a new Recovery Media ISO in the file system.
Open-RMADFEProject Opens the RMADFE project.
Remove-RMADFECloudStorage Removes a registered cloud storage from Recovery Manager for Active Directory.
Remove-RMADFECloudStorageUploadSession Removes an existing cloud storage upload session.
Remove-RMADFERecoveryAgent Removes Forest Recovery Agent from a specified domain controller, or its registration information from Forest Recovery Console.
Remove-RMADFESchedule Removes an existing verification schedule for the RMADFE project.
Restart-RMADFECloudStorageUploadSession Restart a failed or canceled cloud storage upload session.
Resume-RMADFEOperation Resumes paused recovery process operation.
Resume-RMADFERecovery Resumes recovery process.
Save-RMADFEProject Saves the RMADFE project.
Set-RMADFECloudStorage Updates cloud storage in the Recovery Manager.
Set-RMADFECloudStorageCollection Configure a computer collection to use a registered cloud storage.
Set-RMADFEComputer Applies computer settings to the RMADFE project.
Set-RMADFEDnsCache Updates cached DNS records in the Forest Recovery project.
Set-RMADFEDomain Sets the domain settings for the current RMADFE project.
Set-RMADFEGlobalOptions Sets global settings for recovery projects.
Set-RMADFEPersistenceConnection Sets persistence connection settings.
Set-RMADFERecoveryMode Sets recovery mode for the current recovery project
Set-RMADFESchedule Applies settings to the verification schedule for the RMADFE project.
Start-RMADFERecovery Performs the restore operation for the RMADFE project.
Start-RMADFERecoveryAgentOperation Starts so-called agent operation on the remote machine where Forest Recovery agent is installed.
Start-RMADFEVerification Performs verification of the RMADFE project.
Stop-RMADFECloudStorageUploadSession Cancel queued or running cloud storage upload session.
Stop-RMADFEWorkflow Stops the verification or recovery workflow of the recovery project.
Update-RMADFEProject Shows the difference between the current project and live Active Directory and updates the project.

PowerShell cmdlets for Recovery Manager for Active Directory Disaster Recovery Edition Secure Storage Server

Cmdlet Description
Add-RMADStorageServerException Adds a new exception to secure storage hardening policy
Get-RMADStorageServerAllowedVolumes
Get-RMADStorageServerException Lists current secure storage hardening exceptions.
Get-RMADStorageServerHardeningStatus Retrieves the hardening status of the current server.
Get-RMADStorageServerRetentionPolicy Retrieves the retention policy status of the current server.
Protect-RMADStorageServer Enable storage server hardening.
Remove-RMADStorageServerException
Set-RMADStorageServerAllowedVolumes
Set-RMADStorageServerRetentionPolicy Sets the retention policy status of the current server.
Unprotect-RMADStorageServer Disables hardening on the storage server.

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating