NetVault Backup 12.3 - CLI Reference Guide

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

Restore Selection Set

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

NOTE: The -include option must be specified before the -rename option when both options are used in a Restore Selection Set.

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

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

Backup Options Set

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

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

Schedule Set

Table 70. Schedule Set

-schedule <value>

Specifies the schedule type. The supported values are:

-time <hh:mm>

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.

Backup Target Set

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

-reusemedia <value>

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

never: Never reuse media
any: Reuse any media
group: Reuse any media item that belongs to a group

-minimumspace <value>

Specifies minimum space required on a media item for that item to be used for backup. It is specified in MB.

-protectmedia <value>

Write-protects the media. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-firstonmedia <value>

Controls whether backup is first on media. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-localdrivesonly <value>

Allows only locally attached devices. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-mediarequesttime
out <value>

Allows you to set media request timeouts. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-mediarequesttime
outvalue <hh:mm>

Specifies the timeout interval for media requests. It can be set to any value between 00:05 and 23:59. This option is only valid if the option -mediarequesttimeout is set to TRUE.

The minimum timeout interval can be 5 minutes. If you specify a value lesser than “00:05” minutes, an error is displayed. The specified value is automatically rounded up to the nearest 5-minute interval. For example, 7 minutes is automatically changed to 10 minutes and 22 minutes is automatically changed to 25 minutes.

Documents connexes