Skip to content

Get-HaloSite

SYNOPSIS

Gets sites from the Halo API.

SYNTAX

Multi (Default)

1
2
3
Get-HaloSite [-Paginate] [-PageSize <Int32>] [-PageNo <Int32>] [-Order <String>] [-OrderDesc]
 [-Search <String>] [-TopLevelID <Int32>] [-ClientID <Int32>] [-IncludeInactive] [-IncludeActive]
 [-Count <Int32>] [-FullObjects] [<CommonParameters>]

Single

1
Get-HaloSite -SiteID <Int64> [<CommonParameters>]

DESCRIPTION

Retrieves sites from the Halo API - supports a variety of filtering parameters.

EXAMPLES

Example 1

1
PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-ClientID

Filter by the specified client ID.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases: client_id

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Count

The number of sites to return if not using pagination.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-FullObjects

Parameter to return the complete objects.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeActive

Include active sites in the results.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeInactive

Include inactive sites in the results.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Order

The field to order the results by.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OrderDesc

Order results in descending order (respects the field choice in '-Order')

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PageNo

Which page to return.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases: page_no

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PageSize

Number of results per page.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases: page_size

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Paginate

Paginate results

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Search

Return contracts matching the search term in the results.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SiteID

Site ID

1
2
3
4
5
6
7
8
9
Type: Int64
Parameter Sets: Single
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-TopLevelID

Filter by the specified top level ID.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases: toplevel_id

Required: False
Position: Named
Default value: 0
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.

INPUTS

OUTPUTS

A powershell object containing the response.

NOTES