Expert Mode

For advanced NAKIVO Backup & Replication configuration, you can enable the Expert mode. 

To do this, take the following steps:

  1. Log in to your NAKIVO Backup & Replication instance.

  2. Add the word “expert” to the URL parameters of the Settings page.

    Examples:
    https://localhost:4443/c/configuration?expert or  
    https://localhost:4443/c/configuration?action=&targetId=&backUrl=&wizard=false&expert

  3. Click the Expert tab. 

Configuring Settings

To configure advanced product settings, make the necessary changes in the following parameters:

Parameters

Description

Possible Values

system.email.smtp.localhost.mode

Specifies how to determine the name of the localhost that is used in the SMTP HELO or EHLO commands.

  • Default

  • Use DNS

  • Provide custom hostname

system.email.smtp.localhost.name

Specifies the name of the localhost that is used in the SMTP HELO or EHLO commands. This setting is valid for custom hostname resolution mode only.

 

system.email.smtp.tls.version

Specifies the TLS version to use for SMTP server communication when TLS is configured in the Email Settings.

  • Default

  • TLS10

  • TLS11

  • TLS12

  • TLS13

system.email.notifications.skip.event.list

List of event names to skip when creating an email digest. Use space or "," or ";"  as separators. The event names can be found in events.log. 

Event names (example: error60)

system.vmware.esxi.ssh.port

For VMware only. Specifies the SSH port to connect to ESXi (global setting).

  • Default value: 22

  • Minimum value: 1

  • Maximum value: 65535

system.vmware.skip.outdated.tools.checking

For VMware only. When enabled, the system does not check VMware Tools outdated status when creating quiescing snapshot.

  • Unchecked (default)

  • Checked

system.vmware.skip.tag.discovery

VMware only. When enabled, the system does not discover VMware Tags. This is applied to all tenants.

  • Unchecked (default)

  • Checked

system.debug.mode.log.vmware.api.incoming.requests

VMware only. When enabled, the incoming message will be printed for VIJAVA API received response.

The option only works if system.debug.mode.enabled is checked.

  • Unchecked (default)

  • Checked

system.debug.mode.log.vmware.api.outgoing.requests

VMware only. When enabled, the outgoing message will be printed for VIJAVA API sent request.

The option only works if system.debug.mode.enabled is checked.

  • Unchecked (default)

  • Checked

http.max.upload.size

Specifies the max upload size for file upload operations, bytes (global setting). If multiple files are uploaded, this is the total size.   Use -1 for unlimited.
Example: 200MB: 200000000

  • Default value: 1073741824

  • Minimum value: 1

  • Maximum value: 999999999999

system.auth.use.lockout

Enables or disables the login lockout feature. When enabled, the offending IP address is not allowed to login after several failed attempts.

  • Unchecked (default)

  • Checked

system.auth.max.login.attempt.count

Specifies the maximum number of failed login attempts to trigger the login lockout feature for the offending IP.

  • Default value: 5

  • Minimum value: 1

  • Maximum value: 9999

system.auth.lockout.timeout

Specifies the timeout (minutes) for the login lockout feature. The offending IP is allowed to login again after the timeout expires.

  • Default value: 15

  • Minimum value: 1

  • Maximum value: 9999

system.auth.login.history.period

Specifies the period (minutes) to calculate the maximum number of failed login attempts for the login lockout feature.

  • Default value: 5

  • Minimum value: 1

  • Maximum value: 9999

system.auth.ad.integration.follow.referrals

Defines LDAP/Active Directory behavior for referrals. When set to follow, all referrals are resolved (can be slow); otherwise they are ignored.
What are the implications of the ignore option?
* If you only have one domain, there should be no effects.
* If you have multiple domains joined in a forest, then any cross-domain memberships will not be resolved.
More info: https://docs.oracle.com/javase/jndi/tutorial/ldap/referral/jndi.html

  • follow (default)

  • ignore

system.auth.ad.integration.connect.timeout

Specifies the timeout (miliseconds) for connecting LDAP/Active Directory.

  • Default value: 2000

  • Minimum value: 2000

  • Maximum value: 100000

system.auth.ad.integration.read.timeout

Specifies the timeout (miliseconds) for reading LDAP/Active Directory operations.

  • Default value: 10000

  • Minimum value: 10000

  • Maximum value: 100000

system.auth.max.login.2fa.attempt.count

Specifies the attempts for the login lockout feature. The offending IP is allowed to login again after the timeout expires.

  • Default value: 5

  • Minimum value: 1

  • Maximum value: 9999

system.auth.lockout.2fa.timeout

Specifies the timeout (minutes) for the login lockout feature. The offending IP is allowed to login again after the timeout expires.

  • Default value: 5

  • Minimum value: 1

  • Maximum value: 9999

system.job.block.size

Select block size for processing data.

Notes

  • Deduplication can only be efficient with recovery points using the same block size.

  • Once the value is changed, the existing backup jobs, previously using a different block size, will produce a full backup on the next run.

  • Mapping to a backup with a different block size will be skipped

  • 4 MB (default)

  • 2 MB

  • 1 MB

  • 512 KB

  • 256 KB

  • 128 KB

  • 64 KB

  • 32 KB

  • 16 KB

  • 8 KB

  • 4 KB

system.job.map.new.source.item.scope

The scope to search for the existing backup when adding a new source item to the job.

  • Default location (default)

  • Default transporter's locations

  • All locations

system.job.pool.queue.length

Specifies the length of the job queue. A job is placed in a queue before execution. Requires restart.

  • Default value: 200

  • Minimum value: 10

  • Maximum value: 9999

system.job.pool.thread.min

Specifies the minimum thread pool size for jobs. A job requires 1 thread from the job pool to start running. Requires restart.

  • Default value: 30

  • Minimum value: 10

  • Maximum value: 9999

system.job.pool.thread.max

Specifies the maximum thread pool size for jobs. A job requires 1 thread from the job pool to start running. When the pool thread limit is reached, the job is placed in the job queue. Requires restart.

If using Linux and systemd, please add the following to the service startup script: TasksMax=infinity

  • Default value: 200

  • Minimum value: 10

  • Maximum value: 9999

system.job.resolve.host.hostname.on.transporter

If set, sends the source and/or target host hostname as is to Transporter. Transporter will resolve the hostname to the IP address(es) and check if it is reachable. This is done during the Transporter to host checks on a  job run.

The default behavior is to do the resolution locally and send the IP addresses to Transporter. This can be a problem in complex network topologies (VPN, etc).

  • Unchecked (default)

  • Checked

system.job.resolve.transporter.hostname.on.transporter

If set, sends the source and/or target Transporter hostname as is to Transporter. Transporter will resolve the hostname to the IP address(es) and check if it is reachable. This is done during Transporter to Transporter checks on job run.

The default behavior is to do the resolution locally, get hostnames for all resolved IP addresses, and then send them to Transporter. This can be a problem in complex network topologies (VPN, etc).

  • Unchecked (default)

  • Checked

system.job.bandwidth.throttling.source

If set, applies bandwidth throttling for data reading from source.

  • Checked (default)

  • Unchecked 

system.job.bandwidth.throttling.target

If set, applies bandwidth throttling for data writing to target.

  • Checked (default)

  • Unchecked 

system.job.bandwidth.throttling.network

If set, applies bandwidth throttling for data transfer between source and target.

  • Checked (default)

  • Unchecked

system.job.ict.skip.new.disk

If set, new disks added to the source item will not be added to the job automatically.

  • Checked (default)

  • Unchecked

system.job.replica.vm.suffix

The default suffix to append to replica VMs.

This setting is global and can only be changed inside the master tenant.

Can be between 1 and 20 characters ("-replica" by default)

system.job.recovered.vm.suffix

The default suffix to append to recovered/flash-booted VMs.

This setting is global and can only be changed inside the master tenant.

Can be between 1 and 20 characters ("-recovered" by default)

system.job.skip.manual.transporter.data.path.validation

If set, transporter data path validation will be skipped for manually configured transporters.

  • Unchecked (default)

  • Checked

system.metadata.disable.ec2.instance.id.update

Disables EC2 instance ID detection on product startup. The detection is done via a HTTP request to http://169.254.169.254/latest/meta-data/instance-id This is required for proper product functioning in the AWS cloud.

  • Unchecked (default)

  • Checked

system.task.pool.queue.length

Specifies the length of the task queue. A task is placed in the queue before execution. Requires restart.

  • Default value: 200

  • Minimum value: 10

  • Maximum value: 9999

system.task.pool.thread.min

Specifies the minimum thread pool size for tasks. A task requires 1 thread from the task pool to start running. Task example: repository refresh, Transporter refresh, support bundle creation. Requires restart.

  • Default value: 30

  • Minimum value: 10

  • Maximum value: 9999

system.task.pool.thread.max

Specifies the maximum thread pool size for tasks. A task requires 1 thread from the task pool to start running. When the pool thread limit is reached, the task is placed in the task queue. Task example: repository refresh, Transporter refresh, support bundle creation. Requires restart.

  • Default value: 200

  • Minimum value: 10

  • Maximum value: 9999

system.repository.min.free.space.byte

Specifies the minimum free space (bytes) for the repository. If the free space goes below this value, an alarm is generated.

  • Default value: 5368709120

  • Minimum value: 1024

  • Maximum value: 1099511627776

system.repository.min.free.space.percent

Specifies the minimum free space (percent) for the Backup repository. If the free space goes below this value, an alarm is generated.

  • Default value: 5

  • Minimum value: 1

  • Maximum value: 99

system.repository.ec2.min.free.space.resize.percent

In case the free space is less than the set percentage of the total current storage, one minimum chunk will be added to the storage.

  • Default value: 10

  • Minimum value: 1

  • Maximum value: 100

system.repository.ec2.max.free.space.resize.percent

In case the free space is more than the set percentage of the total current storage, one minimum chunk will be removed from the storage.

  • Default value: 15

  • Minimum value: 1

  • Maximum value: 100

system.repository.maintenance.interrupt.timeout.seconds

Specifies the timeout (seconds) to wait for repository maintenance stop during job run.

  • Default value: 300

  • Minimum value: 1

  • Maximum value: 86400

system.repository.refresh.backup.size.calculation

Specifies the backup size calculation on the repository refreshing. True: Always calculates backup size. False: Skips backup size calculation and only calculates backup size with necessary backups.

  • Checked (default)

  • Unchecked

system.repository.refresh.timeout.seconds

Specifies the timeout (seconds) to wait for repository refresh.

  • Default value: 600

  • Minimum value: 1

  • Maximum value: 86400

system.repository.remove.backups.used.by.job

The setting allows to remove backup objects associated with existing jobs, and remove the last RP of a backup object in case such RP is due to be removed according to the retention policy. If enabled, removal of the aforesaid objects can be done manually or automatically, in accordance with the configured retention policy.

  • Unchecked (default)

  • Checked

system.product.skip.update.server.ssl.certificate.verification

The product update check process requires the remote server certificate to be trusted. This parameter disables such check. It can be useful when secure (SSL/TLS) connections are being intercepted by third-party software.A product restart is required to apply.

  • Unchecked (default)

  • Checked

system.debug.mode.enabled

The debug mode prints more information into the logs, including some sensitive one (hardware UUIDs, MAC addresses, etc). The passwords are not printed unless they are present in raw communication dumps (e.g., SOAP/XML/JSON).

  • Unchecked (default)

  • Checked

system.debug.mode.log.passwords

When debug mode is enabled, also log passwords. This can be a security risk.

  • Unchecked (default)

  • Checked

system.debug.mode.log.api.requests

When debug mode is enabled, also log product API requests/responses. The data is logged as is and will contain plaintext passwords. This can be a security risk.

  • Unchecked (default)

  • Checked

system.hyperv.optimize.queries

Hyper-V only. Instructs to use a faster query method to read VM and host information. This will speed up the refresh process in large environments.

  • Checked (default)

  • Unchecked 

system.hyperv.discovery.host.thread.count

Hyper-V only. Sets the max parallel threads to run when refreshing cluster hosts during discovery. Each cluster host can be refreshed separately. This will speed up the refresh process in large environments.

  • Default value: 2

  • Minimum value: 1

  • Maximum value: 20

system.hyperv.discovery.vm.thread.count

Hyper-V only. Sets the max parallel threads to run when refreshing host VMs during discovery. When increasing the setting value, make sure to test its impact on host CPU usage during refresh. This will speed up the refresh process in large environments.

  • Default value: 2

  • Minimum value: 1

  • Maximum value: 10

system.database.scheduled.backup.path

Specifies the target path for database backups. The tenant databases will be stored in subfolders, if present. The path can be local or absolute. The folder will be created automatically if it does not exist.

system.database.scheduled.backup.max.count

Specifies the maximum number of files for periodic database backups. The number is applied separately to each tenant database. The master and tenants product databases are backed up each day.

  • Default value: 5

  • Minimum value: 0

  • Maximum value: 365

system.logging.max.index

Specifies the maximum index of log files. This works globally for all log files. Set 0 to use default value (configured in log4j.xml).

  • Default value: 0

  • Minimum value: 0

  • Maximum value: 999

system.product.min.free.space.byte

Specifies the minimum free space (bytes) for the product installation folder. If the free space goes below this value, an alarm is generated.

  • Default value: 2147483648

  • Minimum value: 10485760

  • Maximum value: 10737418240

system.product.free.memory.threshold

Specifies the minimum ratio for JVM free memory. If the free JVM memory goes below this value, an alarm is generated.

  • Default value: 0.1

  • Minimum value: 0.01

  • Maximum value: 0.9

system.nutanix.discovery.vm.thread.count

Nutanix AHV only. Sets the max parallel threads to run when refreshing host VMs during discovery. When increasing the setting value, make sure to test its impact on host CPU usage during refresh. This will speed up the refresh process in large environments.

  • Default value: 2

  • Minimum value: 1

  • Maximum value: 10

system.aws.discovery.region.thread.count

AWS only. Sets the max parallel threads to run when refreshing the AWS Regions during discovery. When increasing the setting value, make sure to test its influence on host CPU usage during refresh. This will speed up the refresh process in large environments.

  • Default value: 4

  • Minimum value: 1

  • Maximum value: 10

system.aws.discovery.other.thread.count

AWS only. Sets the max parallel threads to run when refreshing other AWS entities inside the Region during discovery. When increasing the setting value, make sure to test its influence on host CPU usage during refresh. This will speed up the refresh process in large environments.

  • Default value: 4

  • Minimum value: 1

  • Maximum value: 10

system.plugin.flr.operation.timeout.seconds

Specifies the timeout (seconds) to wait for plugin session FLR/OLR. This is a low-level setting that is only sent to Transporter and used during iSCSI interaction.

  • Default value: 900

  • Minimum value: 1

  • Maximum value: 86400

system.physical.skip.os.checking

Physical Windows host discovery only. When enabled, the system will not check the supported OS version.

  • Checked

  • Unchecked (default)

system.transporter.agent.injection.skip.vc.redist

When enabled, the system will not automatically install VC redistributable during Transporter/agent injection.

  • Checked

  • Unchecked (default)

system.transporter.load.max.time.created.state.hours

Specifies the timeout (hours) to wait for getting Transporter load request. Default is 5 hours.

  • Default value: 5

  • Minimum value: 1

  • Maximum value: 72

system.transporter.modern.min.heap.size.megabyte

Megabytes.

The -Xms option sets the initial and minimum Java heap size. The Java heap (the “heap”) is the part of the memory where blocks of memory are allocated to objects and freed during garbage collection.

Note: Transporter restart is required to apply the setting.

  • Default value: 512

  • Minimum value: 256

  • Maximum value: 65536

system.transporter.modern.max.heap.size.megabyte

Megabytes.

This option sets the maximum Java heap size. The Java heap (the “heap”) is the part of the memory where blocks of memory are allocated to objects and freed during garbage collection. Depending on the kind of operating system you are running, the maximum value you can set for the Java heap can vary.

Notes:

-Xmx does not limit the total amount of memory that the JVM can use.

Transporter restart is required to apply the setting.

  • Default value: 3072

  • Minimum value: 256

  • Maximum value: 65536

system.transporter.modern.thread.stack.size.kilobyte

Kilobytes.

-Xss sets the thread stack size. Thread stacks are memory areas allocated for each Java thread for their internal use. This is where the thread stores its local execution state.

Note: Transporter restart is required to apply the setting.

  • Default value: 512

  • Minimum value: 64

  • Maximum value: 2048

system.transporter.modern.job.handler.max.thread.count

Specifies the job thread count for modern Transporter.

Notes:

  • 1 job thread equals ~200MB of memory, consider changing the related setting.

  • Transporter restart is required to apply the setting.

  • Default value: 10

  • Minimum value: 1

  • Maximum value: 128

system.transporter.modern.service.handler.max.thread.count

Specifies the service thread count for modern Transporter.
Note: Transporter restart is required to apply the setting.

  • Default value: 10

  • Minimum value: 1

  • Maximum value: 128

system.transporter.jvm.ram.requirement

Bytes.
For NASes only.
Specifies the minimal ram required on NASes to create a SaaS repository.

  • Default value: 4294967296

  • Minimum value: 0

  • Maximum value: 1099511627776

system.transporter.modern.thread.pool.size

Specifies the session factory thread pool size for modern Transporter.

Note: Transporter restart is required to apply the setting.

  • Default value: 1000

  • Minimum value: 100

  • Maximum value: 1000

system.deleted.users.groups.remove.frequency

Specifies the scheduled time for removing unnecessary deleted users, groups (in second).

  • Default value: 86400

  • Minimum value: 300

  • Maximum value: 1.7976931348623157e+308

system.inventory.allow.duplicated

Microsoft 365 and physical machines only. When enabled, the system allows duplicated discovery items.

  • Unchecked (default)

  • Checked 

system.inventory.optimize.discovery.time

Microsoft 365 (SharePoint Online) only. When enabled, the system skips some attributes to optimize the discovery time.

  • Unchecked (default)

  • Checked 

system.o365.suppress.throttling.event

Suppress throttling warning.

  • Unchecked (default)

  • Checked 

system.event.skip.creating.event.list

List of event/alarm/notification names to skip when creating an event. The event is still logged and handled. Use space or , or ; as separators. The names can be found in events.log.

Event names (example: error60)

system.events.use.windows.event.integration

Use Windows Event log integration. Some product events will also be created in the Application log.

This setting is global and can only be changed inside the master tenant.

  • Unchecked (default)

  • Checked 

system.exchange.enable.direct.recovery

When enabled, you can recover Exchange items without using a recovery server. For example, you can download items to the browser or forward them to a certain email. To do this, select Download items or forward via email on the Destination page of the job wizard and then select the appropriate recovery type on the Options page.
Note that Google limits the total size of attachments within a message to 25 MB. Forwarding messages containing attachments that exceed this limit will fail.

  • Unchecked (default)

  • Checked 

system.olr.dsamain.mount.port

TCP port where DSAMAIN mounts NTDS.dit (AD database) for.

  • Default value: 5000

  • Minimum value: 1

  • Maximum value: 65535

system.product.register.disable.periodic.data.collection

When enabled, the product will not send data bundles every 30 days.

  • Unchecked (default)

  • Checked 

system.repository.skip.periodic.refresh.on.transporter.busy.with.job

When enabled and any Transporter repository is locked by a running job, the product skips periodic refresh for this Transporter repository.

  • Unchecked (default)

  • Checked 

system.pql.custom.file.name

PQL file name in the userdata folder. Empty by default. If empty, the file will be downloaded from web.

system.pql.cache.ttl.hours

Time to keep PQL file cache, in hours. Use 0 to disable the cache.

  • Default value: 8

  • Minimum value: 0

  • Maximum value: 72

system.transporter.allow.new

Allows using newer Transporter versions.

  • Unchecked (default)

  • Checked 

system.transporter.allow.old

Allows using older (outdated) Transporter versions.

  • Unchecked (default)

  • Checked 

system.transporter.modern.idle.timeout

Specifies the timeout (milliseconds) for modern Transporter IDLE. If you set it to 0, it will be an unlimited timeout, meaning the transporter can only be stopped manually.

Note: Transporter restart is required to apply the setting.

  • Default value: 3600000

  • Minimum value: 0

  • Maximum value: 86400000

system.volatile.object.processing.type

Default: try to remove the volatile objects periodically until their time to live (fixed) is reached. Alternative: fine-tune the settings. See the other system.volatile.object variables. The setting is global and can be changed inside the master tenant only.

  • Default (default option)

  • Alternative

system.volatile.object.retry.count

Alternative processing type only. The maximum number of retries for volatile objects removal. 0 means no retries, so only one removal attempt will happen. The setting is global and can be changed inside the master tenant only.

  • Default value: 7

  • Minimum value: 0

  • Maximum value: 256

system.volatile.object.retry.interval

Alternative processing type only. Minutes. The desired delay between each removal retry. The real delay depends on the queue and on the exponential retry factor (configurable). The setting is global and can be changed inside the master tenant only.

  • Default value: 60

  • Minimum value: 5

  • Maximum value: 14400

system.volatile.object.exponential.retry.interval.factor

Alternative processing type only. The ratio to use when calculating the delay time for the next retry. The next delay equals interval * (factor^retry). Example: the interval is 60 minutes, the factor is 2. The first retry will happen in +60 minutes, the second in +240 minutes , ... . The setting is global and can be changed inside the master tenant only.

  • Default value: 2

  • Minimum value: 1

  • Maximum value: 10

system.visual.notification.service.disable

Disables the visual notification service. This can speed up the UI when the database contains many event entries.

This setting is global and can be changed inside the master tenant only.

  • Unchecked (default)

  • Checked

system.msp.console.listening.port

TCP port used by the MSP product for listening to remote tenants. Port 6702 is used by default.

  • Default: 6702

  • Minimum value: 1

  • Maximum value: 65535

system.events.use.windows.event.integration

Use Windows Event log integration. Some product events will also be created in the Application log.

The setting is global and can be changed inside the master tenant only.

  • Unchecked (default)

  • Checked

system.transporter.load.path.cost.variation.percent

Percent. Specifies the allowed data path cost variation.

During the job run, automatic transporter selection may happen. The first step is to choose the top N (by cost in milliseconds) data paths. The second step is to choose the best data path based on the lowest transporter load.

For example, 20 paths were found based on round trip time between source and target host.

If the setting is 10%, the best path cost is 2 (N=2), then only paths with costs in range 2 ... 2.2 (2+0.2) will be chosen on the first step.

The setting is global and can be changed inside the master tenant only.

  • Default value: 10

  • Minimum value: 1

  • Maximum value: 10000

system.vmware.discovery.vm.detect.ipaddress.by.dns.skip

The setting is applicable only to VMware vSphere infrastructure.

If enabled, the detection of VM IP address via DNS resolution will be skipped.

Note: Detection of VM IP address via DNS resolution is applied in case VMware Tools are not installed on the VM.

  • Checked (default)

  • Unchecked

system.job.default.retention.approach

Schedule-retention fusion: New backup and backup copy jobs will use the new schedule-retention step.

Legacy: New backup and backup copy jobs will use the legacy schedule and retention steps.

  • Schedule-retention fusion

  • Legacy

system.job.run.skip.infrastructure.refresh

If set, infrastructure refresh will be skipped during job run.

  • Unchecked (default)

  • Checked
system.job.ict.skip.new.source.item If set, new source items will not be added to the job automatically.

  • Unchecked (default)

  • Checked
system.transporter.min.connect.timeout.seconds Specifies the minimum connect timeout (seconds) for transporter connection. Set 0 to use default value in the product (90 seconds).

  • Default value: 0

  • Minimum value: 0

  • Maximum value: 86400
system.transporter.min.write.timeout.seconds Specifies the minimum write timeout (seconds) for transporter command. Set 0 to use default value in the product (60 seconds).

  • Default value: 0

  • Minimum value: 0

  • Maximum value: 86400
system.transporter.min.idle.timeout.seconds Specifies the minimum read idle timeout (seconds) for transporter command. Set 0 to use default value in the product (300 seconds).

  • Default value: 0

  • Minimum value: 0

  • Maximum value: 86400

Configuring Actions View

Click the Actions tab to configure the following actions:

  • Remove all events: By clicking the link, you can remove all events/alarms/etc for the current tenant. 

  • Forget all passwords (except users): By clicking the link, you can set the stored passwords to “” for the current tenant items. The only exception is user passwords; they must be set manually.

  • Clean up job history: By clicking the link, you can immediately apply the configured Store job history for the last setting.

In the text box, you can see the report on the actions.

Example 1

Request 1: sending (Remove all events)...

Request 1: success=true (Remove all events).

Example 2

Request 1: sending (Forget all passwords (except users))...
Request 1: success=true (Forget all passwords (except users)).

Example 3

Request 1: sending (Clean up job history)...
Request 1: success=true (Clean up job history).

Packages

By clicking the Packages tab, you can see the following information:

  • Base local path: packages. Location of packages in product installation directory

  • List of Existing packages 

  • List of Supported packages