Windows

Overview

This section describes how to install and configure MetaDefender (MD) Cluster File Storage service on Windows system. After installation, MD Cluster Control Center can connect to MD Cluster File Storage and monitor its system health.

Prerequisites

Before installing the MD Cluster File Storage service, ensure the following requirements are met.

RequirementDescription
Operating SystemWindows 11 23H2+, or Windows Server 2019+.
PrivilegesAdministrator privileges.
Installation packagemd-cluster-file-storage-<version>-1-x64.msi
Network access

Required port is open (default port: 8890).

A minimum network bandwidth of 1 Gbps is required.

A bandwidth of 5 Gbps or higher is strongly recommended in the following scenarios:

  • Load shared among MetaDefender Core instances for archive processing.
  • CDR or DLP is enabled.
Disk space

Use SSD storage with high read/write throughput for optimal performance.

A minimum of 500 GB of available disk space is required. If CDR or DLP is enabled:

  • Additional disk capacity may be required due to increased processing and storage demands.
  • It is recommended to enable data retention to manage stored files effectively.

Create the ignition file

Create an ignition file in YAML format. This file contains the credentials required for the service to connect to the system.

The file must include the following keys:

KeyDescription
secure.connection_keyA 4–64 character alphanumeric string (a–z, A–Z, 0–9) used by MD Cluster Control Center to connect to the server.
secure.private_keyThe content of private key in X509 format.
secure.certificateThe content of certificate in X509 format.

Example ignition file:

YAML
Copy

Save the ignition file to the following path on the target machine:

Bash
Copy

The ignition file contains sensitive credentials. This file can be safely deleted any time after the installation is complete.

Install the service

  1. Copy the installer file (.msi ) to the target machine.
  2. Open PowerShell with Administrator privileges.
  3. Run the following command to start the installation in silent mode:
Powershell
Copy

Verify the service status

  1. Open PowerShell and run the following command:
Powershell
Copy
  1. Check the Running Status in the output.
  2. If the service is not running, start it manually:
Powershell
Copy

Service management

ActionCommand
Check service statusGet-Service -Name md-cluster-file-storage
Start serviceStart-Service -Name md-cluster-file-storage
Stop serviceStop-Service -Name md-cluster-file-storage
Restart serviceRestart-Service -Name md-cluster-file-storage

Customize the service configuration

During installation, MD Cluster File Storage service generates a configuration file at:

Bash
Copy

To customize the service behavior:

  1. Open the configuration file in a text editor.
  2. Modify the required settings according to your environment.
  3. Save the changes.
  4. Restart the service to apply the new settings.
Powershell
Copy

Directory structure

  • C:\opswat\md_cluster_file_storage.yml: Service Ignition file.
  • C:\Program Files\OPSWAT\MetaDefender Cluster File Storage\md_cluster_file_storage.yml: Service configuration file.
  • C:\Program Files\OPSWAT\MetaDefender Cluster File Storage\data\log\file-storage.log: Service log file.
  • C:\Program Files\OPSWAT\MetaDefender Cluster File Storage\data\storage: Default storage directory.

Log files

To check the service logs, open the file C:\Program Files\OPSWAT\MetaDefender Cluster File Storage\data\log\file-storage.log.

To check logs using Event Viewer:

  1. Open Event Viewer.
  2. Navigate to Windows Logs > Application.
  3. Look for events related to MD Cluster File Storage Service.

Uninstall the service

Open PowerShell and run the following command:

Powershell
Copy

If storage.path is not set in the Ignition file, the storage directory will be deleted when MD Cluster File Storage is uninstalled.

Troubleshooting

A. Service is not running

  1. Check the service status
Powershell
Copy
  1. Start the service if it is not running:
Powershell
Copy

B. Installation fails

Possible causes

  • Insufficient privileges.
  • Missing dependencies.

Solution

  • Ensure the installation command is executed with Administrator privileges.
  • Ensure dependencies are installed.

C. MD Cluster Control Center cannot connect to MD Cluster File Storage.

Possible causes

  • Network connectivity issues.
  • Firewall restrictions.

Solution

  • Ensure MD Cluster Control Center has network connectivity to MD Cluster File Storage.
  • Verify that firewall rules allow inbound and outbound connections.

Ignition file key reference

  • secure.connection_key (Required)

    • Value type: string.
    • Description: Use a 4–64 character string that contains only numbers (0–9) and letters (a–z, A–Z). This string is used by clients to connect to the server. Set this value as the identity.connection_key in the MD Cluster Control Center configuration file.

  • secure.private_key (Required)

    • Value type: string.
    • Description: The content of private key in X509 format.

  • secure.certificate (Required)

    • Value type: string.
    • Description: The content of certificate in X509 format.

  • storage.path (optional)

    • Value type: string.
    • Description: Path to an existing directory where the MD Cluster File Storage server stores its files. On Linux, the server must have full permissions to access this directory.

  • rest.host [optional)

    • Value type: string.
    • Description: IP address (V4/V6) or host where the server resides on. Default value is '*'. Notes: '*' allows the service to accept connections from all network interfaces. To bind the service to a specific interface, specify its IP address or domain name. For example, to listen on all IPv4 interfaces, set the host to 0.0.0.0.

  • rest.port [optional)

    • Value type: number.
    • Description: The port where the server resides on. Default value is 8890.

  • log.streams[@].log_type [optional)

    • Value type: string.
    • Description: Type of log device (file, or syslog)

  • log.streams[@].log_level [optional)

    • Value type: string.
    • Description: Level of log message (dump, debug, info, warning, or error).

  • log.streams[@].log_path [optional)

    • Value type: string.
    • Description: Location where logs are written. If log.streams[@].log_type is "file" then log.streams[@].log_path is the path to a file on file system where logs are written. If log.streams[@].log_type is "syslog" then
      • log.streams[@].log_path can be [tcp/udp]://host:port where host:port is the host and port to a remote syslog server that supports TCP or UDP protocol.
      • log.streams[@].log_path can be "local" to write log to local syslog server (Linux only).

If storage.path is not set in the Ignition file, MD Cluster File Storage saves submitted files to the default storage directory at C:\Program Files\OPSWAT\MetaDefender Cluster File Storage\data\storage
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Linux
null
On This Page
WindowsOverviewPrerequisitesCreate the ignition fileInstall the serviceVerify the service statusService managementCustomize the service configurationDirectory structureLog filesUninstall the serviceTroubleshootingIgnition file key reference