Chat now with support
Chat with Support

NetVault 11.3 - CLI Reference Guide

Introduction Getting started Using the command-line utilities Using the nvreport utility


Modifies a set.

Table 76. nvsetmodify


Specifies the name of the set that you want to modify.


Specifies the set type. It can be one of the following:

BS: Backup Selection Set
BO: Backup Options Set
RS: Restore Selection Set

The nvsetmodify utility does not support the following set types:

S: Schedule Set
BT: Backup Target Set
AB: Backup Advanced Options Set
AR: Restore Advanced Options Set

To modify these sets, you can use the following methods:

Use the nvsetcreate utility to create a set with the same name. This utility overwrites the existing set.


Specifies the changes that you want to make. This option can be used more than once. The <change description> variable is formatted as follows:

<item>[:<field>][:<old value>]=<new value>

<item> can be set to one of the following values

<field> specifies the field in the item that is to be modified.

<old value> specifies the old setting for the selected item.

<new value> specifies the new setting for the selected item.

Change items:

tree: Modifies items in the selection tree. The “tree” item applies only to Backup and Restore Selection Sets. For the “tree” item, the “<field>” variable can be set to the following values:
path: For more information, see path.
rename: For more information, see rename.
info: For more information, see info.
<node name or ID> for inclusion: For more information, see <Node Name> or <ID>.


Options: Adds or modifies the restore options if the plug-in provides any.
Target: Changes items in the target tree (Restore Selection Sets only).



Modifies the client name, the plug-in name, or a single node in the selection path. To change the path, set the old and new variables as follows:


A Backup Selection Set for the Plug-in for FileSystem includes the following selection path on Windows:
On Linux Clients, the Plug-in for FileSystem does not include any predefined level-3 nodes (“Fixed Drives”, “Removable Drives”, and others). Therefore, a similar selection on Linux/UNIX Client includes the following nodes:



Adds or modifies a rename or relocation command to a Restore Selection Set.



Modifies the plug-in information object attached to a node in the selection tree. To use this option, set the variables as follows:


<Node Name> or <ID>

Includes an item in the backup or restore job. The item can either be the “node name” as recognized by the CLI or a numeric “ID” assigned to the node by NetVault Backup. Both of these values are grouped under the [Tree Nodes] section in the nvsetmodify.cfg file.

To use this option, set the variables as follows:


Reads options from a parameter file.

You can use any text editor to create the parameter file. Specify one option with its value per line and omit “-” before the option. Use spaces or tabs to separate the option and values. To include comments, begin the line with a “#” character.


# nvsetmodify example file

setname BackSet1

type BS

This file can be used with the -parameters option as follows:

./nvsetmodify -parameters example.txt


Specifies the assignment operator that you want to use in change descriptions. The default assignment operator is the “=” character. This option must be specified if the old or new values contain the “=” character.


Specifies the character that you want to use as a delimiter in change descriptions. The default delimiter is the “:” character. This option must be specified if old or new values contain the “:” character.


Displays the build date of the NetVault Backup distribution installed on the machine.

In this example, the -delimit option is used to set the character “@” as the delimiter because the path includes “:” which is the default delimiter.
NOTE: The Plug-in for FileSystem (Windows only) and a few other plug-ins (Plug-in for Consolidation, Plug-in for Data Copy, Plug-in for Databases, and Plug-in for Raw Devices) include pre-defined level-3 nodes. You can obtain the exact names of these nodes from the NetVault WebUI. To prevent any user errors, the nvsetmodify utility checks for the correctness of new values specified for level-3 nodes. An error message is displayed if you specify an incorrect value for these nodes. The utility does not perform any checks for the correctness or existence of nodes below level-3.


Triggers a job that has already been defined and saved using the Triggered scheduling option.

This utility is located in the bin directory.

Table 77. nvjobstart


Specifies the name of the NetVault Backup Server that administers the job.

This option is required when a remote server administers the job. It can be omitted when a local server administers the job. The server name is case‑sensitive.


Waits until the task has completed.


Displays additional information when the job starts and completes.

When the job starts, the details such as the Job ID, Instance ID, Job Title, and Start Time are displayed. When the job completes, the end time is displayed.


Aborts a job by terminating the trigger execution. This option must be used with the ‑wait option.

<trigger name>

Specifies the trigger name. This option must be the last option when the tool is invoked as shown in the following example:

nvtrigger -server <server name> -wait -verbose -killonexit <triggername>

The nvtrigger utility returns the following exit codes and messages when the job it is associated with completes execution:
Without the -wait option, the nvtrigger utility can support multiple jobs. With this option, the utility can only be used to trigger a single job. This limitation also applies to -wait -killonexit options. Therefore, you cannot use this option for policy jobs that contains multiple job definitions.
If you specify the -wait option in a script, control is returned to the script only after the triggered job completes. If you do not specify this option, control is returned immediately back to the script even if the triggered job is still running.

Log-specific utilities


Dumps NetVault Backup logs to a text or binary file.

Table 78. nvlogdump


Specifies the job ID for which logs are exported.


Specifies the name of the file to which logs are exported.

Depending on the dump format selected, the dump files are created in the binary or text directories under <NetVault Backup home>\logs\dumps (on Windows) or <NetVault Backup home>/logs/dumps (on Linux).

If you omit the -filename option, NetVault Backup creates a file named CLI_DUMP_<YYYYMMDD>_<HHMMSS> in the specified format. The binary file has the extension “.nlg”; the text file does not have any extension.


Exports logs in text format. If you omit this option, then logs are dumped in binary format.


Specifies the time that serves as the starting point for the log dump. The format to specify start time is YYYYMMDDHHMMSS.


Specifies the time that serves as the stopping point for the log dump. The format to specify end time is YYYYMMDDHHMMSS.

At least the jobid option or a combination of the starttime and endtime options must be specified to properly use this utility. A combination of the options jobid, starttime, and endtime can be specified to dump logs for a particular job that were generated within the given period.

Related Documents