Recovery Manager for AD Forest Edition 10.2.2 - Management Shell Guide

Set-RMADCollection

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

schema: 2.0.0

SYNOPSIS

Sets properties for a computer collection.

SYNTAX

Name (Default)

Set-RMADCollection [-Name] <String[]> [-BackupComponents <BackupComponents>] [-Properties <Hashtable>]
 [-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>] [-AgentCredentialEnabled <Boolean>]
 [-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>] [-StorageCredential <PSCredential>]
 [-ConsoleStorageCredential <PSCredential>] [-SecondaryStorageCredential <PSCredential>]
 [-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf]
 [-Confirm] [<CommonParameters>]

InputObject

Set-RMADCollection [-InputObject] <ComputerCollection[]> [-BackupComponents <BackupComponents>]
 [-Properties <Hashtable>] [-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>]
 [-AgentCredentialEnabled <Boolean>] [-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>]
 [-StorageCredential <PSCredential>] [-ConsoleStorageCredential <PSCredential>]
 [-SecondaryStorageCredential <PSCredential>] [-RetentionPolicyEnabled <Boolean>]
 [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

Id

Set-RMADCollection [-Id] <Int32[]> [-BackupComponents <BackupComponents>] [-Properties <Hashtable>]
 [-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>] [-AgentCredentialEnabled <Boolean>]
 [-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>] [-StorageCredential <PSCredential>]
 [-ConsoleStorageCredential <PSCredential>] [-SecondaryStorageCredential <PSCredential>]
 [-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets properties for the Recovery Manager computer collection you specify.

EXAMPLES

Example 1

PS C:\> Set-RMADCollection -Name Collection1 -BackupComponents ActiveDirectory,Registry,GroupMembership,ForestRecoveryMetadata

This command sets properties for the computer collection named Collection1.

Example 2

PS C:\> Set-RMADCollection * -RetentionPolicyEnabled $false

This command disables all backup retention policies for all existing computer collections.

Example 3

PS C:\> $c = Get-RMADCollection | Where-Object { $_.AgentCredentialEnabled -eq $true }

C:\PS>$cred = Get-Credential

C:\PS>Set-RMADCollection -InputObject $c -AgentCredential $cred

The first command in this example gets objects representing the computer collections whose properties are set to access Backup Agent and backup files with a specific user account.
Then the command saves the computer collection objects in the $c variable.

Example 4

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

C:\PS>Set-RMADCollection -InputObject $a[1] -Properties @{BackupComponents="ActiveDirectory","BootFiles"; UsePreinstalledAgent=$true}

In the first line of this example, the Get-RMADCollection cmdlet gets the Computer Collection whose name is Collection1 and saves it to the $a variable.
In the second line of this example, the Set-RMADCollection cmdlet sets the components to be backed up (that is, Active Directory and boot files) and specifies to use preinstalled Backup Agent for backup operations.
For a complete list of items you can include in the braces, see the description of the Properties parameter.

Example 5

PS C:\> $schedule=(New-RMADSchedule -Daily -StartDate "9/20/2022 10:00" -DaysInterval 1), (New-RMADSchedule -Daily -StartDate "9/20/2022 22:00" -DaysInterval 1)

C:\PS>Set-RMADCollection -InputObject $col -Properties @{EnableEmailLog=$true; EmailLogTo="administrator@mydomain.com"; EmailLogLevel="Everything"}

This example illustrates how to back up a Computer Collection by using two backup schedules.
The first line of this example creates two backup creation schedules and stores them in the $schedule variable.
One schedule invokes the backup operation once in every two days at 10 a.m.
Another schedule invokes the backup operation once in every two days at 10 p.m.
The two backup schedules become effective starting from the 20th September 2022.
The second line of this example enables e-mail notifications for the Computer Collection.
The recipient address for e-mail notifications is administrator@mydomain.com.
The e-mail notifications provide information about all backup events.

Example 6

PS C:\> $cred = Get-Credential

C:\PS>Set-RMADCollection -Name MyCollection -Properties @{AgentSideScriptBeforeBackupEnabled = $true; AgentSideScriptBeforeBackup = 'Set-Disk -Number 5 -IsOffline $false'; AgentSideScriptAfterBackupEnabled = $true; AgentSideScriptAfterBackup = 'Set-Disk -Number 5 -IsOffline $true'; AgentSideScriptCredential = $cred}

This example illustrates how to customize your environment by running PowerShell scripts on the domain controller before and after creating a backup.

PARAMETERS

-AgentCredential

Specifies the credentials for the account you want to use to access Backup Agent installed on the DCs in the computer collection and locations where backup files for the computer collection will be saved.
TO enable using the account whose credentials you supply in this parameter, use the AgentCredentialEnabled parameter.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-AgentCredentialEnabled

Specifies to use a particular account to access Backup Agent installed on the DCs in the computer collection and locations where backup files for the computer collection will be saved.
To specify the credentials for the account, use the AgentCredential parameter.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-BackupComponents

Use this parameter to specify the names of the System State components you want to back up.

Type: BackupComponents
Parameter Sets: (All)
Aliases:
Accepted values: None, ActiveDirectory, Adam, BootFiles, CertificateServer, ClusterQuorum, EnterpriseServices, ForestRecoveryMetadata, GroupMembership, IisMetabase, PerformanceCounters, Registry, CryptoKeys, All

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

-ConsoleStorageCredential

Specifies the credentials for the account you want to use to access local (console) backup files for the computer collection.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Id

Specifies the identifier of the computer collection whose properties you want to set.

Type: Int32[]
Parameter Sets: Id
Aliases:

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.

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 whose properties you want to set.

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 computer collection whose properties you have set along the pipeline.
If this parameter is omitted, the computer 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

-Properties

Allows you to modify the Computer Collection properties.
To specify the properties you want to modify, use an associative array or hash table.
For more information, see the Windows PowerShell help topic on associative arrays (hash tables).
To open the topic, at the PoweShell command prompt enter the following: help about_associative_arrayBelow are the properties you can modify by using this parameter.
The properties are grouped by the names of tabs in the "Computer Collection Properties" dialog box, because each property corresponds to an option on these tabs.To assign a new value to a property, use the following format: PropertyName=Value * UseAlternateStoragePath.
Specifies whether to store a copy of each backup in an alternate location.
Can take one of these values: $true, $false.

• AlternateStoragePath.
  Specifies a storage path format for the alternate location.
  Surround the path with double quotes.
• AgentCredentialEnabled.
  Causes the Recovery Manager console to use a specified user account to access the Backup Agent and backup files on target computers.
  Can take one of these values: $true, $false.
• AgentCredential.
  Specifies the account under which the Recovery Manager console accesses the Backup Agent and backup files, in the form of a PSCredential object.
  Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
• ConfigureFirewall.
  Specifies whether Recovery Manager automatically configures Windows Firewall on target Windows Server 2008-based or Windows Server 2012-based DCs to allow backup operations.
  Can take one of these values: $true, $false.
• UsePreinstalledAgent.
  Specifies whether Recovery Manager automatically preinstalls the Backup Agent.
  Can take one of these values: $true, $false.
• DeployForestRecoveryAgent.
  Specifies whether Recovery Manager verifies that the Forest Recovery Agent is installed on each domain controller in the Computer Collection.
  Can take one of these values: $true, $false.
• BackupDescription.
  Specifies a description for the backups to be created for the Computer Collection.
  The description may include expressions, such as %COMPUTERNAME% and %DATETIME%.
• BackupPasswordEnabled.
  Specifies whether to protect the backups with a password.
  Can take one of these values: $true, $false.
• BackupPassword.
  Specifies a password to protect the backups.
  The value must be a SecureString object.
• ConsoleSideBackupEnabled.
  Specifies to store backups on the Recovery Manager computer or on a Universal Naming Convention (UNC) share.
  Can take one of these values: $true, $false.
• ConsoleSideBackupPath.
  Specifies a storage path format for backup files.
  The path format can include expressions, such as %COMPUTERNAME% and %DATETIME%.
  Surround the path format with double quotes.
• ConsoleSideRetentionPolicyEnabled.
  Specifies whether to apply a retention policy to backups stored at the path provided in the ConsoleSideBackupPath parameter.
  Can take one of these values: $true, $false.
• ConsoleSideRetentioPolicyCount.
  Specifies the number of the most recent backups to retain.
  Other backups are automatically deleted.
• AgentSideBackupEnabled.
  Specifies to store backups on the backed-up DC or on a Universal Naming Convention (UNC) share.
  Can take one of these values: $true, $false.
• AgentSideBackupPath.
  Specifies a storage path format for backup files.
  The path format can include expressions, such as %COMPUTERNAME% and %DATETIME%.
  Surround the path format with double quotes.
• AgentSideRetentionPolicyEnabled.
  Specifies whether to apply a retention policy to backups stored at the path provided in the ConsoleSideBackupPath parameter.
  Can take one of these values: $true, $false.
• AgentSideRetentionPolicyCount.
  Specifies the number of the most recent backups to retain.
  Other backups are automatically deleted.
• StorageCredentialEnabled.
  Causes the Recovery Manager console to use a specified user account to access backup files on target computers.
  Can take one of these values: $true, $false.
• StorageCredential.
  Specifies the account under which the Recovery Manager Backup Agent accesses the backup files, in the form of a PSCredential object.
  Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
• EnableEmailLog.
  Specifies whether to send information about backup creation sessions by e-mail.
  Can take one of these values: $true, $false.
• EnableEmailLogOnlyOnErrors.
  Specifies to send information over e-mail only when an error occurs.
  Can take one of these values: $true, $false.
• EmailLogLevel.
  Specifies the type of information to send over e-mail.
  Possible values: "Everything", "ErrorsOnly".
• EmailLogTo.
  Specifies the recipient's e-mail address to send the information about backup creation sessions.
• EnableApplicationLog.
  Specifies whether to write information about backup creation sessions to the Windows application log on the Recovery Manager computer.
  Can take one of these values: $true, $false.
• EnableApplicationLogOnlyOnErrors.
  Specifies whether to create an Application log event only upon backup creation session errors or warnings.
  Can take one of these values: $true, $false.
• ApplicationLogLevel.
  Specifies the type of information to write to the Application log.
  Possible values: "Everything", "ErrorsOnly".
• EnableLogFile.
  Specifies whether to write information about backup creation sessions to the additional text file you specify.
  Can take one of these values: $true, $false.
• EnableLogFileOnlyOnErrors.
  Specifies whether to write information to the additional text file only upon backup creation session errors or warnings.
  Can take one of these values: $true, $false.
• LogFileLevel.
  Specifies the type of information to write to the additional text file.
  Possible values: "Everything", "ErrorsOnly".
• LogFileName.
  Specifies a path and name for the additional text file.
• LogFileAppend.
  Specifies whether to append information to the additional text file.
  Can take one of these values: "True", "False".
• ExtendedLogging.
  Specifies the logging settings for DCs in the collection.
  Can take one of these values: Use global (default) - use settings from the root node: Recovery Manager for Active Directory->Settings…>Logging, Yes - for all DCs in the current collection: for logs will be used the "Trace" option, No - for all DCs in the current collection: in logs will be only Warnings and Error messages.
• CompressionMethod.
  Specifies a method to compress the backups to be created.
  Can take one of these values: "None", "Fast", "Normal", "Maximum".
• ParallelBackups.
  Specifies the maximum number of computers serviced in parallel when creating backups.
  Increasing this number can speed the backup creation, however, this may result in network saturation and slow network response.
• EnableTransferRateLimit.
  Specifies whether to limit the total bandwidth used by the Backup Agent when transferring data over the network.
  Use this property to prevent the Backup Agent from generating excessive network traffic.
  Can take one of these values: $true, $false.
• TransferRaleLimit.
  Specifies the bandwidth limit in Mbits/sec for the Backup Agent.
• EnableCpuUsageLimit.
  Specifies whether to limit the CPU processing time used by the Backup Agent on each computer.
  Can take one of these values: $true, $false.
• CpuUsageLimit.
  Specifies the CPU processing limit in percent.
• ScheduleEnabled.
  Specifies whether to enable backup creation schedule.
  Can take one of these values: $true, $false.
• Schedule.
  Sets up a backup creation schedule.
  To set up a schedule, use the New-RMADSchedule cmdlet.
• ScheduleCredential.
  Specify the user account under which the Task Scheduler performs backup creation tasks, in the form of a PSCredential object.
  Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.
• BackupComponents.
  Specifies the system state components to back up.
  Possible values: "All", "None", "ActiveDirectory", "Adam", "BootFiles", "CertificateServer", "ClusterQuorum", "EnterpriseServices", "ForestRecoveryMetadata", "GroupMembership", "IisMetabase", "PerformanceCounters", "Registry".
  When specifying multiple values, use a comma as a separator.
• CollectGroupMembership.
  Specifies whether to back up group membership data stored on Global Catalog servers.
  Can take one of these values: $true, $false.
• CollectForestRecoveryMetadata.
  Specifies whether to create backups that can be used to recover the Active Directory forest.
  Can take one of these values: $true, $false.
• OverrideDefaultBackupUnpackSettings.
  Specifies whether to override the global settings for unpacking backups for the Computer Collection.
  Can take one of these values: $true, $false.
• UnpackBackupsUponCreation.
  Specifies whether to unpack each backup upon its creation.
  Can take one of these values: $true, $false.
• UnpackedBackupsToKeep.
  Specifies the number of the most recent unpacked backups to retain.
  Other unpacked backups are automatically deleted.
• IsUnpackOnlySelected.
  Specifies whether to keep unpacked backups only for a list of selected domain controllers.
  Can take one of these values: $true, $false.
• SelectedDCsToUnpack.
  Specifies the names (separated by comma) of domain controllers you want to keep unpacked backups for.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-RetentionPolicyCount

Specifies the number of latest backups you want to keep for each DC in the computer collection.
To enable the deletion of obsolete backups, use the RetentionPolicyEnabled parameter.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-RetentionPolicyEnabled

Specifies to delete obsolete backups for particular computer collection.
To set the number of latest backups you want to keep for each DC in the computer collection, use the RetentionPolicyCount parameter.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Schedule

Causes the computer collection you specify to use the backup creation schedule you set by using the New-RMADSchedule cmdlet.

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

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

-ScheduleCredential

Specifies the user account under which the scheduled backup creation task will be run.
This account must have sufficient permissions to back up the computer collection you specify.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-SecondaryStorageCredential

Specifies the credentials for the account you want to use to Tier 1 remote storage to copy backups to the secondary storage like Secure Storage Server or Cloud Storage.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-StorageCredential

Specifies the credentials for the account you want to use to access locations where backup files for the computer collection will be saved.
To enable using the account whose credentials you supply in this parameter, use the StorageCredentialEnabled parameter.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-StorageCredentialEnabled

Specifies to use a particular account to access locations where backup files for the computer collection will be saved.
To specify the credentials for the account, use the StorageCredential parameter.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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

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