vStor 4.12 Documentation
  • Welcome to vStor!
  • Introduction
  • Installation
    • Deploying Catalogic vStor on Physical Appliances
    • Deploying Catalogic vStor Virtual Appliance for VMware
    • Deploying Catalogic vStor Virtual Appliance for Microsoft Hyper-V
    • Required Ports for Catalogic vStor
    • Updating Catalogic vStor
  • Quick Start
    • Catalogic vStor for VMware
    • Catalogic vStor for Hyper-V
  • Basic Configuration
    • Initializing vStor
    • Adding Catalogic vStor Node to Catalogic DPX
      • Using vStor API Keys with Catalogic DPX
    • Configuring vStor System Settings
    • Configuring vStor Network Settings
    • Backing up Configuration Settings of Catalogic vStor
    • Restoring Configuration Settings of Catalogic vStor
  • Storage Management
    • Adding Disks
    • Managing Storage Pools
    • Managing Volumes
      • Migrating Volumes
      • Creating Volume Snapshots
      • Using vStor Autosnapshot
    • ZFS Compression and Deduplication
    • Managing Shares
    • Managing Hosts for LUN Volumes
    • Using vStor Snapshot Explorer
  • Data Protection
    • Catalogic vStor Backup and Recovery
    • vStor Partnerships
      • Creating Replication Groups
      • Establishing Cross-Version Partnerships
    • Enabling Volume Encryption
    • Immutability in vStor
    • Using GuardMode Scan
    • Using Remote Keystore
  • Advanced Configuration
    • Using Multipath Storage
    • Managing Certificates
    • Adding Encryption URLs
    • Managing MinIO Buckets
    • Assigning an E-mail to a vStor Account
    • Managing vStor User Accounts
    • Using Multifactor Authentication (MFA)
  • vStor Command Line Interface
    • Catalogic vStor Server CLI Overview
  • Best Practices
    • Hardware Configurations: Best Practices
    • Data Backup: Best Practices
    • Data Archiving: Best Practices
    • Backup Storage: Best Practices
    • Frequently Asked Questions: Best Practices
  • Technical Support
Powered by GitBook
On this page
  • System Settings
  • System Information
  • Host
  • Certificates
  • General
  • Kerberos Configuration
  • NFS Configuration
  • Encryption Keystore
  • Telemetry
  • Debug Logging
  • Firewall
  • Time
  • Deduplication
  • Replication
  • E-mail Notification Details
  • E-mail Server Settings
  1. Basic Configuration

Configuring vStor System Settings

PreviousUsing vStor API Keys with Catalogic DPXNextConfiguring vStor Network Settings

Last updated 1 month ago

Catalogic vStor offers a comprehensive set of settings allowing you to customize and optimize your storage environment. These settings can be accessed through the System view in the navigation sidebar. The System view consists of two tabs: System Settings and Network Settings.

Note. The System view is only available for users with Admin role. For more information, see .

System Settings

The System Settings tab features a number of panes, each dedicated to a particular group of settings or parameters. See detailed description of each section below.

System Information

This section gathers general information about the vStor’s OS, library versions and statuses.

Host

This section displays hostname and domain name information.

You can edit this section by clicking the Edit button to launch the Edit Host dialog window.

Certificates

This section allows you to manage certificates in Catalogic vStor.

You can edit this section by clicking the Edit button to launch the Edit Certificate dialog window.

You can use the built-in certificate or add a custom one by selecting Custom certificate from the Certificate dropdown.

General

This section gathers the general settings of your vStor machine.

Async snapshot creation timeout

Sets the maximum time (in seconds) vStor will wait for an asynchronous snapshot creation operation to complete before marking it as failed.

Configuration retention time

Specifies how long (in days) vStor will retain configuration backups.

Dashboard refresh time

Sets the interval (in seconds) for automatically updating the vStor dashboard.

Mount file systems limit

Sets the maximum number of file systems simultaneously mountable during agentless file restores.

Mounted file system volume retention timeout

Controls the default time (in minutes) a mounted volume from an agentless file restore will remain accessible.

NFS server threads

Controls the number of threads dedicated to the NFS server for improved performance.

Schedule timezone

Sets the timezone used for replication and AutoSnapshot schedules.

Snapshot creation timeout

Sets the maximum time (in seconds) vStor will wait for a snapshot creation operation to complete before marking it as failed.

Volume creation timeout

Sets the maximum time (in seconds) vStor will wait for a volume creation operation to complete before marking it as failed.

You can edit this section by clicking the Edit button to launch the Edit General dialog window.

Kerberos Configuration

This section displays the current Kerberos configuration.

You can edit this section by clicking the Edit button to launch the Edit Kerberos Configuration dialog window.

Realm

Specifies the domain over which the Kerberos authentication server has the authority to authenticate a user, host or service.

KDC Hostname

Specifies the Key Distribution Center (KDC) host.

Kerberos Keytab File

Indicates the file containing key pairs for Kerberos authentication.

NFS Configuration

This section displays the current NFS configuration.

You can edit this section by clicking the Edit button to launch the Edit NFS Configuration dialog window.

NFS Server Treads

Specifies the maximum number of threads on the NFS server. The default value is 32.

Enable Support for NFSv3 Connection

This toggle controls compatibility with NFS version 3.

Encryption Keystore

Encryption Keystore is a remote location where encryption keys for vStor volumes are stored. The recommended location for the Encryption Keystore is the DPX Master Server, although all Linux machines are supported.

Managing Keys

You can manage the keys in the keystore by clicking the Manage keys button to launch the Manage Keys dialog window.

To add encryption key to a volume, do the following:

  1. Click the Add key button next to the desired volume to launch the Add Encryption Key button.

  1. Type in the valid encryption key for the volume.

  2. Click Save.

Important. The encryption key you add to the Encryption Keystore must be the same as specified when enabling encryption for the volume. Otherwise, any decription operations will fail.

Configuring Encryption Keystore

When configuring the Encryption Keystore in vStor, the user specifies an existing remote location for the keystore and credentials for the user with writing access to the specified directory.

You can edit the section by clicking the Edit button to launch the Edit Encryption Keystore dialog window.

Note. To save edits made to the Encryption Keystore dialog, you need to specify the valid password to the remote Encryption Store’s location.

  1. Populate the dialog according to the indications below.

Field
Description

User

The Linux user with writing access to the keystore’s directory.

Password

The Linux user’s password.

Host

The hostname or IP address of the machine where the keystore is located.

Port

The port on which the machine with keystore listens.

Path

An existing absolute directory to be used as the Encryption Keystore. The path must be in Linux format.

  1. Click Test to verify the keystore accessibility (optional).

  2. Click Save. The configuration is now saved. The connection will also be tested when saving.

Telemetry

To help improve vStor, you can share usage data with Catalogic Software.

Collect telemetry data

Enables the collection of anonymous usage data.

Share collected telemetry data with Catalogic Software

Select this option to send the collected telemetry

Debug Logging

For in-depth troubleshooting, you can enable more detailed logging.

Generates detailed logs for troubleshooting vStor backend processes.

Firewall

Use the toggle to enable or disable firewall.

Time

By default, vStor uses your machine’s locale to determine the current time.

NTP Servers

The address of your preferred NTP server.

NTP Time

Allows you to manually set the system time. Enter the desired time in ISO 8601 format, which includes the date, time, and timezone offset.

Format: YYYY-MM-DDTHH:MM:SS.SSSSSS+HH:MM

Example: 2024-09-18T05:16:33.135311-04:00

This represents:

  • Date: 2024-09-18 (September 18, 2024)

  • Time: 05:16:33.135311 (5:16 AM, 33 seconds, and microseconds)

  • Timezone offset: -04:00 (4 hours behind UTC)

NTP Timezone

Choose a new timezone from the dropdown list.

You can edit this section by clicking the Edit button to launch the Edit NTP dialog window.

Deduplication

Data deduplication is a process of eliminating excessive copies of data to optimize storage usage.

You can edit this section by clicking the Edit button to launch the Edit Deduplication dialog window.

Use the Reset button to return to default values.

Deduplication disk space limit (bytes)

Defines the maximum disk space (in bytes) the deduplication table can use before ZFS deduplication is disabled on the pool.

Deduplication memory limit (%)

Sets a percentage threshold for memory usage. If exceeded, deduplication on the pool will be disabled.

Replication

This section gathers data transfer settings for outbound replication traffic.

You can edit this section by clicking the Edit button to launch the Edit Replication dialog window.

Bandwidth limit

Defines the bandwidth limit in bytes per second.

Management timeout

Defines the timeout in seconds for requests made to vStor partners.

Maximum replication streams

Defines the maximum replication streams concurrently.

Stream compression

Defines if the replication stream is compressed.

Transfer timeout

Defines the replication transfer timeout in seconds.

E-mail Notification Details

This section includes details concerning vStor e-mail notifications.

You can edit this section by clicking the Edit button to launch the Edit E-mail Notification Details dialog window.

E-mail Sender

Enter the sender name for vStor e-mail notifications.

E-mail Recipients

Enter the e-mail addresses that will receive notifications. Multiple recipients can be added by separating them with commas.

Tip. Use Send test e-mail button to send a test notification and verify your e-mail configuration.

E-mail Server Settings

This section gathers e-mail notifications configuration for your vStor instance.

You can edit this section by clicking the Edit button to launch the Edit E-mail Server Settings dialog window.

Hostname / IP Address

Your SMTP server address.

Port

The port your SMTP server uses (usually 25, 465 or 587).

Enable secure connection

With this option disabled, your e-mail credentials will be sent in plain text.

SMTP Username

Your SMTP server authentication username.

SMTP Password

Your SMTP server authentication password.

  • Click the Reset button to return to default values.

  • Click the Test button to verify the e-mail server data (optional).

See also. For more details on certificates in vStor, see .

The Manage Keys dialog window shows the list of all encrypted volumes on the vStor. Volumes with encryption key added to the Encryption Keystore are marked with .

See also. For more information about the Encryption Keystore, see .

Important. Before enabling debug logging, we recommend contacting the , as the log files in debug mode may occupy a considerable amount of space.

See also. For more information about vStor replication and replication relationships, see .

Managing Certificates
Using Remote Keystore
Catalogic Software Data Protection Technical Support
Creating a New Replication Relationship Using vStor Web Interface
vStor User Roles