external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Retrieves specific objects from Active Directory or certain backups registered with Recovery Manager for Active Directory.
Get-RMADObject [-KeepBackupUnpacked] [-State <ObjectState>] [-Backup <Guid[]>] [-BackupPassword <SecureString>]
[-DisableADSearch] [-Name <String[]>] [-Count <Int32>] [-Attribute <String[]>] [-SearchBase <String>]
[-Timeout <Int32>] [-UseSsl] [-Server <String>] [-Credential <PSCredential>] [-Partition <String>]
[-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Get-RMADObject [-KeepBackupUnpacked] [-State <ObjectState>] [-Backup <Guid[]>] [-BackupPassword <SecureString>]
[-DisableADSearch] [-Id <String[]>] [-Attribute <String[]>] [-UseSsl] [-Server <String>]
[-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]
Get-RMADObject [-KeepBackupUnpacked] [-State <ObjectState>] [-Backup <Guid[]>] [-BackupPassword <SecureString>]
[-DisableADSearch] [-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 objects from Active Directory or certain backups registered with Recovery Manager for Active Directory.By default, with each object, this cmdlet retrieves the following attributes:
If the object is deleted, in addition to the above-listed attributes, the cmdlet also retrieves the following attributes:
You can also specify additional attributes to retrieve.
PS C:\> Get-RMADObject -Name "User 1"
This command uses ambiguous name resolution (ANR) to look for and retrieve the objects whose Name attribute value is User 1.
PS C:\> $b = Get-RMADBackup
C:\PS>Get-RMADObject -DisableADSearch -Backup $b -Name "User 1"
-Attribute *
In the first line of this command, the Get-RMADBackup gets all backups registered with Recovery Manager for Active Directory and stores the backup objects in the $b variable.
PS C:\> Get-RMADObject -Name "User 1" -State Live, Deleted -Attribute usnChanged, usnCreated
This command uses ambiguous name resolution (ANR) to look for and retrieve objects whose Name attribute value is User 1 and whose state is either live or deleted. In addition to the default attribute set, the command retrieves the usnChanged and usnCreated attributes for each object.
PS C:\> Get-RMADObject -Filter "givenName=User 1|User 2,sn=Smith"
This command retrieves the objects whose givenName attribute value is either User 1 or User 2 and whose sn attribute value is Smith.
PS C:\> Get-RMADObject -Filter "whenCreated>=20220601123000.0Z"
This command retrieves all objects that were created on 1 June 2022 at 12:30:00 or after this date.
PS C:\> Get-RMADObject -Filter "whenCreated=20220601000000.0Z"
This command retrieves all objects that were created on 1 June 2022 between 00:00:00 and 23:59:59.
PS C:\> Get-RMADObject -Filter "distinguishedName='CN=user1,DC=mydomain,DC=com'"
Retrieves the object whose distinguished name (DN) is CN=user1,DC=mydomain,DC=com.
PS C:\> Get-RMADObject -Name user1 -State live -SearchBase 'OU=Users,DC=domain,DC=com'
Gets the object whose Name attribute value is user1 and that is located in the container with DN OU=Users,DC=domain,DC=com or in any of its subcontainers.
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:
To specify all available object attributes, type an asterisk (*) in this parameter.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the backup that contains the object to retrieve. To specify a backup, type the backup GUID in this parameter or use the Get-RMADBackup cmdlet.
Type: Guid[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the password to access the password-protected backup that contains the object you want to retrieve.
Type: SecureString
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
When present, specifies to search Active Directory for objects to retrieve.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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
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
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
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 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: 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, 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
Retrieves objects whose state is equal to any of the values specified in this parameter. This parameter can take one of the following values:
When specifying multiple values in this parameter, use a comma as a separator.
Type: ObjectState
Parameter Sets: (All)
Aliases:
Accepted values: Live, Deleted, Recycled, All
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:
Gets all the RMAD consoles in the replication console list.
Get-RMADReplicationConsole [<CommonParameters>]
Gets all the RMAD consoles in the replication console list.
PS C:\> C:\>Get-RMADReplicationConsole
This command gets all the RMAD consoles in the replication console list.
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:
Allows you to get the replication schedule from a specified computer.
Get-RMADReplicationSchedule [<CommonParameters>]
Allows you to get the replication schedule from a specified computer.
PS C:\> Get-RMADReplicationSchedule
This example illustrates how to get the replication schedule from a specified computer.
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 information about replication sessions.
Get-RMADReplicationSession [[-Id] <Int32[]>] [<CommonParameters>]
Retrieves replication sessions. Each replication session contains a set of properties including the session start time, end time, and replication result.
PS C:\> Get-RMADReplicationSession
This command retrieves all the replication sessions.
PS C:\> Get-RMADReplicationSession -Id 1
This command retrieves the replication session by session ID.
Specifies the IDs of the replication sessions.
Type: Int32[]
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.
© ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center