System Administration > File Management System > Administering FMS > Configuring FMS > Configuring file scanning during upload
FMS quarantine volume substitutions and attributes
The FMS (File Management System) can recognize the following parameters and make substitutions for them to supply the correct values for a specific call to the virus scanner. Each time the scanner is called, these values, if they exist in the command, are repopulated before being sent to the script. $SCAN_FILE This is the full path to the file to scan. Some third-party scanners accept an individual file as input. Each time a file is set to scan, it is within the quarantinevolume root using this parameter's value. $SCAN_DIR This is the full path of the directory to scan. Some scanners can scan a directory only. Use this parameter in those cases. Each time a file is set to scan, it is placed in a temporary directory within the quarantinevolume root using this parameter's value $SCAN_UNIQUE This is a randomly generated UID that can be used when forming the scanner output file name. Some scanners send their output to a temporary file that must be parsed by the scanning script. Use this parameter to generate a unique output file name. This avoids file name collisions. The quarantineVolume XML element has the following required and optional attributes: root (required) Specifies a directory where the files are temporarily placed for scanning. The virus scanner and script must have access to this location. The location cannot be automatically scanned by other virus scanners. command (required) Specifies a command line string that is used to run the scan script. This includes the script itself and any input parameters. Use the full path to the command. You must also supply either the file to scan or the directory containing the file to scan. Use either $SCAN_FILE or $SCAN_DIR substitution to supply this value. timeout (optional) Specifies the maximum amount of time in seconds that FMS waits for a return value from the virus scanner. The default value is 20.
Source: https://docs.sw.siemens.com/documentation/external/PL20251212545240207/en-US/tc_help/AWAdmin/fhs4814155880506/uuc1737238583853/fhe1737238587390/nxs1737238591363/qbg1737238593730/xid1308707.html · retrieved Fri Jul 31 2026 00:00:00 GMT+0000 (Coordinated Universal Time)