Set‐OPNsenseClamAV - fvanroie/PS_OPNsense GitHub Wiki

Synopsis

Set the ClamAV configuration on the OPNsense server

Syntax

Set-OPNsenseClamAV [[-Enable] <Boolean>] [[-EnableTCP] <Boolean>] `
             [[-MaxThreads] <Int32>] [[-MaxQueue] <Int32>] [[-IdleTimeout] <Int32>] `
             [[-MaxDirRecursion] <Int32>] [[-FollowDirSym] <Boolean>] `
             [[-FollowFileSym] <Boolean>] [[-DisableCache] <Boolean>] `
             [[-ScanPE] <Boolean>] [[-ScanELF] <Boolean>] [[-DetectBroken] <Boolean>] `
             [[-ScanOLE2] <Boolean>] [[-OLEe2BlockMarcros] <Boolean>] `
             [[-ScanPDF] <Boolean>] [[-ScanSWF] <Boolean>] [[-ScanXMLdocs] <Boolean>] `
             [[-ScanHWP3] <Boolean>] [[-ScanMailFiles] <Boolean>] `
             [[-ScanHtml] <Boolean>] [[-ScanArchive] <Boolean>] `
             [[-ArcBlockEnc] <Boolean>] [[-MaxScanSize] <String>] `
             [[-MaxFileSize] <String>] [[-MaxRecursion] <Int32>] [[-MaxFiles] <Int32>] `
             [[-FreshClamEnable] <Boolean>] [[-FreshClamLogVerbose] <Boolean>] `
             [[-FreshClamMirror] <String>] [[-FreshClamTimeout] <Int32>]

Description

Change the settings of the Clam Anti-Virus scanner on the OPNsense server.

Parameters

-Enable   <Boolean>

Required? false
Position? 0
Default Value?
Pipeline Input? false

-EnableTCP   <Boolean>

Required? false
Position? 1
Default Value?
Pipeline Input? false

-MaxThreads   <Int32>

Required? false
Position? 2
Default Value?
Pipeline Input? false

-MaxQueue   <Int32>

Required? false
Position? 3
Default Value?
Pipeline Input? false

-IdleTimeout   <Int32>

Required? false
Position? 4
Default Value?
Pipeline Input? false

-MaxDirRecursion   <Int32>

Required? false
Position? 5
Default Value?
Pipeline Input? false

-FollowDirSym   <Boolean>

Required? false
Position? 6
Default Value?
Pipeline Input? false

-FollowFileSym   <Boolean>

Required? false
Position? 7
Default Value?
Pipeline Input? false

-DisableCache   <Boolean>

Required? false
Position? 8
Default Value?
Pipeline Input? false

-ScanPE   <Boolean>

Required? false
Position? 9
Default Value?
Pipeline Input? false

-ScanELF   <Boolean>

Required? false
Position? 10
Default Value?
Pipeline Input? false

-DetectBroken   <Boolean>

Required? false
Position? 11
Default Value?
Pipeline Input? false

-ScanOLE2   <Boolean>

Required? false
Position? 12
Default Value?
Pipeline Input? false

-OLEe2BlockMarcros   <Boolean>

Required? false
Position? 13
Default Value?
Pipeline Input? false

-ScanPDF   <Boolean>

Required? false
Position? 14
Default Value?
Pipeline Input? false

-ScanSWF   <Boolean>

Required? false
Position? 15
Default Value?
Pipeline Input? false

-ScanXMLdocs   <Boolean>

Required? false
Position? 16
Default Value?
Pipeline Input? false

-ScanHWP3   <Boolean>

Required? false
Position? 17
Default Value?
Pipeline Input? false

-ScanMailFiles   <Boolean>

Required? false
Position? 18
Default Value?
Pipeline Input? false

-ScanHtml   <Boolean>

Required? false
Position? 19
Default Value?
Pipeline Input? false

-ScanArchive   <Boolean>

Required? false
Position? 20
Default Value?
Pipeline Input? false

-ArcBlockEnc   <Boolean>

Required? false
Position? 21
Default Value?
Pipeline Input? false

-MaxScanSize   <String>

Required? false
Position? 22
Default Value?
Pipeline Input? false

-MaxFileSize   <String>

Required? false
Position? 23
Default Value?
Pipeline Input? false

-MaxRecursion   <Int32>

Required? false
Position? 24
Default Value?
Pipeline Input? false

-MaxFiles   <Int32>

Required? false
Position? 25
Default Value?
Pipeline Input? false

-FreshClamEnable   <Boolean>

Required? false
Position? 26
Default Value?
Pipeline Input? false

-FreshClamLogVerbose   <Boolean>

Required? false
Position? 27
Default Value?
Pipeline Input? false

-FreshClamMirror   <String>

Required? false
Position? 28
Default Value?
Pipeline Input? false

-FreshClamTimeout   <Int32>

Required? false
Position? 29
Default Value?
Pipeline Input? false

Examples

⚠️ **GitHub.com Fallback** ⚠️