external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Recycles specific deleted Active Directory objects.
ConvertTo-RMADRecycledObject -Name <String[]> [-Force] [-Server <String>] [-Credential <PSCredential>]
[-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]
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.
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.
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.
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
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
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
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-7a0674bc246b
To 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
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
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
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
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
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
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:
Creates storage server agent setup.
Create-RMADStorageAgentSetup [-Path] <String> [-Port <Int32>] [<CommonParameters>]
Create storage server agent setup bundle packed to the ZIP archive that contains required components to deploy the storage server agent.
PS C:\> Create-RMADStorageAgentSetup -Path "C:\Setup.zip" -StorageAgentPort 48001
Creates a setup bundle and puts it in the specified file.
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 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
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:
Extracts the contents of a specified backup file.
Expand-RMADBackup [-InputObject] <BackupInfo[]> [-BackupPassword <SecureString>] [-TargetFolder] <String>
[[-Components] <BackupComponentBits>] [-AsJob] [<CommonParameters>]
Expand-RMADBackup [-Path] <String[]> [-BackupPassword <SecureString>] [-TargetFolder] <String>
[[-Components] <BackupComponentBits>] [-AsJob] [<CommonParameters>]
Expand-RMADBackup [-Id] <Int32[]> [-BackupPassword <SecureString>] [-TargetFolder] <String>
[[-Components] <BackupComponentBits>] [-AsJob] [<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.
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: False
Accept pipeline input: False
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
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:
Type: BackupComponentBits
Parameter Sets: (All)
Aliases:
Accepted values: Sam, Security, Software, System, Default, NTUserDat, ActiveDirectoryDatabase, Sysvol, ActiveDirectory, EnterpriseServices, BootFiles, SystemProtectedFiles, BootIni, CertificateServer, IisMetabase, PerformanceCounters, ClusterQuorum, Adam, GroupMembership, BootFilesExt, CryptoKeys, ForestRecoveryMetadata, Components, SchemaDat, Registry, VirtualImage, HardLinks
Required: False
Position: 2
Default value: None
Accept pipeline input: False
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
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
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 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
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] [<CommonParameters>]
Export-RMADBackup [-Id] <Int32[]> [-Path] <String> [-PassThru] [<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.
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
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
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: False
Accept pipeline input: False
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
© 2025 Quest Software Inc. ALL RIGHTS RESERVED. 이용 약관 개인정보 보호정책 Cookie Preference Center