立即与支持人员聊天
与支持团队交流

Recovery Manager for AD Forest Edition 10.3.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-RMADFEComputer 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-RMADConsoleConfigurationBackup 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-RMADFEComputer 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-RMADFEConsoleConfigurationBackupToSecureStorage 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

Add-RMADReplicationConsole


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

schema: 2.0.0

SYNOPSIS

Adds a RMAD console as a replication source.

SYNTAX

Add-RMADReplicationConsole [-ComputerName] <String> [-Mode] <ReplicationMode>
 [-AccessCredential <PSCredential>] [-FallbackCredential <PSCredential>] [-FileSyncEnabled <Boolean>]
 [-SourceFiles <String>] [-TargetFolder <String>] [<CommonParameters>]

DESCRIPTION

RMAD console can synchronize the backups, collections, global options, schedules, Secure Storage servers and backups stored on Secure Storage servers from the consoles in the replication console list manually or on schedule.

EXAMPLES

Example 1

PS C:\> C:\>$credential = Get-Credential
C:\>Add-RMADReplicationConsole Hostname1 -AccessCredential $credential 
-Mode Backups

This command adds the RMAD console on Hostname1 to the replication console list with the Backups mode enabled.

Example 2

PS C:\> C:\>Add-RMADReplicationConsole -ComputerName Hostname1 -Mode Full

This command adds the RMAD console on Hostname1 to the replication console list with the Full mode enabled.

Example 3

PS C:\> C:\>$fallbackAccount = Get-Credential
C:\>Add-RMADReplicationConsole -ComputerName Hostname1 -Mode Full 
-FallbackCredential $fallbackAccount

This command adds the RMAD console on Hostname1 to the replication console list with the Full mode enabled and with the specified fallback account.

Example 4

PS C:\> C:\>Add-RMADReplicationConsole -ComputerName Hostname1 -Mode Full -FileSyncEnabled $true -SourceFiles "C:\MyProjectFiles\*.frproj" -TargetFolder "C:\MyProjectFiles"

This command adds the RMAD console on Hostname1 to the replication console list with the Full mode enabled and with replication of the forest recovery project files.

PARAMETERS

-AccessCredential

Specifies the user credentials to read data from the target computer. The user must be a local Administrator on the target computer. To obtain the user credentials, create a PSCredential object using the Get-Credential cmdlet provided by Windows PowerShell.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-ComputerName

Specifies the hostname of the computer on which the RMAD console you want to add is installed.

Type: String
Parameter Sets: (All)
Aliases:

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

-FallbackCredential

Supplies a fallback account for replacing the account that is used by the backup schedule task. The account must have administrator privileges on the system(s) to be backed up. You can use this parameter only when Full mode is specified for the console.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-FileSyncEnabled

Enables replication of forest recovery project files.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Mode

Specifies the console mode: Full (to replicate backups, collections, global options and schedule) or Backups (to replicate backups only).

Type: ReplicationMode
Parameter Sets: (All)
Aliases:
Accepted values: Full, Backups

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

-SourceFiles

Specifies which forest recovery project files to replicate from the source console.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetFolder

Specifies the folder to store the forest recovery project files replicated from the source console.

Type: String
Parameter Sets: (All)
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

 

Add-RMADStorageServer


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

schema: 2.0.0

SYNOPSIS

Adds a secure storage server, optionally remotely installs a storage server agent.

SYNTAX

Add-RMADStorageServer [-Name] <String> [-Port <Int32>] [-Credential <PSCredential>] [-RegisterBackups]
 [-InstallAgent] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Registers a secure storage server in Recovery Manager for Active Directory.

EXAMPLES

Example 1

PS C:\> Add-RMADStorageServer -Name "backupsrv01.acme.test" -Port 48001

Registers the secure storage server with given name and connection port.

PARAMETERS

-Credential

Server credentials used for remote agent installation. Ignored if the '-InstallAgent' switch is not set.

Type: PSCredential
Parameter Sets: (All)
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: None
Accept pipeline input: False
Accept wildcard characters: False

-InstallAgent

If set, automatically installs storage server agent.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

DNS name or IP address of the server.

Type: String
Parameter Sets: (All)
Aliases:

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

-Port

Port used to connect to the secure storage agent.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-RegisterBackups

If set, backups on an existing storage server will be registered.

Type: SwitchParameter
Parameter Sets: (All)
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

System.String

OUTPUTS

IStorageServer

NOTES

RELATED LINKS

 

Backup-RMADCollection


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

schema: 2.0.0

SYNOPSIS

Backs up an existing computer collection.

SYNTAX

InputObject

Backup-RMADCollection [-InputObject] <ComputerCollection> [-AsJob] [-IgnoreReadOnly] [<CommonParameters>]

Name

Backup-RMADCollection [-Name] <String> [-AsJob] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Backs up the existing computer collection that has the specified name or is represented by the specified objects.

EXAMPLES

Example 1

PS C:\> Backup-RMADCollection -Name "Collection1"

Backs up the Computer Collection named Collection1.

Example 2

PS C:\> Get-RMADCollection -Id 1 | Backup-RMADCollection

Gets the Computer Collection whose identifier is 1, and then backs up that Computer Collection.

Example 3

PS C:\> $c = Get-RMADCollection -Name col

C:\PS>Backup-RMADCollection -InputObject $c -AsJob

In the first line of this command, the Get-RMADCollection cmdlet gets the computer collection named col. The computer collection object is then stored in the $c variable.

PARAMETERS

-AsJob

Runs the command as a background job. You can use this parameter to run commands that take a significant time to complete.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

-InputObject

Backs up the existing Computer Collection represented by the specified collection object. Enter a variable that contains the object or type a command or expression that gets the object.

Type: ComputerCollection
Parameter Sets: InputObject
Aliases:

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

-Name

Specifies the name of the existing Computer Collection to be backed up.

Type: String
Parameter Sets: Name
Aliases:

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

 

Backup-RMADFEConsoleConfiguration


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

schema: 2.0.0

SYNOPSIS

Runs console configuration backup.

SYNTAX

Backup-RMADFEConsoleConfiguration -Password <SecureString> -ProjectFilesFolder <String> [-Path <String>]
 [-PathAccessCredential <PSCredential>] [-SecureStorageServer <String>] [-CloudStorage <String>]
 [<CommonParameters>]

DESCRIPTION

Backs up registered backups information, secure storage servers, cloud storages and its upload sessions, console authentication keys and Forest Recovery projects.

EXAMPLES

Example 1

PS C:\> Backup-RMADFEConsoleConfiguration -Path $path -Password $password -Projects $projectFiles

Backs up console configuration including provided Forest Recovery project files to file specified in $path and encrypts with password

PARAMETERS

-CloudStorage

Cloud storage name to save backup.

Type: String
Parameter Sets: (All)
Aliases:

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

-Password

Console configuration backup password. The password supports special characters including spaces, but double quotes (") are not supported.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-Path

Path to console configuration backup.

Type: String
Parameter Sets: (All)
Aliases:

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

-PathAccessCredential

Credential to access path location.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-ProjectFilesFolder

Path to the directory containing Forest Recovery projects to be backed up.

Type: String
Parameter Sets: (All)
Aliases:

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

-SecureStorageServer

Name of secure storage server to save backup on.

Type: String
Parameter Sets: (All)
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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级