Поделиться через

Get-ScheduledJobOption

  • Ссылка
Модуль:
PSScheduledJob

Возвращает параметры задания запланированных заданий.

Синтаксис

Get-ScheduledJobOption
   [-InputObject] <ScheduledJobDefinition>
   [<CommonParameters>]
Get-ScheduledJobOption
   [-Id] <Int32>
   [<CommonParameters>]
Get-ScheduledJobOption
   [-Name] <String>
   [<CommonParameters>]

Описание

Командлет Get-ScheduledJobOption получает параметры задания запланированных заданий. Эту команду можно использовать для проверки параметров задания или передачи параметров задания другим командлетам.

Параметры задания не сохраняются на диске независимо; они являются частью запланированного задания. Чтобы получить параметры задания запланированного задания, укажите запланированное задание.

Используйте параметры командлета Get-ScheduledJobOption для идентификации запланированного задания. Вы можете определить запланированные задания по их именам или идентификаторам, а также путем ввода или отправки объектов ScheduledJob, таких как те, которые возвращаются командлетом Get-ScheduledJob, для Get-ScheduledJobOption.

Get-ScheduledJobOption является одной из коллекций командлетов планирования заданий в модуле PSScheduledJob, включенном в Windows PowerShell.

Дополнительные сведения о запланированных заданиях см. в разделах "Сведения" в модуле 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.

Вторая команда показывает, как найти запланированное задание, к которому относятся параметры задания. Эта команда использует оператор конвейера (|) для отправки выбранных параметров задания командлету 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.

Вторая команда использует командлет Register-ScheduledJob для создания нового запланированного задания. Значение параметра ScheduledJobOption является объектом параметров в переменной $Opts.

Пример 5. Получение параметров задания с удаленного компьютера

$O = Invoke-Command -ComputerName "Srv01" -ScriptBlock {Get-ScheduledJob -Name "DataDemon" }

Эта команда использует командлет Invoke-Command для получения параметров запланированного задания задания DataDemon на компьютере Srv01. Команда сохраняет параметры в переменной $O.

Параметры

-Id

Указывает идентификационный номер запланированного задания. Get-ScheduledJobOption получает параметры задания указанного запланированного задания.

Чтобы получить идентификационные номера запланированных заданий на локальном компьютере или удаленном компьютере, используйте командлет Get-ScheduledJob.

Тип:Int32
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-InputObject

Указывает запланированное задание. Введите переменную, содержащую объект ScheduledJob или введите команду или выражение, которое получает объект ScheduledJob, например команду Get-ScheduledJob. Можно также передать объект ScheduledJob в Get-ScheduledJobOption.

Тип:ScheduledJobDefinition
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Name

Задает имена запланированных заданий. Get-ScheduledJobOption получает параметры задания указанного запланированного задания. Поддерживаются подстановочные знаки.

Чтобы получить имена запланированных заданий на локальном компьютере или удаленном компьютере, используйте командлет Get-ScheduledJob.

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

Входные данные

ScheduledJobDefinition

Вы можете передать объект запланированного задания в этот командлет.

Выходные данные

ScheduledJobOptions

Этот командлет возвращает объект scheduledJobOptions.