Chat now with support
Chat mit 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

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

 

Install-RMADBackupAgent

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

schema: 2.0.0

SYNOPSIS

Installs Recovery Manager Backup Agent on a specified computer or on each computer in a particular Computer Collection.

SYNTAX

DC

Install-RMADBackupAgent [-Computer] <String> [[-Credentials] <PSCredential>] [[-ConfigureFirewall] <Boolean>]
 [-IgnoreReadOnly] [<CommonParameters>]

Collection

Install-RMADBackupAgent [[-Credentials] <PSCredential>] [[-ConfigureFirewall] <Boolean>]
 [-CollectionName] <String> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Allows you to install the Recovery Manager Backup Agent on a specified computer which can be a domain controller or AD LDS (ADAM) host, or on each computer in a particular Computer Collection.

EXAMPLES

Example 1

PS C:\> $credential = Get-Credential
Install-RMADBackupAgent -Computer dc1 -Credentials $credential

This code connects to the computer "dc1" under the user represented by the "credential" object and installs Recovery Manager Backup Agent there.

Example 2

PS C:\> Install-RMADBackupAgent -CollectionName "New Computer Collection"

This code installs the Recovery Manager Backup Agent on each computer in the collection named "New Computer Collection".

PARAMETERS

-CollectionName

Specifies the name of the Computer Collection that includes the computers on which Backup Agent should be installed.

Type: String
Parameter Sets: Collection
Aliases:

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

-Computer

Specifies the name of the computer which can be domain controller or AD LDS (ADAM) host, where to install a Recovery Manager Backup Agent.

Type: String
Parameter Sets: DC
Aliases:

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

-ConfigureFirewall

Specifies whether Recovery Manager automatically configures Windows Firewall on target Windows Server 2008-based or Windows Server 2012-based DCs to allow backup operations.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
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 installing 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 installed 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

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

 

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen