Chat now with support
Chat with Support

Recovery Manager for AD 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-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADSecureStorageBackup Export-RMADStorageServers Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject 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 Install-RMADBackupAgent New-RMADCollection New-RMADSchedule Protect-RMADSecureStorageServer Publish-RMADBackupSecurityStatus Refresh-RMADStorageServer Register-RMADSecureStorageBackups Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADStorageServer Remove-RMADUnpackedComponent Rename-RMADCollection Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADObject Set-RMADCollection Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADLicense

Remove-RMADReplicationSession


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

schema: 2.0.0

SYNOPSIS

Deletes replication sessions from the replication history.

SYNTAX

Session

Remove-RMADReplicationSession [-Session] <ReplicationSession[]> [<CommonParameters>]

Id

Remove-RMADReplicationSession [-Id] <Int32[]> [<CommonParameters>]

DESCRIPTION

Deletes one or more replication sessions from the replication history.

EXAMPLES

Example 1

PS C:\> Remove-RMADReplicationSession -Id 1

This command deletes the replication session whose ID is 1.

Example 2

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

This command clears the replication history.

PARAMETERS

-Id

Specifies the IDs of replication sessions for deleting.

Type: Int32[]
Parameter Sets: Id
Aliases:

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

-Session

Specifies the replication sessions for deleting.

Type: ReplicationSession[]
Parameter Sets: Session
Aliases:

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

 

Remove-RMADStorageServer


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

schema: 2.0.0

SYNOPSIS

Removes the secure storage server.

SYNTAX

Name

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

Server

Remove-RMADStorageServer [-IgnoreReadOnly] [-Server] <StorageServer> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes currently registered secure storage servers.

EXAMPLES

Example 1

PS C:\> Remove-RMADStorageServer -Name "backupsrv01.acme.test"

Removes the specified secure storage server.

Example 2

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

Removes all registered secure storage servers.

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: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the registered storage server (DNS name or IP address).

Type: String
Parameter Sets: Name
Aliases:

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

-Server

Specifies the secure storage server object.

Type: StorageServer
Parameter Sets: Server
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 happens when you run the cmdlet. The cmdlet does not actually 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.String

QuestSoftware.RecoveryManager.AD.PowerShell.Cmdlets.StorageServersManagement.StorageServer

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Remove-RMADUnpackedComponent


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

schema: 2.0.0

SYNOPSIS

Allows you to delete components (data) unpacked from specified backups.

SYNTAX

Instance

Remove-RMADUnpackedComponent [-InputObject] <BackupInfo[]> [-IgnoreReadOnly] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Id

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

DESCRIPTION

Allows you to delete all components (data) unpacked from specified backups and saved in the Recovery Manager cache for further use.

EXAMPLES

Example 1

PS C:\> Remove-RMADUnpackedComponent (Get-RMADBackup | where{$_.IsUnpacked -eq "true"})

Deletes all components unpacked from backups created with Recovery Manager for Active Directory.

PARAMETERS

-Id

Specifies the IDs of the backups whose unpacked components you want to delete. If you use this parameter, omit the InputObject parameter of this cmdlet.

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

Specifies the IBackupInfo objects representing the backups whose unpacked components you want to delete. If you use this parameter, omit the Id parameter of this cmdlet.

Type: BackupInfo[]
Parameter Sets: Instance
Aliases:

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

 

Rename-RMADCollection


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

schema: 2.0.0

SYNOPSIS

Renames a computer collection.

SYNTAX

Name (Default)

Rename-RMADCollection [-Name] <String> [-Value] <String> [-PassThru] [-IgnoreReadOnly] [-WhatIf] [-Confirm]
 [<CommonParameters>]

InputObject

Rename-RMADCollection [-InputObject] <ComputerCollection> [-Value] <String> [-PassThru] [-IgnoreReadOnly]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Id

Rename-RMADCollection [-Id] <Int32> [-Value] <String> [-PassThru] [-IgnoreReadOnly] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Renames a computer collection with the name you specify.

EXAMPLES

Example 1

PS C:\> Rename-RMADCollection -Name "New Computer Collection" -Value Collection1

This command renames the computer collection named "New Computer Collection" to "Collection1".

Example 2

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

C:\PS>Rename-RMADCollection -InputObject $c -Value "Collection2"

The Get-RMADCollection cmdlet retrieves the computer collection named Collection1. This collection is then passed to the Rename-RMADCollection cmdlet that renames it to Collection2.

PARAMETERS

-Id

Specifies the identifier of the computer collection you want to rename.

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

Renames the computer collection represented by the specified collection objects. Specify the name of the 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 renamed.

Type: String
Parameter Sets: Name
Aliases:

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

-PassThru

Passes the renamed collection along the pipeline. If this parameter is omitted, the renamed collection is not passed along the pipeline.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Value

Specifies the new name you want to assign to the computer collection.

Type: String
Parameter Sets: (All)
Aliases: NewName

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

-Confirm

Prompts for a 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