Set-OBMachineSetting

Set-OBMachineSetting

Sets a OBMachineSetting object for the server.

構文

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>]

詳細説明

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.

パラメーター

-EncryptionPassphrase<SecureString>

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

Aliases

none

必須/オプション

true

位置

2

既定値

none

パイプライン入力の受け入れ

True (ByValue)

ワイルドカード文字の受け入れ

false

-EndWorkHour<TimeSpan>

Specifies the hour that ends the work hours range.

Aliases

none

必須/オプション

true

位置

4

既定値

none

パイプライン入力の受け入れ

True (ByPropertyName)

ワイルドカード文字の受け入れ

false

-NoProxy

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

Aliases

none

必須/オプション

true

位置

2

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

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.

Aliases

none

必須/オプション

true

位置

2

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-NonWorkHourBandwidth<UInt32>

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

Aliases

none

必須/オプション

true

位置

6

既定値

none

パイプライン入力の受け入れ

True (ByPropertyName)

ワイルドカード文字の受け入れ

false

-ProxyPassword<SecureString>

Specifies authentication password to be used for proxy setting.

Aliases

none

必須/オプション

false

位置

5

既定値

none

パイプライン入力の受け入れ

True (ByPropertyName)

ワイルドカード文字の受け入れ

false

-ProxyPort<Int32>

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

Aliases

none

必須/オプション

true

位置

3

既定値

none

パイプライン入力の受け入れ

True (ByPropertyName)

ワイルドカード文字の受け入れ

false

-ProxyServer<String>

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

Aliases

none

必須/オプション

true

位置

2

既定値

none

パイプライン入力の受け入れ

True (ByValue)

ワイルドカード文字の受け入れ

false

-ProxyUsername<String>

Specifies the username to be used for proxy server authenication.

Aliases

none

必須/オプション

false

位置

4

既定値

none

パイプライン入力の受け入れ

True (ByPropertyName)

ワイルドカード文字の受け入れ

false

-StartWorkHour<TimeSpan>

Specifies the hour that starts the range of work hours.

Aliases

none

必須/オプション

true

位置

3

既定値

none

パイプライン入力の受け入れ

True (ByPropertyName)

ワイルドカード文字の受け入れ

false

-WorkDay<DayOfWeek[]>

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

Aliases

none

必須/オプション

true

位置

2

既定値

none

パイプライン入力の受け入れ

True (ByValue)

ワイルドカード文字の受け入れ

false

-WorkHourBandwidth<UInt32>

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

Aliases

none

必須/オプション

true

位置

5

既定値

none

パイプライン入力の受け入れ

True (ByPropertyName)

ワイルドカード文字の受け入れ

false

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

必須/オプション

false

位置

named

既定値

false

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

必須/オプション

false

位置

named

既定値

false

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

  • Microsoft.Internal.CloudBackup.Commands.OBMachineSetting

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

  • Microsoft.Internal.CloudBackup.Commands.OBMachineSetting

使用例

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

関連項目

ConvertTo-SecureString