Get AntiVirus Status 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 antivirus status from the NinjaOne API.

SYNTAX

Get-NinjaOneAntiVirusStatus [[-deviceFilter] <String>] [[-timeStamp] <DateTime>]
 [[-timeStampUnixEpoch] <Int32>] [[-productState] <String>] [[-productName] <String>] [[-cursor] <String>]
 [[-pageSize] <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves the antivirus status from the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

Get-NinjaOneAntivirusStatus -deviceFilter 'org = 1'

Gets the antivirus status for the organisation with id 1.

EXAMPLE 2

Get-NinjaOneAntivirusStatus -timeStamp 1619712000

Gets the antivirus status at or after the timestamp 1619712000.

EXAMPLE 3

Get-NinjaOneAntivirusStatus -productState 'ON'

Gets the antivirus status where the product state is ON.

EXAMPLE 4

Get-NinjaOneAntivirusStatus -productName 'Microsoft Defender Antivirus'

Gets the antivirus status where the antivirus product name is Microsoft Defender Antivirus.

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.

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 in unix time.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-productState

Filter by product state.

Type: String
Parameter Sets: (All)
Aliases:

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

-productName

Filter by product name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
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: 5
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: 6
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/antivirusstatusquery