Set-AMAgentGroup

NAME Set-AMAgentGroup



SYNOPSIS

Sets properties of an AutoMate Enterprise agent group.





SYNTAX

Set-AMAgentGroup [-InputObject] <Object> [-Notes] <String> [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Set-AMAgentGroup can change properties of an agent group object.





PARAMETERS

-InputObject <Object>

The agent group to modify.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Notes <String>

The new notes to set on the object.



Required? true

Position? 2

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

The following AutoMate object types can be modified by this function:

AgentGroup





OUTPUTS

None





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



PS C:\\># Change notes for an agent group



Get-AMAgentGroup "All Agents" | Set-AMUserGroup -Notes "Group containing all agents"









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



PS C:\\># Empty notes for all agent groups



Get-AMAgentGroup | Set-AMUserGroup -Notes ""











RELATED LINKS

https://github.com/AutomatePS/AutomatePS