NetVault 11.4.5 - CLI Reference Guide

-setname

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

-type

Specifies the set type and set-specific options.

The set type can be one of the following:

To obtain a list of available options for any set type, use the following command:

nvsetcreate -type <set type> -- help

Example:

nvsetcreate -type BS -- help

For information about set-specific options, see the following sections:

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

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

# nvsetcreate example file

setname workbackup

type BS

client WinClient

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

./nvsetcreate -parameters example.txt

-client <client>

Specifies the name of the NetVault Backup 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”

-include <path

Specifies the backup path.

Include the names of each node under the selected item in the tree as they appear on the NetVault WebUI. Separate the nodes using “/” or “\” depending on the client operating system.

-exclude <path>

Specifies the paths that you want to omit during backup. It must be specified in the same way as the included paths. This option can only be used to exclude items that appear under items that have already been named for inclusion.

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

Specifies plug-in information object attached to a node in the selection tree.

This information is unavailable to the plug-in at backup time. It can only be specified for nodes where the default values are always added by the plug-in. The type and order of the values is plug-in dependant. For more information, contact Technical Support.

-browsesetting <entry>

Specifies the Tag name and setting for the selected option. Use this option to create Selection Set for filers with limited or no browse capability.

To list the tags, type:

nvsetcreate -type BS -helpndmptags

The available tags are:

LEVEL – NDMPC_TAG_LEVEL

HIST – NDMPC_TAG_GET_FILE_INFO

UPDATE – NDMPC_TAG_UPDATE

DIRECT –NDMPC_TAG_DIRECT_IF_POSSIBLE

-client <client>

Specifies the name of NetVault Backup Client from which the data was backed up.

-plugin <plug-in name>

Specifies the name of the plug-in that was used to perform the backup. The plug-in names must appear exactly as they do on the NetVault WebUI.

Example: -plugin “File System”

-saveset <ID>

Specifies the ID of the saveset that you want to restore.

Use this option when you want to restore a particular saveset. Alternatively, use the ‑title option to restore data from the latest saveset for that backup.

-title <title>

Specifies the name of the backup that you want to restore.

If the saveset name contains a tag (backup type identifier), make sure that it is included in the job name (separated by a “-”).

Example: If the job name is “Test Backup” and the tag or backup type identifier is “VSS Full,” then specify:

-title “Test Backup - VSS FULL”

If more than one saveset exists for the job, the latest one is used. To restore data from a particular saveset, use the -saveset option.

-timestamp <HH:MM DD MMM YYYY>

Specifies the timestamp of the saveset that you want to restore. This option can be used with the “-title” option to create a Restore Selection Set without specifying the saveset ID.

The month names are specified in MMM format (for example, “Jan” for “January”). These names are specified in English.

Example: -timestamp “19:25 21 Apr 2016”

-include <path

Specifies the path that you want to restore. It should specify the names of each node under the selected item in the tree as they appear on the NetVault WebUI. The nodes must be separated by “/” or “\” depending on the client operating system.

-exclude <path>

Specifies the paths that you want to omit during restore. It must be specified in the same way as the included paths. This option can only be used to exclude items that appear under items that have already been named for inclusion.

-rename <path> =<new name or path>

Renames or relocates restore items.

You can combine both options or use each independently. If you want to rename an item without relocating it, provide only the new name. To relocate an item, provide he full path.

When relocating data to a different path, verify that the path exists on the target machine before you run the command.

Examples:

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

-client <client>

Specifies the name of the NetVault Backup 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 Backup. 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.