Chat now with support
Chat with Support

NetVault 13.1.2 - CLI Reference Guide

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

nvjobabort

Aborts an active job.

Table 52. nvjobabort

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

-instanceid

Specifies the ID of the instance that you want to abort. The default value for this option is 1.

nvjobcreate

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.

Table 53. nvjobcreate

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

-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. 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 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 distribution installed on the machine.

After using the nvjobcreate command to create one or more jobs, if you run the following nvreport command, the Scheduler may crash:

Workaround: From the NetVault WebUI, open the jobs for editing and save them without any changes.

nvjobdelete

Deletes jobs that match the specified criteria.

Table 54. nvjobdelete

-servername

Specifies the name of the target NetVault Server.

-jobid

Specifies the ID of the job that you want to delete. Only one Job ID can be specified with this option.

-type

Specifies the type of job that you want to delete: backup or restore.

Use this option if you want to delete a specific job type. Do not use this option if you want to delete all job types.

-jobrange

Specifies a range of Job ID numbers corresponding to a series of jobs that you want to delete. Use a hyphen to separate the start and end Job ID numbers.

Example:

-jobrange 30-45

-jobtitle

Specifies the name of the job that you want to delete. You must provide the full name and enclose the name in quotation marks.

Example:

-jobtitle “Full_Backup_1”

The -jobtitle option deletes a single job.

You can use the -jobrange option with the -jobtitle option to delete multiple jobs that use the same job title.

-client

Specifies the name of the NetVault Client that served as target for the jobs. Use this option to delete all jobs for the specified client.

Example

-client “NV_Client_MKTG”

-plugin

Specifies the name of the plug-in used to perform the jobs. Use this option to delete all jobs that were performed using a particular plug-in. The plug-in name must be enclosed in quotation marks.

Example:

-plugin “File System”

-selectionsetname

Specifies the name of the Backup or Restore Selection Set that was used to create the jobs.

-schedulesetname

Specifies the name of the Schedule Set that was used to create the jobs.

-targetsetname

Specifies the name of the Target Set that was used to create the jobs.

-advoptssetname

Specifies the name of the Advanced Options Set that was used to create the jobs.

-force

Deletes matching jobs that are scheduled to run.

If a job that meets the criteria set by other option is in queue (scheduled to run later), any attempt to delete it fails. Use the “-force” option to delete such jobs.

-scheduleonly

Remove jobs from the job queue without deleting them from the NetVault Database. Use this option in lieu of -force.

-version

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

To delete specific jobs, use a combination of options. For example, if you specify the -jobrange option with the -plugin option, only jobs that fall into the specified Job ID range specified are deleted.

nvjobhold

Places a job on hold. You can use the nvjobresume utility to resume the job later.

Table 55. nvjobhold

-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 place on hold. Only one Job ID can be specified with this option.

-phaseid

Specifies the phase ID.

Use this option to place a particular phase on hold. If you omit this option, all scheduled phases of the specified job are placed on hold.

-version

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

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating