Get-ScheduledJobOption

  • Referência
Módulo:
PSScheduledJob

Obtém as opções de trabalho de trabalhos agendados.

Syntax

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

Description

O Get-ScheduledJobOption cmdlet obtém as opções de trabalho de trabalhos agendados. Você pode usar esse comando para examinar as opções de trabalho ou canalizar as opções de trabalho para outros cmdlets.

As opções de trabalho não são salvas no disco de forma independente; eles fazem parte de um trabalho agendado. Para obter as opções de trabalho de um trabalho agendado, especifique o trabalho agendado.

Use os parâmetros do Get-ScheduledJobOption cmdlet para identificar o trabalho agendado. Você pode identificar trabalhos agendados por seus nomes ou números de identificação, ou inserindo ou canalizando objetos ScheduledJob, como aqueles que são retornados Get-ScheduledJob pelo cmdlet, para Get-ScheduledJobOption.

Get-ScheduledJobOption é 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: Obter opções de trabalho

Este exemplo obtém as opções de trabalho de trabalhos agendados correspondentes a um nome especificado.

Get-ScheduledJobOption -Name "*Backup*"

Exemplo 2: Obter todas as opções de trabalho

Este exemplo obtém as opções de trabalho de todos os trabalhos agendados no computador local.

Get-ScheduledJob | Get-ScheduledJobOption

O exemplo usa o Get-ScheduledJob cmdlet para obter os trabalhos agendados no computador local. Um operador de pipeline (|) envia os trabalhos agendados para o Get-ScheduledJobOption cmdlet, que obtém as opções de trabalho de cada trabalho agendado.

Exemplo 3: Obter opções de trabalho selecionadas

Este exemplo mostra como localizar o objeto de opções de trabalho com valores específicos.

Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun}

Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun} |
    ForEach-Object {$_.JobDefinition}

O primeiro comando obtém opções de trabalho nas quais a propriedade RunElevated tem um valor de $True e a propriedade RunWithoutNetwork tem um valor de $false. A saída mostra o objeto JobOptions que foi selecionado.

O segundo comando mostra como encontrar a qual trabalho agendado as opções de trabalho pertencem. Este comando usa um operador de pipeline (|) para enviar as opções de trabalho selecionadas para o ForEach-Object cmdlet, que obtém a propriedade JobDefinition de cada objeto options. A propriedade JobDefinition contém o objeto de trabalho de origem.

Exemplo 4: Usar opções de trabalho para criar um novo trabalho

Este exemplo mostra como usar as opções de trabalho que Get-ScheduledJobOption entram em um novo trabalho agendado.

$Opts = Get-ScheduledJobOption -Name "BackupTestLogs"
Register-ScheduledJob -Name "Archive-Scripts" -FilePath "\\Srv01\Scripts\ArchiveScripts.ps1" -ScheduledJobOption $Opts

O primeiro comando é usado Get-ScheduledJobOption para obter as opções de trabalhos do trabalho agendado BackupTestLogs. O comando salva as opções na $Opts variável.

O segundo comando usa Register-ScheduledJob cmdlet para criar um novo trabalho agendado. O valor do parâmetro ScheduledJobOption é o objeto options na $Opts variável.

Exemplo 5: Obter opções de trabalho de um computador remoto

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

Este comando usa o Invoke-Command cmdlet para obter as opções de trabalho agendado do trabalho DataDemon no computador Srv01. O comando salva as opções na $O variável.

Parâmetros

-Id

Especifica o número de identificação de um trabalho agendado. Get-ScheduledJobOption Obtém as opções de trabalho do trabalho agendado especificado.

Para obter os números de identificação de trabalhos agendados no computador local ou em um computador remoto, use o Get-ScheduledJob cmdlet.

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

-InputObject

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

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

-Name

Especifica os nomes dos trabalhos agendados. Get-ScheduledJobOption Obtém as opções de trabalho do trabalho agendado especificado. Curingas são suportados.

Para obter os nomes de trabalhos agendados no computador local ou em um computador remoto, use o Get-ScheduledJob cmdlet.

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

Entradas

ScheduledJobDefinition

Você pode canalizar um objeto de trabalho agendado para esse cmdlet.

Saídas

ScheduledJobOptions

Este cmdlet retorna um objeto ScheduledJobOptions .