Chat now with support
Chat with Support

NetVault 11.4.5 - CLI Reference Guide

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

nvjobdelete

Description

Deletes jobs that match the specified criteria.

Syntax
nvjobdelete [-servername <NetVault Backup Server Name>]
[-jobid <Job ID>] [-type <Job Type>]
[-jobrange <Job ID-Job ID>] [-jobtitle <Job Title>] [-client <Client Name>]
[-plugin <Plug-in Name>] [-selectionsetname <Selection Set Name>]
[-schedulesetname <Schedule Set Name>] [-targetsetname <Target Set Name>]
[-advoptssetname <Advanced Options Set Name>] [-force] [-scheduleonly] [-version]
Options
 
Table 52. nvjobdelete
Option
Description

-servername

Specifies the name of the target NetVault Backup 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 Backup 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 Backup distribution installed on the machine.

Notes
•
This note applies to the use of the following options with nvjobdelete command:
•
-client
•
-plugin
•
-selectionsetname
•
-schedulesetname
•
-targetsetname
•
-advoptssetname
When any of these options are used alone in the syntax, all instances of a job that meet the set parameters are deleted. For example, the following command deletes all jobs for the Plug-in for FileSystem:
nvjobdelete -plugin “File System”
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.
Examples
•
Delete jobs with the following Job ID numbers: 1, 5, range 7-12, range 15-19:
nvjobdelete -jobid 1 -jobid 5 -jobrange 7-12 -jobrange 15-19
•
Delete all backup jobs that have the job name “Backup of Client-A” and job ID numbers between 70 and 100:
nvjobdelete -type backup -jobtitle “Backup of Client-A” -jobrange 70-100
•
Delete all jobs for “Client-A” that use the Schedule Set “FirstTuesday”:
nvjobdelete -client Client-A -schedulesetname FirstTuesday -force

nvjobhold

Description

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

Syntax
nvjobhold [-servername <NetVault Backup Server Name>] -jobid <Job ID>
[-phaseid <Phase ID>] [-version]
Options
 
Table 53. nvjobhold
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 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 Backup distribution installed on the machine.

nvjoblist

Description

Displays all active jobs. The output is displayed in fixed column format.

Syntax
nvjoblist [-servername <NetVault Backup Server Name>] [-delimiter <Delimiter>]
[-title <Job Title>] [-noheader] [-runinfo] [-version]
Options
 
Table 54. nvjoblist
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.

-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 Backup 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 55. 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 Backup 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>[:<field>]=<value>

<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 Backup. 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 Backup 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
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating