Chat now with support
Chat with Support

Recovery Manager for AD 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-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADSecureStorageBackup Export-RMADStorageServers Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject 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 Install-RMADBackupAgent New-RMADCollection New-RMADSchedule Protect-RMADSecureStorageServer Publish-RMADBackupSecurityStatus Refresh-RMADStorageServer Register-RMADSecureStorageBackups Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADStorageServer Remove-RMADUnpackedComponent Rename-RMADCollection Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADObject Set-RMADCollection Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADLicense

Export-RMADStorageServers


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

schema: 2.0.0

SYNOPSIS

Exports secure storage servers in CSV file.

SYNTAX

Export-RMADStorageServers [-Path] <String> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Exports currently registered secure storage servers and their current statuses in CSV file.

EXAMPLES

Example 1

PS C:\> Export-RMADStorageServers -Path C:\SecureStorageServers.csv

Saves all current storage servers to C:\SecureStorageServers.csv file

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: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

Path to file where to save secure storage servers information.

Type: String
Parameter Sets: (All)
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

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Get-RMADBackup


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

schema: 2.0.0

SYNOPSIS

Gets backups registered with Recovery Manager.

SYNTAX

Id (Default)

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [[-Id] <Int32[]>] [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-AfterModifiedDate <DateTime>] [-First <Int32>]
 [-Skip <Int32>] [-SourceConsole <String>] [<CommonParameters>]

Id_IncludeSecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-Id] <Int32[]> [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-IncludeSecureStorage]
 [-AfterModifiedDate <DateTime>] [-First <Int32>] [-Skip <Int32>] [-SourceConsole <String>]
 [<CommonParameters>]

Id_OnlySecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-Id] <Int32[]> [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-OnlySecureStorage] [-AfterModifiedDate <DateTime>]
 [-First <Int32>] [-Skip <Int32>] [-SourceConsole <String>] [<CommonParameters>]

Guid

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [[-Guid] <Guid[]>] [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-AfterModifiedDate <DateTime>] [-First <Int32>]
 [-Skip <Int32>] [-SourceConsole <String>] [<CommonParameters>]

Guid_IncludeSecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-Guid] <Guid[]> [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-IncludeSecureStorage]
 [-AfterModifiedDate <DateTime>] [-First <Int32>] [-Skip <Int32>] [-SourceConsole <String>]
 [<CommonParameters>]

Guid_OnlySecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-Guid] <Guid[]> [-ComputerName <String>]
 [-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
 [-BackupComponents <BackupComponents>] [-IncludeDeleted] [-OnlySecureStorage] [-AfterModifiedDate <DateTime>]
 [-First <Int32>] [-Skip <Int32>] [-SourceConsole <String>] [<CommonParameters>]

IncludeSecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-ComputerName <String>] [-MaxDate <DateTime>]
 [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>] [-BackupComponents <BackupComponents>]
 [-IncludeDeleted] [-IncludeSecureStorage] [-AfterModifiedDate <DateTime>] [-First <Int32>] [-Skip <Int32>]
 [-SourceConsole <String>] [<CommonParameters>]

OnlySecureStorage

Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [-ComputerName <String>] [-MaxDate <DateTime>]
 [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>] [-BackupComponents <BackupComponents>]
 [-IncludeDeleted] [-OnlySecureStorage] [-AfterModifiedDate <DateTime>] [-First <Int32>] [-Skip <Int32>]
 [-SourceConsole <String>] [<CommonParameters>]

DESCRIPTION

Retrieves the backup object for the backups registered in the Recovery Manager backup registration database.

EXAMPLES

Example 1

PS C:\> Get-RMADBackup | Where-Object {$_.ComputerName -eq "dc1.dom1.local"}

This command retrieves all backup objects and passes them to the Where-Object cmdlet. The Where-Object cmdlet outputs the backup objects whose ComputerName property value is dc1.dom1.local.

Example 2

PS C:\> Get-RMADBackup -Id 12345

Retrieves the backup whose identifier is 12345.

Example 3

PS C:\> Get-RMADBackup | Where-Object {($_.Date -gt (Get-Date).AddDays(-5)) -and ($_.Path -like "*Toronto*")}

This command retrieves objects that represent backups created by Recovery Manager for Active Directory in the last 5 days. The command retrieves only those backups whose file path includes the word "Toronto".

Example 4

PS C:\> Get-RMADBackup -Skip 10 -First 100

This command skips the first 10 backups and starts retrieving 100 backups from the 11th one.

PARAMETERS

-AfterModifiedDate

Retrieves the backup objects that were last modified after this date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-All

When this parameter is present, the cmdlet gets all backup objects registered in the Recovery Manager backup registration database, including those whose file is physically missing. When this parameter is omitted, the cmdlet gets only those backup objects registered in the Recovery Manager backup registration database whose file is physically present.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BackupComponents

Retrieves the backup objects with the specified components only. If this parameter is not specified, all backup objects are retrieved from the Recovery Manager backup registration database.

Type: BackupComponents
Parameter Sets: (All)
Aliases:
Accepted values: None, ActiveDirectory, Adam, BootFiles, CertificateServer, ClusterQuorum, EnterpriseServices, ForestRecoveryMetadata, GroupMembership, IisMetabase, PerformanceCounters, Registry, CryptoKeys, All

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

-CollectionId

Retrieves the backup objects for the specified collection only.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ComputerName

Retrieves the backup objects from the specified computer only.

Type: String
Parameter Sets: (All)
Aliases:

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

-Domain

Retrieves the backup objects for the specified domain only. If this parameter is not specified, all backup objects are retrieved from the Recovery Manager backup registration database.

Type: String
Parameter Sets: (All)
Aliases:

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

-Guid

Specifies the GUID of the backup to get.

Type: Guid[]
Parameter Sets: Guid
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Guid[]
Parameter Sets: Guid_IncludeSecureStorage, Guid_OnlySecureStorage
Aliases:

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

-Id

Specifies the identifier of the backup to get.

Type: Int32[]
Parameter Sets: Id
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Int32[]
Parameter Sets: Id_IncludeSecureStorage, Id_OnlySecureStorage
Aliases:

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

-IncludeDeleted

When this parameter is present, the cmdlet gets all backup objects from the Recovery Manager backup registration database, including those objects whose status has been marked as Deleted or Unregistered.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-IncludeSecureStorage

When this parameter is present, the cmdlet gets all backup objects from the Recovery Manager backup registration database, including backups stored on Secure Storage servers.

Type: SwitchParameter
Parameter Sets: Id_IncludeSecureStorage, Guid_IncludeSecureStorage
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: IncludeSecureStorage
Aliases:

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

-MaxDate

Retrieves the backup objects after the specified date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-MinDate

Retrieves the backup objects before the specified date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-MinimumId

Retrieves backups with identifier greater than a specified number.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-OnlySecureStorage

Return backups stored on a Secure Storage servers.

Type: SwitchParameter
Parameter Sets: Id_OnlySecureStorage, Guid_OnlySecureStorage
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Type: SwitchParameter
Parameter Sets: OnlySecureStorage
Aliases:

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

-Site

Retrieves the backup objects from the specified AD site

Type: String
Parameter Sets: (All)
Aliases:

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

-SourceConsole

Retrieves backups replicated from a specified console.

Type: String
Parameter Sets: (All)
Aliases:

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

-Skip

Specifies the number of backups to skip before starting retrieving.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-First

Specifies the number of backups to retrieve.

Type: Int32
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

 

Get-RMADBackupAgent


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

schema: 2.0.0

SYNOPSIS

Retrieves objects that represent Recovery Manager Backup Agents, or discovers manually preinstalled Recovery Manager Backup Agents.

SYNTAX

Get-RMADBackupAgent [-Discover] [-UpdateInfo] [<CommonParameters>]

DESCRIPTION

Allows you to retrieve a list of installed and registered in the Recovery Management Console Backup Agents. It also allows you to discover all Backup Agent instances that were manually preinstalled on computers.

EXAMPLES

Example 1

PS C:\> Get-RMADBackupAgent

This code returns a list of installed and registered in the Recovery Management Console Backup Agents.

Example 2

PS C:\> Get-RMADBackupAgent -Discover

This code discovers all Backup Agent instances that were manually preinstalled on computers. Note that after the discover operation completes, you can view and manage the discovered Backup Agent instances using the corresponding cmdlets or from the Backup Agent Management node in the Recovery Manager Console.

PARAMETERS

-Discover

Specifies whether Backup Agent instances that were manually preinstalled on computers should be discovered.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-UpdateInfo

Specifies whether Backup Agents information should be re-requested.

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

 

Get-RMADBackupInfo


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

schema: 2.0.0

SYNOPSIS

Gets the content of the backups held at a specified location.

SYNTAX

Bkf

Get-RMADBackupInfo [-Path] <String[]> [-BackupPassword <SecureString>] [-IgnoreReadOnly] [<CommonParameters>]

OfflineDit

Get-RMADBackupInfo [-Path] <String[]> [-SysvolPath <String[]>] [-ResolveIndexes <Boolean>] [-OfflineDit]
 [-IgnoreReadOnly] [<CommonParameters>]

BackupInfo

Get-RMADBackupInfo [-BackupPassword <SecureString>] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

The Get-RMADBackupInfo cmdlet gets the content of the backups created with Recovery Manager and held at the location specified by the path.

EXAMPLES

Example 1

PS C:\> $b = Get-ChildItem C:\Backups -Filter *.bkf -Recurse | Get-RMADBackupInfo

C:\PS>Where-Object -InputObject $b { $_.Contents -band 64 } | Add-RMADBackup

This command gets the content of all backups held in the C:\Backups folder and its subfolders, and saves the content in the $b variable. The Where-Object cmdlet then passes the Active Directory backups from the $b variable to the Add-Backup cmdlet (the number 64 stands for the Active Directory component.) Add-RMADBackup then registers the passed Active Directory backups in the Recovery Manager database.

Example 2

PS C:\> $p = Read-Host "Backup Password" -AsSecureString

C:\PS>Get-RMADBackupInfo C:\Backups\password-protected_backup1.bkf 
-BackupPassword $p

In this example, the Read-Host cmdlet provided by Windows PowerShell gets the backup password as a SecureString object and saves it in the $p variable. The Get-RMADBackupInfo then uses the password saved in the $p variable to access the password-protected backup C:\Backups\password-protected_backup1.bkf.

PARAMETERS

-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: Bkf, BackupInfo
Aliases:

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

-OfflineDit

Specifies that the application registers the DIT file as a backup.

Type: SwitchParameter
Parameter Sets: OfflineDit
Aliases:

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

-Path

Specifies the path to the backups whose content is to be retrieved.

Type: String[]
Parameter Sets: Bkf, OfflineDit
Aliases: FullName

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

-ResolveIndexes

Reindexes the DIT file in case of invalid index data.

Type: Boolean
Parameter Sets: OfflineDit
Aliases:

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

-SysvolPath

Path to the SYSVOL folder.

Type: String[]
Parameter Sets: OfflineDit
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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating