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 — одна из коллекций командлетов планирования заданий в модуле PSScheduledJob, включенном в Windows PowerShell.

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

Вторая команда использует Set-ScheduledJobOpton командлет для изменения параметров задания, поэтому значения свойств WakeToRun и RunWithoutNetwork $True. Команда использует параметр PassThru для возврата триггера после изменения.

Эта команда не является обязательной, она включена только для того, чтобы показать эффект изменения параметров.

Пример 2. Изменение параметра для всех удаленных запланированных заданий

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

Эта команда изменяет значение IdleTimeout с одного часа (значение по умолчанию) на два часа для всех запланированных заданий на компьютере Server01.

Команда использует Invoke-Command командлет для выполнения команды на компьютере Server01.

Удаленная команда начинается с Get-ScheduledJob команды, которая получает все запланированные задания на компьютере. Запланированные задания передаются Get-ScheduledJobOption командлету, который получает параметры задания запланированных заданий. Каждый объект параметров задания содержит свойство JobDefinition, содержащее запланированное задание, поэтому объект параметров остается связанным с запланированным заданием даже при изменении.

Триггеры задания передаются Set-ScheduledJobOption в командлет, который изменяет значение параметра IdleTimeout на два часа (2:00:00).

Параметры

-ContinueIfGoingOnBattery

Не останавливайте запланированное задание, если компьютер переключается на питание от батареи (отключается от электросети) во время выполнения этого задания. По умолчанию запланированные задания останавливаются при отключении компьютера от электросети.

Параметр ContinueIfGoingOnBattery задает значение свойства StopIfGoingOnBatteries запланированных заданий $true.

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

-DoNotAllowDemandStart

Запускайте задание только при его активации. Пользователи не могут запускать задание вручную, например с помощью функции запуска компонентов в планировщике заданий.

Этот параметр влияет только на планировщик. Он не запрещает пользователям использовать Start-Job командлет для запуска задания.

Параметр DoNotAllowDemandStart задает значение свойства DoNotAllowDemandStart запланированных заданий$true.

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

-HideInTaskScheduler

Не отображайте задание в планировщике заданий. Это значение затрагивает только компьютер, на котором выполняется задание. По умолчанию запланированные задачи отображаются в планировщике заданий.

Даже если задача скрыта, пользователи могут отобразить задачу, выбрав параметр "Показать скрытые задачи " в планировщике задач.

Параметр HideInTaskScheduler задает значение свойства ShowInTaskScheduler запланированных заданий$false.

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

-IdleDuration

Указывает, как долго компьютер должен простаивать перед запуском задания. Значение по умолчанию равно 10 минутам. Если компьютер неактивен в течение указанной длительности до истечения срока действия idleTimeout , запланированное задание не запускается до следующего запланированного времени, если таковой имеется.

Введите объект timepan, например один, созданный New-TimeSpan командлетом, или введите значение в формате, который автоматически преобразуется в <hours>:<minutes>:<seconds> объект TimeSpan.

Чтобы включить это значение, используйте параметр StartIfIdle . По умолчанию для свойства StartIfNotIdle запланированных заданий задано $true значение, а Windows PowerShell игнорирует значения IdleDuration и IdleTimeout .

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

-IdleTimeout

Чтобы включить это значение, используйте параметр StartIfIdle . По умолчанию свойство StartIfNotIdle запланированных заданий имеет значение $True, а Windows PowerShell игнорирует значения IdleDuration и IdleTimeout .

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

-InputObject

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

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

-MultipleInstancePolicy

Определяет, как система реагирует на запрос о запуске экземпляра запланированного задания во время выполнения другого экземпляра этого задания. Допустимые значения для этого параметра:

IgnoreNew — Новый экземпляр задания игнорируется. Это значение по умолчанию.
Parallel — новый экземпляр задания запускается немедленно.
Queue — новый экземпляр задания начинается сразу после завершения текущего экземпляра.
StopExisting — Текущий экземпляр остановки задания и запуск нового экземпляра.

Чтобы запустить задание, должны быть выполнены все условия для расписания задания. Например, если условия, заданные параметрами RequireNetwork, IdleDuration и IdleTimeout , не удовлетворяются, экземпляр задания не запускается независимо от значения этого параметра.

Тип:	TaskMultipleInstancePolicy
Допустимые значения:	None, IgnoreNew, Parallel, Queue, StopExisting
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-PassThru

Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные.

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

-RequireNetwork

Запускает запланированное задание только при наличии доступных сетевых подключений.

Если указать этот параметр и в запланированное время запуска задания сеть будет недоступна, задание не запускается до следующего запланированного времени запуска, если такое имеется.

Параметр RequireNetwork задает значение свойства RunWithoutNetwork запланированных заданий $false.

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

-RestartOnIdleResume

Перезапускает запланированное задание, если компьютер переходит в состояние простоя. Этот параметр работает с параметром StopIfGoingOffIdle , который приостанавливает выполнение запланированного задания, если компьютер становится активным (оставляет состояние простоя).

Параметр RestartOnIdleResume задает значение свойства RestartOnIdleResume запланированных заданий$true.

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

-RunElevated

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

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

Параметр RunElevated задает значение свойства RunElevated запланированных заданий $true.

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

-StartIfIdle

Запускает запланированное задание, если компьютер был неактивным в течение времени, указанного параметром IdleDuration до истечения срока действия параметра IdleTimeout .

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

Если указать этот параметр и в запланированное время запуска задания компьютер будет занят (не будет простаивать), задание не запускается до следующего запланированного времени запуска, если такое имеется.

Параметр StartIfIdle задает значение свойства StartIfNotIdle запланированных заданий$false.

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

-StartIfOnBattery

Запускает запланированное задание, даже если в запланированное время запуска компьютер работает от батарей. Значение по умолчанию — $false.

Параметр StartIfOnBattery задает значение свойства StartIfOnBatteries запланированных заданий $true.

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

-StopIfGoingOffIdle

Приостанавливает выполнение запланированного задания, если компьютер становится активным (выходит из режима простоя) во время выполнения задания.

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

Параметр StopIfGoingOffIdle задает значение свойства StopIfGoingOffIdle запланированных заданий $true.

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

-WakeToRun

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

Параметр WakeToRun задает значение свойства WakeToRun запланированных заданий $true.

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

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

ScheduledJobOptions

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

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

None

По умолчанию этот командлет не возвращает выходные данные.

ScheduledJobOptions

При использовании параметра PassThru этот командлет возвращает параметры задания, которые были изменены.

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

Set-ScheduledJobOption

Синтаксис

Описание

Примеры

Пример 1. Изменение параметров задания

Пример 2. Изменение параметра для всех удаленных запланированных заданий

Параметры

-ContinueIfGoingOnBattery

-DoNotAllowDemandStart

-HideInTaskScheduler

-IdleDuration

-IdleTimeout

-InputObject

-MultipleInstancePolicy

-PassThru

-RequireNetwork

-RestartOnIdleResume

-RunElevated

-StartIfIdle

-StartIfOnBattery

-StopIfGoingOffIdle

-WakeToRun

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

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

Дополнительные ресурсы

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

Set-ScheduledJobOption

Синтаксис

Описание

Примеры

Пример 1. Изменение параметров задания

Пример 2. Изменение параметра для всех удаленных запланированных заданий

Параметры

-ContinueIfGoingOnBattery

-DoNotAllowDemandStart

-HideInTaskScheduler

-IdleDuration

-IdleTimeout

-InputObject

-MultipleInstancePolicy

-PassThru

-RequireNetwork

-RestartOnIdleResume

-RunElevated

-StartIfIdle

-StartIfOnBattery

-StopIfGoingOffIdle

-WakeToRun

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

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

Связанные ссылки

Дополнительные ресурсы