external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Gets backups registered with Recovery Manager.
Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [[-Id] <Int32[]>] [-ComputerName <String>]
[-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
[-BackupComponents <BackupComponents>] [-IncludeDeleted] [-AfterModifiedDate <DateTime>] [-First <Int32>]
[-Skip <Int32>] [-SourceConsole <String>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
Get-RMADBackup [-MinimumId <Int32>] [-Domain <String>] [-All] [[-Guid] <Guid[]>] [-ComputerName <String>]
[-MaxDate <DateTime>] [-MinDate <DateTime>] [-Site <String>] [-CollectionId <Int32>]
[-BackupComponents <BackupComponents>] [-IncludeDeleted] [-AfterModifiedDate <DateTime>] [-First <Int32>]
[-Skip <Int32>] [-SourceConsole <String>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
Retrieves the backup object for the backups registered in the Recovery Manager backup registration database.
PS C:\> Get-RMADBackup | Where-Object {$_.ComputerName -eq "dc1.dom1.local"}
This command retrieves all backup objects and passes them to the Where-Object cmdlet.
The Where-Object cmdlet outputs the backup objects whose ComputerName property value is dc1.dom1.local.
PS C:\> Get-RMADBackup -Id 12345
Retrieves the backup whose identifier is 12345.
PS C:\> Get-RMADBackup | Where-Object {($_.Date -gt (Get-Date).AddDays(-5)) -and ($_.Path -like "*Moscow*")}
This command retrieves objects that represent backups created by Recovery Manager for Active Directory in the last 5 days.
The command retrieves only those backups whose file path includes the word "Moscow".
PS C:\> Get-RMADBackup -Skip 10 -First 100
This command skips the first 10 backups and starts retrieving 100 backups from the 11th one.
Retrieves backups with identifier greater than a specified number.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the backup objects for the specified domain only.
If this parameter is not specified, all backup objects are retrieved from the Recovery Manager backup registration database.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
When this parameter is present, the cmdlet gets all backup objects registered in the Recovery Manager backup registration database, including those whose file is physically missing.
When this parameter is omitted, the cmdlet gets only those backup objects registered in the Recovery Manager backup registration database whose file is physically present.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the identifier of the backup to get.
Type: Int32[]
Parameter Sets: Id
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the backup objects from the specified computer only.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the backup objects after the specified date.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the backup objects before the specified date.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the backup objects from the specified AD site
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the backup objects for the specified collection only.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the backup objects with the specified components only.
If
this parameter is not specified, all backup objects are retrieved from
the Recovery Manager backup registration database.
Type: BackupComponents
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
When this parameter is present, the cmdlet gets all backup objects from the Recovery Manager backup registration database, including those objects whose status has been marked as Deleted or Unregistered
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the backup objects that were last modified after this date.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the number of backups to retrieve.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the number of backups to skip before starting retrieving.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves backups replicated from a specified console.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the GUID of the backup to get.
Type: Guid[]
Parameter Sets: Guid
Aliases:
Required: False
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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Retrieves objects that represent Recovery Manager Backup Agents, or discovers manually preinstalled Recovery Manager Backup Agents.
Get-RMADBackupAgent [-Discover] [-UpdateInfo] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
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.
PS C:\> Get-RMADBackupAgent
This code returns a list of installed and registered in the Recovery Management Console Backup Agents.
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.
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: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether Backup Agents information should be re-requested.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Gets the content of the backups held at a specified location.
Get-RMADBackupInfo [-Path] <String[]> [-BackupPassword <SecureString>] [-UseLegacyEncryption] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Get-RMADBackupInfo [-Path] <String[]> [-SysvolPath <String[]>] [-ResolveIndexes <Boolean>] [-OfflineDit]
[-IgnoreReadOnly] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Get-RMADBackupInfo [-BackupPassword <SecureString>] [-UseLegacyEncryption] [-IgnoreReadOnly]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
The Get-RMADBackupInfo cmdlet gets the content of the backups created with Recovery Manager and held at the location specified by the path.
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.
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.
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
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
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: None
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: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
Specifies that the application registers the DIT file as a backup.
Type: SwitchParameter
Parameter Sets: OfflineDit
Aliases:
Required: True
Position: Named
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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Get objects from backups
Get-RMADBackupObject -InputObject <BackupInfo[]> [-Name <String[]>] [-BackupPassword <SecureString>]
[-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
[-AdLdsInstance <String[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Get-RMADBackupObject -InputObject <BackupInfo[]> [-Id <String[]>] [-BackupPassword <SecureString>]
[-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
[-AdLdsInstance <String[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Get-RMADBackupObject -InputObject <BackupInfo[]> [-Filter <String>] [-BackupPassword <SecureString>]
[-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
[-AdLdsInstance <String[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Get-RMADBackupObject -BackupGuid <Guid[]> [-Id <String[]>] [-BackupPassword <SecureString>]
[-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
[-AdLdsInstance <String[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Get-RMADBackupObject -BackupGuid <Guid[]> [-Name <String[]>] [-BackupPassword <SecureString>]
[-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
[-AdLdsInstance <String[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Get-RMADBackupObject -BackupGuid <Guid[]> [-Filter <String>] [-BackupPassword <SecureString>]
[-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
[-AdLdsInstance <String[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
Retrieves specific objects from certain backups registered with Recovery Manager for Active Directory.
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'.
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.
PS C:\> Get-RMADBackup | Get-RMADBackupObject -Filter "givenName=John|Richard,cn=Smith"
Retrieves a list of all registered backups and all objects that have 'John' or 'Richard' value for the 'givenName' attribute and 'Smith' for the 'CN' attribute.
PS C:\> Get-RMADObject -Filter "distinguishedName='CN=johnDoe,DC=mydomain,DC=com'"
Retrieves a list of all registered backups and all objects that have the following distinguished name: CN=johnDoe,DC=mydomain,DC=com.
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.
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
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
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
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
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
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
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: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
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
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
@{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