Devices
This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets devices from the NinjaOne API.
SYNTAX
Multi (Default)
Get-NinjaOneDevices [[-deviceFilter] <String>] [[-pageSize] <Int32>] [[-after] <Int32>] [-detailed]
[[-expand] <String[]>] [-ParseDateTime] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-NinjaOneDevices [-deviceId] <Int32> [-ParseDateTime] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Organisation
Get-NinjaOneDevices [[-pageSize] <Int32>] [[-after] <Int32>] [-organisationId] <Int32> [[-expand] <String[]>]
[-ParseDateTime] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves devices from the NinjaOne v2 API.
EXAMPLES
EXAMPLE 1
Get-NinjaOneDevices
Gets all devices.
EXAMPLE 2
Get-NinjaOneDevices -deviceId 1
Gets the device with id 1.
EXAMPLE 3
Get-NinjaOneDevices -organisationId 1
Gets all devices for the organisation with id 1.
EXAMPLE 4
Get-NinjaOneDevices -deviceFilter 'status eq APPROVED'
Gets all approved devices.
EXAMPLE 5
Get-NinjaOneDevices -deviceFilter 'class in (WINDOWS_WORKSTATION,MAC,LINUX_WORKSTATION)'
Gets all WINDOWS_WORKSTATION, MAC or LINUX_WORKSTATION devices.
EXAMPLE 6
Get-NinjaOneDevices -deviceFilter 'class eq WINDOWS_WORKSTATION AND online'
Gets all online WINDOWS_WORKSTATION devices.
PARAMETERS
-deviceId
Device id to retrieve
Type: Int32
Parameter Sets: Single
Aliases: id
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-deviceFilter
Filter devices.
Type: String
Parameter Sets: Multi
Aliases: df
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-pageSize
Number of results per page.
Type: Int32
Parameter Sets: Multi, Organisation
Aliases:
Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-after
Start results from device id.
Type: Int32
Parameter Sets: Multi, Organisation
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-detailed
Include locations and policy mappings.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-organisationId
Filter by organisation id.
Type: Int32
Parameter Sets: Organisation
Aliases: organizationId
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-expand
Expand referenced entities in the response. Valid values: location, organization, rolePolicy, policy, role, backupUsage, warranty, assignedOwner, backupBandwidthThrottle
Type: String[]
Parameter Sets: Multi, Organisation
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ParseDateTime
Parse date/time values in the response.
Type: SwitchParameter
Parameter Sets: (All)
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.
INPUTS
OUTPUTS
A powershell object containing the response.
NOTES
RELATED LINKS
https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/devices