Chat now with support
Chat mit Support

Recovery Manager for AD Disaster Recovery 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 Add-RMADStorageServerException 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 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-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 Set-RMADStorageServerAllowedVolumes Set-RMADStorageServerRetentionPolicy Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADSecureStorageBackup Unprotect-RMADStorageServer Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Get-RMADBackupAgent


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

schema: 2.0.0

SYNOPSIS

Retrieves objects that represent Recovery Manager Backup Agents, or discovers manually preinstalled Recovery Manager Backup Agents.

SYNTAX

Get-RMADBackupAgent [-Discover] [-UpdateInfo] [<CommonParameters>]

DESCRIPTION

Allows you to retrieve a list of installed and registered in the Recovery Management Console Backup Agents.
It also allows you to discover all Backup Agent instances that were manually preinstalled on computers.

EXAMPLES

Example 1

PS C:\> Get-RMADBackupAgent

This code returns a list of installed and registered in the Recovery Management Console Backup Agents.

Example 2

PS C:\> Get-RMADBackupAgent -Discover

This code discovers all Backup Agent instances that were manually preinstalled on computers.
Note that after the discover operation completes, you can view and manage the discovered Backup Agent instances using the corresponding cmdlets or from the Backup Agent Management node in the Recovery Manager Console.

PARAMETERS

-Discover

Specifies whether Backup Agent instances that were manually preinstalled on computers should be discovered.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-UpdateInfo

Specifies whether Backup Agents information should be re-requested.

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


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

schema: 2.0.0

SYNOPSIS

Gets the content of the backups held at a specified location.

SYNTAX

Bkf

Get-RMADBackupInfo [-Path] <String[]> [-BackupPassword <SecureString>] [-UseLegacyEncryption] [-IgnoreReadOnly]
 [<CommonParameters>]

OfflineDit

Get-RMADBackupInfo [-Path] <String[]> [-SysvolPath <String[]>] [-ResolveIndexes <Boolean>] [-OfflineDit]
 [-IgnoreReadOnly] [<CommonParameters>]

BackupInfo

Get-RMADBackupInfo [-BackupPassword <SecureString>] [-UseLegacyEncryption] [-IgnoreReadOnly]
 [<CommonParameters>]

DESCRIPTION

The Get-RMADBackupInfo cmdlet gets the content of the backups created with Recovery Manager and held at the location specified by the path.

EXAMPLES

Example 1

PS C:\> $b = Get-ChildItem C:\Backups -Filter *.bkf -Recurse | Get-RMADBackupInfo

C:\PS>Where-Object -InputObject $b { $_.Contents -band 64 } | Add-RMADBackup

This command gets the content of all backups held in the C:\Backups folder and its subfolders, and saves the content in the $b variable.
The Where-Object cmdlet then passes the Active Directory backups from the $b variable to the Add-Backup cmdlet (the number 64 stands for the Active Directory component.) Add-RMADBackup then registers the passed Active Directory backups in the Recovery Manager database.

Example 2

PS C:\> $p = Read-Host "Backup Password" -AsSecureString

C:\PS>Get-RMADBackupInfo C:\Backups\password-protected_backup1.bkf -BackupPassword $p

In this example, the Read-Host cmdlet provided by Windows PowerShell gets the backup password as a SecureString object and saves it in the $p variable.
The Get-RMADBackupInfo then uses the password saved in the $p variable to access the password-protected backup C:\Backups\password-protected_backup1.bkf.

PARAMETERS

-BackupPassword

Specifies the password to access a password-protected backup.
This is the same password that is set in the computer collection properties in the Recovery Manager console.

Type: SecureString
Parameter Sets: Bkf, BackupInfo
Aliases:

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

-OfflineDit

Specifies that the application registers the DIT file as a backup.

Type: SwitchParameter
Parameter Sets: OfflineDit
Aliases:

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

-Path

Specifies the path to the backups whose content is to be retrieved.

Type: String[]
Parameter Sets: Bkf, OfflineDit
Aliases: FullName

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

-ResolveIndexes

Reindexes the DIT file in case of invalid index data.

Type: Boolean
Parameter Sets: OfflineDit
Aliases:

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

-SysvolPath

Path to the SYSVOL folder.

Type: String[]
Parameter Sets: OfflineDit
Aliases:

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

-UseLegacyEncryption

Allows you to work with backups encrypted by the RC4 algorithm from RSA, Inc.
(Microsoft RSA Base Provider).
This algorithm is used to back up Windows Server 2003/2003 R2 domain controllers in Recovery Manager for Active Directory 8.2.x and 8.5.x.

Type: SwitchParameter
Parameter Sets: Bkf, BackupInfo
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-RMADBackupObject


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

schema: 2.0.0

SYNOPSIS

Get objects from backups

SYNTAX

InputObject+Name (Default)

Get-RMADBackupObject -InputObject <BackupInfo[]> [-Name <String[]>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

InputObject+Id

Get-RMADBackupObject -InputObject <BackupInfo[]> [-Id <String[]>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

InputObject+Filter

Get-RMADBackupObject -InputObject <BackupInfo[]> [-Filter <String>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

BackupGuid+Id

Get-RMADBackupObject -BackupGuid <Guid[]> [-Id <String[]>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

BackupGuid+Name

Get-RMADBackupObject -BackupGuid <Guid[]> [-Name <String[]>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

BackupGuid+Filter

Get-RMADBackupObject -BackupGuid <Guid[]> [-Filter <String>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

DESCRIPTION

Retrieves specific objects from certain backups registered with Recovery Manager for Active Directory.

EXAMPLES

Example 1

PS C:\> Get-RMADBackup | Get-RMADBackupObject -Name "Adm" -Attribute *

Retrieves a list of all backups that are registered in Recovery Manager for Active Directory and then search for the object using ambiguous name resolution.
In this example, you will get a list of all objects that have 'Adm' in the beginning of any naming attribute from the 'ANR attribute Set'.

Example 2

PS C:\> Get-RMADBackup | Get-RMADBackupObject -SearchBase 'CN=Partitions,CN=Configuration,DC=CONTOSO,DC=COM' -Filter "objectClass='crossRef'"

Retrieves a list of objects from the container that is specified in the 'SearchBase' parameter.
The objects are filtered by the 'objectClass' attribute.

Example 3

PS C:\> Get-RMADBackup | Get-RMADBackupObject -Filter "givenName=Name 1|Name 2,cn=Smith"

Retrieves a list of all registered backups and all objects that have 'Name 1' or 'Name 2' value for the 'givenName' attribute and 'Smith' for the 'CN' attribute.

Example 4

PS C:\> Get-RMADObject -Filter  "distinguishedName='CN=name1,DC=mydomain,DC=com'"

Retrieves a list of all registered backups and all objects that have the following distinguished name: CN=name1,DC=mydomain,DC=com.

Example 5

PS C:\> Get-RMADBackup | Get-RMADBackupObject -AdLdsInstance 'ContosoApplication' -Filter "distinguishedName='CN=Users,CN=Roles,CN=App1,DC=contoso,DC=com'"

Retrieves the object with the specified distinguished name from the backup of the 'ContosoApplication' AD LDS instance.

PARAMETERS

-AdLdsInstance

If you search in the AD LDS instance backup, you should specify a list of AD LDS instances in which you want to search.

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

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

-Attribute

Specifies the object attributes to retrieve in addition to the attributes the cmdlet retrieves by default.
If this parameter is omitted or empty, the cmdlet retrieves the following default set of object attributes: - distinguishedName - name - objectClass - objectguid

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

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

-BackupGuid

GUID of the registered backup.

Type: Guid[]
Parameter Sets: BackupGuid+Id, BackupGuid+Name, BackupGuid+Filter
Aliases: Guid

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

-BackupPassword

Specifies the password to access a password-protected backup.
This is the same password that is set in the computer collection properties in the Recovery Manager console.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-Count

Limits the maximum number of objects to retrieve.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Filter

Allows you to filter objects by attribute names and attribute values.
For details, see the examples provided for this cmdlet.

Type: String
Parameter Sets: InputObject+Filter, BackupGuid+Filter
Aliases:

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

-Id

Specifies the identifier of the object to retrieve.
This parameter accepts one of the following: - GUID - Distinguished name (DN) - samAccountName - userLogonName

Type: String[]
Parameter Sets: InputObject+Id, BackupGuid+Id
Aliases:

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

-InputObject

Specifies backups that contain the retrieved object.
To get the backup, use the Get-RMADBackup cmdlet.

Type: BackupInfo[]
Parameter Sets: InputObject+Name, InputObject+Id, InputObject+Filter
Aliases: Backup, Backups

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

-KeepBackupUnpacked

Determines whether to save the unpacked backup after the search operation.
If this parameter is not set, the unpacked backup will be deleted after the search operation is completed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

Retrieves objects whose Name attribute value is equal to the value specified in this parameter.

Type: String[]
Parameter Sets: InputObject+Name, BackupGuid+Name
Aliases:

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

-SearchBase

Specifies an Active Directory container in which to search for objects.
The search is performed in the specified container and all its subcontainers.
Specify the distinguished name (DN) of the container in which you want to search.

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


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

schema: 2.0.0

SYNOPSIS

Gets security check information for a specified backup.

SYNTAX

Get-RMADBackupSecurityStatus [-BackupGuid <Guid[]>] [-From <DateTime>] [<CommonParameters>]

DESCRIPTION

Retrieves security check information for a specified backup registered with Recovery Manager for Active Directory.

EXAMPLES

Example 1

PS C:\> $bkf = (Get-RMADBackup -ComputerName dc.DomainName.local)[-1]
$status = New-Object -TypeName QuestSoftware.RecoveryManager.AD.PowerShell.BackupSecurityStatus
$status.Summary = "Passed"
$status.Details = "all successful"
$status.CheckDate = Get-Date 
Publish-RMADBackupSecurityStatus -BackupGuid $bkf.backupGuid -SecurityStatus $status
Get-RMADBackup -ComputerName dc.DomainName.local | %{  
    Get-RMADBackupSecurityStatus -BackupGuid $_.BackupGuid
    }

For troubleshooting only.
This command retrieves information related to antimalware scan results for all backups registered with Recovery Manager for Active Directory.

PARAMETERS

-BackupGuid

This is the GUID of the backup for which a user wants to get the antimalware scan results.

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

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

-From

Specifies the time point to get statuses.

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

 

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen