Chat now with support
Chat with Support

Recovery Manager for AD 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-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-RMADSession 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

New-RMADCollection


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

schema: 2.0.0

SYNOPSIS

Creates a new computer collection.

SYNTAX

New-RMADCollection [[-Name] <String>] [-Temporary] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Creates a new computer collection with a default name or with the name you specify. The new computer collection is created using the default computer collection parameters set in the Recovery Manager console.

EXAMPLES

Example 1

PS C:\> New-RMADCollection -Name Collection1

This command creates a new computer collection named Collection1.

Example 2

PS C:\> New-RMADCollection Collection1 -Temporary

This command creates a new temporary computer collection from the existing collection named Collection1.

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

-Name

Allows you to specify a name for the computer collection to be created.

Type: String
Parameter Sets: (All)
Aliases:

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

-Temporary

Creates a new temporary computer collection.

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

 

New-RMADSchedule


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

schema: 2.0.0

SYNOPSIS

Creates a schedule for the backup creation operation you want to perform on a particular computer collection.

SYNTAX

Once

New-RMADSchedule [-Once] -StartDate <DateTime> [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>]
 [<CommonParameters>]

Daily

New-RMADSchedule [-Daily] -DaysInterval <Int32> -StartDate <DateTime> [-EndDate <DateTime>]
 [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>] [<CommonParameters>]

Weekly

New-RMADSchedule [-Weekly] -WeeksInterval <Int32> -DaysOfWeek <DaysOfTheWeek> -StartDate <DateTime>
 [-EndDate <DateTime>] [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>] [<CommonParameters>]

MonthlyDate

New-RMADSchedule [-MonthlyDate] -Day <Int32> [-Months <Months>] -StartDate <DateTime> [-EndDate <DateTime>]
 [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>] [<CommonParameters>]

MonthlyDOW

New-RMADSchedule [-MonthlyDOW] [-DaysOfWeek <DaysOfTheWeek>] [-Months <Months>] -Week <WhichWeek>
 -StartDate <DateTime> [-EndDate <DateTime>] [-MinutesDuration <UInt32>] [-MinutesInterval <UInt32>]
 [<CommonParameters>]

DESCRIPTION

Creates a schedule to perform the backup creation operation a particular computer collection. You can use the parameters of this cmdlet to set a recurring or non-recurring schedule for the backup creation operation.

EXAMPLES

Example 1

PS C:\> New-RMADSchedule -Once -StartDate "2/20/2022 1:00"

Runs the backup creation operation at 1:00 a.m. on the 20th February 2022.

Example 2

PS C:\> New-RMADSchedule -Daily -StartDate "2/20/2022 1:00" -DaysInterval 3

Runs the backup creation operation every 3 days, starting from 1:00 a.m. on the 20th February 2022.

Example 3

PS C:\> New-RMADSchedule -Weekly -StartDate "2/20/2022 1:00" -WeeksInterval 2 -DaysOfWeek Monday,Friday

Runs the backup creation operation on Monday and Friday of every second week, starting from 1:00 a.m. on the 20th February 2022.

Example 4

PS C:\> New-RMADSchedule -MonthlyDate -StartDate "2/20/2022 1:00" -Day 1

Runs the backup creation operation on every first day of each month (the Months parameter is omitted, therefore the backup creation operation is invoked each month), starting from 1:00 a.m. on the 20th February 2022.

Example 5

PS C:\> New-RMADSchedule -MonthlyDOW -StartDate "2/20/2022 1:00" -DaysOfWeek 1,5 -Week 1

Runs the backup creation operation on every first Monday and Friday of each month, starting from 1:00 a.m. on the 20th February 2022.

PARAMETERS

-Daily

Runs the backup creation operation on a daily basis.

Type: SwitchParameter
Parameter Sets: Daily
Aliases:

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

-Day

Sets the day of the month when you want to run the backup creation operation.

Type: Int32
Parameter Sets: MonthlyDate
Aliases:

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

-DaysInterval

Sets an interval (in number of days) between invocations of the backup creation operation.

Type: Int32
Parameter Sets: Daily
Aliases:

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

-DaysOfWeek

Runs the backup creation operation on particular days of week. To set the weeks when you want to run the backup creation operation, use the Weekly or MonthlyDOW parameter.

Type: DaysOfTheWeek
Parameter Sets: Weekly
Aliases:
Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: DaysOfTheWeek
Parameter Sets: MonthlyDOW
Aliases:
Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday

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

-EndDate

Specifies the date when the backup creation operation schedule expires.

Type: DateTime
Parameter Sets: Daily, Weekly, MonthlyDate, MonthlyDOW
Aliases:

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

-MinutesDuration

Specifies the time period (in minutes) during which you want to repeatedly run (invoke) the backup creation operation. To set the time interval between invocations of the backup creation operation, use the MinutesInterval parameter.

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-MinutesInterval

Specifies the time interval (in minutes) between invocations of the backup creation operation. To set the time period during which you want to repeatedly run (invoke) the backup creation operation, use the MinutesDuration parameter.

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-MonthlyDate

Runs the backup creation operation on particular day of month. To set the months and day of month when you want to run the backup creation operation, use the Months and Day parameters respectively.

Type: SwitchParameter
Parameter Sets: MonthlyDate
Aliases:

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

-MonthlyDOW

Runs the backup creation operation on particular days of week in particular months. To set the months, weeks, and days of week, use the Months, Week, and DaysOfWeek parameters respectively.

Type: SwitchParameter
Parameter Sets: MonthlyDOW
Aliases:

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

-Months

Sets the months when you want to run the backup creation operation.

Type: Months
Parameter Sets: MonthlyDate, MonthlyDOW
Aliases:
Accepted values: January, February, March, April, May, June, July, August, September, October, November, December

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

-Once

Runs the backup creation operation only once.

Type: SwitchParameter
Parameter Sets: Once
Aliases:

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

-StartDate

Specifies the date when the backup creation operation schedule comes into effect.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-Week

Sets the week of the month when you want to run the backup creation operation. This parameter accepts the following values:

  • 1. Specifies the first week of the month.
  • 2. Specifies the second week of the month.
  • 3. Specifies the third week of the month.
  • 4. Specifies the fourth week of the month.
  • 5. Specifies the fifth week of the month.

Type: WhichWeek
Parameter Sets: MonthlyDOW
Aliases:
Accepted values: None, FirstWeek, SecondWeek, ThirdWeek, FourthWeek, LastWeek

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

-Weekly

Runs the backup creation operation on a weekly basis.

Type: SwitchParameter
Parameter Sets: Weekly
Aliases:

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

-WeeksInterval

Sets an interval (in number of weeks) between invocations of the backup creation operation.

Type: Int32
Parameter Sets: Weekly
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

 

Protect-RMADSecureStorageServer


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

schema: 2.0.0

SYNOPSIS

Enables storage server hardening.

SYNTAX

Name

Protect-RMADSecureStorageServer [-IgnoreReadOnly] [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

Server

Protect-RMADSecureStorageServer [-IgnoreReadOnly] [-Server] <StorageServer> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Enables storage server hardening.

EXAMPLES

Example 1

PS C:\> Get-RMADStorageServer | Protect-RMADSecureStorageServer

Enables hardening on all registered secure storage servers.

Example 2

PS C:\> Protect-RMADSecureStorageServer -Name "storage.srv"

Enables hardening on the specified storage server.

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 secure storage server.

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. Use Get-RMADStorageServer to get a list of all secure storage servers.

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 would happen if the cmdlet runs.

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

OUTPUTS

NOTES

RELATED LINKS

 

Publish-RMADBackupSecurityStatus


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

schema: 2.0.0

SYNOPSIS

Publishes security check information for a specified backup.

SYNTAX

Publish-RMADBackupSecurityStatus -BackupGuid <Guid[]> -SecurityStatus <BackupSecurityStatus>
 [<CommonParameters>]

DESCRIPTION

Saves security check information for a specified backup registered with Recovery Manager for Active Directory.

EXAMPLES

Example 1

PS C:\> $bkf = (Get-RMADBackup -ComputerName DC.DomainName.local)[-1]
$status = New-Object -TypeName QuestSoftware.RecoveryManager.AD.PowerShell.BackupSecurityStatus
$status.Summary = "Passed"
$status.Details = "some passed"
$status.CheckDate = Get-Date 
Publish-RMADBackupSecurityStatus -BackupGuid $bkf.backupGuid -SecurityStatus $status
Get-RMADBackupSecurityStatus -BackupGuid $bkf.BackupGuid

For troubleshooting only. This command saves antimalware scan results for a specified backup registered with Recovery Manager for Active Directory.

PARAMETERS

-BackupGuid

This is the GUID of the backup for which a user wants to get the antimalware scan results.

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

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

-SecurityStatus

Result information about the security check of a particular backup.

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

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating