Get-VBRMalwareDetectionExclusion

Short Description

Returns a list of machines added to malware exclusions.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Get-VBRMalwareDetectionExclusion [-Entity <Object>] [-Id <Guid>] [-Name <String>] [-Platform <VBRPlatform>] [-Note <String>] [-ExcludedPaths <String[]>] [-ExcludedActivities <VBRActivityType[]>] [-AutoScanDisabled <Boolean>] [-ExcludeEntireObject <Boolean>] [<CommonParameters>]

Detailed Description

This cmdlet returns a list of machines added to malware exclusions. You can filter the returned exclusions by specifying any combination of the parameters described below.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AutoScanDisabled	Filters the returned exclusions by the autoscan setting: $True: returns only exclusions where autoscan is disabled. $False: returns only exclusions where autoscan is enabled.	Boolean	False	Named	False
Entity	Specifies a machine for which you want to return the exclusion. The cmdlet will return the exclusion that matches this machine. Accepts the following types of objects: [For vSphere VMs] CViVmItem. To get this object, run the Find-VBRViEntity cmdlet. [For Hyper-V VMs] CHvVmItem. To get this object, run the Find-VBRHvEntity cmdlet. [For Cloud Director VMs] CVcdVmItem. To get this object, run the Find-VBRvCloudEntity cmdlet with the Vm parameter. [For discovered computers] VBRDiscoveredComputer. To get this object, run the Get-VBRDiscoveredComputer cmdlet.	Object	False	Named	True (ByPropertyName, ByValue)
ExcludedActivities	Specifies the array of malware detection activities. The cmdlet will return exclusions that contain at least one of the specified activities. If you pass an empty array, the cmdlet will return only exclusions that have no excluded activities.	VBRActivityType[]	False	Named	False
ExcludedPaths	Specifies the array of file or folder paths. The cmdlet will return exclusions whose excluded paths contain at least one of the specified path values (case-insensitive substring match). If you pass an empty array, the cmdlet will return only exclusions that have no excluded paths.	String[]	False	Named	False
Id	Specifies the ID of an exclusion. The cmdlet will return the exclusion with this ID.	Guid	False	Named	False
ExcludeEntireObject	Filters the returned exclusions by whether the entire machine is excluded: $True: returns only exclusions where the entire machine is excluded from all automated malware detection mechanisms. $False: returns only partial exclusions that target specific excluded paths, excluded activities, or autoscan.	Boolean	False	Named	False
Name	Specifies the name of an excluded machine. The cmdlet will return the exclusion for the machine with this name.	String	False	Named	False
Note	Specifies a note value. The cmdlet will return exclusions whose note contains this value (case-insensitive substring match).	String	False	Named	False
Platform	Specifies the platform of the excluded machine. The cmdlet will return exclusions for machines on this platform. Possible values: VMWare HyperV vCD LinuxPhysical WindowsPhysical CustomPlatform	VBRPlatform	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRMalwareDetectionExclusion

Examples

Example 1. Getting All Machines Added to Malware Exclusions

This command returns a list of all machines added to malware exclusions.

Get-VBRMalwareDetectionExclusion

Example 2. Getting Exclusion for Specific VMware vSphere VM

This example shows how to return the malware exclusion for the WinSrv2049 VM.

$vm = Find-VBRViEntity -Name "WinSrv2049"

Get-VBRMalwareDetectionExclusion -Entity $vm

Perform the following steps:

Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $vm variable.
Run the Get-VBRMalwareDetectionExclusion cmdlet. Set the $vm variable as the Entity parameter value.

Example 3. Getting Exclusions With Disabled Autoscan

This command returns all exclusions where autoscan is disabled.

Get-VBRMalwareDetectionExclusion -AutoScanDisabled:$True

Related Commands

Find-VBRViEntity