Get-AMAgent

NAME Get-AMAgent



SYNOPSIS

Gets AutoMate Enterprise agents.





SYNTAX

Get-AMAgent [[-Name] <String>] [-Type {Unknown | TaskAgent | ProcessAgent | All}] [-FilterSet <Hashtable[]>]

[-FilterSetMode <String>] [-SortProperty <String[]>] [-SortDescending] [-Connection <Object>] [<CommonParameters>]



Get-AMAgent [-InputObject <Object>] [[-Name] <String>] [-Type {Unknown | TaskAgent | ProcessAgent | All}]

[-FilterSet <Hashtable[]>] [-FilterSetMode <String>] [-SortProperty <String[]>] [-SortDescending] [-Connection

<Object>] [<CommonParameters>]



Get-AMAgent [[-Name] <String>] [-ID <String>] [-Type {Unknown | TaskAgent | ProcessAgent | All}] [-FilterSet

<Hashtable[]>] [-FilterSetMode <String>] [-SortProperty <String[]>] [-SortDescending] [-Connection <Object>]

[<CommonParameters>]





DESCRIPTION

Get-AMAgent gets agent objects from AutoMate Enterprise. Get-AMAgent can receive items on the pipeline and return

related objects.





PARAMETERS

-InputObject <Object>

The object(s) to use in search for agents.



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>

The name of the agent (case sensitive). Wildcard characters can be escaped using the ` character. If using

escaped wildcards, the string

must be wrapped in single quotes. For example: Get-AMAgent -Name '`[Test`]'



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ID <String>

The ID of the agent.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Type

The type of agent.



Required? false

Position? named

Default value All

Accept pipeline input? false

Accept wildcard characters? false



-FilterSet <Hashtable[]>

The parameters to filter the search on. Supply hashtable(s) with the following properties: Property,

Operator, Value.

Valid values for the Operator are: =, !=, <, >, contains (default - no need to supply Operator when using

'contains')



Required? false

Position? named

Default value @()

Accept pipeline input? false

Accept wildcard characters? false



-FilterSetMode <String>

If multiple filter sets are provided, FilterSetMode determines if the filter sets should be evaluated with an

AND or an OR



Required? false

Position? named

Default value And

Accept pipeline input? false

Accept wildcard characters? false



-SortProperty <String[]>

The object property to sort results on. Do not use ConnectionAlias, since it is a custom property added by

this module, and not exposed in the API.



Required? false

Position? named

Default value Name

Accept pipeline input? false

Accept wildcard characters? false



-SortDescending [<SwitchParameter>]

If specified, this will sort the output on the specified SortProperty in descending order. Otherwise,

ascending order is assumed.



Required? false

Position? named

Default value False

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

Agents related to the following objects can be retrieved by this function:

Workflow

Task

Condition

Process

AgentGroup

Folder

Instance





OUTPUTS

Agent





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



PS C:\\># Get agent "agent01"



Get-AMAgent "agent01"









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



PS C:\\># Get agents in agent group "group01"



Get-AMAgentGroup "group01" | Get-AMAgent









-------------------------- EXAMPLE 3 --------------------------



PS C:\\># Get agents configured within any workflow for the condition "My Condition"



Get-AMCondition "My Condition" | Get-AMAgent









-------------------------- EXAMPLE 4 --------------------------



PS C:\\># Get agents using filter sets



Get-AMAgent -FilterSet @{ Property = "Enabled"; Operator = "="; Value = "true"}











RELATED LINKS

https://github.com/AutomatePS/AutomatePS