Search <book_title>...

Veritas NetBackup™ Deduplication Guide

Last Published: 2018-01-31

Product(s): NetBackup (8.1)

About the CloudCatalyst esfs.json configuration file

The NetBackup CloudCatalyst uses the configuration options that are included in the esfs.json file for many operations, including options that determine when data is uploaded to cloud storage or when it is evicted from the local cache. Some of the options are configurable by the NetBackup administrator. The location of the esfs.json file depends on the location of the local cache directory.

As part of the Cloud Storage Server Configuration Wizard, the administrator configures a local cache directory. The local cache directory (local_cache_dir in the following topic) determines the location of other directories which are installed automatically and are critical to CloudCatalyst operations:

A mount path (/storage): local_cache_dir/storage
The Veritas NetBackup Extendable Storage File System process (vxesfsd) runs on the mount path.
A cache path (/cache): local_cache_dir/cache/etc/esfs.json
This is the location of the esfs.json file.

Configuring the options in the esfs.json file

The NetBackup CloudCatalyst configuration options are listed in Table: Configuration items in the esfs.json file.

To change the configuration items in the esfs.json configuration

Change one or more of the configuration items in the esfs.json file. The file is found in the following location:
local_cache_dir/cache/etc/esfs.json
Save and close the file.
If vxesfsd is running, run the esfs_reconfig command, indicating the mount path, as follows:
/usr/openv/esfs/bin/esfs_reconfig local_cache_dir/storage
If esfs.json is changed while vxesfsd is stopped, the changes take effect the next time vxesfsd starts.
Some items require that you restart vxesfsd before the new configuration can take effect.
These items are indicated in Table: Configuration items in the esfs.json file.
- Before stopping vxesfsd, make sure that no processes are using vxesfsd, including the current working directory of any user.
  The NetBackup Deduplication Manager (spad) and the NetBackup Deduplication Engine (spoold) use vxesfsd, so they need to be stopped if either is running.
- Before starting vxesfsd, make sure that no data exists in the mount point. If data exists in the mount point, vxesfsd fails to restart.
The following topic contains additional information about restarting vxesfsd:
See Restarting the vxesfsd process.

Table: Configuration items in the esfs.json file

Configuration item	Default setting	Description	vxesfsd restart required?
Log
Path	\/usr\/openv\/netbackup\/logs	This setting indicates the directory where logs for the vxesfsd process are created. The logs include the following: esfs_database esfs_filesystem esfs_monitor esfs_storage esfs_storagemanager	Yes
Path	\/usr\/openv\/esfs\/logs\/ops	esfs-config.* esfs-run.*	Yes
Size	10485760	This value (in kilobytes) controls the maximum size that a single log file is allowed to grow. Once the file reaches that approximate size, the log file is closed and another log file is opened.	No
Level	1	This value determines the logging level and what information is included in the logs: 1: Errors only 2: Warnings and errors 3: All log entries Note: The Global logging level in the Host Properties has no effect on this setting.	Yes
Monitor
DACDays	30	The Delete After Close Days value determines how long a container file remains in the cache after it is last accessed and then closed. After the specified number of days, vxesfsd removes the file from the cache directory only if it has been successfully uploaded to the cloud. This commonly occurs shortly after midnight where the CloudCatalyst storage server is located. Files which have not been successfully uploaded to the cloud are not removed from the cache directory.	No
HighWatermark	80	This value determines how full the cache partition is allowed to grow before vxesfsd begins to evict container files. The value represents the percentage of used space on the cache partition. The oldest files are evicted until the LowWatermark is met. Files that have not been successfully uploaded to the cloud are not removed from the cache directory by the eviction process. If the HighWatermark value is set very low, the cache is nearly cleared. That is, nearly all of the eligible files are evicted. Note: The file system on which the cache resides must not contain data from any other applications.	No
LowWatermark	70	This value determines at what point vxesfsd stops evicting container files after the HighWatermark triggers eviction. The value represents the percentage of used space on the cache partition.	No
BackupDBTime	12	This value determines how frequently (in hours) the database is backed up. This value is unrelated to the drcontrol policy, if one exists. Veritas recommends that a drcontrol policy is created and used to protect your cloud storage server. Veritas recommends that this value is not changed. Note: This is a special database for the cloud storage server, not the NetBackup or MSDP catalog.	No
StorageManager
IOSize	1048576	This value (in bytes) has been used for internal testing. Veritas recommends that this value is not changed.	No
UploadThreads	20	This value determines the number of threads available for uploading data to the cloud.	Yes
DownloadThreads	20	This value determines the number of threads available for downloading data from the cloud.	Yes
BackupDBCopies	14	This value determines the maximum number of saved copies of the database that will be created for backup. Veritas recommends that this value is not changed. This value is unrelated to the drcontrol policy, if one exists. Veritas recommends that a drcontrol policy is created and used to protect your cloud storage server. Note: This is a special database for the cloud storage server, not the NetBackup or MSDP catalog.	No
FileSystem
MaxOpenFile	192114	This value determines the maximum number of files that can be open at one time. Veritas recommends that this value is not changed.	Yes
ReadOnly	0	This value indicates whether the files currently stored in the cloud can be modified: 0: The files can be modified. (Default.) 1: The files are read only. This setting is used for disaster recovery and should not be changed under normal usage.	Yes