Get-ScheduledJobOption
Obtém as opções de trabalho de trabalhos agendados.
Sintaxe
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 este comando para examinar as opções de trabalho ou para direcionar as opções de trabalho para outros cmdlets.
As opções de trabalho não são salvas em disco de modo independente; elas são parte de um trabalho agendado. Para obter as opções de trabalho de um trabalho agendado, especifique esse trabalho.
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 retornados pelo Get-ScheduledJob
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 o 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 que correspondem 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 um 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 localizar a qual trabalho agendado as opções de trabalho pertencem. Esse 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 de opções. 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 usa Get-ScheduledJobOption
para obter as opções de trabalhos do trabalho agendado BackupTestLogs. O comando salva as $Opts
opções na 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" }
Esse comando usa o Invoke-Command
cmdlet para obter as opções de trabalho agendado do trabalho DataDemon no computador Srv01. O comando salva as $O
opções na 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.
Tipo: | Int32 |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | 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
Tipo: | ScheduledJobDefinition |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Name
Especifica os nomes dos trabalhos agendados. Get-ScheduledJobOption
Obtém as opções de trabalho do trabalho agendado especificado. Há suporte para caracteres curinga.
Para obter os nomes dos trabalhos agendados no computador local ou em um computador remoto, use o Get-ScheduledJob
cmdlet.
Tipo: | String |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
Entradas
Você pode canalizar um objeto de trabalho agendado para esse cmdlet.
Saídas
Esse cmdlet retorna um objeto ScheduledJobOptions .
Links Relacionados
- Add-JobTrigger
- Disable-JobTrigger
- Disable-ScheduledJob
- Enable-JobTrigger
- Enable-ScheduledJob
- Get-JobTrigger
- Get-ScheduledJob
- Get-ScheduledJobOption
- New-JobTrigger
- New-ScheduledJobOption
- Register-ScheduledJob
- Remove-JobTrigger
- Set-JobTrigger
- Set-ScheduledJob
- Set-ScheduledJobOption
- Unregister-ScheduledJob