Get-ePoClientTask

NAME Get-ePoClientTask



SYNOPSIS

Gets client task information based on filter parameter.





SYNTAX

Get-ePoClientTask [[-Filter] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Gets client task information based on filter parameter. Uses the clienttask.find api command





PARAMETERS

-Filter <String>

The search string to use for finding the client task. Defaults to a space, which returns all of

the client tasks.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Can be used with to filter for a client task and then pipe the results to the Start-ePoClientTask.

Added support for -Whatif



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-ePoClientTask -Filter "Full scan - Normal Priority"



Returns information about the client task with Full scan - Normal Priority in the task name.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-ePoClientTask -Filter "scan"



Returns information about client tasks with scan in the task name.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>$UpdateClientTasks = Get-ePoClientTask -Filter "update"



$DatUpdateTask = $UpdateClientTasks | Where {$_.TaskName -like "DAT Update"}



$DatUpdateTask | Start-ePoClientTask -ComputerName "NEEDSDAT-UPDT"



First gets information about clients tasks with update in the task name and stores it in a variable.

Then filters that variable to Where-Object, for tasks with a name like DAT Update and stores it in a variable.

Finally, it pipes that variable to Start-ePoClientTask, starting the Dat update client task on the computer named

NEEDSDAT-UPDT.









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-ePoClientTask -Verbose



Gets all of the Client tasks on the ePo server.











RELATED LINKS