Remove-AMAgentGroupMember

NAME Remove-AMAgentGroupMember



SYNOPSIS

Removes agents from an AutoMate Enterprise agent group.





SYNTAX

Remove-AMAgentGroupMember -InputObject <Object> [-Agent] <Object> [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Remove-AMAgentGroupMember can remove agents from an agent group.





PARAMETERS

-InputObject <Object>

The agent group to modify.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Agent <Object>

The agent(s) to remove to the agent group.



Required? true

Position? 1

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:\\># Remove all agents from an agent group



Get-AMAgentGroup "All Agents" | Remove-AMAgentGroupMember -Agent *









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



PS C:\\># Remove an agent from an agent group (using agent object)



Get-AMAgentGroup | Remove-AMAgentGroupMember -Agent (Get-AMAgent "Agent1")











RELATED LINKS

https://github.com/AutomatePS/AutomatePS