external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Extracts the contents of a specified backup file.
Expand-RMADBackup [-InputObject] <BackupInfo[]> [-BackupPassword <SecureString>] [-UseLegacyEncryption]
[-TargetFolder] <String> [[-Components] <BackupComponentBits>] [-AsJob]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Expand-RMADBackup [-Path] <String[]> [-BackupPassword <SecureString>] [-UseLegacyEncryption]
[-TargetFolder] <String> [[-Components] <BackupComponentBits>] [-AsJob]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Expand-RMADBackup [-Id] <Int32[]> [-BackupPassword <SecureString>] [-UseLegacyEncryption]
[-TargetFolder] <String> [[-Components] <BackupComponentBits>] [-AsJob]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Allows you to selectively extract the contents of a backup file created with Recovery Manager for Active Directory to the location you want.
PS C:\> Expand-RMADBackup -InputObject (Get-RMADBackup | where {$_.Date -gt (Get-Date).AddDays(-2)}) -TargetFolder 'C:\UnpackedBackups'
This command extracts the contents of all backups created within last two days to the local folder C:\UnpackedBackups.
Accepts a backup object as input to the cmdlet.
Enter a variable that contains the object or type a command or expression that gets the object.
Type: BackupInfo[]
Parameter Sets: BackupInfo
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
If the backup is password-protected, specifies the password to open the backup.
The parameter value must be a SecureString object.
Type: SecureString
Parameter Sets: (All)
Aliases: Password
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the target folder to which you want to extract the backup.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the backup components you want to extract.
When specifying multiple backup components in this parameter, use a comma as a separator.
This parameter accepts the following values for backup components:* Sam - Specifies to extract the SAM registry hive.
Type: BackupComponentBits
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Runs the command as a background job.
You can use this parameter to run commands that take a significant time to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Path to the backup file.
Type: String[]
Parameter Sets: Bkf
Aliases: FullName
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Specifies the identifier of the backup you want to extract.
Type: Int32[]
Parameter Sets: Id
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Exports registration information for a backup into an .xml file.
Export-RMADBackup [-InputObject] <BackupInfo[]> [-Path] <String> [-PassThru]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Export-RMADBackup [-Id] <Int32[]> [-Path] <String> [-PassThru] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
This cmdlet exports the registration information for the specified backup into an .xml file.
You can then use the Import-RMADBackup cmdlet to transform the registration information saved in the .xml file into an object.
PS C:\> $b = Get-RMADBackup
Export-RMADBackup -Path Backups.xml -InputObject $b
Exports registration information for all backups registered in the Recovery Manager for Active Directory backup registration database located on the computer where you are using this cmdlet.
The backup registration information is saved in the Backups.xml file.
PS C:\> Export-RMADBAckup -Id 1 -Path C:\ExportedBackups
Exports the registration information of the backup whose ID 1 to an XML file in the folder C:\ExportedBackups.
Accepts a backup object as input to the cmdlet.
Enter a variable that contains the object or type a command or expression that gets the object.
Type: BackupInfo[]
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the path to the .xml file where you want to save registration information for the backup.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Passes the registration information for the specified backup along the pipeline.
If this parameter is omitted, the registration information is not passed along the pipeline.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the identifiers of one or more backups to export.
This parameter accepts an array of integers.
Type: Int32[]
Parameter Sets: Id
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Exports Forest Recovery certificates.
Export-RMADFERecoveryCertificate [-Path] <String> [-Password] <SecureString>
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
This cmdlet exports Forest Recovery certificates to the specified location.
You must also supply the password that is used to protect the certificates.
@{paragraph=PS C:\>}
PS C:\> Export-RMADFERecoveryCertificate -Path C:\Certificates\RMADFeCertificates.pfx" -Password (ConvertTo-SecureString "protection password" -AsPlainText -Force)
This command exports Forest Recovery certificates to the specified location.
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
Specifies the password that is used to protect 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
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Export the verification result of an RMADFE project.
Export-RMADFEResult [-Results] <ProjectSummary> [-Path] <String> [[-FileType] <ExportFileType>]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
This cmdlet exports results after verifying all the domain controllers in a recovery project.To export the verification result, get the current status of the RMADFE project first, and then specify the file path and format to save the results of export file.
@{paragraph=PS C:\>}
PS C:\> Open-RMADFEProject -Path C:\RMADFeProjects\SampleProject.frproj -Password (ConvertTo-SecureString "project password" -AsPlainText -Force)
Start-RMADFEVerification
$results = Get-RMADFEProject
Export-RMADFEResult -Results $results -Path "C:\result.xml"
Export-RMADFEResult -Results $results -Path "C:\result.html" -FileType Html
This example illustrates how to export verification results to an XML file and an HTML file.
The first line of this example gets the current status of the RMADFE project.
The second line of this example exports the verification results to an XML and the file path is c:\result.xml.
The third line of this example exports the verification results to an HTML file and the file path is c:\result.html.
@{paragraph=PS C:\>}
PS C:\> Open-RMADFEProject -Path C:\RMADFeProjects\SampleProject.frproj -Password (ConvertTo-SecureString "project password" -AsPlainText -Force)
Start-RMADFEVerification
Get-RMADFEProject | Export-RMADFEResult -Path "c:\result.xml"
Get-RMADFEProject | Export-RMADFEResult -Path "c:\result.htm" -FileType Html
This example illustrates how to export verification results with the pipeline.
The first line of this example exports verification results to an XML file and saves it to c:\result.xml with the pipeline.
The second line of this example exports verification results to an HTML file and saves it to c:\result.html with the pipeline.
Specifies the current status of the RMADFE project.
Type: ProjectSummary
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the path to save the results.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the format of the exported file. Default format is XML.
Type: ExportFileType
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: Xml
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@{Text=}
Type: String
Parameter Sets: (All)
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center