Skip to main content

Device OS Patch Scan

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​

Starts an OS Patch Scan job on the target device.

SYNTAX​

Start-NinjaOneOSPatchScanJob [-deviceId] <Int32> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]

DESCRIPTION​

Submits a job (POST) to start an OS patch scan on a device via the NinjaOne v2 API. Complements the PATCH variant.

EXAMPLES​

EXAMPLE 1​

Start-NinjaOneOSPatchScanJob -deviceId 1

Starts an OS Patch Scan job on device 1.

PARAMETERS​

-deviceId​

The device Id to start the OS patch scan job for.

Type: Int32
Parameter Sets: (All)
Aliases: id

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

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
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​

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Set/ospatchscan