Chat now with support
Chat with Support

Recovery Manager for AD Forest Edition 10.3 - 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 Backup-RMADCollection Backup-RMADFEConsoleConfiguration Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Copy-RMADFEBackup Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFECloudStorageBackup Export-RMADFECloudStorageServers Export-RMADFERecoveryCertificate Export-RMADFEResult Export-RMADSecureStorageBackup Export-RMADStorageServers 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-RMADFEConsoleConfigurationBackupSchedule Get-RMADFEConsoleConfigurationProjectFiles 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 Import-RMADBackup Import-RMADFERecoveryCertificate Install-RMADBackupAgent Install-RMADFERecoveryAgent New-RMADCollection New-RMADFEProject New-RMADFERecoveryMedia New-RMADSchedule Open-RMADFEProject Protect-RMADSecureStorageServer 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-RMADUnpackedComponent Rename-RMADCollection Restart-RMADFECloudStorageUploadSession Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADFEConsoleConfiguration Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEConsoleConfigurationBackupSchedule Set-RMADFEConsoleConfigurationProjectFiles Set-RMADFEDnsCache Set-RMADFEDomain Set-RMADFEGlobalOptions Set-RMADFEPersistenceConnection Set-RMADFERecoveryMode Set-RMADFESchedule Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Import-RMADFERecoveryCertificate


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

schema: 2.0.0

SYNOPSIS

Imports Forest Recovery certificates.

SYNTAX

Import-RMADFERecoveryCertificate [-Path] <String> [-Password] <SecureString> [<CommonParameters>]

DESCRIPTION

This cmdlet imports Forest Recovery certificates from the specified location.
You must also supply the password that is used to protect the certificates.

EXAMPLES

EXAMPLE 1

PS C:\> Import-RMADFERecoveryCertificate -Path C:\Certificates\RMADFeCertificates.pfx" -Password (ConvertTo-SecureString "protection password" -AsPlainText -Force)

This command imports Forest Recovery certificates from the specified location.

PARAMETERS

-Password

Specifies the password that is used to access the Forest Recovery certificates.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-Path

Specifies the full path to the Forest Recovery certificate file.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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

OUTPUTS

NOTES

RELATED LINKS

 

Install-RMADBackupAgent


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

schema: 2.0.0

SYNOPSIS

Installs Recovery Manager Backup Agent on a specified computer or on each computer in a particular Computer Collection.

SYNTAX

DC

Install-RMADBackupAgent [-Computer] <String> [[-Credentials] <PSCredential>] [[-ConfigureFirewall] <Boolean>]
 [-IgnoreReadOnly] [<CommonParameters>]

Collection

Install-RMADBackupAgent [[-Credentials] <PSCredential>] [[-ConfigureFirewall] <Boolean>]
 [-CollectionName] <String> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Allows you to install the Recovery Manager Backup Agent on a specified computer which can be a domain controller or AD LDS (ADAM) host, or on each computer in a particular Computer Collection.

EXAMPLES

Example 1

PS C:\> $credential = Get-Credential
Install-RMADBackupAgent -Computer dc1 -Credentials $credential

This code connects to the computer "dc1" under the user represented by the "credential" object and installs Recovery Manager Backup Agent there.

Example 2

PS C:\> Install-RMADBackupAgent -CollectionName "New Computer Collection"

This code installs the Recovery Manager Backup Agent on each computer in the collection named "New Computer Collection".

PARAMETERS

-CollectionName

Specifies the name of the Computer Collection that includes the computers on which Backup Agent should be installed.

Type: String
Parameter Sets: Collection
Aliases:

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

-Computer

Specifies the name of the computer which can be domain controller or AD LDS (ADAM) host, where to install a Recovery Manager Backup Agent.

Type: String
Parameter Sets: DC
Aliases:

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

-ConfigureFirewall

Specifies whether Recovery Manager automatically configures Windows Firewall on target Windows Server 2008-based or Windows Server 2012-based DCs to allow backup operations.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Credentials

Specifies the user name and the password of the user account to use for connecting to the target computer and installing Backup Agent. Use the Get-Credential cmdlet provided by Windows PowerShell to get the PSCredential object representing user credentials.
Notes:

  • The user should be a local Administrator on the target computer.
  • If you omit this parameter, Backup Agent will be installed under the current user account.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
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

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

 

Install-RMADFERecoveryAgent


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

schema: 2.0.0

SYNOPSIS

Installs Forest Recovery Agent on a specified domain controller or on each domain controller in the forest.

SYNTAX

ProjectSpecificParameters (Default)

Install-RMADFERecoveryAgent [-ComputerName] <String> [<CommonParameters>]

ProjectLessNormalMode

Install-RMADFERecoveryAgent [-ComputerName] <String> -DcCredential <PSCredential> [<CommonParameters>]

ProjectLessBothMode

Install-RMADFERecoveryAgent [-ComputerName] <String> -DcCredential <PSCredential>
 -DsrmCredential <PSCredential> [<CommonParameters>]

ProjectLessDsrm

Install-RMADFERecoveryAgent [-ComputerName] <String> -DsrmCredential <PSCredential> [<CommonParameters>]

DESCRIPTION

Allows you to install Forest Recovery Agent on a specified domain controller or on each domain controller in the forest.

EXAMPLES

EXAMPLE 1

PS C:\> Open-RMADFEProject -Path C:\rmadfe.frproj -Password (ConvertTo-SecureString "password" -AsPlainText -Force)

Install-RMADFERecoveryAgent -Name dc1.RMAD.local

Installs Forest Recovery Agent on the specified domain controller in the RMADFE project.

EXAMPLE 2

PS C:\> $credentials = New-Object PSCredential(".\Administrator", (ConvertTo-SecureString 'Password' -AsPlainText -Force))

Install-RMADFERecoveryAgent -name dc1.RMAD.local -DcCredential $credentials -DsrmCredential $credentials

Installs Forest Recovery Agent on the specified domain controller (either in Normal or DSRM mode).
In this example, you should use only domain credentials or DSRM credentials, or both.

PARAMETERS

-ComputerName

Specifies the fully qualified domain name of the computer.

Type: String
Parameter Sets: (All)
Aliases:

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

-DcCredential

Specifies the user name and password with which you want Recovery Manager for Active Directory Forest Edition to access the selected domain controllers in the Normal mode.

Type: PSCredential
Parameter Sets: ProjectLessNormalMode, ProjectLessBothMode
Aliases:

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

-DsrmCredential

Specifies the user name and password with which you want Recovery Manager for Active Directory Forest Edition to access domain controllers in the selected domain in Directory Services Restore Mode (DSRM).

Type: PSCredential
Parameter Sets: ProjectLessBothMode, ProjectLessDsrm
Aliases:

Required: True
Position: Named
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

OUTPUTS

NOTES

RELATED LINKS

 

New-RMADCollection


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

schema: 2.0.0

SYNOPSIS

Creates a new computer collection.

SYNTAX

New-RMADCollection [[-Name] <String>] [-Temporary] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Creates a new computer collection with a default name or with the name you specify. The new computer collection is created using the default computer collection parameters set in the Recovery Manager console.

EXAMPLES

Example 1

PS C:\> New-RMADCollection -Name Collection1

This command creates a new computer collection named Collection1.

Example 2

PS C:\> New-RMADCollection Collection1 -Temporary

This command creates a new temporary computer collection from the existing collection named Collection1.

PARAMETERS

-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

Allows you to specify a name for the computer collection to be created.

Type: String
Parameter Sets: (All)
Aliases:

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

-Temporary

Creates a new temporary computer collection.

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating