Start-AMTask

NAME Start-AMTask



SYNOPSIS

Starts AutoMate Enterprise tasks.





SYNTAX

Start-AMTask -InputObject <Object> [-Agent <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]



Start-AMTask -InputObject <Object> [-AgentGroup <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Start-AMTask starts tasks.





PARAMETERS

-InputObject <Object>

The tasks to start.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Agent <Object>

The agent to run the task on.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AgentGroup <Object>

The agent group to run the task on.



Required? false

Position? named

Default value

Accept pipeline input? false

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

Tasks can be supplied on the pipeline to this function.





OUTPUTS

System.Object[]





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



PS C:\\># Starts task "My Task" on agent "agent01"



Get-AMTask "My Task" | Start-AMTask -Agent "agent01"











RELATED LINKS

https://github.com/AutomatePS/AutomatePS