NetVault 13.1.2 - CLI Reference Guide

NOTE: When you use the -rename option to rename and relocate, NetVault automatically splits the new path into the relocate section and the rename section. If a NetVault plug-in requires you to specify rename and relocate in the same section, use double quotes around the new path to instruct NetVault to keep the selections in the same path and to use the entire literal path for the rename section. For example:

-rename /usr/joe/diary=”/home/joe/diary.old”

-rename /filename/volume=”filename_target/volume_target”

-restoreoption <option=value>

Specifies Restore Options for a job.

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. Both of these values are grouped under the [Plugin Options] section in the nvsetmodify.cfg file.

The format for specifying this option is:

-restoreoption <Tag ID=value>

-restoretarget <client>

Specifies the name of the target client.

By default, items are restored to the same client that they were backed up from. When restoring data to an alternate client, ensure that the selected plug-in is installed on the client.

-info <path=value[:value[:…]]>

Specifies plug-in information object attached to a node in the selection tree. The type and order of the values is plug-in dependant. For more information, contact Technical Support.

Examples

•

The following example creates a Restore Selection Set “restorebig” that restores data from saveset ID “320” created with the Plug-in for FileSystem. The data was backed up from client “isp9039.” The set includes the entire volume for restore except directory “/a1”and relocates the file “document” from “/usr/var” to “usr/tmp” directory. Lastly, it enables the restore option “Overwrite Newer Files”:

nvsetcreate -setname restorebig -type RS -client isp9039 -plugin “File System” -saveset 320 -include “/” -exclude /a1
-rename /usr/var/document=/usr/tmp/document
-restoreoption NVFS_OPT_OVERNEW=TRUE

•

The following example creates a Restore Selection Set using the -timestamp option:

nvsetcreate -setname fs_time -client Client-A -type RS -plugin "File System"
-title fs_full -timestamp "19:25 21 Apr 2016" -include c:\testdata\small\data

Backup Options Set

Options

Table 69. Backup Options Set
Option	Description
-client <client>	Specifies the name of the NetVault Client that you want to back up.
-plugin <plug-in name>	Specifies the name of the plug-in that you to use for the backup. The plug-in names must appear exactly as they do on the NetVault WebUI. Example: -plugin “File System”
-backupoption <option=value>	Specifies backup options for a job. 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. Both of these values are grouped under the [Plugin Options] section in the nvsetmodify.cfg file. The format for specifying this option is: -backupoption <Tag ID>=<Value> To specify multiple backup options: -backupoption <Tag ID>=<Value> -backupoption <Tag ID>=<Value> ... Example: -backupoption NTFSOPT_SHADOW_COPY=true -backupoption NTFSOPT_TYPEFULL=true -backupoption NTFSOPT_RESTARTABLE=true
-backupoptionspath <path>	Specifies the backup options path. This option is only applicable if a plug-in can specify different backup option page depending on a selection path within that plug-in. It can be used to specify a particular backup options page from a selection path.

Examples

•

Create a Backup Options Set to perform Incremental Backups using Plug-in for FileSystem:

nvsetcreate -setname FSOptions -type BO -client WinClient
-plugin "File System" -backupoption NTFSOPT_TYPEINCR=true

•

Create a Backup Options Set to perform Full Backups using Plug-in for FileSystem. The backup must be configured as restartable:

nvsetcreate -setname FSOptions2 -type BO -client WinClient
-plugin "File System" -backupoption NTFSOPT_TYPEFULL=true -backupoption NTFSOPT_RESTARTABLE=true

Schedule Set

Options

Table 70. Schedule Set

Option

Description

-schedule <value>

Specifies the schedule type. The supported values are:

•

•

•

•

Specifies the start time for the job.

-date <DD-MMM-YYYY>

Specifies the date on which the schedule takes effect.

-weekdays <ddd[,ddd[,…]]>

Specifies the days of week when the job is run.

Example: -weekdays Mon, Tue, Wed, Thu, Fri

-weeks <n[,n[,…]]>

Specifies the weeks in a month when the job is run. Use “L” to specify the last week in the month.

Example: -weeks 1, 3 L

-monthdays <n[,n[,…]]>

Specifies the dates in the month when the job is run. Use “L” to specify the last day of the month.

Example: -monthdays 7, 14, 21, L

-every <n-period>

Specifies the interval at which the job is run. It is specified as number of hours, days, weeks or months. A hyphen (-) is used to separate the numeric value and period.

Example: -every 12-month

-trigger <trigger>

Specifies the name of the trigger to run a triggered job.

-priority <number>

Specifies the priority level for a job. This option is used to prioritize resource allocation when two or more jobs are scheduled to run at the same time. The priority level can be set to any value between 1 (highest priority) and 100 (lowest priority). A priority level of zero sets a job to run as a background task. The default value for this option is 30.

-retry <boolean>

Enables or disables job retries after an initial attempt to run the job fails. Set it to TRUE to enable job retries. The default value for this option is FALSE.

-retries <number>

Specifies the maximum number of retries for a job. It can be set to any value between 1 and 10. This option is only valid if -retry is set to TRUE. The default value for this option is 1.

-retrydelay <hh:mm>

Specifies the time delay between retries. It can be set to any value between 00:00 and 23:59. This option is only valid if -retry is set to TRUE. By default, the job is scheduled to run immediately if -retry is set to TRUE and no value is set for this option.

Examples

•

Create a Schedule Set “EveryLastTuesday” to run a job at 11:30 P.M. on the last Tuesday of every month:

nvsetcreate -type S -setname EveryLastTuesday -schedule repeating -time 23:30
-weekdays tue -weeks L

Backup Target Set

Options

Table 71. Backup Target Set

Option

Description

-device <device>

Specifies the name of the target device or library. This option can be used more than once in the command. The default value for this option is “Any Device.”

-librarydrivenumber <n>

Specifies the target drive. This option must be preceded by the -device option. Specify each drive that can be used separately using -librarydrivenumber option.

-anymedia

Uses any media regardless of media group associations. If you do not specify this option, only media items that belong to a group are used.

-mid <MID>

Uses media with specified media ID.

-group <media group>

Uses media associated with specified media group.

-autolabel <value>

Labels blank media. The values that can be used are TRUE or FALSE. The default value for this option is TRUE.

-bestfordedupe <value>

Optimizes target selection for best deduplication. The values that can be used are TRUE or FALSE. The default value for this option is TRUE.

-reusemedia <value>

Specifies media reuse media. The values that can be used with this option are: