vStor System Settings
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.
The System view is only available for users with Admin role. For more information, see vStor User Roles.
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.
![[image expected here]](/assets/images/system-system_settings_1-92d2372219ec774de3a5366e52900390.png)
System Informationβ
This section gathers general information about the vStorβs OS, library versions and statuses.
![[image expected here]](/assets/images/system-system_settings-system_information_1-65daafe9dfa7c10eafe089e041f9ba1b.png)
Hostβ
This section displays hostname and domain name information.
![[image expected here]](/assets/images/system-system_settings-host-22d0d052917d42a4abb83368d716eb0b.png)
You can edit this section by clicking the Edit button to launch the Edit Host dialog window.
![[image expected here]](/assets/images/system-system_settings-host-edit_host-49067399d1a9368c579584d8134cb8e3.png)
Certificatesβ
This section allows you to manage certificates in Catalogic vStor.
![[image expected here]](/assets/images/system_settings-certificates-1bcf346d1713497efeb8fddf8b03a701.png)
You can edit this section by clicking the Edit button to launch the Edit Certificate dialog window.
![[image expected here]](/assets/images/system_settings-certificates-edit_certificate-5adfe4060f05498d2eb177438f3d7cf5.png)
You can use the built-in certificate or add a custom one by selecting Custom certificate from the Certificate dropdown.
For more details on certificates in vStor, see Managing Certificates.
Generalβ
This section gathers the general settings of your vStor machine.
![[image expected here]](/assets/images/system-system_settings-general-4e4370991036d8f3d619baa8ea20dc0d.png)
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.
![[image expected here]](/assets/images/system-system_settings-edit_general-ccf9d85a1aa3a9a3c6b10de572c1b18a.png)
Use the Reset button to restore default values. You will be prompted to confirm your decision.
Kerberos Configurationβ
This section displays the current Kerberos configuration.
![[image expected here]](/assets/images/system-system_settings-kerberos_configuration-047ac9ba154a9de79bf7af4d7702cea7.png)
You can edit this section by clicking the Edit button to launch the Edit Kerberos Configuration dialog window.
![[image expected here]](/assets/images/system-system_settings-edit_kerberos_configuration-f904373900706077c3f06d284505c474.png)
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.
Use the Reset button to restore default values. You will be prompted to confirm your decision.
NFS Configurationβ
This section displays the current NFS configuration.
![[image expected here]](/assets/images/system-system_settings-nfs-configuration-22973738a64131909a8b0d0fbc59e3e6.png)
You can edit this section by clicking the Edit button to launch the Edit NFS Configuration dialog window.
![[image expected here]](/assets/images/system-system_settings-edit_nfs_configuration-e1d59be1d923e18349b27765ef65d3cf.png)
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.
Use the Reset button to restore default values. You will be prompted to confirm your decision.
Encryption Keystoreβ
Encryption Keystore is a remote location where encryption keys for vStor volumes are stored. Starting with version 4.15, vStor supports external key management using the Key Management Interoperability Protocol (KMIP).
- Navigate to System > System Settings tab > Encryption Keystore pane.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore_pane-unpopulated-8798df13aeadc2530ce3c062114252ea.png)
- Click Edit to launch the Edit Encryption Keystore pane.
Configuring KMIP Encryption Keystoreβ
- Select KMIP Keystore as Type.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore_pane-edit_kmip_keystore-ef4a134a6a68add3b2a136406b611df0.png)
-
Populate the dialog with required information and certificates.
-
Click Test to verify the keystore accessibility (optional).
-
Click Save. The configuration is now saved.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore_pane-kmip_keystore_configured-f83721444eb21a45cb0004797d1972e9.png)
Configuring SSH Encryption Keystoreβ
When configuring the SSH 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.
We recommend using your DPX Master Server as the remote Encryption Keystore, but you can use any Linux machine.
Note. User authentication must not require any additional steps besides specifying the username and password , e.g. multifactor authentication. In such a case, a connection error will be thrown.
To save edits made to the Encryption Keystore dialog, you need to specify the valid password to the remote Encryption Storeβs location.
- Populate the dialog according to the indications below.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore_pane-edit_ssh_keystore-5a9d9805ab6c3f3cdd49f888c15169b8.png)
| 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. |
-
Click Test to verify the keystore accessibility (optional).
-
Click Save. The configuration is now saved. The connection will also be tested when saving.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore_pane-ssh_keystore_configured-cadfbbf521dff6bc4c27415d42d8b28b.png)
For more information about the Encryption Keystore, see Remote Keystore.
Managing Keysβ
You can manage the keys in the keystore by clicking the Manage keys button to launch the Manage Keys dialog window.
![[image expected here]](/assets/images/system-encryption_keystore-manage_keys_dialog-5d33d0eb1404d68fddbbb9eff32e5a00.png)
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 .
To add encryption key to a volume, do the following:
- Click the Add key button next to the desired volume to launch the Add Encryption Key button.
![[image expected here]](/assets/images/add_encryption_key_dialog-a5411b6a96171a33c790e833a6862c75.png)
- Type in the valid encryption key for the volume.
- Click Save.
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.
Deleting Keysβ
![[image expected here]](/assets/images/system-encryption_keystore-manage_keys_dialog-delete-c2201162c2015549a593bbba127eaf84.png)
To delete a key from Encyption Keystore, hover over a row with Encryption Key added and click theicon. You will be prompted to confirm your decision. Click Delete.
![[image expected here]](/assets/images/system-system_settings-manage_keys-confirm_delete_key-6cb353ab775e2242e8c10a4cc58324e4.png)
You can also delete all stored Encryption Keys using the Delete all keys button at the bottom of the Manage Keys dialog window. You will be prompted to confirm your decision by typing your vStor password. Click Delete.
![[image expected here]](/assets/images/system-system_settings-manage_keys-confirm_delete_all_keys_1-9454f877411bc3352ddc113e59ae3909.png)
Migrating Keystoresβ
vStor supports key migration from and to both KMIP and SSH keystore.
To migrate your existing keystore:
- Go to the Encryption Keystore pane click Manage keys to launch the Manage Keys dialog window.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore_pane-manage_keys_dialog-migrate_highlighted-fda9f4037d778563839f95f531c924fa.png)
- Click Migrate keys to launch the Migrate Keys dialog window.
![[image expected here]](/assets/images/encryption_keystore-migrate_keys_step1-54b2be6465d41b9764a0592784551c82.png)
-
Change the keystore type if necessary and provide all the necessary details.
Click Next. -
In step 2, all keys stored in the original Encryption Keystore are shown.
Optionally, switch on the Delete keys in source keystore upon migration toggle. This operation must be confirmed with your userβs vStor password.
![[image expected here]](/assets/images/encryption_keystore-migrate_keys_step2-0870226f58953585fb2187467fb0c7eb.png)
- Click Migrate. When the operation is completed, you will be informed about the result.
Click Finish.
![[image expected here]](/assets/images/encryption_keystore-migrate_keys-migration_completed-9b02da333c5cd8640cf4547ddb10fb56.png)
No keys are deleted from the original keystore unless the migration has been successfully completed.
Resetting Encryption Keystoreβ
Use the Reset button to restore default values. You will be prompted to confirm your decision.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore-confirm_reset_no_delete-18c2af091e57d810858363be93136e60.png)
You can use the toggle to delete all associated keys from the keystore. You will need to confirm your decision by typing your vStor password.
![[image expected here]](/assets/images/system-system_settings-encryption_keystore-confirm_reset_yes_delete-8a68d1863567470b0cf0d66b340994db.png)
Click Reset. The Encryption Keystore configuration will be cleared and all keys stored remotely by your vStor will be deleted from the remote location.
Telemetryβ
To help improve vStor, you can share usage data with Catalogic Software.
![[image expected here]](/assets/images/system-system_settings-telemetry-0fb58b0276a854224c3a36ded3341dbf.png)
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.
Before enabling debug logging, we recommend contacting the Catalogic Software Data Protection Technical Support, as the log files in debug mode may occupy a considerable amount of space.
Firewallβ
Use the toggle to enable or disable firewall.
Timeβ
By default, vStor uses your machineβs locale to determine the current time.
![[image expected here]](/assets/images/system-system_settings-time-e53c1e2010f0be068753313e55f0e93c.png)
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 Time dialog window.
![[image expected here]](/assets/images/system_settings-time-edit_time_dialog-a8ccb79b58d50cb9adefc9fa7e70e522.png)
Deduplicationβ
Data deduplication is a process of eliminating multiple copies of data to optimize storage usage. Instead, only unique data chunks are stored.
![[image expected here]](/assets/images/system-system_settings-deduplication-42f1b444a4012a8a44c498c65dcf4ef6.png)
You can edit this section by clicking the Edit button to launch the Edit Deduplication dialog window.
![[image expected here]](/assets/images/system-system_settings-edit_deduplication-794057787c945775e226f251eb893db7.png)
Deduplication table prefetch timeout (seconds)β
Defines the maximum time (in seconds) vStor will try to load the deduplication table into memory.
Use the Reset button to restore the default value (900 seconds). You will be prompted to confirm your decision.
Replicationβ
This section gathers data transfer settings for outbound replication traffic.
![[image expected here]](/assets/images/system-system_settings-replication-b22aa47a4e2e3dfbf62bf4ec5595f238.png)
You can edit this section by clicking the Edit button to launch the Edit Replication dialog window.
![[image expected here]](/assets/images/system-system_settings-edit_replication-ca672531c2799a1f140c0ffd5d23f55d.png)
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.
Use the Reset button to restore default values. You will be prompted to confirm your decision.
For more information about vStor replication and replication relationships, see Creating a Replication Relationship.
E-mail Notification Detailsβ
This section includes details concerning vStor e-mail notifications.
![[image expected here]](/assets/images/system-system_settings-email_notofication_details-c1b625fb8e945717f36b8321b08e0002.png)
You can edit this section by clicking the Edit button to launch the Edit E-mail Notification Details dialog window.
![[image expected here]](/assets/images/system-system_settings-edit_email_notofication_details-70c144f4e13b91f5b9016657b63102de.png)
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.
- Use the Send test e-mail button to send a test notification and verify your e-mail configuration.
- Use the Reset button to restore default values. You will be prompted to confirm your decision.
E-mail Server Settingsβ
This section gathers e-mail notifications configuration for your vStor instance.
![[image expected here]](/assets/images/system-system_settings-email_server_settings-4b999e69d4cf7e966037040e339c0712.png)
You can edit this section by clicking the Edit button to launch the Edit E-mail Server Settings dialog window.
![[image expected here]](/assets/images/system-system_settings-edit_email_server_settings-f12ce20f38dc685053cd10a070953bca.png)
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.
- Use the Test button to verify e-mail server data (optional).
- Use the Reset button to restore default values. You will be prompted to confirm your decision.