Set-OBMachineSetting

Module:

MSOnlineBackup Module

Sets a OBMachineSetting object for the server.

Set-OBMachineSetting
 [-EncryptionPassphrase] <SecureString>
 [[-SecurityPin] <String>]
 [[-PassphraseSaveLocation] <String>]
 [[-KeyVaultUri] <String>]
 [-Confirm]
 [-WhatIf]

Set-OBMachineSetting
 [-WorkDay] <DayOfWeek[]>
 [-StartWorkHour] <TimeSpan>
 [-EndWorkHour] <TimeSpan>
 [-WorkHourBandwidth] <UInt32>
 [-NonWorkHourBandwidth] <UInt32>
 [-Confirm]
 [-WhatIf]

Set-OBMachineSetting
 [-NoProxy]
 [-Confirm]
 [-WhatIf]

Set-OBMachineSetting
 [-NoThrottle]
 [-Confirm]
 [-WhatIf]

Set-OBMachineSetting
 [-ProxyServer] <String>
 [-ProxyPort] <Int32>
 [[-ProxyUsername] <String>]
 [[-ProxyPassword] <SecureString>]
 [-Confirm]
 [-WhatIf]

The Set-OBMachineSetting cmdlet sets a OBMachineSetting object for the server that includes proxy server settings for accessing the internet, network bandwidth throttling settings, and the encryption passphrase that is required to decrypt the files during recovery to another server.

This cmdlet supports WhatIf and Confirm parameters with a medium impact. The medium impact signifies that the cmdlet will not prompt the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Using -Confirm:$FALSE will override the prompt.

To use Microsoft Azure Backup cmdlets, the user needs to be an administrator on the protected machine.

$spwd = ConvertTo-SecureString -String Notag00pa55word -AsPlainText -Force
Set-OBMachineSetting -EncryptionPassphrase $spwd -PassphraseSaveLocation C:\

This example sets encryption passphrase for a computer.

$spwd = ConvertTo-SecureString -String Notag00pa55word -AsPlainText -Force
$setOBMachineSettingSplat = @{
 ProxyServer = 'http://proxycontoso.com'
 ProxyPort = '<your proxy port>'
 ProxyUsername = 'contoso\johnj99'
 ProxyPassword = $spwd
}
Set-OBMachineSetting @setOBMachineSettingSplat

This example sets proxy settings for a server.

$setOBMachineSettingSplat = @{
 WorkDay = [System.DayOfWeek]::Monday, [System.DayOfWeek]::Tuesday
 StartWorkHour = '9:00:00'
 EndWorkHour = '18:00:00'
 WorkHourBandwidth = (512*1024)
 NonWorkHourBandwidth = (2048*1024)
}
Set-OBMachineSetting @setOBMachineSettingSplat

This example sets throttling settings.

Set-OBMachineSetting -NoThrottle

This example specifies that network bandwidth throttling will not be used by this server.

Set-OBMachineSetting -NoProxy

This example specifies that this server does not use a unique proxy server configuration.

$spwd = ConvertTo-SecureString -String abcdefgh123456000345 -AsPlainText -Force
$setOBMachineSettingSplat = @{
 EncryptionPassphrase = $spwd
 SecurityPIN = 123456
 PassphraseSaveLocation = 'C:\Users\myuser\MyFolder \Desktop\passphrases\'
}
Set-OBMachineSetting @setOBMachineSettingSplat

This example registers a server with the given passphrase and saves it in the location provided.

$spwd = ConvertTo-SecureString -String abcdefgh123456000345 -AsPlainText -Force
$setOBMachineSettingSplat = @{
 EncryptionPassphrase = $spwd
 SecurityPIN = 123456
 KeyVaultUri = 'https://mykeyvault.vault.azure.net/'
}
Set-OBMachineSetting @setOBMachineSettingSplat

This example registers a server with the given passphrase and saves it in Azure Key Vault.