NetVault 13.1.2 - CLI Reference Guide

Table 56. nvjoblist
Option	Description
-servername	Specifies the name of the NetVault 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.
-delimiter	Specifies the character that you want to use as a delimiter. By default, a white-space character is used as a delimiter.
-title	Specifies the name of the job. Use this option to display all jobs with the specified name. You must provide the full name and enclose the name in quotation marks. Example: -title “Full_Backup_1
-noheader	Suppresses display of header row.
-runinfo	Includes run status and next run time in the output.
-version	Displays the version number of the CLI tools and the build date of the NetVault distribution installed on the machine.

nvjobmodify

Description

Modifies a job definition.

Syntax

nvjobmodify -jobid <Job ID> -jobname <Job Title> -type <Job Type>
[-change <Change Description>] [-submit] [-parameters <Parameter File>]
[-assign <Assignment Character>] [-delimit <Delimiter Character>] [-version]

Options

Table 57. nvjobmodify

Option

Description

-jobid

Specifies the ID of the job that you want to modify.

Example

-jobid 56

This option is not required if you specify the -jobname option.

-jobname

Specifies the name of the job that you want to modify. The job name must be enclosed in quotation marks.

If two or more jobs on the NetVault Server have the same name, the command fails. In such cases, you must use the -jobid option.

-type

Specifies the type of job that you want to modify (backup or restore)

-change

Specifies the changes that you want to make to the job definition. You can specify any number of values with this option. You can omit this option if you want to submit a job without any changes.

The <Change description> variable for the -change option is formatted as follows:

<item> can take one of the following values: Title, Set, or Options.

<field> calls out a specific field in the item that you want to modify.

<value> is the new setting for the selected field.

Change items:

•

Title: Changes the job name.

•

Set: Changes the set used to define a job. <value> specifies the new set name. <field> may take any of the following values:

BS: Backup Selection Set

BO: Backup Options Set

S: Schedule Set

BT: Backup Target Options Set

AB: Backup Advanced Options Set

RS: Restore Selection Set

AR: Restore Advanced Options Set

•

Options: Modifies the 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:

Options:<Tag ID>=<value>

Example:

Options:<Tag ID>=True/False

NOTE: If you specify a trigger name that is used by any other job, an error message (“The Trigger Name is Already in Use. Redefine this Job if this was not Intended.”) is displayed when you try to save or submit the job. The message is for information only and does not stop you from saving or submitting the job.

-submit

Schedules a job. This option may also be used on its own to schedule jobs that have been created but not scheduled.

-parameter

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

# nvjobmodify example file

jobname Backup File System 10-15

type backup

change Set:BS=selectionsetcli

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

./nvjobmodify -parameter example.txt

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

-version

Displays the build date of the NetVault distribution installed on the machine.

Examples

•

Modify the job “Backup File System 10-15” to perform Incremental Backup instead of Full Backup using the Plug-in for FileSystem:

nvjobmodify -jobname “Backup File System 10-15”
-change Options:ntfsopt_typeincr=true

nvjobresume

Description

Resumes a job that was previously placed on hold. Only one job can be resume with a single use of this command.

Syntax

nvjobresume [-servername <NetVault Server Name>] -jobid <Job ID>
[-phaseid <Phaseid>] [-version]

Options

Table 58. nvjobresume
Option	Description
-servername	Specifies the name of the NetVault 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 to resume. Only one Job ID can be specified with this option.
-phaseid	Specifies the phase ID. Use this option if you want to resume a particular job phase. If you omit this option, all known phases of the specified job are resumed.
-version	Displays the build date of the NetVault distribution installed on the machine.

nvjobstart

Description

Runs a job using its Job ID, phase number, and instance number.


	NOTE: The nvjobstart command always starts a new job instance. It does not restart a stopped job.

Syntax

nvjobstart [-servername <NetVault Server Name>] -jobid <Job ID>
-phase <Phase number> -instance <Instance number> [-wait] [-version]

Options

Table 59. nvjobstart
Option	Description
-servername	Specifies the name of the NetVault 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 to run.
-phase	Specifies the phase number to start. The default value for this option is 1.
-instance	Specifies the instance number that you want nvjobstart to use as a reference to run on the new instance of the job. NOTE: The instance number does not restart the specified job instance. The instance number retrieves the instance of the job that you want as the basis for the new job instance on which nvjobstart runs. If this option is not specified or the specified instance does not exist, the last instance of the job is used as a reference .
-wait	Waits until the task has completed.
-version	Displays the build date of the NetVault distribution installed on the machine.

Notes

•

By default, the nvjobstart utility returns the following messages depending on the job exit codes.

Table 60. Default job exit codes and status messages

Exit code

Status message

Job completed successfully

Job failed with error: ‘Job Failed’

This message is returned for the following job completion states:

•

Job failed

•

Job completed with warnings

•

Job aborted

•

Job stopped

•

Job died

If you enable the option nvjobstart Enhanced Job Completion Status, the utility returns the following codes and messages:

Table 61. Enhanced job exit codes and status messages
Exit code	Status message
0	Job completed successfully
1	Job Failed
2	Job Completed with Warnings
3	Job Aborted
4	Job Stopped
5	Job Died
-1	Job Failed with Undefined Error

For more information about this option, see the Quest NetVault Administrator’s Guide.

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

NetVault 13.1.2 - CLI Reference Guide

nvjoblist

nvjobmodify

nvjobresume

nvjobstart