Chat now with support
Chat with Support

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

Get-RMADFECloudStorage

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

schema: 2.0.0

SYNOPSIS

Returns cloud storage registered in Recovery Manager for Active Directory.

SYNTAX

Get-RMADFECloudStorage [-Id <Int32>] [<CommonParameters>]

DESCRIPTION

Returns cloud storage registered in Recovery Manager for Active Directory specified by the Id parameter. Display name, container and type of cloud storage is returned.
If no Id parameter provided all registered cloud storages will be returned.

EXAMPLES

Example 1

PS C:\> Get-RMADFECloudStorage

Id DisplayName Container Type
-- ----------- --------- ----
1 MyCloudStorage adbackups CloudStorageAzure
2 CompanyStorage bmrbackups CloudStorageAzure

Returns all registered cloud storages in Recovery Manager for Active Directory.

Example 2

PS C:\> Get-RMADFECloudStorage -Id 1

Id DisplayName Container Type
-- ----------- --------- ----
1 MyCloudStorage adbackups CloudStorageAzure

Retrieve a cloud storage specified by the Id parameter. If no Id parameter provided all registered cloud storages will be returned.

PARAMETERS

-Id

Cloud storage Id that is registered in Recovery Manager for Active Directory.

Type: Int32
Parameter Sets: (All)
Aliases: StorageId

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

 

Get-RMADFECloudStorageCollection

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

schema: 2.0.0

SYNOPSIS

Returns computer collections for the cloud storage registered in Recovery Manager for Active Directory.

SYNTAX

Id

Get-RMADFECloudStorageCollection [-Id] <Int32[]> [-IgnoreReadOnly] [<CommonParameters>]

InputObject

Get-RMADFECloudStorageCollection [-InputObject] <CloudStorage[]> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Returns computer collections for the cloud storage specified in the parameter Id. Each computer collection is returned with collection name, last status result, last run date, next run date and schedule.

EXAMPLES

Example 1

PS C:\> Get-RMADFECloudStorage

Id DisplayName    Container              Type
-- -----------    ---------              ----
 1 CloudStorageAF adbackups CloudStorageAzure

PS C:\>Get-RMADFECloudStorageCollection -Id 1

Name                 LastResult  LastRunDate            NextRunDate            Schedule
----                 ----------  -----------            -----------            --------
MyCollection         Success     10/28/2022    16:45    10/28/2022    13:55    {At 4:55 PM every day}

Returns all computer collections for the cloud storage with Id 1.

PARAMETERS

-Id

Cloud storage Id that is registered in Recovery Manager for Active Directory.

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.

Type: CloudStorage[]
Parameter Sets: InputObject
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

System.Int32[]

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

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Get-RMADFECloudStorageUploadSession

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

schema: 2.0.0

SYNOPSIS

Retrieves the cloud storage upload session details.

SYNTAX

Get-RMADFECloudStorageUploadSession [-Id <Int32>] [-StorageId <Int32>] [-Limit <Int32>] [<CommonParameters>]

DESCRIPTION

Returns the upload sessions details for the specified cloud storage. Each upload session is returned with a status, creation timestamp and error message if available.
Using the Limit parameter specify the number of upload sessions to be returned.

EXAMPLES

Example 1

PS C:\> Get-RMADFECloudStorageUploadSession -StorageId 1 -Limit 1

Id : 1
StorageId : 1
BackupId : 248
SourceBackupPath : \mycomputer.company.ca\Backups\mycomputer-2022-10-28 16-13-51.bkf
TargetBackupPath : mycomputer.company.ca\Backups\mycomputer-2022-10-28 16-13-51.bkf
ErrorMessage :
CreationTimestamp : 10/28/2022 4:14:10 PM
ModificationTimestamp : 10/28/2022 4:14:17 PM
Status : UploadStatusCompleted

Retrieve the latest upload session for the cloud storage with Id 1.

PARAMETERS

-Id

Specifies the upload session Id.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Limit

Maximum number of session to return. When not specified all upload sessions will be returned. 

Type: Int32
Parameter Sets: (All)
Aliases:

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

-StorageId

Specifies the cloud storage Id.

Type: Int32
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

 

Get-RMADFEComputer

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

schema: 2.0.0

SYNOPSIS

Retrieves a list of computer settings from the current RMADFE project.

SYNTAX

Get-RMADFEComputer [[-ComputerName] <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet retrieves the computer settings for one or more computers from the current RMADFE project.
By default, this cmdlet retrieves the following information for each computer: - Computer Name

  • User Name
  • DSRM User Name
  • Network Share User Name
  • Use of Default Domain Settings

EXAMPLES

EXAMPLE 1

PS C:\> Get-RMADFEComputer -Name dc1.acme.com

This command retrieves information about the specified computer from the current RMADFE project.

EXAMPLE 2

PS C:\> Get-RMADFEComputer

This command retrieves information about all computers from the current RMADFE project.

PARAMETERS

-ComputerName

Specifies the fully qualified domain name of the computer.

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

Required: False
Position: 0
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