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

スポンサーリンク

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

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

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

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

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

Stop-DPMJob コマンドレット

名前

Stop-DPMJob

概要

DPM ジョブを停止します。

構文

Stop-DPMJob [-Job] <Job[]> [-Confirm] [-WhatIf] [<CommonParameters>]

Stop-DPMJob [-Task] <Task[]> [-Confirm] [-WhatIf] [<CommonParameters>]

説明

Stop-DPMJob コマンドレットは、System Center 2016 – Data Protection Manager (DPM) で実行するジョブを停止します。

パラメーター

-Job <Job[]>

このコマンドレットが、停止するジョブの配列を指定します。Job オブジェクトを取得するために、Get-DPMJob コマンドレットを用います。

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

-Task <Task[]>

タスク オブジェクトの配列を指定します。

必須true
位置1
既定値なし
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可する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 ジョブを停止する

$PGroup = Get-DPMProtectionGroup -DPMServerName "Contoso-DPMServer"
$Jobs = Get-DPMJob -ProtectionGroup $PGroup -Status InProgress
Stop-DPMJob -Job $Jobs

最初のコマンドは、Get-DPMProtectionGroup コマンドレットを用いて DPM サーバー「Contoso-DPMServer」の保護グループを取得し、変数 $PGroup に格納します。

2 番目のコマンドは、Get-DPMJob コマンドレットを用いて保護グループで実行中のジョブを取得、変数 $Jobs に格納します。

3 番目のコマンドは、$Job に格納されたジョブを停止します。

関連するリンク

  • Get-DPMJob
  • Get-DPMProtectionGroup
  • Restart-DPMJob

参考