< Back
Start-ePoClientTask
Post
NAME Start-ePoClientTask
SYNOPSIS
Starts the specified client task on specified target system.
SYNTAX
Start-ePoClientTask [-ComputerName] <String> [-TaskId] <Object> [-ProductId] <Object> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Starts the specified client task on specified target system. Requires the productId and taskId of the clienttask
to run. Uses the
clienttask.run api command.
PARAMETERS
-ComputerName <String>
The name of the computer to start the client task on.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-TaskId <Object>
The id number of the client task to run.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ProductId <Object>
The Product ID of the product to run with that task.
Required? true
Position? 3
Default value
Accept pipeline input? true (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
Added support for -Whatif
TODO: Implement script wrapping this to start a virus scan on client as soon as Malware alert is triggered.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Start-ePoClientTask -ComputerName "THATPC" -ProductId "VIRUSCAN8800" -TaskId "111"
Starts a client task for a Full Scan - Normal priority on the computer named "THATPC"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-ePoClientTask -Filter "Full scan - Normal Priority" | Start-ePoClientTask -ComputerName "THATPC"
First uses the Get-ePoClientTask function to find the correct client task and then pipes the TaskId and ProductId
to
the Start-ePoClientTask function.
RELATED LINKS
SYNOPSIS
Starts the specified client task on specified target system.
SYNTAX
Start-ePoClientTask [-ComputerName] <String> [-TaskId] <Object> [-ProductId] <Object> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Starts the specified client task on specified target system. Requires the productId and taskId of the clienttask
to run. Uses the
clienttask.run api command.
PARAMETERS
-ComputerName <String>
The name of the computer to start the client task on.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-TaskId <Object>
The id number of the client task to run.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ProductId <Object>
The Product ID of the product to run with that task.
Required? true
Position? 3
Default value
Accept pipeline input? true (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
Added support for -Whatif
TODO: Implement script wrapping this to start a virus scan on client as soon as Malware alert is triggered.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Start-ePoClientTask -ComputerName "THATPC" -ProductId "VIRUSCAN8800" -TaskId "111"
Starts a client task for a Full Scan - Normal priority on the computer named "THATPC"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-ePoClientTask -Filter "Full scan - Normal Priority" | Start-ePoClientTask -ComputerName "THATPC"
First uses the Get-ePoClientTask function to find the correct client task and then pipes the TaskId and ProductId
to
the Start-ePoClientTask function.
RELATED LINKS