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

Get-RMADReportSession


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

schema: 2.0.0

SYNOPSIS

Retrieves an object representing the online comparison or restore operation report.

SYNTAX

Get-RMADReportSession [-SessionId <Int32>] [-SqlCredential <PSCredential>] [<CommonParameters>]

DESCRIPTION

Retrieves an object representing the online comparison or restore operation report.

EXAMPLES

Example 1

PS C:\> Get-RMADReportSession | Sort OperationDate

This command retrieves an object representing the online comparison or restore operation report. The report data is sorted by date.

PARAMETERS

-SessionId

Specifies the compare or restore session identifier.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-SqlCredential

Specifies the user name and password of the user account with which you want to connect to SQL Server to generate a report. The user name and password must be in the form of a PSCredential object.

Type: PSCredential
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-RMADSession


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

schema: 2.0.0

SYNOPSIS

Retrieves an object representing Recovery Manager backup sessions.

SYNTAX

collection (Default)

Get-RMADSession [[-Collection] <ComputerCollection[]>] [-Result <SessionResult[]>] [-UseCache]
 [-DayCount <Int32>] [-StartType <SessionStartType>] [<CommonParameters>]

collectionId

Get-RMADSession [[-CollectionId] <Int32[]>] [-Result <SessionResult[]>] [-UseCache] [-DayCount <Int32>]
 [-StartType <SessionStartType>] [<CommonParameters>]

collectionName

Get-RMADSession [[-CollectionName] <String[]>] [-Result <SessionResult[]>] [-UseCache] [-DayCount <Int32>]
 [-StartType <SessionStartType>] [<CommonParameters>]

DESCRIPTION

Retrieves an object representing one or more Recovery Manager backup sessions for a specified Computer Collection. The retrieved object has such properties as names of the domain controllers that participated in the backup session, names of the domains to which the domain controllers belong, backup session result, and error messages, if any, encountered during the backup session.

EXAMPLES

Example 1

PS C:\> Get-RMADSession -CollectionName col1 -Result Error,Warning 
-DayCount 5

Returns backup sessions that ended with an error or warning and started in the recent 5 days for the Computer Collection named col1.

Example 2

PS C:\> Get-RMADSession -CollectionName "Collection1"

Returns all backup sessions for the Computer Collection named Collection1.

PARAMETERS

-Collection

Specifies the name of the computer collection for which you want to retrieve backup sessions.

Type: ComputerCollection[]
Parameter Sets: collection
Aliases:

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

-CollectionId

Specifies the ID of the computer collection for which you want to retrieve backup sessions.

Type: Int32[]
Parameter Sets: collectionId
Aliases:

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

-CollectionName

Specifies the name of the computer collection for which you want to retrieve backup sessions.

Type: String[]
Parameter Sets: collectionName
Aliases:

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

-DayCount

Specifies the number of days within which the sessions you want to retrieve started. If you omit this parameter, sessions are retrieved regardless of when they started.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Result

Retrieves backup sessions based on their result. If you omit this parameter, sessions are retrieved regardless of their result. This parameter can take one of the following values:

  • Success
  • Error
  • Warning
  • Unknown
  • Running
  • Canceled
  • Abandoned
  • Pending
  • Verifying
  • Installing
  • Working

Type: SessionResult[]
Parameter Sets: (All)
Aliases:
Accepted values: Success, Error, Warning, Unknown, Running, Canceled, Abandoned, Pending, Verifying, Installing, Working

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

-StartType

Specifies to return either scheduled backup sessions or backup sessions that were started manually. This parameter can take one of the following values:

  • Manual - Specifies to return backup sessions that were started manually.
  • Scheduled - Specifies to return scheduled backup sessions.

Type: SessionStartType
Parameter Sets: (All)
Aliases:
Accepted values: Manual, Scheduled

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

-UseCache

Specifies to return the data from the cache.

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


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

schema: 2.0.0

SYNOPSIS

Gets items from a specified backup creation session.

SYNTAX

session (Default)

Get-RMADSessionItem [-Session <Session[]>] [-Result <SessionResult[]>] [<CommonParameters>]

sessionId

Get-RMADSessionItem [-SessionId <Int32[]>] [-Computer <String[]>] [-Result <SessionResult[]>]
 [<CommonParameters>]

DESCRIPTION

Gets items from a specified backup creation session.

EXAMPLES

Example 1

PS C:\> Get-RMADSessionItem -Computer "Comp*"

This command gets all session items from all backup creation sessions created for the computers whose name starts with Comp.

PARAMETERS

-Computer

Gets items from the backup creation sessions run for the computer whose name specified in this parameter.
This parameter accepts the asterisk (*) wildcard.

Type: String[]
Parameter Sets: sessionId
Aliases:

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

-Result

Gets items from the backup creation sessions that completed with the result specified in this parameter.

Type: SessionResult[]
Parameter Sets: (All)
Aliases:
Accepted values: Success, Error, Warning, Unknown, Running, Canceled, Abandoned, Pending, Verifying, Installing, Working

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

-Session

Specifies the backup creation session from which to get session items.

Type: Session[]
Parameter Sets: session
Aliases:

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

-SessionId

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

Type: Int32[]
Parameter Sets: sessionId
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-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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating