New-ScheduledTaskSettingsSet

New-ScheduledTaskSettingsSet

Creates a new scheduled task settings object.

構文

Parameter Set: NewSettings1
New-ScheduledTaskSettingsSet [-AllowStartIfOnBatteries] [-AsJob] [-CimSession <CimSession[]> ] [-Compatibility <CompatibilityEnum> ] [-DeleteExpiredTaskAfter <TimeSpan> ] [-Disable] [-DisallowDemandStart] [-DisallowHardTerminate] [-DisallowStartOnRemoteAppSession] [-DontStopIfGoingOnBatteries] [-DontStopOnIdleEnd] [-ExecutionTimeLimit <TimeSpan> ] [-Hidden] [-IdleDuration <TimeSpan> ] [-IdleWaitTimeout <TimeSpan> ] [-MaintenanceDeadline <TimeSpan> ] [-MaintenanceExclusive] [-MaintenancePeriod <TimeSpan> ] [-MultipleInstances <MultipleInstancesEnum> ] [-NetworkId <String> ] [-NetworkName <String> ] [-Priority <Int32> ] [-RestartCount <Int32> ] [-RestartInterval <TimeSpan> ] [-RestartOnIdle] [-RunOnlyIfIdle] [-RunOnlyIfNetworkAvailable] [-StartWhenAvailable] [-ThrottleLimit <Int32> ] [-WakeToRun] [ <CommonParameters>]




詳細説明

The New-ScheduledTaskSettingsSet cmdlet creates an object that contains scheduled task settings. Each scheduled task has one set of task settings. Use this cmdlet to configure options to manage the behavior of the task upon completion, to manage the behavior of the task if a problem occurs, or to manage the behavior of the task if an instance of the task is already running.

You can use the scheduled task settings to register a new scheduled task or update an existing task registration.

パラメーター

-AllowStartIfOnBatteries

Indicates that Task Scheduler starts if the computer is running on battery power.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-AsJob

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。


エイリアス

Session

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Compatibility<CompatibilityEnum>

Indicates which version of Task Scheduler with which a task is compatible. このパラメーターに対して使用できる値:
-- V1
-- Vista
-- Win7
-- Win8


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-DeleteExpiredTaskAfter<TimeSpan>

Specifies the amount of time that Task Scheduler waits before deleting the task after it expires.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Disable

Indicates that the task is disabled.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-DisallowDemandStart

Indicates that the task cannot be started by using either the Run command or the Context menu.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-DisallowHardTerminate

Indicates that the task cannot be terminated by using TerminateProcess.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-DisallowStartOnRemoteAppSession

Indicates that the task does not start if the task is triggered to run in a Remote Applications Integrated Locally (RAIL) session.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-DontStopIfGoingOnBatteries

Indicates that the task does not stop if the computer switches to battery power.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-DontStopOnIdleEnd

Indicates that Task Scheduler does not terminate the task if the idle condition ends before the task is completed.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ExecutionTimeLimit<TimeSpan>

Specifies the amount of time that Task Scheduler is allowed to complete the task.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Hidden

Indicates that the task is hidden in the Task Scheduler UI.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-IdleDuration<TimeSpan>

Specifies the amount of time that the computer must be in an idle state before Task Scheduler runs the task.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-IdleWaitTimeout<TimeSpan>

Specifies the amount of time that Task Scheduler waits for an idle condition to occur.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-MaintenanceDeadline<TimeSpan>

Specifies the amount of time after which Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task failed to complete during regular Automatic maintenance.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-MaintenanceExclusive

Indicates that the task needs to run alone when it is started in maintenance mode.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-MaintenancePeriod<TimeSpan>

Specifies the amount of time that the task needs to run once during regular Automatic maintenance.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-MultipleInstances<MultipleInstancesEnum>

Specifies the policy that defines how Task Scheduler handles multiple instances of the task.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-NetworkId<String>

Specifies the ID of a network profile that Task Scheduler uses to determine if the task can run. You must specify the ID of a network if you specify the RunOnlyIfNetworkAvailable paramater.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-NetworkName<String>

Specifies the name of a network profile that Task Scheduler uses to determine if the task can run. The Task Scheduler UI uses this setting for display purposes. Specify a network name if you specify the RunOnlyIfNetworkAvailable paramater.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Priority<Int32>

Specifies the priority level of the task. Priority must be an integer from 1 (lowest priority) to 10 (highest priority). The default value is 7.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-RestartCount<Int32>

Specifies the number of times that Task Scheduler attempts to restart the task.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-RestartInterval<TimeSpan>

Specifies the amount of time that Task Scheduler attempts to restart the task.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-RestartOnIdle

Indicates that Task Scheduler restarts the task when the computer cycles into an idle condition more than once.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-RunOnlyIfIdle

Indicates that Task Scheduler runs the task only when the computer is idle.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-RunOnlyIfNetworkAvailable

Indicates that Task Scheduler runs the task only when a network is available. Task Scheduler uses the NetworkID paramater and NetworkName parameter that you specify in this cmdlet to determine if the network is available.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-StartWhenAvailable

Indicates that Task Scheduler can start the task at any time after its scheduled time has passed.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WakeToRun

Indicates that Task Scheduler wakes the computer before it runs the task.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_TaskSettings

Example 1: Register a scheduled task that uses default task settings

This example registers a scheduled task that uses default task settings.


 

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.


PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

 

The second command creates scheduled task settings that use the default settings and assigns the ScheduledTaskSettings object to the Stset variable.


PS C:\> $STSet = New-ScheduledTaskSettingsSet

 

The third command registers the scheduled task Task01 to run the task action named Cmd and to use the default task settings.


PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $STSet

Example 2: Set the priority of a scheduled task

This example sets the priority of a scheduled task.


 

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.


PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

 

The second command creates scheduled task settings that sets a higher priority for the scheduled task, and assigns the ScheduledTaskSettings object to the Stset variable.


PS C:\> $STSet = New-ScheduledTaskSettingsSet -Priority 5

 

The third command registers the scheduled task Task01 to run the task action named Cmd and to use the task settings that have a priority setting of 9.


PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stset

Example 3: Set restart settings for a scheduled task

This example sets restart settings for a scheduled task.


 

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.


PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

 

The second command creates scheduled task settings that specify that Task Scheduler attempts three restarts of the task at sixty minute intervals. This command assigns the ScheduledTaskSettings object to the Stset variable.


PS C:\> $Stset = New-ScheduledTaskSettingsSet -RestartCount 3 -RestartInterval 60

 

The third command registers the scheduled task Task01 to run the task action named Cmd and to use the task settings that the ScheduledTaskSettings object defines.


PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stset

Example 4: Set idle settings for a scheduled task

This example sets idle settings for a scheduled task.


 

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.


PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

 

The second command creates scheduled task settings that specify that Task Scheduler runs the task only when the computer is idle for 2 minutes and waits for 2 hours and 30 minutes for an idle condition. This command assigns the ScheduledTaskSettings object to the Stset variable.


PS C:\> $Stset = New-ScheduledTaskSettingsSet -RunOnlyIfIdle -IdleDuration 00:02:00 -IdleWaitTimeout 02:30:00

 

The third command registers the scheduled task Task01 to run the task action named Cmd and to use the task settings that the ScheduledTaskSettings object defines.


PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stset

Example 5: Register a scheduled task that runs only when a network is available

This example registers a scheduled task that runs only when a network is available.


 

The first command creates a scheduled task action named Cmd and assigns the ScheduledTaskAction object to the Sta variable.


PS C:\> $Sta = New-ScheduledTaskAction -Execute "Cmd"

 

The second command creates scheduled task settings that specify that Task Scheduler runs the task only when a network is available. This command assigns the ScheduledTaskSettings object to the Stset variable.


PS C:\> $Stset = New-ScheduledTaskSettingsSet -RunOnlyIfNetworkAvailable

 

The third command registers the scheduled task Task01 to run the task action named Cmd only when a network is available.


PS C:\> Register-ScheduledTask Task01 -Action $Sta -Settings $Stset

関連トピック

コミュニティの追加

追加
表示: