Chat now with support
Chat with Support

Recovery Manager for AD Forest 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 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 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-RMADStorageServer 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 Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Get-RMADSessionItemEvent


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

schema: 2.0.0

SYNOPSIS

Gets events from a specified backup creation session item.

SYNTAX

sessionItem (Default)

Get-RMADSessionItemEvent [[-SessionItem] <SessionItem[]>] [-Type <EventType[]>] [<CommonParameters>]

sessionItemId

Get-RMADSessionItemEvent [[-SessionItemId] <Int32[]>] [-Type <EventType[]>] [<CommonParameters>]

DESCRIPTION

Gets events from a specified backup creation session item.

EXAMPLES

Example 1

PS C:\> Get-RMADSessionItemEvent -Type Warning

Gets all Warning events for all backup creation sessions.

PARAMETERS

-SessionItem

Specifies the backup creation session item from which to get events.

Type: SessionItem[]
Parameter Sets: sessionItem
Aliases:

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

-SessionItemId

Specifies the identifier of the backup creation session item from which to get events.

Type: Int32[]
Parameter Sets: sessionItemId
Aliases:

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

-Type

Specifies the types of events to get.
This parameter accepts the following values for event types:* Information * Warning

  • Error When specifying multiple event types, use a comma as a separator.
Type: EventType[]
Parameter Sets: (All)
Aliases:
Accepted values: Information, Warning, Error

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-RMADStorageServer


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

schema: 2.0.0

SYNOPSIS

Returns a list of registered secure storage servers.

SYNTAX

Get-RMADStorageServer [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

Returns a list of currently registered secure storage servers.

EXAMPLES

Example 1

PS C:\> Get-RMADStorageServer

Displays the list of currently registered storage servers.

Example 2

PS C:\> Get-RMADStorageServer -Name storage.local

Displays a secure storage server with the 'storage.local' name, if any.

PARAMETERS

-Name

Specifies the name of a secure storage server to display.

Type: String
Parameter Sets: (All)
Aliases:

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

OUTPUTS

String

NOTES

RELATED LINKS

 

Import-RMADBackup


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

schema: 2.0.0

SYNOPSIS

Reads the backup registration information from the .xml file and returns backup descriptions in the BackupInfo objects.

SYNTAX

Paths

Import-RMADBackup [-Path] <String[]> [-IgnoreReadOnly] [<CommonParameters>]

Definition

Import-RMADBackup -Definition <String> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Reads the backup registration information from the .xml file and returns backup descriptions in the BackupInfo objects.
After you import backups, you need to register them with Recovery Manager so that the backups become available in the Recovery Manager user interface.
To register the backups, use the Add-RMADBackup cmdlet.

EXAMPLES

Example 1

PS C:\> Import-RMADBackup C:\ImportedBackups\RMADBackups.xml | Add-RMADBackup

Imports backups from the C:\ImportedBackups\RMADBackups.xml file to the Recovery Manager for Active Directory backup registration database on the computer where you are using this cmdlet.
Then, the Add-RMADBackup registers the imported backups with Recovery Manager for Active Directory.

PARAMETERS

-Definition

Specifies the registration information about the backups you want to import into the Recovery Manager for Active Directory backup registration database.

Type: String
Parameter Sets: Definition
Aliases:

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

-Path

Specifies the path to the .xml file that contains the registration information about the backups you want to import into the Recovery Manager for Active Directory backup registration database.

Type: String[]
Parameter Sets: Paths
Aliases:

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

 

Import-RMADFERecoveryCertificate


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

schema: 2.0.0

SYNOPSIS

Imports Forest Recovery certificates.

SYNTAX

Import-RMADFERecoveryCertificate [-Path] <String> [-Password] <SecureString> [<CommonParameters>]

DESCRIPTION

This cmdlet imports Forest Recovery certificates from the specified location.
You must also supply the password that is used to protect the certificates.

EXAMPLES

EXAMPLE 1

PS C:\> Import-RMADFERecoveryCertificate -Path C:\Certificates\RMADFeCertificates.pfx" -Password (ConvertTo-SecureString "protection password" -AsPlainText -Force)

This command imports Forest Recovery certificates from the specified location.

PARAMETERS

-Password

Specifies the password that is used to access the Forest Recovery certificates.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-Path

Specifies the full path to the Forest Recovery certificate file.

Type: String
Parameter Sets: (All)
Aliases:

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