Disable-ScheduledJob

  • Referência
Módulo:
PSScheduledJob

Desabilita um trabalho agendado.

Syntax

Disable-ScheduledJob
       [-InputObject] <ScheduledJobDefinition>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-ScheduledJob
       [-Id] <Int32>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-ScheduledJob
       [-Name] <String>
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

O Disable-ScheduledJob cmdlet desabilita temporariamente trabalhos agendados. A desativação preserva todas as propriedades do trabalho e não desabilita os gatilhos do trabalho, mas impede que os trabalhos agendados sejam iniciados automaticamente quando acionados. Você pode iniciar um trabalho agendado desabilitado usando o cmdlet ou usar um trabalho agendado desabilitado Start-Job como modelo.

Para desabilitar um trabalho agendado, o Disable-ScheduledJob cmdlet define a propriedade Enabled do trabalho agendado como False. Para reativar o trabalho agendado, use o Enable-ScheduledJob cmdlet.

Disable-ScheduledJob é um de uma coleção de cmdlets de agendamento de trabalho no módulo PSScheduledJob incluído no Windows PowerShell.

Para obter mais informações sobre trabalhos agendados, consulte os tópicos Sobre no módulo PSScheduledJob. Importe o módulo PSScheduledJob e digite: Get-Help about_Scheduled* ou consulte about_Scheduled_Jobs.

Este cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: Desativar um trabalho agendado

Este exemplo desabilita um trabalho agendado no computador local.

Disable-ScheduledJob -ID 2 -Passthru

Este comando desativa o trabalho agendado com ID 2 no computador local.

Exemplo 2: Desativar todos os trabalhos agendados

Este exemplo desabilita todos os trabalhos agendados no computador local.

Get-ScheduledJob | Disable-ScheduledJob -Passthru

Id         Name            Triggers        Command                                  Enabled
--         ----            --------        -------                                  -------
1          ArchiveProje... {}              C:\Scripts\Archive-DxProjects.ps1        False
2          Inventory       {1, 2}          \\Srv01\Scripts\Get-FullInventory.ps1    False
4          Test-HelpFiles  {1}             .\Test-HelpFiles.ps1                     False
5          TestJob         {1, 2}          .\Run-AllTests.ps1                       False

O Get-ScheduledJob cmdlet para obter todos os trabalhos agendados e canaliza-os para o Disable-ScheduledJob cmdlet para desativá-los.

Você pode reativar o trabalho agendado usando o Enable-ScheduledJob cmdlet e executar um trabalho agendado desabilitado usando o Start-Job cmdlet.

Disable-ScheduledJob não gera avisos ou erros se você desabilitar um trabalho agendado que já está desativado, para que você possa desabilitar todos os trabalhos agendados sem condições.

Exemplo 3: Desativar trabalhos agendados selecionados

Este exemplo desabilita o trabalho agendado não inclui uma credencial.

Get-ScheduledJob | Where-Object {!$_.Credential} | Disable-ScheduledJob

Os trabalhos sem credenciais são executados com a permissão do usuário que os criou.

O comando usa o Get-ScheduledJob cmdlet para obter todos os trabalhos agendados no computador. Um operador de pipeline envia os trabalhos agendados para o Where-Object cmdlet, que seleciona os trabalhos agendados que não têm credenciais. O comando usa o operador not (!) e faz referência à propriedade Credential do trabalho agendado. Outro operador de pipeline envia os trabalhos agendados selecionados para o cmdlet, o Disable-ScheduledJob que os desabilita.

Exemplo 4: Desativar trabalhos agendados em um computador remoto

Este exemplo desabilita um trabalho agendado em dois computadores remotos.

Invoke-Command -ComputerName Srv01, Srv10 -ScriptBlock {Disable-ScheduledJob -Name TestJob}

O comando usa o Invoke-Command cmdlet para executar um Disable-ScheduledJob comando nos computadores Srv01 e Srv10. O comando usa o parâmetro Name de Disable-ScheduledJob para selecionar o trabalho agendado TestJob em cada computador.

Exemplo 5: Desabilitar um trabalho agendado por sua ID global

Este exemplo mostra como desabilitar um trabalho agendado usando seu identificador global. O valor da propriedade GlobalID de um trabalho agendado é um identificador exclusivo (GUID). Use o valor GlobalID quando a precisão for necessária, como quando você estiver desabilitando trabalhos agendados em vários computadores.

Get-ScheduledJob | Format-Table -Property Name, GlobalID, Command -Autosize

Name             GlobalId                             Command
----             --------                             -------
ArchiveProjects1 a26a0b3d-b4e6-44d3-8b95-8706ef621f7c C:\Scripts\Archive-DxProjects.ps1
Inventory        3ac37e5d-84c0-4a8f-9661-7e88ebb8f914 \\Srv01\Scripts\Get-FullInventory.ps1
Backup-Scripts   4d0cc6be-c082-48d1-baec-1bd8278f3c81  Copy-Item C:\CurrentScripts\*.ps1 -Destination C:\BackupScripts
Test-HelpFiles   d77020ca-f20d-42be-86c8-fc64df97db90 .\Test-HelpFiles.ps1
Test-HelpFiles   2f1606d2-c6cf-4bef-8b1c-ae36a9cc9934 .\Test-DomainHelpFiles.ps1

Get-ScheduledJob | Where-Object {$_.GlobalID = d77020ca-f20d-42be-86c8-fc64df97db90} | Disable-ScheduledJob

O primeiro comando demonstra uma maneira de encontrar o GlobalID de um trabalho agendado. O comando usa o Get-ScheduledJob cmdlet para obter os trabalhos agendados no computador. Um operador de pipeline (|) envia os trabalhos agendados para o Format-Table cmdlet, que exibe as propriedades Name, GlobalID e Command de cada trabalho em uma tabela.

O segundo comando usa o Get-ScheduledJob cmdlet para obter os trabalhos agendados no computador. Um operador de pipeline (|) envia os trabalhos agendados para o Where-Object cmdlet, que seleciona o trabalho agendado com a ID global especificada. Outro operador de pipeline envia o trabalho para o cmdlet, que Disable-ScheduledJob o desabilita.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Desabilita o trabalho agendado com o número de identificação (ID) especificado. Insira o ID de um trabalho agendado.

Type:Int32
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Especifica o trabalho agendado a ser desabilitado. 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 Disable-ScheduledJob.

Type:Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Desabilita os trabalhos agendados com os nomes especificados. Insira o nome de um trabalho agendado. Curingas são suportados.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

Você pode canalizar um trabalho agendado para Disable-ScheduledJob.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

Quando você usa o parâmetro PassThru , esse cmdlet retorna o trabalho agendado que está desabilitado.

Notas

  • Disable-ScheduledJob não gera avisos ou erros se você usá-lo para desativar um trabalho agendado que já está desativado.