Release Notes

Windows Server

Deployment Guide for Veza Windows Server Integration

Overview

The Veza integration for Windows Server comprises an OAA package and a collection of .NET 8.0 applications. These tools discover metadata from a Windows Server host and forward it to a Veza instance. The application package comes as an MSI installer for deployment on Windows Server.

For automated deployment at scale with per-machine unique Team API Keys, see the Enterprise Deployment guide.

Components

The Veza Windows OAA application includes:

  1. A service that discovers local groups, user accounts, services, and scheduled tasks within the Windows Server OS.

  2. A service to detect Active Directory filesystem permissions on SMB file shares.

  3. A GUI application for configuring discovery services and setting up the Veza connection.

Prerequisites

  • Windows Server 2012 R2 or newer

  • .NET 8.0 Runtime (included in the installer)

  • You will need the installation program from Veza, available here

Deployment Specifications

System Requirements

Resource
Requirement
Notes

Memory

< 50MB RAM

During normal operation

Disk Space

~300MB

For application installation

Additional Disk Space

Varies

Up to 1GB for logs when using Debug level

Network

Outbound HTTPS (443)

To Veza tenant

Permissions

Local Administrator

Required for installation and operation

Performance Impact

The Veza Windows integration is engineered to operate with minimal resource utilization across enterprise environments:

  • CPU Utilization: Typically insignificant during standard metadata collection operations

  • Memory Consumption: <50MB RAM during normal operational cycles

  • Network Bandwidth: Optimized data transmission with lightweight payloads transmitted at configurable intervals (default: 60 minutes)

  • Storage I/O: Negligible impact on storage subsystems outside of scheduled log maintenance or diagnostic activities

Operational Schedule

  • By default, the application collects and sends metadata to Veza every 60 minutes

  • This interval can be configured between 1 hour and 1 day to suit your organizational requirements

  • For file share discovery, a minimum interval of 120 minutes is recommended

Log Management

  • The application stores 14 days of logging information

  • Logs are automatically purged as they age out

  • At the standard Info level, log storage is negligible

  • At Debug level, logs may consume up to 1GB of disk space

  • Log locations:

    • C:\Program Files\Veza\Local Accounts\logs\VezaWindows.log

    • C:\Program Files\Veza\Folders\logs\VezaFiles.log

Installation

Deployment Options

The Veza Windows integration supports both manual and automated deployment methods:

Manual Installation

Run the Veza.msi installation program and follow the on-screen prompts. By default, the application installs in C:\Program Files\Veza.

Silent Installation (for automated deployment)

The MSI package supports standard silent installation parameters for enterprise deployment:

Important: API keys are encrypted using the Windows Data Protection API and cannot be set directly in configuration files.

# Basic silent install
msiexec /i Veza.msi /qn

# Install with specific log file
msiexec /i Veza.msi /qn /l*v install.log

# Install to custom directory
msiexec /i Veza.msi /qn INSTALLDIR="D:\Applications\Veza"

# Install with an existing configuration file
msiexec /i Veza.msi /qn CONFIG="\\deployment-share\Veza\Veza.config"

# Install with an existing API key (recommended for automated deployment)
msiexec /i Veza.msi /qn APIKEY="<api_key>"

# Install with existing configuration file and API key
msiexec /i Veza.msi /qn CONFIG="\\deployment-share\Veza\Veza.config" APIKEY="<api_key>"

API Key Deployment Methods

Method 1: MSI Installation with APIKEY Parameter (Recommended)

This method encrypts the API key during installation:

msiexec /i Veza.msi /qn CONFIG="\\deployment-share\Veza\Veza.config" APIKEY="<api_key>"

Method 2: Post-Installation API Key Configuration

If you cannot include the API key in the MSI command:

# Install without API key (use full path for CONFIG)
msiexec /i Veza.msi /qn CONFIG="C:\path\to\Veza.config" /l*v install.log

# Configure API key post-installation
Start-Process -FilePath "C:\Program Files\Veza\VezaWindowsTray.exe" -ArgumentList "--api_key=<api_key>" -NoNewWindow -Wait

Example Configuration File

Below is a standard configuration template that can be customized for your environment:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <configSections>
  <section name="PathConfigurationSection" type="Veza.Integrations.PathConfigurationDataSection, PathConfiguration, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
 </configSections>
 <PathConfigurationSection>
  		<PathConfigurations>
  		  </clear>
			  <add path=”\\fileserver01.example.com\Finance” depth=”1” />
			  <add path=”\\fileserver02.example.com\Human Resources\Benefits” depth=”1” />
  		</PathConfigurations>
 </PathConfigurationSection>
 <appSettings>
  <!-- Local Account Collection Settings -->
  <add key="windows_local_accounts-enabled" value="true" />
  <add key="windows_local_accounts-interval" value="60" />
  <add key="windows_local_accounts-services_enabled" value="true" />
  <add key="windows_local_accounts-tasks_enabled" value="true" />
  <add key="windows_local_accounts-save_json" value="false"/>

  <!-- Veza API Connection Settings -->
  <!-- WARNING: Do not set veza-api_key here - use MSI APIKEY parameter or post-install command -->
  <add key="veza-url" value="https://YOUR_TENANT.vezacloud.com" />
  <add key="veza-insight_point_proxy" value="http://INSIGHT_POINT_IP:8080">
  <add key="veza-loglevel" value="Info" />

  <!-- File Share Discovery Settings -->
  <add key="windows_files-enabled" value="true" />
  <add key="windows_files-interval" value="120" />
  <add key="windows_files-threads" value="1" />
  <add key="windows_files-save_json" value="false"/>
 </appSettings>
</configuration>

Required configuration parameters are listed and described in the table below:

Configuration Parameter
Description
Notes

windows_local_accounts-enabled

Enables the discovery of local accounts, services, and scheduled tasks

"true" or "false"

windows_local_accounts-interval

The execution interval in minutes for local accounts discovery

Set to an integer greater than 60 in quotes

windows_local_accounts-services_enabled

Include local service metadata in Veza

"true" or "false"

windows_local_accounts-tasks_enabled

Include Scheduled Tasks metadata in Veza

"true" or "false"

windows_local_accounts-save_json

Save the payload uploaded to Veza to disk into <INSTALL_DIRECTORY>\Local Accounts\

"true" or "false"

veza-api_key

The encrypted API key used to communicate with the Veza tenant

Populated by MSI APIKEY parameter or post-install command

veza-insight_point_proxy

The URL of the local Insight Point for proxying outbound connections to Veza

See Insight Point documentation for configuration information

veza-url

The URL of the Veza tenant

Veza tenant URL

veza-loglevel

Sets the verbosity of the logs for the Veza service

"Info" or "Debug"

windows_files-enabled

Enables the discovery of Windows File Server folders and permissions

"true" or "false"

windows_files-interval

The execution interval in minutes for Windows File Server discovery

Set to an integer greater than 120 in quotes

windows_files-threads

The number of simultaneous threads used during Windows File Server discoviry

Set to "1" unless instructed to change by Veza support

windows_files-save_json

Save the payload uploaded to Veza to disk into <INSTALL_DIRECTORY>\Folders\

"true" or "false"

GUI Configuration (manual deployment)

Post-installation, open Veza for Windows from the Start menu.

  1. Under the Veza API tab, input your Veza instance URL into Veza URL.

  2. Paste the previously created API key into Veza API Key.

  3. Optionally provide the URL for the Insight Point Proxy.

  4. Click Apply.

To verify the successful connection, log in to Veza and open the Integrations page. You should see Windows Server enabled on the list of all integrations.

Note: The installed service needs to run with Administrative privileges.

Security Considerations

API Key Management

The Veza Windows integration uses an API key to authenticate with the Veza tenant. Important security considerations include:

  • Key Generation: API keys are issued from the Veza tenant by users with administrative access

  • Key Deployment Options:

    • Deploy a unique key per server for the highest security

    • Deploy a shared key across all servers for simplified management

    • Deploy keys by department or region for balanced security and management

  • Key Storage:

    • The API key is encrypted using Windows Data Protection API

    • Stored in the configuration file at C:\Program Files\Veza\Veza.config

  • Key Rotation:

    • Keys are not automatically rotated

    • Keys can be manually deleted and replaced with new ones via the Veza tenant

  • Key Compromise:

    • A compromised key would grant access to the endpoints listed in Veza APIs

    • Immediately delete and replace any compromised keys

See Authentication for more about Veza API keys.

Network Security

The Veza Windows integration requires:

  • Outbound HTTPS (443) access to the Veza tenant or Insight Point

  • All data is transmitted using TLS 1.2 or higher

No inbound connectivity is required.

Update Management

The Veza for Windows application follows a separate release cadence from the Veza platform:

  • Updates are released only for bug fixes, security bulletins, and feature enhancements

  • Updates are manually deployed via new MSI packages published by Veza

  • No automatic updates are performed

  • Update notifications are sent to tenant administrators

To update existing installations:

  1. Download the latest MSI from Veza

  2. Deploy using the same methods as the initial installation

  3. The installation program will automatically upgrade the existing installation

Configuration settings are preserved during upgrades.

Standard Functionality

Windows Local Accounts

This service identifies local security principals on the Windows Server host. By default, it detects:

  1. Local user accounts

  2. Local groups

  3. (Optional) Installed services

  4. (Optional) Configured scheduled tasks

Properties

User Properties
Description

cannot_change_password

Indicates if the user's password can't be changed (boolean)

locked_out

Shows if the user account is locked out (boolean)

password_never_expires

Checks if the user's password is set to never expire (boolean)

password_not_required

Checks if the user doesn't need a password (boolean)

type*

Differentiates between local or active directory user accounts (string)

Group Properties
Details

type*

Specifies if the group is local or associated with active directory (string)

Scheduled Task Properties
Details

path

Full path of the scheduled task (string)

state

Current state: Ready, Running, Disabled, etc. (string)

Service Properties
Details

service_account_name

Account used to run the service (string)

start_type

Start type: Automatic, Manual, etc. (string)

status

Current status: Running, Stopped, etc. (string)

Note (*): Local groups on Windows Server can contain both Active Directory subgroups and local user accounts. The type property distinguishes between the two entities.

Windows Files

This service discovers filesystem permissions for specified paths and subdirectories based on the set depth. It primarily identifies:

  1. Filesystem paths

  2. Active Directory users and groups with permissions on each path

  3. Permission inheritance

Limitations

  • Designed for SMB file shares utilizing Active Directory permissions

  • Metadata from security principals that do not correlate to Active Directory users or groups is omitted before sending data to Veza

  • Enumerating large shares can be more memory-intensive and will increase the RAM requirement during execution

Configuration Options

Local Accounts

In Local Accounts, adjust settings as desired:

Option
Purpose

Enabled

Toggles discovery (check mark to enable discovery)

Discovery Interval

Sets interval between discovery runs (min: 60 minutes)

Include Services

Enables service discovery (optional)

Include Scheduled Tasks

Activates scheduled task data discovery (optional)

Files

In Folders, customize as needed:

Option
Purpose

Enabled

Toggles discovery

Discovery Interval

Time gap between discoveries (min: 120 minutes)

Discovery Threads

Sets concurrent discovery threads

Paths

Use Add Path to specify discovery paths

Troubleshooting

Common Issues

API Key Not Working During MSI Installation:

  • Problem: API key included directly in configuration file

  • Solution: API keys cannot be set in configuration files. Use MSI APIKEY parameter or post-installation configuration

  • Example: msiexec /i Veza.msi /qn CONFIG="C:\path\to\Veza.config" APIKEY="your_key"

Configuration Parameters Not Applied:

  • Problem: Configuration file path incorrect or MSI cannot access relative paths

  • Solution: Use full filesystem path for CONFIG parameter, not relative paths

  • Example: Use CONFIG="C:\Users\Administrator\Desktop\Veza.config" instead of CONFIG="Veza.config"

  • Root Cause: MSI executes in different user context than current directory

Connection Failures:

  • Verify network connectivity to the Veza tenant

  • Check API key validity in the Veza tenant

  • Ensure correct URL format (e.g. https://tenant-name.vezacloud.com)

Performance Issues:

  • If memory usage exceeds 50MB during normal operation, check file share sizes

  • Reduce the number of discovery threads for file shares

  • Increase discovery intervals

Log Analysis:

  • You can adjust the service's log level using the dropdown menu. By default, logs are saved at C:\\Program Files\Veza\Local Accounts\logs\VezaWindows.log and C:\\Program Files\Veza\Folders\logs\VezaFiles.log.

  • Set log level to Debug temporarily to gather more information for troubleshooting and support requests.

  • Reduce the logging level after troubleshooting to minimize disk usage

Support

For additional assistance, contact Veza Support at [email protected] or through your account representative.

PreviousVezaNextEnterprise Deployment

Last updated

Was this helpful?