< Back

Stop-AMInstance

Sat Jan 11, 2020 3:43 am

NAME Stop-AMInstance



SYNOPSIS

Stops AutoMate Enterprise workflow and task instances.





SYNTAX

Stop-AMInstance [-WhatIf] [-Confirm] [<CommonParameters>]



Stop-AMInstance [-InputObject <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Stop-AMInstance stops running workflow and task instances.





PARAMETERS

-InputObject <Object>

The instances to stop.



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue)

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

Instances can be supplied on the pipeline to this function.





OUTPUTS

System.Object[]





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



PS C:\\># Stops all currently running instances



Get-AMInstance -Status Running | Stop-AMInstance











RELATED LINKS

https://github.com/AutomatePS/AutomatePS