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

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

Backup Advanced Options Set

-backuptype <value>

Specifies the backup type (backup or archive).

-discardtime <interval>

Specifies the length of time you want to retain the backup. The backup is automatically discarded after the period elapses. The period can be specified in number of days, weeks or years.

Example: -discardtime 26-weeks

-backuplife <value>

Specifies the number of full backups that you want to retain for the job. Older backups are automatically discarded.

-encryption <value>

Enables encryption for the backup. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-verify <value>

Performs backup verification. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-deduplicate <value>

Deduplicates the backup data. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-netcompress <value>

Enables network compression for the data transferred between the NetVault Backup Client and Server. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-secondarycopy <value>

Creates a secondary copy. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-duplicate <value>

Uses the Duplicate Method to create a secondary copy. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-datacopy <value>

Uses the Data Copy Method to create the secondary copy. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-encryptsecondary
copy <value>

Encrypts the secondary copy. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-migrate <value>

Removes the original backup after the secondary copy is created. The values that can be used are TRUE or FALSE. The default value for this option is FALSE.

-usereplication <value>

Enables transfer of deduplicated data directly from one device to another device of the same type during a Data Copy or Duplicate operation. The values that can be used are TRUE or FALSE. The default value for this option is TRUE.

Replication provides an efficient method to create secondary copies and offers the following advantages:

The following storage devices support optimized replication:

Quest NetVault SmartDisk devices: To perform optimized replication, you require NetVault SmartDisk 2.0 or later.

 

Dell DR Series Systems: To perform optimized replication, both the source and target Dell DR Series systems must be running the same release version of the DR OS. Replication is not supported between systems that run different releases of the OS.
DD Boost-Enabled Data Domain Systems: The secondary copy backups between two DD Boost-Enabled Data Domain Systems use the managed file-level replication feature provided by DD Boost.

-duplicateclient <value>

Specifies the name of the NetVault backup Client on which you want to run the secondary copy job. It can be Server, Original, or any NetVault Backup Client.

-duplicatescheduleset <set name>

Specifies the name of the Schedule Set for the secondary copy.

-duplicatetargetset <set name>

Specifies the name of the Target Set for the secondary copy.

-duplicatesource <set name>

Specifies the name of the Source Set for the secondary copy.

-allowstreamstosharemedia <value>

Enables streams to share media. The values that can be used are TRUE or FALSE. The default value for this option is FALSE. This option is only valid if the -secondarycopy option is set to TRUE.

-duplicatelife <interval>

Specifies the retention period for secondary copy. If you omit this option, the lifetime of the original (specified using the -discardtime option) is used.

-offlineindexafter <interval>

Specifies the retention period for online index. The backup index is automatically deleted from the NetVault Database after the period elapses. This period can be specified in number of days, weeks, or years.

Examples:

-offlineindexafter 2-days

-offlineindexafter 24-weeks

-prescript <script name>

Specifies the name of the script file that you want to run before the job starts. The file must be stored in the NetVault Backup “scripts” directory.

-prescriptarg <arg>

Specifies the run-time parameters for the script.

-postscript <script name>

Specifies the name of the script file that you want to run before the job completes. The file must be stored in the NetVault Backup “scripts” directory.

-postscriptarg <arg>

Specifies the run-time parameters for the script.

-eventsuccess <arg>

Event to be raised when the job completes successfully.

-eventwarning <arg>

Event to be raised when the job completes with warnings.

-eventfailure <arg>

Event to be raised when the job fails.

Related Documents