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
参考
- Data Protection Manager Cmdlets
https://technet.microsoft.com/en-us/library/hh881730(v=sc.30).aspx - Set-DPMCloudSubscriptionSetting
https://technet.microsoft.com/en-us/library/jj612791(v=sc.30).aspx