Set-ScheduledJob

Especifica valores para os parâmetros do script especificado pelo parâmetro FilePath ou para o comando especificado pelo parâmetro ScriptBlock .

Especifica o mecanismo usado para autenticar as credenciais do usuário. Os valores aceitáveis para esse parâmetro são:

• Default
• Basic
• Credssp
• Digest
• Kerberos
• Negotiate
• NegotiateWithImplicitCredential

O valor padrão é Default. Para obter mais informações sobre os valores desse parâmetro, consulte Enumeração AuthenticationMechanism no SDK do PowerShell.

Exclui o histórico de execução atual e os resultados salvos do trabalho agendado.

O histórico de execução do trabalho e os resultados do trabalho são salvos com o trabalho agendado $HOME\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs no diretório do computador em que o trabalho é criado. Para ver o histórico de execução, use o Get-Job cmdlet. Para obter os resultados do trabalho, use o Receive-Job cmdlet.

Esse parâmetro não afeta os eventos que o Agendador de tarefas grava nos logs de eventos do Windows e não impede que o Windows PowerShell salve os resultados do trabalho. Para gerenciar o número de resultados de trabalho salvos, use o parâmetro MaxResultCount .

Especifica uma conta de usuário que tenha permissão para executar o trabalho agendado. O padrão é o usuário atual.

Digite um nome de usuário, como User01 ou Domain01\User01, ou insira um objeto PSCredential , como um do Get-Credential cmdlet. Se você inserir apenas um nome de usuário, uma senha será solicitada.

Especifica um script que o trabalho agendado executa. Insira o caminho para um arquivo .ps1 no computador local. Para especificar valores padrão para os parâmetros de script, use o parâmetro ArgumentList . Cada trabalho agendado deve ter um valor ScriptBlock ou FilePath .

Especifica o caminho totalmente qualificado para um script do Windows PowerShell (.ps1). O script de inicialização é executado na sessão criada para o trabalho em segundo plano antes dos comandos especificados pelo parâmetro ScriptBlock ou pelo script especificado pelo parâmetro FilePath . Você pode usar o script de inicialização para configurar a sessão, adicionando arquivos, funções ou aliases, criando diretórios ou verificando pré-requisitos.

Para especificar um script que executa os comandos de trabalho primários, use o parâmetro FilePath .

Se o script de inicialização gerar um erro, incluindo um erro de não encerramento, a instância atual do trabalho agendado não será executada e seu status será Failed.

Especifica o trabalho agendado a ser alterado. Insira uma variável que contenha objetos ScheduledJobDefinition ou digite um comando ou expressão que obtenha objetos ScheduledJobDefinition , como um Get-ScheduledJob comando. Você também pode canalizar um objeto ScheduledJobDefinition para Set-ScheduledJob.

Se você especificar vários trabalhos agendados, Set-ScheduledJob o fará as mesmas alterações em todos os trabalhos.

Especifica quantas entradas de resultado do trabalho são mantidas para o trabalho agendado. O valor padrão é 32.

O Windows PowerShell salva o histórico de execução e os resultados de cada instância disparada do trabalho agendado no disco. O valor desse parâmetro determina o número de resultados de instância de trabalho que são salvas para essa tarefa agendada. Quando o número de resultados de instância de trabalho excede esse valor, o Windows PowerShell exclui os resultados da instância de trabalho mais antiga para abrir espaço para os resultados da instância de trabalho mais recente.

O histórico de execução do trabalho e os resultados do trabalho são salvos no $HOME\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs\<JobName>\Output\<Timestamp> diretórios no computador no qual o trabalho é criado. Para ver o histórico de execução, use o Get-Job cmdlet. Para obter os resultados do trabalho, use o Receive-Job cmdlet.

O parâmetro MaxResultCount define o valor da propriedade ExecutionHistoryLength do trabalho agendado.

Para excluir o histórico de execução atual e os resultados do trabalho, use o parâmetro ClearExecutionHistory .

Especifica um novo nome para o trabalho agendado e instâncias do trabalho agendado. O nome deve ser exclusivo no computador local.

Para identificar o trabalho agendado a ser alterado, use o parâmetro InputObject ou canalize um trabalho agendado de Get-ScheduledJob para .Set-ScheduledJob

Esse parâmetro não altera os nomes das instâncias de trabalho em disco. Ele afeta somente instâncias de trabalho que foram iniciadas após a conclusão do comando.

Retorna um objeto que representa o item com que você está trabalhando. Por padrão, este cmdlet não gera saída.

Executa o trabalho agendado em um processo de 32 bits.

Usado para especificar a frequência de execução do trabalho. Por exemplo, use essa opção para executar um trabalho a cada 15 minutos.

Inicia um trabalho imediatamente, assim que o Set-ScheduledJob cmdlet é executado. Esse parâmetro elimina a necessidade de disparar o Agendador de tarefas para executar um script do Windows PowerShell imediatamente após o registro e não exige que os usuários criem um disparador que especifica a data e a hora de início.

Define opções para o trabalho agendado. Insira um objeto ScheduledJobOptions , como um que você cria usando o New-ScheduledJobOption cmdlet, ou um valor de tabela de hash.

Você pode definir opções para um trabalho agendado ao registrar o trabalho agendado ou usar os Set-ScheduledJobOption cmdlets ou Set-ScheduledJob para definir ou alterar opções.

Muitas das opções e seus valores padrão determinam se e quando um trabalho agendado será executado. Certifique-se de examinar essas opções antes de agendar um trabalho. Para obter uma descrição das opções de trabalho agendado, incluindo os valores padrão, consulte New-ScheduledJobOption.

Para enviar uma tabela de hash, use as seguintes chaves. Na tabela de hash a seguir, as chaves são exibidas com seus valores padrão.

@{# 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}

Especifica os comandos que o trabalho agendado executa. Coloque os comandos entre chaves ({}) para criar um bloco de script. Para especificar valores padrão para parâmetros de comando, use o parâmetro ArgumentList .

Cada Register-ScheduledJob comando deve usar os parâmetros ScriptBlock ou FilePath .

Especifica os gatilhos para o trabalho agendado. Insira um ou mais objetos ScheduledJobTrigger , como os objetos que o New-JobTrigger cmdlet retorna ou uma tabela de hash de chaves e valores de gatilho de trabalho.

Um gatilho de trabalho inicia um trabalho agendado automaticamente em um agendamento único ou recorrente ou quando ocorre um evento.

Disparadores de trabalho são opcionais. Você pode adicionar um gatilho ao criar o trabalho agendado, usar os Add-JobTrigger cmdlets ou Set-ScheduledJob para adicionar gatilhos posteriormente ou usar o Start-Job cmdlet para iniciar o trabalho agendado imediatamente. Você também pode criar e manter um trabalho agendado sem nenhum disparador de trabalho.

Para enviar uma tabela de hash, use as seguintes chaves.

@{Frequency="Once" (or Daily, Weekly, AtStartup, AtLogon);At="3am" (ou qualquer sequência de tempo válida); DaysOfWeek="Monday", "Wednesday" (ou qualquer combinação de nomes de dias); Interval=2 (ou qualquer intervalo de frequência válido); RandomDelay="30minutes" (ou qualquer string de intervalo de tempo válida); User="Domain1\User01" (ou qualquer usuário válido; usado apenas com o valor de frequência AtLogon)

}