Share via

Set-OBMachineSetting

  • Reference
Module:
MSOnlineBackup

Sets a OBMachineSetting object for the server.

Syntax

Set-OBMachineSetting
   [-EncryptionPassphrase] <SecureString>
   [[-SecurityPin] <String>][[-PassphraseSaveLocation] <String>]
   [[-KeyVaultUri] <String>]
   [-Confirm]
   [-WhatIf]
Set-OBMachineSetting
   [-WorkDay] <DayOfWeek[] {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}>
   [-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]

Description

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.

Examples

EXAMPLE 1

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

This example sets encryption passphrase for a computer.

EXAMPLE 2

$spwd = ConvertTo-SecureString -String Notag00pa55word -AsPlainText -Force



Set-OBMachineSetting -ProxyServer http://proxycontoso.com -ProxyPort <your proxy port> -ProxyUsername contoso\johnj99 -ProxyPassword $spwd

This example sets proxy settings for a server.

EXAMPLE 3

$mon = [System.DayOfWeek]::Monday



$tue = [System.DayOfWeek]::Tuesday



Set-OBMachineSetting -WorkDay $mon, $tue -StartWorkHour "9:00:00" -EndWorkHour "18:00:00" -WorkHourBandwidth (512*1024) -NonWorkHourBandwidth (2048*1024)

This example sets throttling settings.

EXAMPLE 4

Set-OBMachineSetting -NoThrottle

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

EXAMPLE 5

Set-OBMachineSetting -NoProxy

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

EXAMPLE 6

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

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

EXAMPLE 7

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

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-EncryptionPassphrase

Sets the encryption passphrase to be used to encrypt the backed up data.

Type:SecureString
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-EndWorkHour

Specifies the hour that ends the work hours range.

Type:TimeSpan
Position:4
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-KeyVaultUri

Enter a Key Vault URI to save the passphrase securely. A new secret is created in the key vault specified to save the passphrase. One of PassphraseSaveLocation or KeyVaultUri (recommended) needs to be specified.

Type:String
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-NonWorkHourBandwidth

Specifies the bandwidth throttling setting to be used to limit the network bandwidth consumed by data transfers during non-work hours.

Type:UInt32
Position:6
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoProxy

Specifies that unique proxy server settings are not to be used for online backups.

Type:SwitchParameter
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoThrottle

Specifies that network throttling is not used with online backups. Data transfers of backed up items from the local server to the Microsoft Azure Backup server will use bandwidth as needed.

Type:SwitchParameter
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassphraseSaveLocation

Enter a network location or folder where the passphrase can be saved. Saving the passphrase in the machine being protected is not recommended. Microsoft cannot recover backup data if the passphrase is lost. One of PassphraseSaveLocation or KeyVaultUri (recommended) needs to be specified.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProxyPassword

Specifies authentication password to be used for proxy setting.

Type:SecureString
Position:5
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProxyPort

Specifies the port number to be used on the proxy server.

Type:Int32
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProxyServer

Specifies the proxy server to be used when connecting to the Microsoft Azure Backup server.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProxyUsername

Specifies the username to be used for proxy server authentication.

Type:String
Position:4
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SecurityPin

Security pin is necessary if you are changing passphrase and the hybrid security setting is turned on for the Recovery Services Vault. You must generate a security pin by selecting Generate under Settings > Properties > Security PIN in the Recovery Services vault section of the Azure portal.

Type:String
Position:named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StartWorkHour

Specifies the hour that starts the range of work hours.

Type:TimeSpan
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

-WorkDay

Specifies the array of work days using the using [DayOfWeek] system variables.

Type:DayOfWeek[] {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WorkHourBandwidth

Specifies the bandwidth throttling setting to be used to limit the network bandwidth consumed by data transfers during work hours.

Type:UInt32
Position:5
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Microsoft.Internal.CloudBackup.Commands.OBMachineSetting

Outputs

Microsoft.Internal.CloudBackup.Commands.OBMachineSetting