次の方法で共有

Set-SCExternalJob

  • リファレンス
モジュール:
VirtualMachineManager

既存の外部ジョブを更新します。

構文

Set-SCExternalJob
   [-Job] <Task>
   -ProgressValue <Int32>
   [<CommonParameters>]
Set-SCExternalJob
   [-Job] <Task>
   [-Completed]
   [-InfoMessage <String>]
   [<CommonParameters>]
Set-SCExternalJob
   [-Job] <Task>
   [-Failed]
   -InfoMessage <String>
   [<CommonParameters>]

説明

Set-SCExternalJob コマンドレットは、Virtual Machine Manager (VMM) の既存の外部ジョブを更新します。 ジョブの達成率を更新するか、ジョブの状態を完了または失敗に設定できます。

外部ジョブの詳細については、new-SCExternalJob コマンドレット を参照してください。

例

例 1: 外部ジョブを 15% 完了に設定する

PS C:\> $ExternalJob = Get-SCJob -Name "ExternalJob01"
PS C:\> Set-SCExternalJob -Job $ExternalJob -ProgressValue 15

最初のコマンドは、ExternalJob01 という名前の外部ジョブ オブジェクトを取得し、そのオブジェクトを $ExternalJob 変数に格納します。

2 番目のコマンドは、$ExternalJobに格納されているジョブの進行状況の値を 15 に設定します。

例 2: 外部ジョブを完了に設定する

PS C:\> $ExternalJob = Get-SCJob -Name "ExternalJob02"
PS C:\> Set-SCExternalJob -Job $ExternalJob -Completed -InfoMessage "Some information about the completed job"

最初のコマンドは、ExternalJob02 という名前の外部ジョブ オブジェクトを取得し、そのオブジェクトを $ExternalJob 変数に格納します。

2 番目のコマンドは、$ExternalJobに格納されているジョブの状態を完了に設定し、ジョブに関する情報を追加します。

例 3: 外部ジョブを失敗に設定する

PS C:\> $ExternalJob = Get-SCJob -Name "ExternalJob03"
PS C:\> Set-SCExternalJob -Job $ExternalJob -Failed -InfoMessage "An error message for the failed job"

最初のコマンドは、ExternalJob03 という名前の外部ジョブ オブジェクトを取得し、そのオブジェクトを $ExternalJob 変数に格納します。

2 番目のコマンドは、$ExternalJobに格納されているジョブの状態を失敗に設定し、ジョブに関する情報を追加します。

パラメーター

-Completed

外部ジョブの状態を完了に設定します。

型:SwitchParameter
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Failed

外部ジョブの状態を失敗に設定します。

型:SwitchParameter
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InfoMessage

外部ジョブの情報メッセージを提供します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Job

VMM ジョブ オブジェクトを指定します。

型:Task
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ProgressValue

外部ジョブの進行状況の達成率を指定します。

型:Int32
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

出力

Task

このコマンドレットは、Task オブジェクトを返します。