Get-HaloAgent
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets agents from the Halo API.
SYNTAX
Multi (Default)
Get-HaloAgent [-Team <String>] [-Search <String>] [-SectionID <Int32>] [-DepartmentID <Int32>]
[-ClientID <Int32>] [-Role <String>] [-IncludeEnabled] [-IncludeDisabled] [-IncludeUnassigned] [-IncludeRoles]
[-ShowAll] [-IncludeAPIAgents] [-CanEditOnly] [-IncludeNamedCount] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Me
Get-HaloAgent [-Me] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloAgent -AgentID <Int64> [-IncludeDetails] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves agents from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-Me
Get the agent object for the access token owner
Type: SwitchParameter
Parameter Sets: Me
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-AgentID
Agent ID.
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Team
Filter by the specified team name.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Search
Filter by name, email address or telephone number using the specified search string.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SectionID
Filter by the specified team ID. ?ACT Query with Halo what this does!
Type: Int32
Parameter Sets: Multi
Aliases: section_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-DepartmentID
Filter by the specified department ID.
Type: Int32
Parameter Sets: Multi
Aliases: department_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ClientID
Filter by the specified client ID (agents who have access to this client).
Type: Int32
Parameter Sets: Multi
Aliases: client_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Role
Filter by the specified role ID (requires int as string.)
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeEnabled
Include agents with enabled accounts (defaults to $True).
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeDisabled
Include agents with disabled accounts.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeUnassigned
Include the system unassigned agent account.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeRoles
Include the agent's roles list in the response.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeDetails
Include extra detail objects (for example teams and roles) in the response.
Type: SwitchParameter
Parameter Sets: Single
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ShowAll
Show all agents, including those that have been deleted.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeAPIAgents
Include API agents in the response.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-CanEditOnly
Show only agents the API user has permissions to edit.
Type: SwitchParameter
Parameter Sets: Multi
Aliases: can_edit_only
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeNamedCount
Include counts of named license consumption in the response.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.