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

Refresh-RMADStorageServer


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

schema: 2.0.0

SYNOPSIS

Refreshes current information of the secure storage server.

SYNTAX

Name

Refresh-RMADStorageServer [-IgnoreReadOnly] [-Name] <String> [<CommonParameters>]

Server

Refresh-RMADStorageServer [-IgnoreReadOnly] [-Server] <StorageServer> [<CommonParameters>]

DESCRIPTION

Connects to the secure storage server and retrieves the current status (agent state and hardening state).

EXAMPLES

Example 1

PS C:\> Get-RMADStorageServer | Refresh-RMADStorageServer

Updates statuses of all registered secure storage servers.

Example 2

PS C:\> Refresh-RMADStorageServer -Name "storage.srv"

Refreshes the status of the specified secure storage server.

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

-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 secure storage server. Use Get-RMADStorageServer to get a list of all secure storage servers.

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

OUTPUTS

NOTES

RELATED LINKS

 

Register-RMADSecureStorageBackups


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

schema: 2.0.0

SYNOPSIS

Registers backups on an existing secure storage server in a Recovery Manager database.

SYNTAX

Name

Register-RMADSecureStorageBackups [-IgnoreReadOnly] [-Name] <String> [<CommonParameters>]

Server

Register-RMADSecureStorageBackups [-IgnoreReadOnly] [-Server] <StorageServer> [<CommonParameters>]

DESCRIPTION

Registers backups on an existing secure storage server in a Recovery Manager database so that the backups become available in the Recovery Manager user interface.

EXAMPLES

Example 1

PS C:\> Register-RMADSecureStorageBackups -Name "storage.srv"

Registers backups on a specified storage server.

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

-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 secure storage server. Use Get-RMADStorageServer to get a list of all secure storage servers.

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

 

Remove-RMADBackup


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

schema: 2.0.0

SYNOPSIS

Allows you to selectively unregister backups from the Recovery Manager backup registration database.

SYNTAX

Instance

Remove-RMADBackup [-InputObject] <BackupInfo[]> [-Delete <Boolean>] [-ShareCredential <PSCredential>]
 [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

Id

Remove-RMADBackup [-Id] <Int32[]> [-Delete <Boolean>] [-ShareCredential <PSCredential>] [-IgnoreReadOnly]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Allows you to selectively unregister backups from the Recovery Manager backup registration database. Optionally, you can delete the unregistered backups from their location.

EXAMPLES

Example 1

PS C:\> Get-RMADBackup | Where-Object {$_.Date -lt (Get-Date).AddDays(-15)} | Remove-RMADBackup -Delete $true

Gets all backups created by Recovery Manager for Active Directory in the last 15 days, unregisters these backups from the backup registration database, and then deletes the backup files.

PARAMETERS

-Delete

Specifies to delete the backups being unregistered from their locations. This parameter can take one of the following values:

  • $true
  • $false

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Id

Specifies the IDs of the backups you want to unregister from the Recovery Manager backup registration database. If you use this parameter, omit the InputObject parameter of this cmdlet.

Type: Int32[]
Parameter Sets: Id
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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

-InputObject

Specifies the IBackupInfo objects representing the backups you want to unregister from the Recovery Manager backup registration database. If you use this parameter, omit the Id parameter of this cmdlet.

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 in case of -delete flag is true.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts for a confirmation before executing the command.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Describes what would happen if you ran the command without actually running the command.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

 

Remove-RMADBackupAgent


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

schema: 2.0.0

SYNOPSIS

Removes Recovery Manager Backup Agent from a specified computer, or its registration information from the Recovery Manager Console.

SYNTAX

Remove-RMADBackupAgent [-Computer] <String> [[-Credentials] <PSCredential>] [-Uninstall] [-IgnoreReadOnly]
 [<CommonParameters>]

DESCRIPTION

Allows you to completely remove Recovery Manager Backup Agent from a specified computer. You can also select to remove only registration information that relates to a particular Backup Agent from the Recovery Manager Console. This may be useful if you removed Backup Agent from a computer manually but the related agent entry remains on the Backup Agent Management node of the Recovery Manager Console.

EXAMPLES

Example 1

PS C:\> Remove-RMADBackupAgent -Computer "dc1"

This code removes registration information that relates to Backup Agent installed on the computer "dc1" from the Recovery Management Console.

Example 2

PS C:\> $credential = Get-Credential
Remove-RMADBackupAgent -Computer "dc1" -Credentials $credential -Uninstall

This code connects to the computer "dc1" under the user represented by the "credential" object and removes Backup Agent from it. Note that corresponding Backup Agent registration information is removed from the Recovery Management Console as well.

PARAMETERS

-Computer

Specifies the name of the computer from which to remove Recovery Manager Backup Agent.

Type: String
Parameter Sets: (All)
Aliases:

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

-Credentials

Specifies the user name and the password of the user account to use for connecting to the target computer and removing Backup Agent. Use the Get-Credential cmdlet provided by Windows PowerShell to get the PSCredential object representing user credentials.
Notes:

  • The user should be a local Administrator on the target computer.
  • If you omit this parameter, Backup Agent will be removed under the current user account.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Uninstall

Specifies whether the Recovery Manager Backup Agent should be completely removed. If this parameter is omitted, only the agent registration information will be removed.

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating