NetVault 11.4.5 - CLI Reference Guide


	IMPORTANT: Several utilities described in this section reference a file named nvsetmodify.cfg. This configuration file includes a list of options used to define a backup job and the associated code number that can be used to identify the option in the CLI. You can find nvsetmodify.cfg in <NetVault Backup home>\config on Windows and <NetVault Backup Home>/config on Linux. When you use the file, verify that you do not modify the contents in any manner. You can take a printout of this file and use the print for reference purposes. This functionality is intended for highly experienced users. Any attempt to use the values provided in this configuration file must be performed under the guidance of Technical Support.

nvexpiresaveset

Description

Performs the following functions:

•

Deletes the specified saveset. Optionally, deletes the duplicates of the specified saveset. The savesets are deleted immediately.

•

Marks multiple savesets for deletion. Optionally, includes the duplicates of the specified savesets. The marked savesets are deleted when the Media Manager performs the next “retirement check.”

Syntax

nvexpiresaveset [-duplicates] [-duplicateonly] -savesetid <Saveset ID>

nvexpiresaveset [-duplicates] [-duplicateonly] [-success] -markforexpiry -infile <input file>
-outfile <output file>

nvexpiresaveset [-version]

Options

To delete a specific saveset and its duplicates, use the following options.

Table 48. nvexpiresaveset — Options for deleting a specific saveset and its duplicates
Option	Description
-savesetid	Specifies the ID of the saveset that you want to delete. Only a single saveset ID is supported with this form of the command. The specified saveset is removed immediately. The dependent Incremental and Differential Backups that exist for the saveset are also removed immediately, even if these backups have not reached their retirement date.
-duplicates	Deletes duplicates of the specified saveset. This option can also be used to delete only the saveset of a phase 1 or phase 2 Data Copy backup, since they have different saveset IDs. Accordingly, the required saveset ID can be provided as the input to nvexpiresaveset.
-duplicateonly	Specifies whether only the phase 2 saveset is to be deleted. Use this option ONLY for deleting a phase 2 Duplicate copy.

To mark multiple savesets and their duplicates for deletion, use the following options.

Table 49. nvexpiresaveset — Options for marking multiple savesets and their duplicates
Option	Description
-markforexpiry	Marks savesets specified in the input file (infile) for deletion. If no dependent Incremental or Differential Backups exist for a saveset, the saveset is removed when the Media Manager performs the next retirement check. By default, these checks are performed at the interval of 60 minutes. To change the interval between two checks, configure the Retirement Check Granularity in Mins setting in the mediamgr.cfg file. For more information about this setting, see Quest NetVault Backup Administrator’s Guide. If any dependent Incremental or Differential Backups exist for a saveset, the saveset is removed only after all dependent backups have reached their retirement date.
-duplicates	Marks duplicates of the specified savesets for deletion. This option can also be used to delete only the saveset of a phase 1 or phase 2 Data Copy backup, since they have different saveset IDs. Accordingly, the required saveset ID can be provided as the input to nvexpiresaveset.
-success	Includes ID numbers of the successful savesets in the output file. Without this option, the utility includes ID numbers of the failed savesets in the output file.
-infile	Specifies the name of the input file. The input file contains the ID numbers of the savesets that you want to mark for deletion. You can use any text editor to create this file. Specify one saveset ID per line. Provide the complete path if the input file is not located in the directory from which you run the utility.
-outfile	Specifies the name of the output file. By default, the file is created in the directory from which you run the utility. Provide the complete path if you want to save the file in a different location.

To view the version of NetVault Backup distribution, use the following option.

•

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

Examples

•

Delete saveset ID 120:

nvexpiresaveset -savesetid 120

•

Delete saveset ID 150 and its duplicates:

nvexpiresaveset -duplicates -savesetid 150

•

Mark savesets included in input file “C:\deletelist.txt” for deletion. Send the default output to “C:\failedlist.txt”:

nvexpiresaveset -markforexpiry -infile “c:\deletelist.txt”
-outfile “c:\failedlist.txt”

•

Mark savesets included in the input file “deletelist.txt” and their duplicates for deletion. Send the list of successful savesets to the output file “marked.txt”:

nvexpiresaveset -duplicates -success -markforexpiry -infile deletelist.txt
-outfile marked.txt

nvjobabort

Description

Aborts an active job.

Syntax

nvjobabort [-servername <NetVault Backup Server Name>] -jobid <Job ID>
[-instanceid <Instance ID>]

Options

Table 50. nvjobabort
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.
-jobid	Specifies the ID of the job that you want abort.
-instanceid	Specifies the ID of the instance that you want to abort. The default value for this option is 1.

nvjobcreate

Description

Create and schedules a backup or restore job. You can also use this utility to save a job definition without scheduling it.

The nvjobcreate utility does not provide any option to configure the Restore Options. These options must be included in the Restore Selection Set. The nvsetcreate utility provides an option that can be used to specify Restore Options in the Restore Selection Set. For more information, see nvsetcreate.

Syntax

nvjobcreate [-servername <NetVault Backup Server Name>] -jobtitle <Job Title> [-type <Job Type>] -selectionsetname <Backup or Restore Selection Set Name>
[-selectionoptionssetname <Backup Options Set Name>]
[-schedulesetname <Schedule Set Name>] [-backupoption <Backup Option>=<value>]
[-targetsetname <Target Set Name>] [-advoptssetname <Advanced Options Set Name>]
[-jobidfile <Output Filename>] -submit -parameters <Parameter Filename> [-version]

Options

Table 51. nvjobcreate
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.
-jobtitle	Specifies the name of the job.
-type	Specifies the job type: backup or restore. The default value for this option is “backup.”
-selectionsetname	Specifies the name of the Backup or Restore Selection Set. You can use the NetVault WebUI or the nvsetcreate utility to create this set.
-selectionoptionsset name	Specifies the name of the Backup Options Set. This option must be specified when creating a backup job. If you do not specify this option while creating a backup job, the job is created successfully. However, when you try to run the job from the CLI or WebUI, it reports an error and fails. When you try to view the job definition from the WebUI, the Manage Job Definitions — View Job page does not show any details.
-schedulesetname	Specifies the name of the Schedule Set. The job is scheduled to run immediately if you omit this option. You can use the NetVault WebUI or the nvsetcreate utility to create this set.
-backupoption	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> Example: -backupoption <Tag ID>=True/False
-targetsetname	Specifies the name of the Target Set. You can use the NetVault WebUI or the nvsetcreate utility to create this set. If you do not specify a Target Set, the default target options displayed on the NetVault WebUI are used.
-advoptssetname	Specifies the name of the Backup or Restore Advanced Options Set. You can use the NetVault WebUI or the nvsetcreate utility to create this set. If you do not specify an Advanced Options Set, the default target options displayed on the NetVault WebUI are used.
-jobidfile	Specifies the name of the output file that stores the Job ID. This option is useful if the nvjobcreate utility is configured to return the exit status instead of Job ID. For more information about the configuration option, see the Quest NetVault Backup Administrator’s Guide. You can provide an absolute or a relative path for the file. The file stores the Job ID as a string. You can use a script to read this string. This file must be deleted manually after use.
-submit	Schedules a job and lists it as an active job. If you omit this option, the job definition is only saved and not scheduled to run. You can schedule it later using the nvjobmodify utility.
-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: # nvjobcreate example file jobtitle cli job 1 selectionsetname cliselset This file can be used with the -parameters option as follows: ./nvjobcreate -parameters example.txt
-version	Displays the build date of the NetVault Backup distribution installed on the machine.