Get-HaloSite
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets sites from the Halo API.
SYNTAX
Multi (Default)
Get-HaloSite [-Paginate] [-PageSize <Int32>] [-PageNo <Int32>] [-Order <String>] [-OrderDesc]
[-Search <String>] [-TopLevelID <Int32>] [-ClientID <Int32>] [-IncludeInactive] [-IncludeActive]
[-Count <Int32>] [-FullObjects] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloSite -SiteID <Int64> [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves sites from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-SiteID
Site ID
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Paginate
Paginate results
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
Number of results per page.
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-PageNo
Which page to return.
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Order
The field to order the results by.
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')
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
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.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TopLevelID
Filter by the specified top level ID.
Type: Int32
Parameter Sets: Multi
Aliases: toplevel_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ClientID
Filter by the specified client ID.
Type: Int32
Parameter Sets: Multi
Aliases: client_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-IncludeInactive
Include inactive sites in the results.
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.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Count
The number of sites to return if not using pagination.
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.
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.