Recovery Manager for AD Forest Edition 10.3.1

About Management Shell Installing and opening Management Shell

Installation Requirements Installing Management Shell Opening Management Shell

Getting Help Descriptions of PowerShell Commands

Add-RMADBackup Add-RMADCollectionItem Add-RMADFECloudStorage Add-RMADReplicationConsole Add-RMADStorageServer 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 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-RMADSession Remove-RMADStorageServer 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 Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Get-RMADGlobalOptions

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

schema: 2.0.0

SYNOPSIS

Sets global settings for the application.

SYNTAX

Get-RMADGlobalOptions [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

Sets Recovery Manager for Active Directory global settings.

EXAMPLES

Example 1

PS C:\> Get-RMADGlobalOptions -Name "UnpackingPath"

This cmdlet returns the value of the "UnpackingPath" global option.

Example 2

PS C:\> Get-RMADGlobalOptions "UnpackingPath"

This cmdlet also can return the value of the "UnpackingPath" global option.

Example 3

PS C:\> Get-RMADGlobalOptions

This code returns a HashTable which contains the name and value of all global options.

PARAMETERS

-Name

Specifies the name to the option whose value is retrieved.

Type: String
Parameter Sets: (All)
Aliases:

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

schema: 2.0.0

SYNOPSIS

Gets the domain systems associated with the Hybrid Connector.

SYNTAX

Get-RMADHybridRecoveryDomainOptions [<CommonParameters>]

DESCRIPTION

Returns the domain and associated systems used in the Hybrid Connector.

EXAMPLES

Example 1

PS C:\>Get-RMADHybridRecoveryDomainOptions

Id                : 6
Name              : hal-test.dev.hal.ca.qsft
PrimaryComputerId : 5
Username          : hal-test\master
Computers         : {ID: 5, Name: hal-test-dc.hal-test.dev.hal.ca.qsft, 
                    ID: 7, Name: hal-test-srv.hal-test.dev.hal.ca.qsft}

PARAMETERS

CommonParameters

INPUTS

None

OUTPUTS

NOTES

schema: 2.0.0

SYNOPSIS

Gets the information related to the Hybrid Connector.

SYNTAX

Get-RMADHybridRecoveryOptions [<CommonParameters>]

DESCRIPTION

Returns the information related to the Hybrid Connector. This includes the data contained in the file received or exported from On Demand Recovery (ODR) used to establish the connection. Also included is the host name of the system that is connected to the ODB via the Hybrid Connector and the status of the connector.

EXAMPLES

Example 1

PS C:\>Get-RMADHybridRecoveryOptions

Enabled                        : True
RelayUrl                       : https://backupaad-rmaz-hybrid-
                                 us.servicebus.windows.net/org-
                                 05843ce6-cdde-a9c1-d228-70
                                 983618c6cb
RelayKeyName                   : listenKey
AADConnectHost                 : hal-test-dc
AADConnectUsername             : hal-test\master
UseAgentlessMethod             : True
UsePackedBackups               : True
SkipReplication                : False
AutomaticallyConfigureFirewall : False
Status                         : Completed: True, Failed: False, Relay 
                                 Error: '', AAD Connect Error: ''

PARAMETERS

CommonParameters

INPUTS

None

OUTPUTS

NOTES

schema: 2.0.0

SYNOPSIS

Retrieves information about the installed license key file.

SYNTAX

Get-RMADLicenseInfo [<CommonParameters>]

DESCRIPTION

Allows you to retrieve information about the installed license key file including the following fields:

aboutText
purchased
allocated
expirationDate
managedUsers
isDemo
isForestRecoveryLicensed
isOrwAgentModeDisabled

EXAMPLES

Example 1

PS C:\> Get-RMADLicenseInfo

AboutText                  :
Purchased                  : 6000
Allocated                  : 4980
ExpirationDate             : 12/30/2025 12:00:00 AM
IsDemo                     : False
IsForestRecoveryLicensed   : True
IsDisasterRecoveryLicensed : True
LicenseNumber              : 123-456-789
IsInstalled                : True
ManagedUsers               : -1

This code returns all information about the license.

Example 2

PS C:\> (Get-RMADLicenseInfo).Allocated
4980

This code returns the number of already allocated licenses.

Example 3

PS C:\> (Get-RMADLicenseInfo).Purchased
6000

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Recovery Manager for AD Forest Edition 10.3.1 - Management Shell Guide

Get-RMADGlobalOptions

schema: 2.0.0

SYNOPSIS

SYNTAX

DESCRIPTION

EXAMPLES

Example 1

Example 2

Example 3

PARAMETERS

-Name

CommonParameters

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Get-RMADHybridRecoveryDomainOptions

schema: 2.0.0

SYNOPSIS

SYNTAX

DESCRIPTION

EXAMPLES

Example 1

PARAMETERS

CommonParameters

INPUTS

None

OUTPUTS

NOTES

RELATED LINKS

Get-RMADHybridRecoveryOptions

schema: 2.0.0

SYNOPSIS

SYNTAX

DESCRIPTION

EXAMPLES

Example 1

PARAMETERS

CommonParameters

INPUTS

None

OUTPUTS

NOTES

RELATED LINKS

Get-RMADLicenseInfo

schema: 2.0.0

SYNOPSIS

SYNTAX

DESCRIPTION

EXAMPLES

Example 1

Example 2

Example 3

PARAMETERS

CommonParameters

INPUTS

OUTPUTS

NOTES

RELATED LINKS