NetVault 12.4 - CLI Reference Guide

Table 76. nvsetimport
Option	Description
-file	Specifies the name of the input file.
-setname[=<newname>]	Specifies the names of the sets that you want to import from the input file. To import multiple sets, specify each set name separately using the -setname option. You can rename each set while importing them to NetVault Backup. If you omit this option, all sets available in the input file are imported, each retaining their original name. The existing sets with the same name are overwritten.
-assign	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 any value contains the “=” character.
-version	Displays the build date of the NetVault Backup distribution installed on the machine.

Examples

•

Import all sets from the file “schedules.nss”:

nvsetimport -file schedules.nss

•

Import the set “Robin” from the file “bandr.nss”, renaming the imported set to “Ptarmigan”:

nvsetimport -file bandr.nss -setname Robin=Ptarmigan

•

Import the set “Blackbird” from file “bandr.nss”, renaming the imported set to “b=k”:

nvsetimport -file bandr.nss -assign @ -setname Blackbird@b=k

nvsetmodify

Description

Modifies a set.

Syntax

nvsetmodify -setname <set name> -type <set type> -change <change description>
[-parameters <parameter file>] [-assign <assignment character>]
[-delimit <delimiter character>] [-version]

Options

Table 77. nvsetmodify

Option

Description

-setname

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

-type

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.

•

Use the NetVault WebUI to modify the set.

-change

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> 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.

To use this option, you require the “Tag ID” of the option that you want to set. The Tag ID can either be the backup option name as recognized by the CLI or a numeric value assigned to the option by NetVault Backup. Both of these values are grouped under the [Plugin Options] section in the nvsetmodify.cfg file.

The format for specifying this option is:

Options:<Tag ID>=True/False

•

Target: Changes items in the target tree (Restore Selection Sets only).

The <field> variable is used to specify the type to be changed. The only permitted value is a valid NetVault Backup Client name. The <new value> specifies the new target Client.

NOTE: If no “<new value>” variable is specified, anything that is selected or omitted in the “<old value>” is considered de-selected when you run the command.

path

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:

•

Client:

<old value> = Name of the current NetVault Backup Client

<new value> = Name of the new NetVault Backup Client. Ensure that the client is added to the NetVault Backup Server.

•

Plug-in:

<old value> = Name of the current NetVault Backup Plug-in

<new value> = Name of the new NetVault Backup Plug-in. Ensure that the new plug-in is installed on the NetVault Backup Server or Client for which the set is defined.

•

Selection path:

<old value> = Full path to the node, from the plug-in root node to the node that you want to change. Depending on the client OS, use the backslash (\) character (Windows) slash (/) character (Linux/UNIX) as the path separator.

<new value> = Name of the new node

Example:

A Backup Selection Set for the Plug-in for FileSystem includes the following selection path on Windows:

Fixed Drives\C:\work\t1\dump\a

To change the directory “t1” to “t2” in this path, the variables are set as follows:

<old value> = Fixed Drives\C:\work\t1

<new value> = t2

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:

/work /t1/dump/a

To change the directory “t1” to “t2” in this path, the variables are set as follows:

<old value> =/work/t1

<new value> =t2

rename

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

•

To add a new rename or relocation command, set the variables as follows:

<old value> = Current name or path of the rename or relocation target

<new value> = New name or path for the rename or relocation target

•

To modify an existing rename or relocation command, set the variables as follows:

<old value> = Current rename or relocation syntax

<new value> = New rename or relocation syntax

info

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

<old value>= Full path to the item, from the plug-in root node to the applicable item.

<new value> = New values for the plug-in information object, separated by colons (“:”). To leave any field unchanged, specify a double colon (“::”) as the new value.

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:

<old value> = Node Name or Node ID of the current node. If the selection tree for the target NetVault Backup Client contains multiple nodes of the given type, specify the Node Name instead of the Node ID.

<new value> = Node name or ID of the new root node.

-parameters

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.

Example:

# nvsetmodify example file

setname BackSet1

type BS

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

./nvsetmodify -parameters example.txt

-assign

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.

-delimit

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.

-version

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

Examples

•

Modify the Backup Selection Set “BS-Set1” to change the NetVault Backup Client from “Client-A” to “Client-B”:

nvsetmodify -setname BS-Set1 -type BS -change Tree:path:Client-A=Client-B

•

Modify the Backup Selection Set “BS-Set1” to change the plug-in from “File System” to “Data Copy”:

nvsetmodify -setname BS-Set1 -type BS -change "Tree:path:File System=Data Copy"

•

Modify the Backup Selection Set “BS-Set1” to change the directory “t1” to “t2” in the selection path “Fixed Drives\C:\work\t1\dump\a”:

nvsetmodify -setname BS-Set1 -type BS
-change "Tree@path@Fixed Drives\C:\work\t1=t2" -delimit @

In this example, the -delimit option is used to set the character “@” as the delimiter because the path includes “:” which is the default delimiter.

•

Modify the Backup Selection Set “BS-Set1” to change the directory “t1” to “t2” in the selection path “/work/t1/dump/a”:

nvsetmodify -setname BS-Set1 -type BS -change "Tree:path:/work/t1=t2"

•

Modify the Backup Selection Set “BS-Set1” to change the drive node from “C:\” to “D:\” in the selection path “Fixed Drives\C:\work\t1\dump\a”:

nvsetmodify -setname BackupSetName -type BS
-change "Tree@path@Fixed Drives\C:\=D:\\" -delimit @

In this example, an extra backslash character is added to the new value D:\ to escape the first backslash character. If you do not include it, then the sequence D:\” would be interpreted as D:”; the first backslash would be used to escape the quotation mark (”).

•

Modify the Backup Selection Set “BS-Set1” to change the Network Share path from “\\Server1\a” to “\\Server2\b:

nvsetmodify -setname BackupSetName -type BS
-change "Tree@path@Network Shares\\\Server1\a\=\\Server2\b\\" -delimit @

•

Modify the Backup Selection Set “BS-Set1” to change the “Fixed Drives” node to “Removable Drives”:

nvsetmodify -setname BackupSetName -type BS
-change "Tree:path:Fixed Drives=Removable Drives"


	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.

•

Modify the Restore Selection Set “RestoreSet1” (created for the Plug-in for FileSystem) to make the following changes:

•

Change the target client from “WinClient1” to “WinClient2”

•

Relocate the directory “C:\Mail” to “C:\MyMail”

•

Set the Restore Option “Overwrite Newer Files”

nvsetmodify -setname RestoreSet1 -type RS
-change target:client:WinClient1=WinClient2
-change options:nvfs_opt_overnew=true -change @tree@path@c:\mail=c:\MyMail

nvtrigger

Description

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

This utility is located in the bin directory.

Syntax

nvtrigger [-server <server name>] [-wait] [-verbose] [-killonexit] <trigger name>

Options

Table 78. nvjobstart
Option	Description
-servername	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.
-wait	Waits until the task has completed.
-verbose	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.
-killonexit	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>

Notes

•

The nvtrigger utility returns the following exit codes and messages when the job it is associated with completes execution:

•

0: Backup Completed

•

1: Backup Failed

•

2: Backup Completed with Warnings

•

3: Backup Aborted

•

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

•

nvlogdump

•

nvlogpurge

•

nvreadlog

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

NetVault 12.4 - CLI Reference Guide

nvsetimport

nvsetmodify

nvtrigger

Log-specific utilities