Get-ScheduledJobOption
スケジュールされたジョブのジョブ オプションを取得します。
構文
Get-ScheduledJobOption
[-InputObject] <ScheduledJobDefinition>
[<CommonParameters>]
Get-ScheduledJobOption
[-Id] <Int32>
[<CommonParameters>]
Get-ScheduledJobOption
[-Name] <String>
[<CommonParameters>]
説明
Get-ScheduledJobOption
コマンドレットは、スケジュールされたジョブのジョブ オプションを取得します。 このコマンドを使用すると、ジョブ オプションを確認することや、パイプを使用してジョブ オプションを他のコマンドレットに渡すことができます。
ジョブ オプションは、スケジュールされたジョブの一部であり、ディスクに単独で保存されるわけではありません。 スケジュールされたジョブのジョブ オプションを取得するには、スケジュールされたジョブを指定します。
スケジュールされたジョブを識別するには、 Get-ScheduledJobOption
コマンドレットのパラメーターを使用します。 スケジュールされたジョブは、名前または識別番号で識別したり、Get-ScheduledJob
コマンドレットによって返されるオブジェクトなどのScheduledJobオブジェクトを入力またはパイプ処理してGet-ScheduledJobOption
できます。
Get-ScheduledJobOption
は、Windows PowerShell に含まれる PSScheduledJob モジュールのジョブ スケジューリング コマンドレットのコレクションの 1 つです。
スケジュールされたジョブの詳細については、PSScheduledJob モジュールの概要トピックを参照してください。 PSScheduledJob モジュールをインポートし、「 Get-Help about_Scheduled*
」と入力するか、 about_Scheduled_Jobsを参照してください。
このコマンドレットは、Windows PowerShell 3.0 で導入されました。
例
例 1: ジョブ オプションを取得する
この例では、指定した名前に一致するスケジュールされたジョブのジョブ オプションを取得します。
Get-ScheduledJobOption -Name "*Backup*"
例 2: すべてのジョブ オプションを取得する
この例では、ローカル コンピューター上のすべてのスケジュールされたジョブのジョブ オプションを取得します。
Get-ScheduledJob | Get-ScheduledJobOption
この例では、 Get-ScheduledJob
コマンドレットを使用して、ローカル コンピューターでスケジュールされたジョブを取得します。 パイプライン演算子 (|
) は、スケジュールされたジョブを Get-ScheduledJobOption
コマンドレットに送信し、スケジュールされた各ジョブのジョブ オプションを取得します。
例 3: 選択したジョブ オプションを取得する
この例では、特定の値でジョブ オプション オブジェクトを検索する方法を示します。
Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun}
Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun} |
ForEach-Object {$_.JobDefinition}
最初のコマンドは、RunElevated プロパティの値が $True で、 RunWithoutNetwork プロパティの値が $false
であるジョブ オプションを取得します。 出力には、選択された JobOptions オブジェクトが表示されます。
2 番目のコマンドは、ジョブ オプションが属しているスケジュールされたジョブを検索する方法を示しています。 このコマンドでは、パイプライン演算子 (|
) を使用して、選択したジョブ オプションを ForEach-Object
コマンドレットに送信します。これにより、各オプション オブジェクトの JobDefinition プロパティが取得されます。 JobDefinition プロパティには、元のジョブ オブジェクトが含まれています。
例 4: ジョブ オプションを使用して新しいジョブを作成する
この例では、新しいスケジュールされたジョブで取得 Get-ScheduledJobOption
ジョブ オプションを使用する方法を示します。
$Opts = Get-ScheduledJobOption -Name "BackupTestLogs"
Register-ScheduledJob -Name "Archive-Scripts" -FilePath "\\Srv01\Scripts\ArchiveScripts.ps1" -ScheduledJobOption $Opts
最初のコマンドでは、 Get-ScheduledJobOption
を使用して、BackupTestLogs のスケジュールされたジョブのジョブ オプションを取得します。 このコマンドは、オプションを $Opts
変数に保存します。
2 番目のコマンドでは、 Register-ScheduledJob
コマンドレットを使用して、新しいスケジュールされたジョブを作成します。
ScheduledJobOption パラメーターの値は、$Opts
変数の options オブジェクトです。
例 5: リモート コンピューターからジョブ オプションを取得する
$O = Invoke-Command -ComputerName "Srv01" -ScriptBlock {Get-ScheduledJob -Name "DataDemon" }
このコマンドは、 Invoke-Command
コマンドレットを使用して、Srv01 コンピューター上の DataDemon ジョブのスケジュールされたジョブ オプションを取得します。 このコマンドは、オプションを $O
変数に保存します。
パラメーター
-Id
スケジュールされたジョブの識別番号を指定します。 Get-ScheduledJobOption
は、指定されたスケジュールされたジョブのジョブ オプションを取得します。
ローカル コンピューターまたはリモート コンピューターでスケジュールされたジョブの識別番号を取得するには、 Get-ScheduledJob
コマンドレットを使用します。
型: | Int32 |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
スケジュールされたジョブを指定します。 ScheduledJob オブジェクトを含む変数を入力するか、Get-ScheduledJob
コマンドなどのScheduledJob オブジェクトを取得するコマンドまたは式を入力します。 ScheduledJob オブジェクトをパイプ処理してGet-ScheduledJobOption
することもできます。
型: | ScheduledJobDefinition |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
スケジュールされたジョブの名前を指定します。 Get-ScheduledJobOption
は、指定されたスケジュールされたジョブのジョブ オプションを取得します。 ワイルドカードを利用できます。
ローカル コンピューターまたはリモート コンピューターでスケジュールされたジョブの名前を取得するには、 Get-ScheduledJob
コマンドレットを使用します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
スケジュールされたジョブ オブジェクトをこのコマンドレットにパイプできます。
出力
このコマンドレットは、 ScheduledJobOptions オブジェクトを返します。
関連リンク
- 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
PowerShell