Get Device Health Query
This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets the device health from the NinjaOne API.
SYNTAX
Get-NinjaOneDeviceHealth [[-deviceFilter] <String>] [[-health] <String>] [[-cursor] <String>]
[[-pageSize] <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves the device health from the NinjaOne v2 API.
EXAMPLES
EXAMPLE 1
Get-NinjaOneDeviceHealth
Gets the device health.
EXAMPLE 2
Get-NinjaOneDeviceHealth -deviceFilter 'org = 1'
Gets the device health for the organisation with id 1.
EXAMPLE 3
Get-NinjaOneDeviceHealth -health 'UNHEALTHY'
Gets the device health for devices with the health status 'UNHEALTHY'.
PARAMETERS
-deviceFilter
Filter devices.
Type: String
Parameter Sets: (All)
Aliases: df
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-health
Filter by health status.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-cursor
Cursor name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-pageSize
Number of results per page.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
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
RELATED LINKS
https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/devicehealthquery