Set-OBMachineSetting
Set-OBMachineSetting
Sets a OBMachineSetting object for the server.
Syntax
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>]
Detaillierte Beschreibung
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.
Parameter
-EncryptionPassphrase<SecureString>
Sets the encryption passphrase to be used to encrypt the backed up data.
Aliase |
none |
Erforderlich? |
true |
Position? |
2 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByValue) |
Platzhalterzeichen akzeptieren? |
false |
-EndWorkHour<TimeSpan>
Specifies the hour that ends the work hours range.
Aliase |
none |
Erforderlich? |
true |
Position? |
4 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-NoProxy
Specifies that unique proxy server settings are not to be used for online backups.
Aliase |
none |
Erforderlich? |
true |
Position? |
2 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
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.
Aliase |
none |
Erforderlich? |
true |
Position? |
2 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-NonWorkHourBandwidth<UInt32>
Specifies the bandwidth throttling setting to be used to limit the network bandwidth consumed by data transfers during non-work hours.
Aliase |
none |
Erforderlich? |
true |
Position? |
6 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-ProxyPassword<SecureString>
Specifies authentication password to be used for proxy setting.
Aliase |
none |
Erforderlich? |
false |
Position? |
5 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-ProxyPort<Int32>
Specifies the port number to be used on the proxy server.
Aliase |
none |
Erforderlich? |
true |
Position? |
3 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-ProxyServer<String>
Specifies the proxy server to be used when connecting to the online backup server.
Aliase |
none |
Erforderlich? |
true |
Position? |
2 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByValue) |
Platzhalterzeichen akzeptieren? |
false |
-ProxyUsername<String>
Specifies the username to be used for proxy server authenication.
Aliase |
none |
Erforderlich? |
false |
Position? |
4 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-StartWorkHour<TimeSpan>
Specifies the hour that starts the range of work hours.
Aliase |
none |
Erforderlich? |
true |
Position? |
3 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-WorkDay<DayOfWeek[]>
Specifies the array of work days using the using [DayOfWeek] system variables.
Aliase |
none |
Erforderlich? |
true |
Position? |
2 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByValue) |
Platzhalterzeichen akzeptieren? |
false |
-WorkHourBandwidth<UInt32>
Specifies the bandwidth throttling setting to be used to limit the network bandwidth consumed by data transfers during work hours.
Aliase |
none |
Erforderlich? |
true |
Position? |
5 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-Confirm
Fordert Sie vor der Ausführung des Cmdlet zum Bestätigen auf.
Erforderlich? |
false |
Position? |
named |
Standardwert |
false |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-WhatIf
Zeit, was passieren würde, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
Erforderlich? |
false |
Position? |
named |
Standardwert |
false |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Eingaben
Der Eingabetyp ist der Typ der Objekte, die Sie per Piping an das Cmdlet übergeben können.
- Microsoft.Internal.CloudBackup.Commands.OBMachineSetting
Ausgaben
Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.
- Microsoft.Internal.CloudBackup.Commands.OBMachineSetting
Beispiele
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