Set-ScheduledJob

FilePath パラメーターで指定されたスクリプトのパラメーター、または ScriptBlock パラメーターで指定されたコマンドの値を指定します。

ユーザーの資格情報を認証するために使用するメカニズムを指定します。 このパラメーターに使用できる値は次のとおりです。

• 既定値
• ベーシック
• クレドスプ
• ダイジェスト
• Kerberos
• 交渉する
• NegotiateWithImplicitCredential（インプリシットクレデンシャルで交渉する）

既定値は Default です。 このパラメーターの値の詳細については、MSDN ライブラリ AuthenticationMechanism 列挙 を参照してください。

注意: Credential Security Support Provider (CredSSP) 認証は、ユーザーの資格情報が認証されるリモート コンピュータに渡され、リモート ネットワーク共有へのアクセスなど、複数のリソースで認証を必要とするコマンド用に設計されています。 このメカニズムにより、リモート操作のセキュリティ リスクが高まります。 リモート コンピューターが侵害された場合、それに渡される資格情報を使用してネットワーク セッションを制御できます。

スケジュールされたジョブの現在の実行履歴と保存されている結果を削除します。

ジョブの実行履歴とジョブの結果は、スケジュールされたジョブと共に、ジョブが作成されたコンピューターの $home\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs ディレクトリに保存されます。 実行履歴を表示するには、Get-Job コマンドレットを使用します。 ジョブの結果を取得するには、Receive-Job コマンドレットを使用します。

このパラメーターによって、タスク スケジューラから Windows イベント ログに書き込まれたイベントが影響を受けることはありません。また、Windows PowerShell がジョブの結果の保存を停止することもありません。 保存されるジョブ結果の数を管理するには、 MaxResultCount パラメーターを使用します。

スケジュールされたジョブを実行するアクセス許可を持つユーザー アカウントを指定します。 既定値は現在のユーザーです。

User01 や Domain01\User01 などのユーザー名を入力するか、Get-Credential コマンドレットの PSCredential オブジェクトを入力します。 ユーザー名のみを入力すると、パスワードの入力を促すメッセージが表示されます。

スケジュールされたジョブを実行するスクリプトを指定します。 ローカル コンピューター上の .ps1 ファイルへのパスを入力します。 スクリプト パラメーターの既定値を指定するには、ArgumentList パラメーターを使用します。 スケジュールされたすべてのジョブには、 ScriptBlock または FilePath 値が必要です。

Windows PowerShell スクリプト (.ps1) への完全修飾パスを指定します。 初期化スクリプトは、ScriptBlock パラメーターで指定されたコマンドまたは FilePath パラメーターで指定されたスクリプトの前に、バックグラウンド ジョブ用に作成されたセッションで実行されます。 初期化スクリプトを使用して、ファイル、関数、エイリアスの追加、ディレクトリの作成、前提条件の確認など、セッションを構成できます。

プライマリ ジョブ コマンドを実行するスクリプトを指定するには、FilePath パラメーターを使用します。

初期化スクリプトで終了しないエラーを含むエラーが生成された場合、スケジュールされたジョブの現在のインスタンスは実行されず、状態は Failed になります。

変更するスケジュールされたジョブを指定します。 ScheduledJobDefinition オブジェクトを含む変数を入力するか、Get-ScheduledJob コマンドなどの ScheduledJobDefinition オブジェクトを取得するコマンドまたは式を入力します。 また、ScheduledJobDefinition オブジェクトを Set-ScheduledJob にパイプ処理することもできます。

複数のスケジュールされたジョブを指定した場合、 Set-ScheduledJob はすべてのジョブに同じ変更を加えます。

スケジュールされたジョブに対して保持されるジョブ結果エントリの数を指定します。 既定値は 32 です。

Windows PowerShell は、スケジュールされたジョブのトリガーされた各インスタンスの実行履歴と結果をディスクに保存します。 このパラメーターの値は、このスケジュールされたジョブに対して保存されるジョブ インスタンスの結果の数を決定します。 ジョブ インスタンスの結果の数がこの値を超えると、Windows PowerShell は、最も古いジョブ インスタンスの結果を削除して、最新のジョブ インスタンスの結果を確認できます。

ジョブの実行履歴とジョブの結果は、ジョブが作成されたコンピューター上の $home\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs\<JobName>\Output\<Timestamp> ディレクトリに保存されます。 実行履歴を表示するには、Get-Job コマンドレットを使用します。 ジョブの結果を取得するには、Receive-Job コマンドレットを使用します。

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

現在の実行履歴とジョブの結果を削除するには、 ClearExecutionHistory パラメーターを使用します。

スケジュールされたジョブの新しい名前とスケジュールされたジョブのインスタンスを指定します。 名前は、ローカル コンピューター上で一意である必要があります。

変更するスケジュールされたジョブを識別するには、 InputObject パラメーターを使用するか、スケジュールされたジョブを Get-ScheduledJob から Set-ScheduledJob にパイプします。

このパラメーターによって、ディスク上のジョブ インスタンスの名前が変更されることはありません。 このコマンドが完了した後に開始されるジョブ インスタンスのみが影響を受けます。

作業中のアイテムを表すオブジェクトを返します。 既定では、このコマンドレットは出力を生成しません。

スケジュールされたジョブを 32 ビット プロセスで実行します。

ジョブを実行する頻度を指定するために使用します。 たとえば、15 分ごとにジョブを実行するには、このオプションを使用します。

Set-ScheduledJob コマンドレットが実行されるとすぐに、ジョブを開始します。 このパラメーターを使用すると、登録直後に Windows PowerShell スクリプトを実行するためにタスク スケジューラをトリガーする必要がなくなります。また、開始日時を指定するトリガーをユーザーが作成する必要はありません。

スケジュールされたジョブのオプションを設定します。 ScheduledJobOptions オブジェクト (New-ScheduledJobOption コマンドレットを使用して作成するもの、ハッシュ テーブル値など) を入力します。

スケジュールされたジョブを登録するとき、または Set-ScheduledJobOption または Set-ScheduledJob コマンドレットを使用してオプションを設定または変更するときに、スケジュールされたジョブのオプションを設定できます。

多くのオプションとその既定値によって、スケジュールされたジョブがいつ実行されるかが決まります。 ジョブをスケジュールする前に、必ずこれらのオプションを確認してください。 スケジュールされたジョブ オプションの説明 (既定値を含む) については、「New-ScheduledJobOption」を参照してください。

ハッシュ テーブルを送信するには、次のキーを使用します。 次のハッシュ テーブルでは、キーが既定値と共に表示されます。

@{# Power SettingsStartIfOnBattery=$False;StopIfGoingOnBattery=$True; WakeToRun=$False; # Idle SettingsStartIfNotIdle=$False; IdleDuration="00:10:00"; IdleTimeout="01:00:00"; StopIfGoingOffIdle=$True; RestartOnIdleResume=$False;# Security settingsShowInTaskScheduler=$TrueRunElevated=$False;# MiscRunWithoutNetwork=$False;DoNotAllowDemandStart=$False;MultipleInstancePolicy=IgnoreNew# Can be IgnoreNew, Parallel, Queue, StopExisting}

スケジュールされたジョブを実行するコマンドを指定します。 コマンドを中かっこ ( { } ) で囲み、スクリプト ブロックを作成します。 コマンド パラメーターの既定値を指定するには、ArgumentList パラメーターを使用します。

すべての Register-ScheduledJob コマンドでは、 ScriptBlock パラメーターまたは FilePath パラメーターを使用する必要があります。

スケジュールされたジョブのトリガーを指定します。 scheduledJobTrigger オブジェクト (New-JobTrigger コマンドレットが返すオブジェクトなど) またはジョブ トリガーのキーと値のハッシュ テーブルを 1 つ以上入力します。

ジョブ トリガーは、スケジュールされたジョブを、1 回限りまたは定期的なスケジュールに基づいて、またはイベントが発生したときに自動的に開始します。

ジョブ トリガーは省略可能です。 スケジュールされたジョブを作成するときにトリガーを追加したり、Add-JobTrigger または Set-ScheduledJob コマンドレットを使用して後でトリガーを追加したり、Start-Job コマンドレットを使用してスケジュールされたジョブをすぐに開始したりできます。 また、ジョブ トリガーのないスケジュールされたジョブを作成し、管理することもできます。

ハッシュ テーブルを送信するには、次のキーを使用します。

@{Frequency="Once" (or Daily, Weekly, AtStartup, AtLogon);At="3am" (または任意の有効な時刻文字列); DaysOfWeek="Monday", "Wednesday" (または曜日名の任意の組み合わせ); Interval=2 (または任意の有効な頻度間隔); RandomDelay="30minutes" (または任意の有効な期間の文字列); User="Domain1\User01" (または有効なユーザー。AtLogon の頻度値でのみ使用されます)

}