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

Convert-RMADBackup


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

schema: 2.0.0

SYNOPSIS

Converts Windows Server backups into RMAD Bare Metal Recovery backups.

SYNTAX

Convert-RMADBackup [-WindowsServerBackupLocation] <String> [-BareMetalRecoveryPath] <String> [-AsJob]
 [<CommonParameters>]

DESCRIPTION

Converts Windows Server Backups into RMAD Bare Metal Recovery backups.

EXAMPLES

Example 1

PS C:\> Convert-RMADBackup \\backup_srv01\wsb\WindowsImageBackup \\backup_srv01\rmad\bmr.vhdx

Synchronously starts the conversion of the Windows Server backup to the bmr.vhdx file located on the network share.

Example 2

PS C:\> Convert-RMADBackup \\backup_srv01\wsb\WindowsImageBackup \\backup_srv01\rmad\bmr.vhdx | Add-RMADBackup

Synchronously starts the conversion of the Windows Server backup located at the remote network share, puts the result into the bmr.vhdx file, and then registers the resulting backup.

Example 3

PS C:\> $job = Convert-RMADBackup D:\WindowsImageBackup D:\bmr.vhdx -AsJob
$job.StatusMessage

Runs conversion as a background job and shows the current status message.

PARAMETERS

-AsJob

Runs the conversion process as a background job.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BareMetalRecoveryPath

Specifies the full path to the RMAD Bare Metal Recovery backup file.

Type: String
Parameter Sets: (All)
Aliases:

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

-WindowsServerBackupLocation

Specifies the full path to the Windows Server backup.
You must specify the path including the WindowsImageBackup folder.

Type: String
Parameter Sets: (All)
Aliases:

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

 

ConvertTo-RMADRecycledObject


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

schema: 2.0.0

SYNOPSIS

Recycles specific deleted Active Directory objects.

SYNTAX

ConvertTo-RMADRecycledObject -Name <String[]> [-Force] [-Server <String>] [-Credential <PSCredential>]
 [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Allows you to manually recycle specific deleted Active Directory objects held in Microsoft's Active Directory Recycle Bin in the forest where Recovery Manager is installed.
This cmdlet overrides the deleted object lifetime setting that applies to the deleted objects being recycled.
You can only use this cmdlet if Microsoft's Active Directory Recycle Bin feature is enabled in the forest where Recovery Manager is installed.

EXAMPLES

Example 1

PS C:\> (Get-RMADDeletedObject dc1.dom1.lab.local) |
Where-Object { $_.objectclass -contains "user" } |
Foreach-Object { ConvertTo-RMADRecycledObject -Name $_.Name -Server dc1.dom1.lab.local }

This example shows how to recycle all user objects held in Microsoft's Active Directory Recycle Bin.
The Get-RMADDeletedObject cmdlet gets all deleted objects from Microsoft's Active Directory Recycle Bin by connecting to the dc1.dom1.lab.local domain controller.
Then the Get-RMADDeletedObject cmdlet pipes the objects to the Where-Object cmdlet that filters out user objects.
Then, the Foreach-Object cmdlet uses the ConvertTo-RMADRecycledObject cmdlet to transfer each user object to the recycled state.

Example 2

PS C:\> ConvertTo-RMADRecycledObject -Name "User 1\0ADEL:7dbac5c7-f38d-4270-8ac2-7a0674bc246b"

Converts the deleted object "User 1\0ADEL:7dbac5c7-f38d-4270-8ac2-7a0674bc246b" to recycled state.

PARAMETERS

-Credential

The user name and password of the user account with which you want to connect, in the form of a PSCredential object.
Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Force

Suppresses the cmdlet prompt for confirmation.
When this parameter is omitted, the cmdlet prompts you for confirmation before recycling objects.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

Allows you to specify the deleted object you want to recycle.
To specify a deleted object, enter the value of the object's Name attribute in this parameter.
The Name attribute provides the object's relative distinguished name (RDN) that looks similar to the following: User 1\0ADEL:7dbac5c7-f38d-4270-8ac2-7a0674bc246bTo view the value of the Name attribute for a deleted object, you can use the Get-RMADDeletedObject cmdlet.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Partition

Specifies the distinguished name of the Active Directory partition from which deleted objects are to be retrieved.
If this parameter is omitted, the default naming context is used.
This parameter is required if you specify an ADAM instance host in the DirectoryHost parameter.

Type: String
Parameter Sets: (All)
Aliases:

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

-Port

Specifies the port number to be used for connection.
If this parameter is set to 0 or not specified, the default LDAP port (389) is used.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Server

Specifies the Active Directory domain, domain controller, or AD LDS (ADAM) instance host from which you want the cmdlet to retrieve objects.
If this parameter is omitted, the cmdlet retrieves objects from any available domain controller in the current domain.
To specify a domain controller or AD LDS (ADAM) instance host, use the computer name or IP address.
If you specify an Active Directory domain name in this parameter, the cmdlet retrieves objects from any available domain controller in the specified domain.

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

 

Copy-RMADFEBackup


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

schema: 2.0.0

SYNOPSIS

Copies a backup from a network share to the secure storage server.

SYNTAX

Copy-RMADFEBackup -BackupPath <String> [-BackupAccessCredentials <PSCredential>] -StorageServer <String>
 [-AgentPort <UInt32>] [-AsJob] [<CommonParameters>]

DESCRIPTION

Copies a backup from a network share to the secure storage server.
Backup is pulled from a network share by an agent running on the secure storage server.

EXAMPLES

Example 1

$credentials = New-Object PSCredential("user", (ConvertTo-SecureString "password" -asPlainText -Force) )
Copy-RMADFEBackup -StorageServer 'storage' -StorageServerBackupPath 'E:\Backups\DC1.rmad.local\2022-09-10 14-54-49.bkf' -BackupPath '\\fr\backupsnew\DC1.rmad.local\2022-09-10 14-54-49.bkf' -BackupAccessCredentials $credentials

PARAMETERS

-AgentPort

Secure storage agent port

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-AsJob

Runs the command as a background job.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BackupAccessCredentials

Network credentials to access the backup stored on BackupPath.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-BackupPath

Network path to the backup.

Type: String
Parameter Sets: (All)
Aliases:

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

-StorageServer

Secure storage name or IP address.
Assuming that the Forest Recovery agent is already installed on secure storage server.

Type: String
Parameter Sets: (All)
Aliases:

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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Create-RMADStorageAgentSetup


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

schema: 2.0.0

SYNOPSIS

Creates storage server agent setup.

SYNTAX

Create-RMADStorageAgentSetup [-Path] <String> [-Port <Int32>] [<CommonParameters>]

DESCRIPTION

Create storage server agent setup bundle packed to the ZIP archive that contains required components to deploy the storage server agent.

EXAMPLES

Example 1

PS C:\> Create-RMADStorageAgentSetup -Path "C:\Setup.zip" -StorageAgentPort 48001

Creates a setup bundle and puts it in the specified file.

PARAMETERS

-Path

Path to the result file in which the setup will be created.

Type: String
Parameter Sets: (All)
Aliases:

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

-Port

Port that will be used to run storage agent on.

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

System.String

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen