Chat now with support
Chat mit Support

Recovery Manager for AD Disaster Recovery Edition 10.2.2 - Management Shell Guide

Overview
About Management Shell Installing and opening Management Shell Getting Help Descriptions of PowerShell Commands
Add-RMADBackup Add-RMADCollectionItem Add-RMADFECloudStorage Add-RMADReplicationConsole Add-RMADStorageServer Add-RMADStorageServerException Backup-RMADCollection Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Copy-RMADFEBackup Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFECloudStorageBackup Export-RMADFERecoveryCertificate Export-RMADFEResult Export-RMADSecureStorageBackup Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject Get-RMADFEAvailableSubnet Get-RMADFECloudStorage Get-RMADFECloudStorageCollection Get-RMADFECloudStorageUploadSession Get-RMADFEComputer Get-RMADFEConsole Get-RMADFEDnsCache Get-RMADFEDomain Get-RMADFEEvent Get-RMADFEGlobalOptions Get-RMADFEOperation Get-RMADFEPersistenceConnection Get-RMADFEProject Get-RMADFERecoveryAgent Get-RMADFESchedule Get-RMADGlobalOptions Get-RMADHybridRecoveryDomainOptions Get-RMADHybridRecoveryOptions Get-RMADLicenseInfo Get-RMADObject Get-RMADReplicationConsole Get-RMADReplicationSchedule Get-RMADReplicationSession Get-RMADReplicationSessionItem Get-RMADReportObject Get-RMADReportObjectAttributes Get-RMADReportObjectChildren Get-RMADReportSession Get-RMADSession Get-RMADSessionItem Get-RMADSessionItemEvent Get-RMADStorageServer Get-RMADStorageServerAllowedVolumes Get-RMADStorageServerException Get-RMADStorageServerHardeningStatus Get-RMADStorageServerRetentionPolicy Import-RMADBackup Import-RMADFERecoveryCertificate Install-RMADBackupAgent Install-RMADFERecoveryAgent New-RMADCollection New-RMADFEProject New-RMADFERecoveryMedia New-RMADSchedule Open-RMADFEProject Protect-RMADSecureStorageServer Protect-RMADStorageServer Publish-RMADBackupSecurityStatus Refresh-RMADStorageServer Register-RMADSecureStorageBackups Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADFECloudStorage Remove-RMADFECloudStorageUploadSession Remove-RMADFERecoveryAgent Remove-RMADFESchedule Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADStorageServer Remove-RMADStorageServerException Remove-RMADUnpackedComponent Rename-RMADCollection Restart-RMADFECloudStorageUploadSession Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEDnsCache Set-RMADFEDomain Set-RMADFEGlobalOptions Set-RMADFEPersistenceConnection Set-RMADFERecoveryMode Set-RMADFESchedule Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Set-RMADStorageServerAllowedVolumes Set-RMADStorageServerRetentionPolicy Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADSecureStorageBackup Unprotect-RMADStorageServer Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Get-RMADCollection


external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:

schema: 2.0.0

SYNOPSIS

Retrieves Recovery Manager computer collection objects or default computer collection settings.

SYNTAX

Name (Default)

Get-RMADCollection [[-Name] <String[]>] [<CommonParameters>]

Id

Get-RMADCollection [-Id] <Int32[]> [<CommonParameters>]

Default

Get-RMADCollection [-Default] [<CommonParameters>]

DESCRIPTION

Allows you to retrieve an existing Recovery Manager computer collection by its name or ID.
This cmdlet retrieves all existing computer collections if no collection name or ID is specified.
You can also use this cmdlet to retrieve the default computer collection settings that apply to each new computer collection.

EXAMPLES

Example 1

PS C:\> Get-RMADCollection

This command retrieves all Recovery Manager computer collections.

Example 2

PS C:\> (Get-RMADCollection Coll1).Schedule

This command retrieves the line containing the schedule for the collection named Coll1.

PARAMETERS

-Default

Allows you to retrieve the default computer collection settings that apply to each new computer collection.
Do not use the Name or ID parameter along with this parameter.

Type: SwitchParameter
Parameter Sets: Default
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Id

Specifies the identifier of the Computer Collection to retrieve.

Type: Int32[]
Parameter Sets: Id
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the computer collection you want to retrieve.
In the computer collection name that you type in this parameter, you can use an asterisk as a wildcard symbol for any number of any characters.
Do not use the Default parameter along with this parameter.

Type: String[]
Parameter Sets: Name
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Get-RMADCollectionItem


external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:

schema: 2.0.0

SYNOPSIS

Retrieves information about items added to specified Recovery Manager for Active Directory computer collections.

SYNTAX

InputObject

Get-RMADCollectionItem [-InputObject] <ComputerCollection[]> [-UseCache] [-ComputerInfo] [<CommonParameters>]

Name

Get-RMADCollectionItem [-UseCache] [-Name] <String[]> [-ComputerInfo] [<CommonParameters>]

Id

Get-RMADCollectionItem [-UseCache] [-Id] <Int32[]> [-ComputerInfo] [<CommonParameters>]

DESCRIPTION

Retrieves information about items added to specified Recovery Manager for Active Directory computer collections.
You can use this cmdlet to retrieve information about one of the following:* Items that are explicitly added to computer collections (such as domain controllers, Active Directory domains, Active Directory sites, organizational units, AD LDS (ADAM) hosts, AD LDS (ADAM) instances, and AD LDS (ADAM) sites).

  • Domain controllers and AD LDS (ADAM) hosts that are explicitly or implicitly added to computer collections.

EXAMPLES

Example 1

PS C:\> Get-RMADCollectionItem -Collection NewCollection

Retrieves information about items that are explicitly added to the Computer Collection named NewCollection.
These items can include domain controllers, Active Directory domains, Active Directory sites, organizational units, AD LDS (ADAM) hosts, AD LDS (ADAM) instances, and AD LDS (ADAM) sites.

Example 2

PS C:\> Get-RMADCollectionItem -Collection NewCollection -ComputerInfo

Retrieves information about domain controllers and AD LDS (ADAM) hosts explicitly or implicitly added to the Computer Collection named NewCollection.

PARAMETERS

-ComputerInfo

When present, specifies to retrieve information about the domain controllers and AD LDS (ADAM) hosts that are explicitly or implicitly added to the computer collections you specified in the Collection parameter.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Id

Specifies the identifier of the computer collection that includes the items you want to retrieve.

Type: Int32[]
Parameter Sets: Id
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InputObject

Specifies the object representing the computer collections that include the items you want to retrieve.

Type: ComputerCollection[]
Parameter Sets: InputObject
Aliases: Collection

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the computer collection that includes the items you want to retrieve.

Type: String[]
Parameter Sets: Name
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-UseCache

Specifies to return the data from cache

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Get-RMADDeletedObject


external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:

schema: 2.0.0

SYNOPSIS

Retrieves deleted Active Directory objects.

SYNTAX

Name (Default)

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>]

Identity

Get-RMADDeletedObject [-All] [-Restorable] [-Computer <String>] [-RetrieveOnlyUnpackedBackups]
 [-ForceBackupRetrieving] [-Id <String[]>] [-Attribute <String[]>] [-UseSsl] [-Server <String>]
 [-Credential <PSCredential>] [-Partition <String>] [-Port <Int32>] [-IgnoreReadOnly] [<CommonParameters>]

Filter

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>]

DESCRIPTION

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: - GUID

  • Distinguished name (DN)
  • Name
  • objectClass

You can also specify additional attributes you want to retrieve.

EXAMPLES

Example 1

PS C:\> Get-RMADDeletedObject

This command retrieves all deleted Active Directory objects in the current domain.

Example 2

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.

Example 3

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.

Example 4

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.

Example 5

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.

Example 6

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.

Example 7

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.

PARAMETERS

-All

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

-Attribute

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: - GUID

  • Distinguished name (DN)
  • Name
  • objectClassTo 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

-Computer

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

-Count

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

-Credential

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

-Filter

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

-ForceBackupRetrieving

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

-Id

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: Identity
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IgnoreReadOnly

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

-Name

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

-Partition

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

-Port

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

-Restorable

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

-RetrieveOnlyUnpackedBackups

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

-SearchBase

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

-Server

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

-Timeout

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

-UseSsl

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Get-RMADFEAvailableSubnet


external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:

schema: 2.0.0

SYNOPSIS

For internal use only.

SYNTAX

Get-RMADFEAvailableSubnet [[-NetworkAddress] <String>]
 [[-CurrentSubnets] <System.Collections.Generic.List`1[System.String]>] [[-Cidr] <Int32>] [<CommonParameters>]

DESCRIPTION

For internal use only.

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-Cidr

For internal use only.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CurrentSubnets

For internal use only.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: Subnets

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NetworkAddress

For internal use only.

Type: String
Parameter Sets: (All)
Aliases: Network

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen