Set-ScheduledJobOption

モジュール:

PSScheduledJob

スケジュールされたジョブのジョブ オプションを変更します。

構文

Set-ScheduledJobOption
   [-InputObject] <ScheduledJobOptions>
   [-PassThru]
   [-RunElevated]
   [-HideInTaskScheduler]
   [-RestartOnIdleResume]
   [-MultipleInstancePolicy <TaskMultipleInstancePolicy>]
   [-DoNotAllowDemandStart]
   [-RequireNetwork]
   [-StopIfGoingOffIdle]
   [-WakeToRun]
   [-ContinueIfGoingOnBattery]
   [-StartIfOnBattery]
   [-IdleTimeout <TimeSpan>]
   [-IdleDuration <TimeSpan>]
   [-StartIfIdle]
   [<CommonParameters>]

説明

Set-ScheduledJobOptions コマンドレットは、スケジュールされたジョブのジョブ オプションを変更します。

スケジュールされたジョブのオプションを変更するには、まず、 Get-ScheduledJobOption コマンドレットを使用して、スケジュールされたジョブのジョブ オプションを取得します。 次に、オプションをパイプ処理して、オプションを Set-ScheduledJobOption または変数に保存し、コマンドレットの InputObject パラメーター Set-ScheduledJobOption 使用してオプションを識別します。 ジョブ オプションを変更するには、 Set-ScheduledJobOption の残りのパラメーターを使用します。

ジョブ オプションを有効にするには、そのオプションを設定するパラメーターを使用します。 オプションをオフにするには、パラメーター名、コロン (:)、および $falseを入力します。 たとえば、 RunElevated オプションをオフにするには、「 -RunElevated:$false」と入力します。

各ジョブ オプション オブジェクトには、スケジュールされたジョブを含む JobDefinition プロパティが含まれているため、ジョブ オプションが変更されると、スケジュールされたジョブとの関連付けが保持されます。

スケジュールされたジョブのオプションにより、タスク スケジューラによって開始されたジョブの実行方法が決まります。 これらのオプションは、 Start-Job コマンドレットを使用してスケジュールされたジョブを開始するときに適用されません。

Set-ScheduledJobOption は、Windows PowerShell に含まれる PSScheduledJob モジュールのジョブ スケジューリング コマンドレットのコレクションの 1 つです。

スケジュールされたジョブの詳細については、PSScheduledJob モジュールの概要トピックを参照してください。 PSScheduledJob モジュールをインポートし、「 Get-Help about_Scheduled* 」と入力するか、 about_Scheduled_Jobsを参照してください。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: ジョブ オプションを変更する

Get-ScheduledJobOption -Name "DeployPackage"

StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : False
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : False
DoNotAllowDemandStart  : False
MultipleInstancePolicy : IgnoreNew
JobDefinition          :

Get-ScheduledJobOption -Name "DeployPackage" |
    Set-ScheduledJobOption -WakeToRun -RequireNetwork:$false -Passthru

StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : True
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : True
DoNotAllowDemandStart  : False
MultipleInstancePolicy : IgnoreNewJobDefinition          :

この例では、ローカル コンピューター上のスケジュールされたジョブのオプションを変更する方法を示します。

最初のコマンドでは、 Get-ScheduledJobOption コマンドレットを使用して、DeployPackage のスケジュールされたジョブのジョブ オプションを取得します。 出力は、WakeToRun プロパティと RunElevated プロパティが $false に設定されていることを示しています。

2 番目のコマンドでは、 Set-ScheduledJobOpton コマンドレットを使用してジョブ オプションを変更し、WakeToRun プロパティと RunWithoutNetwork プロパティの値が$Trueされるようにします。 このコマンドは、 Passthru パラメーターを使用して、変更後にトリガーを返します。

このコマンドは必須ではありません。オプションの変更の結果を表示するためにのみ含まれています。

例 2: すべてのリモート・スケジュール・ジョブのオプションを変更する

Invoke-Command -Computer "Server01" -ScriptBlock {
    Get-ScheduledJob |
        Get-ScheduledJobOption |
        Set-ScheduledJobOption -IdleTimeout 2:00:00
}

このコマンドは、 IdleTimeout の値を、Server01 コンピューター上のすべてのスケジュールされたジョブで 1 時間 (既定値) から 2 時間に変更します。

このコマンドでは、 Invoke-Command コマンドレットを使用して Server01 コンピューターでコマンドを実行します。

リモート コマンドは、コンピューター上のすべてのスケジュールされたジョブを取得する Get-ScheduledJob コマンドで始まります。 スケジュールされたジョブは、スケジュールされたジョブのジョブ オプションを取得する Get-ScheduledJobOption コマンドレットにパイプされます。 各ジョブ オプション オブジェクトには、スケジュールされたジョブを含む JobDefinition プロパティが含まれているため、オプション オブジェクトは、変更された場合でも、スケジュールされたジョブに関連付けられたままになります。

ジョブ トリガーは、 Set-ScheduledJobOption コマンドレットにパイプ処理され、 IdleTimeout オプションの値が 2 時間 (2:00:00) に変更されます。

パラメーター

-ContinueIfGoingOnBattery

ジョブの実行中に、コンピューターがバッテリ電源に切り替わっても (AC 電源から切断されても)、スケジュールされたジョブを停止しません。 既定では、コンピューターが AC 電源から切断されると、スケジュールされたジョブは停止します。

ContinueIfGoingOnBattery パラメーターは、スケジュールされたジョブの StopIfGoingOnBatteries プロパティの値を$trueに設定します。

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

-DoNotAllowDemandStart

トリガーされた場合にのみ、ジョブを開始します。 ユーザーは、タスク スケジューラの実行機能などを使用して、手動でジョブを開始することはできません。

このパラメーターは、タスク スケジューラにのみ影響します。 ユーザーが Start-Job コマンドレットを使用してジョブを開始することを防ぐことはありません。

DoNotAllowDemandStart パラメーターは、スケジュールされたジョブの DoNotAllowDemandStart プロパティの値を$trueに設定します。

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

-HideInTaskScheduler

タスク スケジューラにジョブを表示しません。 この値は、ジョブが実行されるコンピューターにのみ影響します。 既定では、スケジュールされたタスクはタスク スケジューラに表示されます。

タスクが非表示の場合でも、ユーザーはタスク スケジューラの [非表示タスクの表示] オプション選択してタスクを表示できます。

HideInTaskScheduler パラメーターは、スケジュールされたジョブの ShowInTaskScheduler プロパティの値を$falseに設定します。

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

-IdleDuration

コンピューターのアイドル状態がどれだけ続いたらジョブを開始するかを指定します。 既定値は 10 分です。 IdleTimeoutの値が期限切れになる前に、指定した期間、コンピューターがアイドル状態でない場合、スケジュールされたジョブは次にスケジュールされた時刻 (ある場合) まで実行されません。

New-TimeSpan コマンドレットによって生成された timespan オブジェクトを入力するか、TimeSpan オブジェクトに自動的に変換される値を<hours>:<minutes>:<seconds>形式で入力します。

この値を有効にするには、 StartIfIdle パラメーターを使用します。 既定では、スケジュールされたジョブの StartIfNotIdle プロパティは $true に設定され、Windows PowerShell は IdleDuration および IdleTimeout 値を無視します。

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

-IdleTimeout

コンピューターのアイドル状態がどれだけ続いたらジョブを開始するかを指定します。 既定値は 10 分です。 IdleTimeoutの値が期限切れになる前に、指定した期間、コンピューターがアイドル状態でない場合、スケジュールされたジョブは次にスケジュールされた時刻 (ある場合) まで実行されません。

New-TimeSpan コマンドレットによって生成された timespan オブジェクトを入力するか、TimeSpan オブジェクトに自動的に変換される値を<hours>:<minutes>:<seconds>形式で入力します。

この値を有効にするには、 StartIfIdle パラメーターを使用します。 既定では、スケジュールされたジョブの StartIfNotIdle プロパティは $True に設定され、Windows PowerShell は IdleDuration と IdleTimeout の値を無視します。

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

-InputObject

ジョブ オプションを指定します。 ScheduledJobOptions オブジェクトを含む変数を入力するか、Get-ScheduledJobOption コマンドなどのScheduledJobOptionsオブジェクトを取得するコマンドまたは式を入力します。 ScheduledJobOptions オブジェクトをパイプ処理してSet-ScheduledJobOptionすることもできます。

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

-MultipleInstancePolicy

スケジュールされたジョブのインスタンスの実行中にそのジョブの別のインスタンスを開始する要求に対するシステムの応答方法を決定します。 このパラメーターの有効値は、次のとおりです。

• IgnoreNew - 新しいジョブ インスタンスは無視されます。 これが既定値です。
• Parallel - 新しいジョブ インスタンスが直ちに開始されます。
• Queue - 新しいジョブ インスタンスは、現在のインスタンスが完了するとすぐに開始されます。
• StopExisting - ジョブの現在のインスタンスが停止し、新しいインスタンスが開始されます。

ジョブを実行するには、ジョブ スケジュールのすべての条件を満たす必要があります。 たとえば、 RequireNetwork、 IdleDuration、および IdleTimeout パラメーターによって設定された条件が満たされていない場合、このパラメーターの値に関係なく、ジョブ インスタンスは開始されません。

型:	TaskMultipleInstancePolicy
指定可能な値:	None, IgnoreNew, Parallel, Queue, StopExisting
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PassThru

作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

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

-RequireNetwork

ネットワーク接続が利用可能な場合にのみ、スケジュールされたジョブを実行します。

このパラメーターを指定し、スケジュールされた開始時刻にネットワークが利用できない場合は、(次のスケジュールされた開始時刻が設定されていれば、それまで) ジョブは実行されません。

RequireNetwork パラメーターは、スケジュールされたジョブの RunWithoutNetwork プロパティの値を$falseに設定します。

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

-RestartOnIdleResume

コンピューターがアイドル状態になると、スケジュールされたジョブを再開します。 このパラメーターは、 StopIfGoingOffIdle パラメーターで動作します。このパラメーターは、コンピューターがアクティブになった場合 (アイドル状態を離れる) 場合に、実行中のスケジュールされたジョブを中断します。

RestartOnIdleResume パラメーターは、スケジュールされたジョブの RestartOnIdleResume プロパティの値を$trueに設定します。

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

-RunElevated

ジョブが実行されるコンピューター上の Administrators グループのメンバーのアクセス許可で、スケジュールされたジョブを実行します。

スケジュールされたジョブを管理者のアクセス許可で実行できるようにするには、Register-ScheduledJobの Credential パラメーターを使用して、ジョブの明示的な資格情報を指定します。

RunElevated パラメーターは、スケジュールされたジョブの RunElevated プロパティの値を$trueに設定します。

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

-StartIfIdle

IdleTimeout パラメーターで指定された時間が経過する前に、IdleDuration パラメーターで指定された時間、コンピューターがアイドル状態であった場合に、スケジュールされたジョブを開始します。

既定では、 IdleDuration パラメーターと IdleTimeout パラメーターは無視され、コンピューターがビジー状態であっても、スケジュールされた開始時刻にジョブが開始されます。

このパラメーターを指定し、スケジュールされた開始時刻にコンピューターがビジー状態の場合 (アイドル状態でない場合) は、(次のスケジュールされた開始時刻が設定されていれば、それまで) ジョブは実行されません。

StartIfIdle パラメーターは、スケジュールされたジョブの StartIfNotIdle プロパティの値を$falseに設定します。

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

-StartIfOnBattery

スケジュールされた開始時刻にコンピューターがバッテリで動作していても、スケジュールされたジョブを開始します。 既定値は $false です。

StartIfOnBattery パラメーターは、スケジュールされたジョブの StartIfOnBatteries プロパティの値を$trueに設定します。

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

-StopIfGoingOffIdle

ジョブの実行中に、コンピューターがアクティブになる (アイドル状態でなくなる) と、実行中のスケジュールされたジョブを中断します。

既定では、コンピューターがアクティブになったときに中断されたスケジュールされたジョブは、コンピューターが再びアイドル状態になると再開されます。 この既定の動作を変更するには、 RestartOnIdleResume パラメーターを使用します。

StopIfGoingOffIdle パラメーターは、スケジュールされたジョブの StopIfGoingOffIdle プロパティの値を$trueに設定します。

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

-WakeToRun

スケジュールされた開始時刻にコンピューターの休止状態またはスリープ状態を解除して、ジョブを実行できるようにします。 既定では、スケジュールされた開始時刻にコンピューターが休止状態またはスリープ状態の場合、ジョブは実行されません。

WakeToRun パラメーターは、スケジュールされたジョブの WakeToRun プロパティの値を$trueに設定します。

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

入力

ScheduledJobOptions

スケジュールされたジョブ オプション オブジェクトをこのコマンドレットにパイプできます。

出力

None

既定では、このコマンドレットは出力を返しません。

ScheduledJobOptions

PassThru パラメーターを使用すると、このコマンドレットは変更されたジョブ オプションを返します。

関連リンク

• Add-JobTrigger
• Disable-JobTrigger
• Disable-ScheduledJob
• Enable-JobTrigger
• Enable-ScheduledJob
• Get-JobTrigger
• Get-ScheduledJob
• Get-ScheduledJobOption
• New-JobTrigger
• New-ScheduledJobOption
• Register-ScheduledJob
• Remove-JobTrigger
• Set-JobTrigger
• Set-ScheduledJob
• Set-ScheduledJobOption
• Unregister-ScheduledJob