Chat now with support
Chat with Support

Recovery Manager for AD Forest Edition 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-RMADFECloudStorage Add-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Backup-RMADFEConsoleConfiguration Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject 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-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-RMADSession Remove-RMADStorageServer Remove-RMADUnpackedComponent Rename-RMADCollection Restart-RMADFECloudStorageUploadSession Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADFEConsoleConfiguration Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Send-RMADFEBackupToSecureStorage Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEConsoleConfigurationBackupSchedule 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

Get-RMADFEPersistenceConnection

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

schema: 2.0.0

SYNOPSIS

Gets persistence connection settings.

SYNTAX

Get-RMADFEPersistenceConnection [<CommonParameters>]

DESCRIPTION

Retrieves persistence connection settings that are used to store the state of Forest Recovery process.

EXAMPLES

Example 1

PS C:\> $creds = new-object PSCredential("sa",  (ConvertTo-SecureString 'Password' -asPlainText -Force))
Set-RMADFEPersistenceConnection -DataSource "ws\SQLExpress" -Credentials $creds 
Set-RMADFEPersistenceConnection -Enable
Get-RMADFEPersistenceConnection

This command retrieves persistence connection settings that are used to store the state of the Forest Recovery process.

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

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

schema: 2.0.0

SYNOPSIS

Gets the current status of the RMADFE project.

SYNTAX

Get-RMADFEProject [-ProjectInfo] [<CommonParameters>]

DESCRIPTION

This cmdlet gets the current status of the RMADFE project.

EXAMPLES

EXAMPLE 1

PS C:\> Get-RMADFEProject | Format-List *

This command gets the current status of the RMADFE project.

PARAMETERS

-ProjectInfo

Specifies to return special project information container

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

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

schema: 2.0.0

SYNOPSIS

Returns information about Forest Recovery Agents that are installed and registered in Forest Recovery Console.

SYNTAX

ProjectSpecificParameters (Default)

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

ProjectlessDomain

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

ProjectlessDsrm

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

ProjectlessLocal

Get-RMADFERecoveryAgent [-ComputerName] <String> [-LocalCredential <PSCredential>] [<CommonParameters>]

ProjectlessAll

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

DESCRIPTION

Allows you to retrieve a list of Forest Recovery Agent instances that are installed and registered in Forest Recovery Console. You can get the agent information for an existing RMADFE project using the user credentials specified in the project or by providing credentials as parameters.

EXAMPLES

EXAMPLE 1

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

Get-RMADFERecoveryAgent

Returns information about all Forest Recovery Agents installed and registered in the RMADFE project.

EXAMPLE 2

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

Get-RMADFERecoveryAgent -name dc1.RMAD.local

Returns information about the Forest Recovery Agent installed on the specified domain controller in the RMADFE project.

EXAMPLE 3

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

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

Returns information about the Forest Recovery Agent installed 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: ProjectSpecificParameters
Aliases:

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

Type: String
Parameter Sets: ProjectlessDomain, ProjectlessDsrm, ProjectlessLocal, ProjectlessAll
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: ProjectlessDomain, ProjectlessAll
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: ProjectlessDsrm, ProjectlessAll
Aliases:

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

-LocalCredential

Specifies the user name and password with which you want Recovery Manager for Active Directory Forest Edition to access standalone machines.

Type: PSCredential
Parameter Sets: ProjectlessLocal, ProjectlessAll
Aliases:

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

 

Get-RMADFESchedule

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

schema: 2.0.0

SYNOPSIS

Gets a schedule for the RMADFE project verification.

SYNTAX

Get-RMADFESchedule [<CommonParameters>]

DESCRIPTION

This cmdlet returns a schedule for verification of the current RMADFE project.

EXAMPLES

EXAMPLE 1

PS C:\> Get-RMADFESchedule

Returns the current project schedule or nothing if the schedule is not configured.

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating