System Center 2016 – Data Protection Manager の DPM 管理シェルで使用できるコマンドレット (Set-DPMCloudSubscriptionSetting) について

System Center 2016 – Data Protection Manager (DPM 2016) の DPM 管理シェルは、PowerShell を用いたコマンドライン インタフェースです。

DPM 管理シェルは、デスクトップ上のアイコン、もしくは [スタート メニュー] – [Microsoft System Center 2016] – [DPM 管理シェル] を選択、クリックすることで起動することが可能です。

DPM 2016 の管理を目的として様々なコマンドレットが DPM 管理シェルに用意されていますが、 コマンドレットのヘルプについては、日本語の情報は公開されていません。

このヘルプ情報について、「Get-Help」コマンドレットの -Full オプションを用いて実行した結果を編集、意訳しました。

この記事では、「Set-DPMCloudSubscriptionSetting」コマンドレットについて記載します (他のコマンドレットについては、「System Center 2016 – Data Protection Manager の DPM 管理シェルで使用できるコマンドレットについて」を参照)。

Set-DPMCloudSubscriptionSetting コマンドレット

名前

Set-DPMCloudSubscriptionSetting

概要

DPM サーバーの Azure Online Backup のサブスクリプション設定を更新します。

構文

Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting> [-Commit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting> [-EncryptionPassphrase] <SecureString> [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting> [-WorkDay] <DayOfWeek[]> [-StartWorkHour] <TimeSpan> [-EndWorkHour] <TimeSpan> [-WorkHourBandwidth] <UInt32> [-NonWorkHourBandwidth] <UInt32> [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting> [-NoProxy] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting> [-NoThrottle] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting> [-ProxyServer] <String> [-ProxyPort] <Int32> [[-ProxyUsername] <String>] [[-ProxyPassword] <SecureString>] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting> [-StagingAreaPath] <String> [-Confirm] [-WhatIf] [<CommonParameters>]

説明

Set-DPMCloudSubscriptionSetting コマンドレットは、System Center 2016 – Data Protection Manager (DPM) サーバーの Azure Online Backup のサブスクリプション設定を更新します。

パラメーター

-Commit <SwitchParameter>

DPM が Azure Online Backup 設定を保存する場合に指定します。

必須true
位置3
既定値なし
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

-DPMServerName [<String>]

このコマンドレットが、設定を更新する DPM サーバー名を指定します。

必須false
位置1
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-EncryptionPassphrase <SecureString>

DPM サーバーからバックアップの暗号化で使用されるパスフレーズが含まれるセキュアな文字列を指定します。

必須true
位置3
既定値なし
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

-EndWorkHour <TimeSpan>

-WorkHourBandwidth パラメーターの調整設定が有効な場合に、終了時間の範囲を指定します。このパラメーターは、-StartWorkHour パラメーターと一緒に使用します。

必須true
位置5
既定値なし
パイプライン入力を許可するTrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-NonWorkHourBandwidth <UInt32>

-StartWorkHour および -EndWorkHour パラメーターで定義されている範囲外の時間で帯域の調整設定を行う場合に指定します。

必須true
位置7
既定値なし
パイプライン入力を許可するTrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-NoProxy <SwitchParameter>

コマンドレットが、プロキシ サーバーを使用しない場合に指定します。

必須true
位置3
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-NoThrottle <SwitchParameter>

コマンドレットが、帯域幅の調整を使用しない場合に指定します。

必須true
位置3
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-ProxyPassword [<SecureString>]

プロキシ サーバーのパスワードが含まれるセキュアな文字列を指定します。

必須false
位置6
既定値なし
パイプライン入力を許可するTrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-ProxyPort <Int32>

プロキシ サーバーのポート番号を指定します。

必須true
位置4
既定値なし
パイプライン入力を許可するTrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-ProxyServer <String>

プロキシ サーバー名を指定します。

必須true
位置3
既定値なし
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

-ProxyUsername [<String>]

プロキシ サーバーにログオンするためのユーザー名を指定します。

必須false
位置1
既定値なし
パイプライン入力を許可するTrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-StagingAreaPath <String>

バックアップを最終的な場所に回復する前にダウンロードするパスを指定します。指定した場所にバックアップを保持するのに十分な空き領域があることを確認します。

必須true
位置3
既定値なし
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

-StartWorkHour <TimeSpan>

-WorkHourBandwidth パラメーターの調整設定が有効な場合に、開始時間の範囲を指定します。このパラメーターは、-EndWorkHour パラメーターと一緒に使用します。

必須true
位置4
既定値なし
パイプライン入力を許可するTrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-SubscriptionSetting <CloudSubscriptionSetting>

サブスクリプション設定が含まれる Subscription オブジェクトを指定します。Subscription オブジェクトを取得するために、Get-DPMCloudSubscription コマンドレットを用います。

必須true
位置2
既定値なし
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

-WorkDay <DayOfWeek[]>

Azure Online Backup を実行するときの週の日を指定します。

このパラメーターで利用可能な値 :

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
必須true
位置3
既定値なし
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

-WorkHourBandwidth <UInt32>

Azure Online Backup が稼働時間中に使用する帯域幅を指定します。

必須true
位置6
既定値なし
パイプライン入力を許可するTrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-Confirm [<SwitchParameter>]

コマンドレットを実行する前に確認のプロンプトを表示します。

必須false
位置named
既定値false
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-WhatIf [<SwitchParameter>]

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

必須false
位置named
既定値false
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose-Debug-ErrorAction-ErrorVariable-WarningAction-WarningVariable-OutBuffer-PipelineVariable、および -OutVariable。詳細については、about_CommonParameters を参照してください。

入力

入力の種類は、コマンドレットにパイプ可能なオブジェクトの種類です。

出力

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

例 1 : DPM サーバーの Azure Online Backup オプションを指定する

$Setting = Get-DPMCloudSubscriptionSetting -DPMServerName "TestingServer"
Set-DPMCloudSubscriptionSetting -DPMServerName "TestingServer" -SubscriptionSetting $Setting -StagingAreaPath "C:\StagingArea"
Set-DPMCloudSubscriptionSetting -DPMServerName "TestingServer" -SubscriptionSetting $Setting -NoProxy
$Passphrase = ConvertTo-SecureString -string "passphrase123456789" -AsPlainText -Force
Set-DPMCloudSubscriptionSetting -DPMServerName "TestingServer" -SubscriptionSetting $Setting -EncryptionPassphrase $Passphrase
Set-DPMCloudSubscriptionSetting -DPMServerName "TestingServer" -SubscriptionSetting $Setting -Commit

最初のコマンドは、DPM サーバー「TestingServer」のサブスクリプション設定を取得し、変数 $Setting に格納します。

2 番目のコマンドは、「TestingServer」からバックアップ用のステージング領域として「C:\StagingArea」を指定します。

3 番目のコマンドは、バックアップがプロキシ サーバーを使用しないことを指定します。

4 番目のコマンドは、文字列「passphrase123456789」をセキュアな文字列に変換、変数 $Passphrase に格納します。

5 番目のコマンドは、「TestingServer」からバックアップを暗号化するためのパスワードとして $Passphrase のセキュアな文字列を設定します。

最後のコマンドは、これまでのコマンドで設定したバックアップ オプションを保存します。

関連するリンク

  • Get-DPMCloudSubscription
  • Get-DPMCloudSubscriptionSetting

参考

DPM 2016 System Center
タイトルとURLをコピーしました