Locations
This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets locations from the NinjaOne API.
SYNTAX
Get-NinjaOneLocations [[-pageSize] <Int32>] [[-after] <Int32>] [[-organisationId] <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves locations from the NinjaOne v2 API, automatically combining pages from the global locations endpoint. Page size controls each request, not the total number of locations returned.
EXAMPLES
EXAMPLE 1
Get-NinjaOneLocations
Gets all locations.
EXAMPLE 2
Get-NinjaOneLocations -pageSize 1000
Gets all locations using requests of up to 1000 locations per page.
EXAMPLE 3
Get-NinjaOneLocations -after 1
Gets all locations after location id 1.
EXAMPLE 4
Get-NinjaOneLocations -organisationId 1
Gets all locations for the organisation with id 1.
PARAMETERS
-pageSize
Number of results requested per page. Values above 1000 are capped at 1000 with a warning.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-after
Start results from location id.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-organisationId
Filter by organisation id.
Type: Int32
Parameter Sets: (All)
Aliases: id, organizationId
Required: False
Position: 3
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
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
RELATED LINKS
https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/locations