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

Set-RMADFECloudStorage


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

schema: 2.0.0

SYNOPSIS

Updates cloud storage in the Recovery Manager.

SYNTAX

IdAzureProviderSet

Set-RMADFECloudStorage [-Id] <Int32[]> [-DisplayName <String>] [-Container <String>]
 -AzureConnectionString <String> [-PassThru] [-IgnoreReadOnly] [<CommonParameters>]

IdAwsProviderSet

Set-RMADFECloudStorage [-Id] <Int32[]> [-DisplayName <String>] [-Container <String>] -AwsAccessKey <String>
 -AwsSecretKey <String> [-PassThru] [-IgnoreReadOnly] [<CommonParameters>]

InputObjectAzureProviderSet

Set-RMADFECloudStorage [-InputObject] <CloudStorage[]> [-DisplayName <String>] [-Container <String>]
 -AzureConnectionString <String> [-PassThru] [-IgnoreReadOnly] [<CommonParameters>]

InputObjectAwsProviderSet

Set-RMADFECloudStorage [-InputObject] <CloudStorage[]> [-DisplayName <String>] [-Container <String>]
 -AwsAccessKey <String> -AwsSecretKey <String> [-PassThru] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Updates properties for the registered cloud storage in Recovery Manager for Active Directory.

EXAMPLES

Example 1

PS C:\>  Set-RMADFECloudStorage -Id 7 -DisplayName "MyStorage" -AzureConnectionString "..." -Container "MyContainer"

Updates cloud storage settings for the Azure cloud storage with the Id 7.

Example 2

PS C:\>  Set-RMADFECloudStorage -Id 7 -DisplayName "MyStorage" -AwsAccessKey "..." -AwsSecretKey "..." -Container "MyContainer"

Updates cloud storage settings for the AWS cloud storage with the Id 7.

PARAMETERS

-AwsAccessKey

AWS access key ID

Type: String
Parameter Sets: IdAwsProviderSet, InputObjectAwsProviderSet
Aliases:

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

-AwsSecretKey

AWS secret key ID

Type: String
Parameter Sets: IdAwsProviderSet, InputObjectAwsProviderSet
Aliases:

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

-AzureConnectionString

Microsoft Azure connection string

Type: String
Parameter Sets: IdAzureProviderSet, InputObjectAzureProviderSet
Aliases:

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

-Container

Name of container in storage account. Backups will be copied to this location.

Type: String
Parameter Sets: (All)
Aliases:

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

-DisplayName

Cloud storage display name for the registered storage in Recovery Manager for Active Directory.

Type: String
Parameter Sets: (All)
Aliases:

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

-Id

Specifies the cloud storage Id representing the storage you want to update.

Type: Int32[]
Parameter Sets: IdAzureProviderSet, IdAwsProviderSet
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 update.

Type: CloudStorage[]
Parameter Sets: InputObjectAzureProviderSet, InputObjectAwsProviderSet
Aliases:

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

-PassThru

Passes the modified cloud storage along the pipeline.
If this parameter is omitted, the modified cloud storage is not passed along the pipeline.

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

System.Int32[]

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

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Set-RMADFECloudStorageCollection


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

schema: 2.0.0

SYNOPSIS

Configure a computer collection to use a registered cloud storage.

SYNTAX

Id

Set-RMADFECloudStorageCollection [-Collection <ComputerCollection[]>] [-CollectionId <Int32[]>] [-Id] <Int32[]>
 [-IgnoreReadOnly] [<CommonParameters>]

InputObject

Set-RMADFECloudStorageCollection [-Collection <ComputerCollection[]>] [-CollectionId <Int32[]>]
 [-InputObject] <CloudStorage[]> [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Configure a computer collection to use a registered cloud storage. Backups from the specified computer collections will be copied to the cloud storage. Multiple computer collections can use a cloud storage account.

EXAMPLES

Example 1

PS C:\> Set-RMADFECloudStorageCollection -Id 2 -CollectionId @(1,2,3)

Specifies the computer collections with Id 1, 2 and 3 to copy backups to the cloud storage with Id 2.

PARAMETERS

-Collection

Computer collection object.

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

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

-CollectionId

Id of computer collection to copy backups from to cloud storage.

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

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

-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 you want to update.

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

 

Set-RMADFEComputer


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

schema: 2.0.0

SYNOPSIS

Applies computer settings to the RMADFE project.

SYNTAX

Set-RMADFEComputer [-ComputerName] <String> [-Domain <String>] [-Backup <Guid>] [-BmrBackup <Guid>]
 [-BackupPassword <SecureString>] [-BmrBackupPassword <SecureString>] [-LocalCredential <PSCredential>]
 [-DcCredential <PSCredential>] [-DsrmCredential <PSCredential>] [-NetworkShareCredential <PSCredential>]
 [-BmrBackupNetworkShareCredential <PSCredential>] [-UseDomainSettings <Boolean>]
 [-RecoveryMethod <RecoveryMethod>] [-RestoreSysvolFromBackup <Boolean>] [-InstallFromMedia <Boolean>]
 [-DitPath <String>] [-LogPath <String>] [-SysvolPath <String>] [-RestoreAdOverBmrBackup <Boolean>]
 [-WipeDisks <Boolean>] [-PerformMalwareScan <Boolean>] [-MalwareCheckPause <Boolean>]
 [-UseOriginalTargetNetworkSettings <Boolean>] [-UseNatRouter <Boolean>] [-NatRouterPort <UInt32>]
 [-NatRouterAddress <String>] [-TargetIpAddress <String>] [-IsoIpAddress <String>] [-SubnetMask <String>]
 [-DefaultGateway <String>] [-DnsServers <String>] [-ConfigureAsGlobalCatalog <Boolean>]
 [-InstallReadOnly <Boolean>] [-RecoveryMediaPath <String>] [-RecoveryMediaShareCredential <PSCredential>]
 [-SaveRecoveryMediaOnBackupShare <Boolean>] [-TargetHardwareType <TargetInfrastructureType>]
 [-TargetHardwareManagementAddress <String>] [-TargetHardwareManagementProtocol <String>]
 [-TargetHardwareManagementPort <Int32>] [-TargetHardwareManagementCredential <PSCredential>]
 [-TargetHostCreateVMScript <String>] [-TargetHostBootScript <String>] [-TargetHostEjectScript <String>]
 [-CreateVM <Boolean>] [-VMName <String>] [-VMCPUNum <Int32>] [-VMMemorySize <Int64>]
 [-HypervisorHost <String>] [-HypervisorHostPlacement <String>] [-VMNetwork <String>] [-VMFolder <String>]
 [-VMNetworkRange <String>] [-VMSubNetworkName <String>] [-VMSubNetworkRange <String>]
 [-UseVMNetworkGateway <Boolean>] [-VMNetworkGateway <String>] [-VMVpnAddressPool <String>]
 [-UseStaticIPAddress <Boolean>] [-DriversPath <String>] [-AllowAddCustomDrivers <Boolean>]
 [-AllowAddCustomDriversFromBackup <Boolean>] [-TargetHardwareBootScript <String>] [-SubscriptionId <String>]
 [-TenantId <String>] [-AutoSelectVMSize <Boolean>] [-VMSize <VMSize>] [-VMLocation <String>]
 [-VMResourceGroup <String>] [-VMSecurityGroup <String>] [-VMStorageType <String>] [-VMStorageSize <Int32>]
 [-VMStorageSizeMode <VMStorageSizeMode>] [-DeleteVMAfterVerify <Boolean>]
 [-DeleteInfrastructureAfterVerify <Boolean>] [-OverwriteExistingVM <Boolean>] [-KeepInProject <Boolean>]
 [<CommonParameters>]

DESCRIPTION

This cmdlet applies computer settings to the current RMADFE project.

EXAMPLES

EXAMPLE 1

PS C:\> $dcCreds = Get-Credential
$dsrmCreds = Get-Credential
$shareCreds = Get-Credential

Set-RMADFEComputer -Name dc1.acme.com -BackupPassword (ConvertTo-SecureString "pwd" -AsPlainText -Force) -DcCredential $dcCreds -DsrmCredential $dsrmCreds -NetworkShareCredential $shareCreds -UseDomainSettings $false

This command applies the specified settings to the dc1.acme.com computer.

EXAMPLE 2

PS C:\> $shareCreds= Get-Credential
$dcCreds = Get-Credential
$dsrmCreds = Get-Credential
$localCreds  = Get-Credential

Set-RMADFEComputer -Name dc1.acme.com -NetworkShareCredential $shareCreds -DcCredential $dcCreds -DsrmCredential $dsrmCreds -LocalCredential $localCreds -RecoveryMethod InstallAD -InstallFromMedia $true

This command applies the specified settings to the dc1.acme.com computer, and installs AD using media.

PARAMETERS

-AllowAddCustomDrivers

Turns on the ability to set up custom drivers.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-AllowAddCustomDriversFromBackup

Turns on the ability to set up custom drivers from the backup.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-AutoSelectVMSize

Specifies if VM size should be selected automatically.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Backup

Specifies a System State backup that is used for recovery.

Type: Guid
Parameter Sets: (All)
Aliases:

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

-BackupPassword

Specifies the password to access a password-protected backup.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-BmrBackup

Specifies a Bare Metal Recovery backup that is used in case of the Bare Metal Active Directory Recovery method.

Type: Guid
Parameter Sets: (All)
Aliases:

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

-BmrBackupNetworkShareCredential

Specifies the user name and the password with which you want Recovery Manager for Active Directory Forest Edition to access the selected domain controllers to the BMR backup location.
Use the Get-Credential cmdlet provided by Windows PowerShell to get the PSCredential object representing user credentials.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-BmrBackupPassword

Specifies the password to access a password-protected BMR backup.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-ComputerName

Specifies the fully qualified domain name of the computer.

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

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

-ConfigureAsGlobalCatalog

Sets the Global Catalog role for the domain controller.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-CreateVM

Specifies if a new machine must be created on the target platform.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-DcCredential

Specifies the user name and the password with which you want Recovery Manager for Active Directory Forest Edition to access the selected domain controllers in the Normal mode.
Use the Get-Credential cmdlet provided by Windows PowerShell to get the PSCredential object representing user credentials.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-DefaultGateway

Specifies the default gateway for the custom Bare Metal Recovery network settings.

Type: String
Parameter Sets: (All)
Aliases:

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

-DeleteInfrastructureAfterVerify

Specifies if infrastructure (security group, virtual network, virtual network gateway) must be deleted after project verification.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-DeleteVMAfterVerify

Specifies if a virtual machine must be deleted after project verification.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-DitPath

Specifies a path to the DIT file if the custom location is required.

Type: String
Parameter Sets: (All)
Aliases:

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

-DnsServers

Specifies DNS Servers for the custom Bare Metal Recovery network settings.

Type: String
Parameter Sets: (All)
Aliases:

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

-Domain

Specifies the Domain DNS name of the computer.

Type: String
Parameter Sets: (All)
Aliases:

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

-DriversPath

Specifies a path to custom drivers.

Type: String
Parameter Sets: (All)
Aliases:

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

-DsrmCredential

Specifies the user name and the password with which you want Recovery Manager for Active Directory Forest Edition to access the selected domain controllers in Directory Services Restore Mode (DSRM).
Use the Get-Credential cmdlet provided by Windows PowerShell to get the PSCredential object representing user credentials.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-HypervisorHost

Specifies Hypervisor host name.

Type: String
Parameter Sets: (All)
Aliases:

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

-HypervisorHostPlacement

Specifies the placement of the virtual machine.

Type: String
Parameter Sets: (All)
Aliases:

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

-InstallFromMedia

This option allows you to install or reinstall AD using media.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-InstallReadOnly

Sets Read-only property for the domain controller.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-IsoIpAddress

Specifies the IP address for ISO image which is used as a boot disk.

Type: String
Parameter Sets: (All)
Aliases:

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

-KeepInProject

Marks domain controller to be recovered later.
If this domain controller is removed from the Active Directory, it will not removed from the project on updating with Active Directory changes.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-LocalCredential

Specifies local credentials for the computer.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-LogPath

Specifies a path to Active Directory log files if the custom location is required.

Type: String
Parameter Sets: (All)
Aliases:

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

-MalwareCheckPause

Specifies if the recovery process must be paused to scan for malware threats.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-NatRouterAddress

Set the NAT routing address (deprecated).

Type: String
Parameter Sets: (All)
Aliases:

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

-NatRouterPort

Set the NAT routing port (deprecated).

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-NetworkShareCredential

Specifies the user name and the password with which you want Recovery Manager for Active Directory Forest Edition to access the selected domain controllers to the backup location.
Use the Get-Credential cmdlet provided by Windows PowerShell to get the PSCredential object representing user credentials.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-OverwriteExistingVM

Specifies if an existing machine must be deleted before creation.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-PerformMalwareScan

Specifies if the backup must be scanned for malware threats.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RecoveryMediaPath

Specifies a path to ISO image which is used as a boot disk.

Type: String
Parameter Sets: (All)
Aliases:

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

-RecoveryMediaShareCredential

Specifies credentials to get access to ISO image which is used as a boot disk.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-RecoveryMethod

Specifies the recovery method for this domain controller.

Type: RecoveryMethod
Parameter Sets: (All)
Aliases:
Accepted values: DoNotRecover, RestoreFromBackup, ReinstallAD, AdjustADChanges, UninstallAD, RestoreSYSVOL, InstallAD, RestoreFromWindowsBackup, RestoreOnCleanOS, Skip

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

-RestoreAdOverBmrBackup

This option allows you to select the RMADFE Active Directory and Registry backup to be restored over the BMR backup.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RestoreSysvolFromBackup

{{ Fill RestoreSysvolFromBackup Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-SaveRecoveryMediaOnBackupShare

Specifies a location of the ISO image which is used as a boot disk.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-SubnetMask

Specifies a subnet mask for the custom Bare Metal Recovery network settings.

Type: String
Parameter Sets: (All)
Aliases:

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

-SubscriptionId

Specifies an Azure SubscriptionId.

Type: String
Parameter Sets: (All)
Aliases:

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

-SysvolPath

Specifies a path to SYSVOL if the custom location is required.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHardwareBootScript

Specifies custom script to boot the target host.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHardwareManagementAddress

Specifies the address of the target platform for the new domain controller.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHardwareManagementCredential

Specifies network credentials for communicating with the platform for the new domain controller.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-TargetHardwareManagementPort

Specifies the network port for communicating with the platform for the new domain controller.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-TargetHardwareManagementProtocol

Specifies the network protocol for communicating with the platform for the new domain controller.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHardwareType

Specifies the target platform for the new domain controller.

Type: TargetInfrastructureType
Parameter Sets: (All)
Aliases:
Accepted values: None, PhysicalDell, PhysicalHP, Custom, VMWare, HyperV, Azure, AWS

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

-TargetHostBootScript

Specifies a custom script to boot the target host.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHostCreateVMScript

Specifies a custom script to create a virtual machine on the target platform.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetHostEjectScript

Specifies a custom script to eject bootable disk on the target host.

Type: String
Parameter Sets: (All)
Aliases:

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

-TargetIpAddress

Specifies the target IP for the computer.

Type: String
Parameter Sets: (All)
Aliases:

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

-TenantId

Specifies an Azure TenantId.

Type: String
Parameter Sets: (All)
Aliases:

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

-UseDomainSettings

This option lets you use the default domain credentials to access domain controllers.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-UseNatRouter

Allows using NAT (deprecated).

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-UseOriginalTargetNetworkSettings

This option allows you to use network settings from Bare Metal Recovery backup.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-UseStaticIPAddress

Specifies if static IP address should be assigned to the virtual machine.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-UseVMNetworkGateway

Specifies if VPN Gateway should be used to connect the virtual machine.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-VMCPUNum

Specifies the number of CPUs on the virtual machine.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-VMFolder

Specifies a target folder for the virtual machine.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMLocation

Specifies an Azure VM location.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMMemorySize

Specifies memory size on the virtual machine.

Type: Int64
Parameter Sets: (All)
Aliases:

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

-VMName

Specifies the name of the virtual machine on the target platform.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMNetwork

Specifies network settings for the virtual machine.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMNetworkGateway

Specifies VPN Gateway used to connect the virtual machine.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMNetworkRange

Specifies network range for the virtual network.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMResourceGroup

Specifies an Azure VM resource group.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMSecurityGroup

Specifies an Azure VM security group.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMSize

Specifies an Azure VM size.

Type: VMSize
Parameter Sets: (All)
Aliases:

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

-VMStorageSize

Specifies the virtual machine disk size in GB.
Applicable with VMStorageSizeMode = SetVMStorageSize.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-VMStorageSizeMode

Specifies the virtual machine disk size selection mode.
UseDefaultVMStorageSize - set disk size based on the Active Directory data size.
SetVMStorageSize - set custom disk size.
Minimal disk size values are 128 GB for OS disk and 8 GB for AD data disk.

Type: VMStorageSizeMode
Parameter Sets: (All)
Aliases:
Accepted values: UseDefaultVMStorageSize, SetVMStorageSize

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

-VMStorageType

Specifies the virtual machine storage type.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMSubNetworkName

Specifies subnetwork name for the virtual network.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMSubNetworkRange

Specifies subnetwork range for the virtual network.

Type: String
Parameter Sets: (All)
Aliases:

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

-VMVpnAddressPool

Specifies virtual machine address pool.

Type: String
Parameter Sets: (All)
Aliases:

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

-WipeDisks

Specifies if a full disk cleanup on the target machine is required before starting restore from the Bare Metal Recovery backup.

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

OUTPUTS

NOTES

RELATED LINKS

 

Set-RMADFEDnsCache


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

schema: 2.0.0

SYNOPSIS

Updates cached DNS records in the Forest Recovery project.

SYNTAX

Set-RMADFEDnsCache [-HostName] <String> [-Address] <Object> [-Override] [<CommonParameters>]

DESCRIPTION

This cmdlet updates the cached DNS records for the specified hostname in the Forest Recovery project.

EXAMPLES

Example 1

PS C:\> Set-RMADFEDnsCache -HostName DC1.rmad.local -Address "192.168.0.2"

This command prepends "192.168.0.2" to the cached DNS records of DC1.rmad.local.

Example 2

PS C:\> Set-RMADFEDnsCache -HostName DC1.rmad.local -Address @("192.168.0.2","10.0.0.2")

This command prepends "192.168.0.2" and "10.0.0.2" to the cached DNS records of DC1.rmad.local.

Example 3

PS C:\> Set-RMADFEDnsCache -HostName DC1.rmad.local -Address "192.168.0.2" -Override

This command resets the cached DNS records of DC1.rmad.local to "192.168.0.2".

PARAMETERS

-Address

Specifies a list of IP addresses for the specified hostname.

Type: Object
Parameter Sets: (All)
Aliases:

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

-HostName

Specifies the hostname of the domain controller.

Type: String
Parameter Sets: (All)
Aliases:

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

-Override

This option lets you reset the cached DNS records to the specified address.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

None

OUTPUTS

NOTES

RELATED LINKS

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating