Chat now with support
Chat with Support

Recovery Manager for AD Forest Edition 10.2.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-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Copy-RMADFEBackup Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFECloudStorageBackup Export-RMADFERecoveryCertificate Export-RMADFEResult Export-RMADSecureStorageBackup 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-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-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer 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-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Remove-RMADBackupAgent


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

schema: 2.0.0

SYNOPSIS

Removes Recovery Manager Backup Agent from a specified computer, or its registration information from the Recovery Manager Console.

SYNTAX

Remove-RMADBackupAgent [-Computer] <String> [[-Credentials] <PSCredential>] [-Uninstall] [-IgnoreReadOnly]
 [<CommonParameters>]

DESCRIPTION

Allows you to completely remove Recovery Manager Backup Agent from a specified computer.
You can also select to remove only registration information that relates to a particular Backup Agent from the Recovery Manager Console.
This may be useful if you removed Backup Agent from a computer manually but the related agent entry remains on the Backup Agent Management node of the Recovery Manager Console.

EXAMPLES

Example 1

PS C:\> Remove-RMADBackupAgent -Computer "dc1"

This code removes registration information that relates to Backup Agent installed on the computer "dc1" from the Recovery Management Console.

Example 2

PS C:\> $credential = Get-Credential
Remove-RMADBackupAgent -Computer "dc1" -Credentials $credential -Uninstall

This code connects to the computer "dc1" under the user represented by the "credential" object and removes Backup Agent from it.
Note that corresponding Backup Agent registration information is removed from the Recovery Management Console as well.

PARAMETERS

-Computer

Specifies the name of the computer from which to remove Recovery Manager Backup Agent.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
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 removing 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 removed 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

-Uninstall

Specifies whether the Recovery Manager Backup Agent should be completely removed.
If this parameter is omitted, only the agent registration information will be removed.

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

 

Remove-RMADCollection


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

schema: 2.0.0

SYNOPSIS

Deletes specified Computer Collections.

SYNTAX

Name (Default)

Remove-RMADCollection [-Name] <String[]> [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Remove-RMADCollection [-InputObject] <ComputerCollection[]> [-IgnoreReadOnly] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Id

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

DESCRIPTION

Deletes the Computer Collections that have the specified name or are represented by the specified objects.

EXAMPLES

Example 1

PS C:\> Remove-RMADCollection -Name "New Computer Collection"

Deletes the computer collection named New Computer Collection.

Example 2

PS C:\> Get-RMADCollection | Where-Object {$_.Schedule.Count -eq 0} | Remove-RMADCollection

The Get-RMADCollection cmdlet gets all computer collections.
The Where-Object cmdlet then filters out the collections for which no backup creation operation is scheduled.
The pipeline operator passes the filtered collection objects to the Remove-RMADCollection cmdlet, which deletes these collection objects.

PARAMETERS

-Id

Specifies the identifier of the Computer Collection to delete.

Type: Int32[]
Parameter Sets: Id
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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

Deletes Computer Collections represented by the specified collection objects.
Enter a variable that contains the objects or type a command or expression that gets the objects.

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 Computer Collection to be deleted.

Type: String[]
Parameter Sets: Name
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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

 

Remove-RMADCollectionItem


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

schema: 2.0.0

SYNOPSIS

Removes items from a specified Computer Collection.

SYNTAX

Remove-RMADCollectionItem [-Collection] <String[]> [-Item] <String[]> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Allows you to selectively remove items from the Computer Collection you specify.

EXAMPLES

Example 1

PS C:\> Remove-RMADCollectionItem -Collection Collection1 -Item Comp1

Removes the item named Comp1 from the Computer Collection named Collection1.

PARAMETERS

-Collection

Specifies the Computer Collection from which to remove items.
To specify a Computer Collection, type the Computer Collection name in this parameter.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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

-Item

Specifies items to remove from the Computer Collection.
To specify an item, type the item name in this parameter.

Type: String[]
Parameter Sets: (All)
Aliases:

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating