external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Retrieves deleted Active Directory objects.
Get-RMADDeletedObject [-All] [-Restorable] [-Computer <String>] [-RetrieveOnlyUnpackedBackups]
[-ForceBackupRetrieving] [-Name <String[]>] [-Count <Int32>] [-Attribute <String[]>] [-SearchBase <String>]
[-Timeout <Int32>] [-UseSsl] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
[-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Get-RMADDeletedObject [-All] [-Restorable] [-Computer <String>] [-RetrieveOnlyUnpackedBackups]
[-ForceBackupRetrieving] [-Id <String[]>] [-Attribute <String[]>] [-UseSsl] [-Server <String>]
[-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Get-RMADDeletedObject [-All] [-Restorable] [-Computer <String>] [-RetrieveOnlyUnpackedBackups]
[-ForceBackupRetrieving] [-Filter <String>] [-Count <Int32>] [-Attribute <String[]>] [-SearchBase <String>]
[-Timeout <Int32>] [-UseSsl] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
[-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Allows you to retrieve specific deleted or recycled Active Directory objects. The cmdlet retrieves objects from the default naming context or the Active Directory partition you specify. You can only retrieve recycled objects when Microsoft's Active Directory Recycle Bin is enabled in your environment. By default, for each deleted object, this cmdlet retrieves the following attributes:
You can also specify additional attributes you want to retrieve.
PS C:\> Get-RMADDeletedObject
This command retrieves all deleted Active Directory objects in the current domain.
PS C:\> Get-RMADDeletedObject -Name "User 1"
This command uses ambiguous name resolution (ANR) to look for and retrieve the deleted objects whose Name attribute value is User 1.
PS C:\> Get-RMADDeletedObject -Name "User 1" -Attribute usnChanged, usnCreated
This command uses ambiguous name resolution (ANR) to look for and retrieve the deleted objects whose Name attribute value is User 1. In addition to the default set of object attributes (that is, GUID, Distinguished name (DN), Name, and objectClass), this command also retrieves the attributes usnChanged and usnCreated.
PS C:\> Get-RMADDeletedObject -Filter "whenCreated>=20220601123000.0Z"
This command retrieves all deleted objects that were created on 1 June 2022 at 12:30:00 or after this date.
PS C:\> Get-RMADDeletedObject -Filter "whenCreated=20220601000000.0Z"
This command retrieves all deleted objects that were created on 1 June 2022 between 00:00:00 and 23:59:59.
PS C:\> Get-RMADDeletedObject -Filter "distinguishedName='CN=user1\\0ADEL:b0806312-d320-41fb-9e4d-ebad82706a74,CN=Deleted Objects,DC=mydomain,DC=com'"
Retrieves the deleted object whose distinguished name (DN) is CN=user1\0ADEL:b0806312-d320-41fb-9e4d-ebad82706a74,CN=Deleted Objects,DC=mydomain,DC=com.
PS C:\> Get-RMADDeletedObject -Name user1 -SearchBase 'OU=Users,DC=domain,DC=com'
Gets the deleted object whose Name attribute value is user1 and that was deleted from the container with DN OU=Users,DC=domain,DC=com or from any of its subcontainers.
Specifies to retrieve all deleted and recycled Active Directory objects.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: ShowRecycled
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies the object attributes to retrieve in addition to the attributes retrieved by default. If this parameter is omitted or empty, the cmdlet retrieves the following default set of object attributes:
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the computer whose backups contain the deleted object to retrieve.
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: Name, Filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Allows you to filter objects by attribute names and attribute values. For the syntax this parameter accepts, see the examples provided for this cmdlet.
Type: String
Parameter Sets: Filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the ID of the backup that contains the deleted object even if this object can be restored using the Active Directory Recycle Bin.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies the identifier of the object to retrieve. This parameter accepts one of the following:
Type: String[]
Parameter Sets: Identity
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: False
Accept pipeline input: False
Accept wildcard characters: False
Retrieves objects whose Name attribute value is equal to the value specified in this parameter. The Name attribute stores object's relative distinguished name (RDN) which looks similar to the following:
User 1\0ADEL:7dbac5c7-f38d-4270-8ac2-7a0674bc246b
Type: String[]
Parameter Sets: Name
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the distinguished name of the Active Directory partition from which you want to retrieve objects. If this parameter is omitted, the default naming context is used. This parameter is required if you specify an AD LDS (ADAM) instance host in the Server 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 connect to. If this parameter is set to 0 or omitted, 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 to retrieve only those objects that can be completely restored. That is, objects located in Microsoft's Active Directory Recycle Bin or in a backup registered with Recovery Manager for Active Directory.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Retrieves the deleted objects only from the unpacked backups.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies an Active Directory container in which to search for deleted objects. This is the container from which the objects you want to find were deleted. The search is performed in the specified container and all its subcontainers, including the deleted ones. Specify the distinguished name (DN) of the container in which you want to search.
Type: String
Parameter Sets: Name, Filter
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, deleted objects are retrieved 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
Specifies the maximum wait time for retrieving the objects, in seconds. The default value is 30.
Type: Int32
Parameter Sets: Name, Filter
Aliases:
Required: False
Position: Named
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False
Specifies whether use Secure Sockets Layer (SSL) to encrypt the connection.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
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:
Sets global settings for the application.
Get-RMADGlobalOptions [[-Name] <String>] [<CommonParameters>]
Sets Recovery Manager for Active Directory global settings.
PS C:\> Get-RMADGlobalOptions -Name "UnpackingPath"
This cmdlet returns the value of the "UnpackingPath" global option.
PS C:\> Get-RMADGlobalOptions "UnpackingPath"
This cmdlet also can return the value of the "UnpackingPath" global option.
PS C:\> Get-RMADGlobalOptions
This code returns a HashTable which contains the name and value of all global options.
Specifies the name to the option whose value is retrieved.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
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 domain systems associated with the Hybrid Connector.
Get-RMADHybridRecoveryDomainOptions [<CommonParameters>]
Returns the domain and associated systems used in the Hybrid Connector.
PS C:\>Get-RMADHybridRecoveryDomainOptions
Id : 6
Name : hal-test.dev.hal.ca.qsft
PrimaryComputerId : 5
Username : hal-test\master
Computers : {ID: 5, Name: hal-test-dc.hal-test.dev.hal.ca.qsft,
ID: 7, Name: hal-test-srv.hal-test.dev.hal.ca.qsft}
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 information related to the Hybrid Connector.
Get-RMADHybridRecoveryOptions [<CommonParameters>]
Returns the information related to the Hybrid Connector. This includes the data contained in the file received or exported from On Demand Recovery (ODR) used to establish the connection. Also included is the host name of the system that is connected to the ODB via the Hybrid Connector and the status of the connector.
PS C:\>Get-RMADHybridRecoveryOptions
Enabled : True
RelayUrl : https://backupaad-rmaz-hybrid-
us.servicebus.windows.net/org-
05843ce6-cdde-a9c1-d228-70
983618c6cb
RelayKeyName : listenKey
AADConnectHost : hal-test-dc
AADConnectUsername : hal-test\master
UseAgentlessMethod : True
UsePackedBackups : True
SkipReplication : False
AutomaticallyConfigureFirewall : False
Status : Completed: True, Failed: False, Relay
Error: '', AAD Connect Error: ''
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