Get-AMSystemAgent

NAME Get-AMSystemAgent



SYNOPSIS

Gets AutoMate Enterprise system agent types.





SYNTAX

Get-AMSystemAgent [-Connection <Object>] [<CommonParameters>]



Get-AMSystemAgent [-ID <String>] [-Connection <Object>] [<CommonParameters>]



Get-AMSystemAgent [-Type <String>] [-Connection <Object>] [<CommonParameters>]





DESCRIPTION

Get-AMSystemAgent returns a list of system agent types and their IDs.





PARAMETERS

-ID <String>

The ID of the system agent.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Type <String>

The type of system agent to return.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Object>

The AutoMate Enterprise management server.



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

System.Object[]





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



PS C:\\># Get the default system agent



Get-AMSystemAgent -Type Default









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



PS C:\\># Get workflows that use "Previous Agent"



Get-AMSystemAgent -Type Previous | Get-AMWorkflow











RELATED LINKS

https://github.com/AutomatePS/AutomatePS