< Back
Remove-LinaAgentGroup
Post
NAME Remove-LinaAgentGroup
SYNOPSIS
Deletes a Lina Agent Group from a Lina Server.
SYNTAX
Remove-LinaAgentGroup -Name <String> [-WhatIf] [-Bulk] [<CommonParameters>]
Remove-LinaAgentGroup -LinaAgentGroups <PSObject[]> [-WhatIf] [-Bulk] [<CommonParameters>]
DESCRIPTION
Deletes a Lina Agent Group. Agents in this group will go to the "unsorted" group.
PARAMETERS
-LinaAgentGroups <PSObject[]>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <String>
Name of the agent group to delete. Wildcards are accepted (don't forget to enable Bulk mode for actions on
multiple groups).
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
No actual deletion will happen if set. It will only display what agent groups would be deleted.
Sometimes also called "Dry Run mode"
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Bulk [<SwitchParameter>]
Security parameter to enable deletion of multiple agent group. If not set only one group will be deleted.
Required? false
Position? named
Default value False
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
Accept pipelining of LinaAgentGroup objects (from Get-LinaAgentGroup for example)
OUTPUTS
None
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-LinaAgentGroup -Name "Group132"
Real deletion of a single agent group by name
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-LinaAgentGroup -Name "Group132" | Remove-LinaAgentGroup
Same example as #1 but using piped commands
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-LinaAgentGroup -Name "Group1*" | Remove-LinaAgentGroup -Bulk -WhatIf
Simulates deletion of a multiple agent groups by name (WhatIf mode)
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-LinaAgentGroup -Name Group1*" | Remove-LinaAgentGroup -Bulk
Real deletion of a multiple agent groups by name
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-LinaAgentGroups -ID 164 | Remove-LinaAgentGroups -WhatIf
Simulates deletion of a single agent group by ID
RELATED LINKS
SYNOPSIS
Deletes a Lina Agent Group from a Lina Server.
SYNTAX
Remove-LinaAgentGroup -Name <String> [-WhatIf] [-Bulk] [<CommonParameters>]
Remove-LinaAgentGroup -LinaAgentGroups <PSObject[]> [-WhatIf] [-Bulk] [<CommonParameters>]
DESCRIPTION
Deletes a Lina Agent Group. Agents in this group will go to the "unsorted" group.
PARAMETERS
-LinaAgentGroups <PSObject[]>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <String>
Name of the agent group to delete. Wildcards are accepted (don't forget to enable Bulk mode for actions on
multiple groups).
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
No actual deletion will happen if set. It will only display what agent groups would be deleted.
Sometimes also called "Dry Run mode"
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Bulk [<SwitchParameter>]
Security parameter to enable deletion of multiple agent group. If not set only one group will be deleted.
Required? false
Position? named
Default value False
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
Accept pipelining of LinaAgentGroup objects (from Get-LinaAgentGroup for example)
OUTPUTS
None
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-LinaAgentGroup -Name "Group132"
Real deletion of a single agent group by name
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-LinaAgentGroup -Name "Group132" | Remove-LinaAgentGroup
Same example as #1 but using piped commands
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-LinaAgentGroup -Name "Group1*" | Remove-LinaAgentGroup -Bulk -WhatIf
Simulates deletion of a multiple agent groups by name (WhatIf mode)
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-LinaAgentGroup -Name Group1*" | Remove-LinaAgentGroup -Bulk
Real deletion of a multiple agent groups by name
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-LinaAgentGroups -ID 164 | Remove-LinaAgentGroups -WhatIf
Simulates deletion of a single agent group by ID
RELATED LINKS