Chat now with support
Chat with Support

Recovery Manager for AD Disaster Recovery 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 Add-RMADStorageServerException 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 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-RMADSession Remove-RMADStorageServer Remove-RMADStorageServerException 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 Set-RMADStorageServerAllowedVolumes Set-RMADStorageServerRetentionPolicy Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADBackup Test-RMADSecureStorageBackup Unprotect-RMADStorageServer Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Remove-RMADFECloudStorage


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

schema: 2.0.0

SYNOPSIS

Removes a registered cloud storage from Recovery Manager for Active Directory.

SYNTAX

Id

Remove-RMADFECloudStorage [-Id] <Int32[]> [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Remove-RMADFECloudStorage [-InputObject] <CloudStorage[]> [-IgnoreReadOnly] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Removes a registered cloud storage from Recovery Manager for Active Directory. Only storage registration in Recovery Manager will be removed; backup and any other data on the cloud storage is not affected.

EXAMPLES

Example 1

PS C:\> Get-RMADFECloudStorage
PS C:\> Remove-RMADFECloudStorage -Id 1

Removes cloud storage specified by the Id parameter.

Example 2

PS C:\> Get-RMADFECloudStorage | Remove-RMADFECloudStorage -Confirm:$false

Remove all registered cloud storages without a confirmation.

PARAMETERS

-Id

Specifies the cloud storage Id representing the storage you want to unregister from the Recovery Manager.

Type: Int32[]
Parameter Sets: Id
Aliases: StorageId

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

-IgnoreReadOnly

Allows you to perform the action in a console currently performing full replication (for internal use only).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-InputObject

Specifies the CloudStorage object representing the storage you want to unregister from the Recovery Manager. If you use this parameter, omit the Id parameter of this cmdlet.

Type: CloudStorage[]
Parameter Sets: InputObject
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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.Int32[]

QuestSoftware.RecoveryManager.AD.FE.PowerShell.CloudStorage[]

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Remove-RMADFECloudStorageUploadSession


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

schema: 2.0.0

SYNOPSIS

Removes an existing cloud storage upload session.

SYNTAX

Id

Remove-RMADFECloudStorageUploadSession [-Id] <Int32[]> [-IgnoreReadOnly] [-WhatIf] [-Confirm]
 [<CommonParameters>]

InputObject

Remove-RMADFECloudStorageUploadSession [-InputObject] <UploadSession[]> [-IgnoreReadOnly] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Removes an existing cloud storage upload session. Only session information in Recovery Manager for Active Directory will be removed; backup and any other data on the cloud storage is not affected.

EXAMPLES

Example 1

PS C:\> Get-RMADFECloudStorageUploadSession | Remove-RMADFECloudStorageUploadSession

Removes all registered upload sessions without a confirmation.

Example 2

PS C:\> Remove-RMADFECloudStorageUploadSession -Id 1

Removes a specific registered upload session with the session Id of 1.

PARAMETERS

-Id

Specifies the upload session Id representing the upload session you want to remove from the history in Recovery Manager for Active Directory.

Type: Int32[]
Parameter Sets: Id
Aliases:

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

-IgnoreReadOnly

Allows you to perform the action in a console currently performing full replication (for internal use only).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-InputObject

Specifies the UploadSession object representing the cloud storage upload session you want to unregister from Recovery Manager for Active Directory. If you use this parameter, omit the Id parameter of this cmdlet.

Type: UploadSession[]
Parameter Sets: InputObject
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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.Int32[]

QuestSoftware.RecoveryManager.AD.FE.PowerShell.UploadSession[]

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Remove-RMADFERecoveryAgent


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

schema: 2.0.0

SYNOPSIS

Removes Forest Recovery Agent from a specified domain controller, or its registration information from Forest Recovery Console.

SYNTAX

ProjectSpecificParameters (Default)

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

ProjectlessDomain

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

ProjectlessAll

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

ProjectlessDsrm

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

ProjectlessLocal

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

DESCRIPTION

Allows you to completely remove Forest Recovery Agent from a specified domain controller. You can also select to remove only registration information that relates to a particular Forest Recovery Agent from Forest Recovery Console. This may be useful if you removed Forest Recovery Agent from a domain controller manually, but the related agent entry remains in Forest Recovery Console.

EXAMPLES

EXAMPLE 1

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

Remove-RMADFERecoveryAgent -Name dc1.RMAD.local

Removes Forest Recovery Agent from the specified domain controller in the RMADFE project.

EXAMPLE 2

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

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

Removes Forest Recovery Agent from 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: 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: ProjectlessAll, ProjectlessDsrm
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: ProjectlessAll, ProjectlessLocal
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

 

Remove-RMADFESchedule


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

schema: 2.0.0

SYNOPSIS

Removes an existing verification schedule for the RMADFE project.

SYNTAX

Remove-RMADFESchedule [-Credential] <PSCredential> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet allows you to remove the verification schedule for the RMADFE project.

EXAMPLES

EXAMPLE 1

PS C:\> Remove-RMADFESchedule

Removes the current project schedule.

PARAMETERS

-Credential

Specifies credentials that will be used to run the command.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts for confirmation before executing the command.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Describes what would happen if you ran the command without actually running the command.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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