Tchater maintenant avec le support
Tchattez avec un ingénieur du support

Recovery Manager for AD 10.3.1 - Management Shell Guide

Overview
About Management Shell Installing and opening Management Shell Getting Help Descriptions of PowerShell Commands
Add-RMADBackup Add-RMADCollectionItem Add-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADSecureStorageBackup Export-RMADStorageServers Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject 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 Import-RMADBackup Install-RMADBackupAgent New-RMADCollection New-RMADSchedule Protect-RMADSecureStorageServer Publish-RMADBackupSecurityStatus Refresh-RMADStorageServer Register-RMADSecureStorageBackups Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADSession Remove-RMADStorageServer Remove-RMADUnpackedComponent Rename-RMADCollection Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADObject Set-RMADCollection Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADLicense

Get-RMADLicenseInfo

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 the installed license key file.

SYNTAX

Get-RMADLicenseInfo [<CommonParameters>]

DESCRIPTION

Allows you to retrieve information about the installed license key file including the following fields:

  • aboutText
  • purchased
  • allocated
  • expirationDate
  • managedUsers
  • isDemo
  • isForestRecoveryLicensed
  • isOrwAgentModeDisabled

EXAMPLES

Example 1

PS C:\> Get-RMADLicenseInfo

AboutText                  :
Purchased                  : 6000
Allocated                  : 4980
ExpirationDate             : 12/30/2025 12:00:00 AM
IsDemo                     : False
IsForestRecoveryLicensed   : True
IsDisasterRecoveryLicensed : True
LicenseNumber              : 123-456-789
IsInstalled                : True
ManagedUsers               : -1

This code returns all information about the license.

Example 2

PS C:\> (Get-RMADLicenseInfo).Allocated
4980

This code returns the number of already allocated licenses.

Example 3

PS C:\> (Get-RMADLicenseInfo).Purchased
6000

This code returns the number of purchased licenses.

PARAMETERS

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

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

schema: 2.0.0

SYNOPSIS

Retrieves specific objects from Active Directory or certain backups registered with Recovery Manager for Active Directory.

SYNTAX

Name (Default)

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

Identity

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

Filter

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

DESCRIPTION

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:

  • distinguishedName
  • name
  • objectClass
  • objectguid
  • isDeleted
  • isRecycled

If the object is deleted, in addition to the above-listed attributes, the cmdlet also retrieves the following attributes:

  • whenchanged
  • whencreated
  • lastKnownParent
  • msDS
  • LastKnownRDN

You can also specify additional attributes to retrieve.

EXAMPLES

Example 1

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.

Example 2

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.

Example 3

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.

Example 4

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.

Example 5

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.

Example 6

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.

Example 7

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.

Example 8

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.

PARAMETERS

-Attribute

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
  • isDeleted
  • isRecycled

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

-Backup

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

-BackupPassword

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

-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

-DisableADSearch

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

-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

-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

-KeepBackupUnpacked

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

-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

-SearchBase

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

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

-State

Retrieves objects whose state is equal to any of the values specified in this parameter. This parameter can take one of the following values:

  • All
  • Deleted
  • Live
  • Recycled

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

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

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

schema: 2.0.0

SYNOPSIS

Gets all the RMAD consoles in the replication console list.

SYNTAX

Get-RMADReplicationConsole [<CommonParameters>]

DESCRIPTION

Gets all the RMAD consoles in the replication console list.

EXAMPLES

Example 1

PS C:\> C:\>Get-RMADReplicationConsole

This command gets all the RMAD consoles in the replication console list.

PARAMETERS

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

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

schema: 2.0.0

SYNOPSIS

Allows you to get the replication schedule from a specified computer.

SYNTAX

Get-RMADReplicationSchedule [<CommonParameters>]

DESCRIPTION

Allows you to get the replication schedule from a specified computer.

EXAMPLES

Example 1

PS C:\> Get-RMADReplicationSchedule

This example illustrates how to get the replication schedule from a specified computer.

PARAMETERS

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

 

Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation