Software Patches Query

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Gets the software patches from the NinjaOne API.

SYNTAX

Get-NinjaOneSoftwarePatches [[-deviceFilter] <String>] [[-timeStamp] <DateTime>]
 [[-timeStampUnixEpoch] <Int32>] [[-status] <String>] [[-productIdentifier] <String>] [[-type] <String>]
 [[-impact] <String>] [[-cursor] <String>] [[-pageSize] <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Retrieves the software patches from the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

Get-NinjaOneSoftwarePatches

Gets all software patches.

EXAMPLE 2

Get-NinjaOneSoftwarePatches -deviceFilter 'org = 1'

Gets the software patches for the organisation with id 1.

EXAMPLE 3

Get-NinjaOneSoftwarePatches -timeStamp 1619712000

Gets the software patches with a monitoring timestamp at or after 1619712000.

EXAMPLE 4

Get-NinjaOneSoftwarePatches -status 'FAILED'

Gets the software patches with a status of 'FAILED'.

EXAMPLE 5

Get-NinjaOneSoftwarePatches -productIdentifier 23e4567-e89b-12d3-a456-426614174000

Gets the software patches with a product identifier of '23e4567-e89b-12d3-a456-426614174000'.

EXAMPLE 6

Get-NinjaOneSoftwarePatches -type 'PATCH'

Gets the software patches with a type of 'PATCH'.

EXAMPLE 7

Get-NinjaOneSoftwarePatches -impact 'OPTIONAL'

Gets the software patches with an impact of 'OPTIONAL'.

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

-timeStamp

Monitoring timestamp filter. PowerShell DateTime object.

Type: DateTime
Parameter Sets: (All)
Aliases: ts

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

-timeStampUnixEpoch

Monitoring timestamp filter. Unix Epoch time.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-status

Filter patches by patch status.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-productIdentifier

Filter patches by product identifier.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-type

Filter patches by type.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-impact

Filter patches by impact.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-cursor

Cursor name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
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: 8
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/softwarepatchesquery