Set-OBMachineSetting

Set-OBMachineSetting

Sets a OBMachineSetting object for the server.

Syntaxe

Parameter Set: Encryption
Set-OBMachineSetting [-EncryptionPassphrase] <SecureString> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: NoProxy
Set-OBMachineSetting [-NoProxy] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: NoThrottle
Set-OBMachineSetting [-NoThrottle] [-Confirm] [-WhatIf] [ <CommonParameters>]

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

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

Description détaillée

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.

Paramètres

-EncryptionPassphrase<SecureString>

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

Alias	none
Requis ?	true
Position ?	2
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByValue)
Accepter les caractères génériques ?	false

-EndWorkHour<TimeSpan>

Specifies the hour that ends the work hours range.

Alias	none
Requis ?	true
Position ?	4
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-NoProxy

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

Alias	none
Requis ?	true
Position ?	2
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-NoThrottle

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

Alias	none
Requis ?	true
Position ?	2
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-NonWorkHourBandwidth<UInt32>

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

Alias	none
Requis ?	true
Position ?	6
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-ProxyPassword<SecureString>

Specifies authentication password to be used for proxy setting.

Alias	none
Requis ?	false
Position ?	5
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-ProxyPort<Int32>

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

Alias	none
Requis ?	true
Position ?	3
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-ProxyServer<String>

Specifies the proxy server to be used when connecting to the online backup server.

Alias	none
Requis ?	true
Position ?	2
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByValue)
Accepter les caractères génériques ?	false

-ProxyUsername<String>

Specifies the username to be used for proxy server authenication.

Alias	none
Requis ?	false
Position ?	4
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-StartWorkHour<TimeSpan>

Specifies the hour that starts the range of work hours.

Alias	none
Requis ?	true
Position ?	3
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-WorkDay<DayOfWeek[]>

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

Alias	none
Requis ?	true
Position ?	2
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByValue)
Accepter les caractères génériques ?	false

-WorkHourBandwidth<UInt32>

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

Alias	none
Requis ?	true
Position ?	5
Valeur par défaut	none
Accepter l'entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-Confirm

Vous invite à confirmer l'exécution de l'applet de commande.

Requis ?	false
Position ?	named
Valeur par défaut	false
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-WhatIf

Indique ce qui se produit en cas d'exécution de l'applet de commande. L'applet de commande n'est pas exécutée.

Requis ?	false
Position ?	named
Valeur par défaut	false
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez  . about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d'entrée correspond au type des objets que vous pouvez adresser à l'applet de commande.

• Microsoft.Internal.CloudBackup.Commands.OBMachineSetting

Sorties

Le type de sortie correspond au type des objets que l'applet de commande émet.

• Microsoft.Internal.CloudBackup.Commands.OBMachineSetting

Exemples

EXAMPLE 1

This example sets encryption passphrase for a computer.

PS C:\> ConvertTo-SecureString -String Notag00pa55word -AsPlainText -Force | Set-OBMachineSetting

EXAMPLE 2

This example sets proxy settings for a server.

PS C:\> $spwd = ConvertTo-SecureString -String Notag00pa55word -AsplainText –ForcePS C:\> Set-OBMachineSetting -ProxyServer http://proxycontoso.com -ProxyPort <your proxy port> -ProxyUsername contoso\johnj99 -ProxyPassword $spwd

EXAMPLE 3

This example sets throttling settings.

PS C:\> $mon = [System.DayOfWeek]::MondayPS C:\> $tue = [System.DayOfWeek]::TuesdayPS C:\> Set-OBMachineSetting -WorkDay $mon, $tue -StartWorkHour "9:00:00" -EndWorkHour "18:00:00" -WorkHourBandwidth  (512*1024) -NonWorkHourBandwidth (2048*1024)

EXAMPLE 4

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

PS C:\> Set-OBMachineSetting –NoThrottle

EXAMPLE 5

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

PS C:\> Set-OBMachineSetting –NoProxy

Rubriques connexes

ConvertTo-SecureString