Get-LinaAgentGroup

NAME Get-LinaAgentGroup



SYNOPSIS

Retrieves the agent groups





SYNTAX

Get-LinaAgentGroup [-Name <String>] [-Tenant <String>] [<CommonParameters>]



Get-LinaAgentGroup -Name <String> -Tenant <String> [<CommonParameters>]



Get-LinaAgentGroup -Name <String> [<CommonParameters>]



Get-LinaAgentGroup -ID <Int32> [<CommonParameters>]



Get-LinaAgentGroup -Tenant <String> [<CommonParameters>]





DESCRIPTION

Retrieves the agent groups (Main view of agents)





PARAMETERS

-Name <String>

Name of the Group to retrieve. Wilcards are allowed. For example : *UNCATEGOR*



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ID <Int32>

ID of the group retrieve. For example : 4.



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Tenant <String>

Name of the Tenant hosting the groups

Can also be used in conjunction with -Name to filter by name AND Tenant.

Can be useful if multiple groups have the same name in multiple tenants.



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

None





OUTPUTS

Array of LinaAgentGroup Objects





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



PS C:\\>Get-LinaAgentGroup



Retrieve all agent groups









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



PS C:\\>Get-LinaAgentGroup -ID 131



Retrieve agent group by it ID. Will return a unique object.









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



PS C:\\>Get-LinaAgentGroup -Name "Group1"



Retrieve agent group by its Name. Wilcards are allowed.

Warning : result may not be unique even without using wildcards. Group names may not be unique across tenants.









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



PS C:\\>Get-LinaAgentGroup -Tenant "MyTenant"



Retrieve agent groups of the Tenant MyTenant









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-LinaAgentGroup -Name "Group1" -Tenant "BaasCustomer1"



Filter agent group by name and by Tenant MyTenant. If not using wildcards in name, return will be unique.











RELATED LINKS