< Back

Start-AMProcess

Sat Jan 11, 2020 3:42 am

NAME Start-AMProcess



SYNOPSIS

Starts AutoMate Enterprise processes.





SYNTAX

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



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





DESCRIPTION

Start-AMProcess starts processes.





PARAMETERS

-InputObject <Object>

The processes to start.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Agent <Object>

The agent to run the process on.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AgentGroup <Object>

The agent group to run the process 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

Processes can be supplied on the pipeline to this function.





OUTPUTS

System.Object[]





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



PS C:\\># Starts process "My Process" on agent "agent01"



Get-AMProcess "My Process" | Start-AMProcess -Agent "agent01"











RELATED LINKS

https://github.com/AutomatePS/AutomatePS