Use this command to resume a job previously put on hold. The “-jobid” option can only be used once per use of this command. It is not possible to resume multiple jobs with a single use this command.
Syntax
nvjobresume [-servername <NVBU Server Name>] -jobid <Job ID> [-phaseid <Phaseid>] [-version]
Options
-servername – Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive.
-jobid– Job ID of the job to be resumed. Only one job can be resume
-phaseid – Phase ID of the particular phase of a job that you want to resume. This is an optional parameter. If you do not specify this parameter, NVBU will resume all the known phases that are on hold for the job specified using the jobid parameter.
-version – Displays the build date of the NVBU distribution.
3.4.9 nvjobstart
Runs a saved job using the proper Job ID, phase number and instance number.
Syntax
nvjobstart [-servername <NVBU Server Name>] -jobid <Job ID> -phase <Phase ID> -instance <Instance ID>[-wait] -version]
Options
-servername – Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive.
-jobid – Job ID of the job to be run.
-phase – Phase ID of the job phase to be run. The default value for this option is 1. If this option is not specified, phase 1 of the job is run. -instance – Instance ID of the job instance to be run. If this option is not
specified or the specified instance does not exist, the last instance of the job is run.
-wait – Add this option to tell NVBU to wait until this task has completed before moving forward. Depending on the job status, it displays the following message:
-version – Displays the build date of the NVBU distribution.
3.4.10 nvpolicy
Use this command to perform the following tasks: List policy jobs
Delete a policy
Check whether a policy job exists or not Define Clients for a policy job
Create a policy definition
Syntax
nvpolicy -list [<Policy Name>] -delete <Policy Name> -ack <Policy Name> -addclient <Policy Name> <client name> [ <Client Name> ... ] -addgroup <Policy Name> <Group Name> [ <Group Name> ...]
-create <Policy Definition File> -state <Policy Name> -quiesce <Policy Name>
Options
-list – Lists existing policies. To view the list of jobs defined for a policy, use this option with the policy name. For example, the following command will list the jobs defined for policy p1.
nvpolicy -list p1 -delete – Name of the policy that is to be deleted. -ack – Use this option to acknowledge errors.
Job Status Message
Job Completes Successfully Job completed successfully Job Completes with Warnings Job failed with error: ‘Job Failed’ Job Fails Job failed with error: ‘Job Failed’
-addclient – Adds clients to the policy definition. For example, the following command will add Client1 and Client2 to the policy p1.
nvpolicy -addclient p1 Client1 Client2
-addgroup – Adds Client Groups to the policy definition. For example, the following command will add Client Groups Group1 and Group2 to the policy p1.
nvpolicy -addgroup p1 Group1 Group2
-create – Creates a policy with the details specified in the given file. The format for the policy definition file is shown in the example given below: [Policy] Title=policy3 EvtWarn=Event-Warn-1 EvtFail=Event-Fail-1 Clients=client1,client2,client3,client4 [Job] Title=MyJob Selection=MySelection Options=MyOption Target=MyTarget Source=MySource Schedule=MySchedule Advanced=MyAdvanced Active=TRUE
A policy can contain one or more job definitions. For multiple jobs, include a [Job] section for each job as shown in the example below:
[Policy] Title=policy3 EvtWarn=Event-Warn-1 EvtFail=Event-Fail-1 Clients=client1,client2,client3,client4 [Job] Title=MyJob Selection=MySelection
Options=MyOption Target=MyTarget Source=MySource Schedule=MySchedule Advanced=MyAdvanced Active=TRUE [Job] Title=MyJob-2 Selection=MySelection-2 Options=MyOption-2 Target=MyTarget-2 Schedule=MySchedule-2 Advanced=MyAdvanced-2 Active=TRUE
Important: The Source parameter is only required when defining a job for the NetVault Backup Plug-ins for Consolidation or Data Copy.
-state – Displays the current state of a policy. For example, Dormant, Active, or Quiescing.
-quiesce – Places an active policy in a quiesced state.
3.4.11 nvrestore
This command can be used to list the completed backup jobs, and create restore jobs. The backup jobs listed can be filtered based on date, NVBU Client, Plug-in used or selection set used. When creating a restore saveset, it is possible to relocate or rename specific nodes and select nodes for exclusion.
Syntax
nvrestore -list [-client <NVBU Client Name>] [-plugin <Plug-in Name> | -select <Selection Set Name>]
[-startdate <DD/MM/YY>] [-enddate <DD/MM/YY>] nvrestore -create <Saveset> -title <Job Title> -path <Path>
[-relocate <Path>] [-rename <Path>] [-run [-wait]]
nvrestore -create <Saveset> -definition <Restore Definition File> [-run [-wait]]
Options
-list – Use this form of the command to list all completed backup jobs. It can be used as a standalone command to list all jobs administered by the NVBU Server or additional parameters can be used to limit the search results. -client <NVBU Client Name> – Name of the NVBU Client to list only
those jobs that targeted the specified client.
-plugin <Plug-in Name> – NVBU Plug-in Name to list only those jobs that used the specified plug-in.
-select <Selection Set Name> – Name of the Backup Selection Set to list only those backup jobs that used the specified Selection Set.
Note: The “-plugin” and the “-select” parameters are mutually exclusive and cannot be used together in the same Instance of a “nvrestore -list” command. -startdate <DD/MM/YY> – Start Date to list only those backup jobs that
occurred after the specified date. The valid format for the start date is DD/MM/YY.
-enddate <DD/MM/YY> – End Date to list to only those backup jobs that occurred before the specified date. The valid format for the end date is DD/MM/YY.
-create <Saveset Name> -title <Job Title> -path <Path> – Use this form of the command to create a restore job but not run it.
<saveset> – Saveset number for the backup saveset to be restored. In addition to the saveset number, you can preface the saveset number with the target Client Name and the plug-in used, each separated with a colon. For example, “NVSERVER:filesystem:59”. This is helpful in reducing the amount of time it takes the CLI utility to locate the saveset.
-title <Job Title> – Job Title for the restore job.
-path <path> – Specific path to the directory for the restore. The path named must exist within the same path that was originally backed up. For example, if the directory “/usr/saved” was backed up and sub-directory, “/data” is to be restored, then the path “-path /usr/saved/data/” would recover the “/data” sub-directory. To restore a single file, provide the complete file path including the file name as path.
Note: You cannot use the “-path” parameter to relocate data for a restore. This parameter requires you to provide a path that existed on the client at the time of backup. To relocate data during restore, you must use the “-relocate” parameter.
-relocate <Path> – Alternate restore path. The specified directory must exist when the restore job is actually run.
-rename <Path> – Alternate name for restored directory or file. This is useful when you do not want to overwrite existing files or directories. Note: You can use both “-relocate” and “-rename” in the same command. However, both parameters must use the same “<path>” variable, which is the desired relocation directory.
-run [-wait] – Use the -run option to run the job. Without this option the restore job will be created and saved, but not run.
With -wait, the NVBU waits for task completion and return a result of “job succeeded” or “job failed” before releasing the prompt for additional commands.
-create <Saveset> -definition <Restore Definition File> – Use this form of the command to create a restore job from a restore definition file.
<saveset> – Saveset number for the backup saveset to be restored. In addition to the saveset number, you can preface the saveset number with the target Client Name and the plug-in used, each separated with a colon. For example, “NVSERVER:filesystem:59”. This is helpful in reducing the amount of time it takes the CLI utility to locate the saveset.
-definition <Restore Definition file> – Name of the file that includes a list of files/directories should be included and/or excluded from the restore. The “<Restore Definition File>” variable refers to the complete path and file name for the file to be used. The file must be created in the following format: Figure 3-3: A sample Restore Definition File [Restore] Title=<Job Title>
Schedule=<desired Schedule Set to be used> Advanced=<Advanced Options Set to be used> [Include]
Path=Specific path to the directory for the restore. The path named must exist within the same path that was originally backed up. For example, if the directory “/usr/saved” was backed up and sub- directory, “/data” is to be restored, then the path “-path /usr/saved/ data/” would recover the “/data” sub-directory. To restore a single file, provide the complete file path including the file name as path.
Relocate=Alternate restore path. The specified directory must exist when the restore job is actually run.
Rename=Alternate name for restored directory or file. This is useful when you do not want to overwrite existing files or directories. -run [-wait] – Use the -run option to run the job. Without this option the
restore job will be created and saved, but not run.
With -wait, the NVBU waits for task completion and return a result of “job succeeded” or “job failed” before releasing the prompt for additional commands.
Notes
The following rules apply to Restore Definition File:
The “Schedule” and “Advanced” entries must be included in the [Restore] stanza with a valid variable input even if specific Schedule and Restore Advanced Options Sets are not required. For details, refer to nvsetcreate on page 67. You can also use the sets created in the NVBU Console.
Only one inclusion can be specified per line with the [Inclusion] stanza. If multiple directories and/or files are to be included, they must specified in their own line. Correct [Include] C:\data C:\new C:\Program Files
If using the Rename or Relocate parameters, they must exist with a single instance of the “path=” parameter below its own instance of the [Include] stanza heading. If multiple Instances of the “path=” parameter existed with a relocate/rename parameter, the CLI would not know which Instance of the “path=” parameter the rename/relocate command refers to.
Correct [Include]
path=C:\data\files relocate=C:\data\new
[Include]
path=C:\Program Files
relocate=C:\Old Program Files Incorrect
[Include]
path=C:\data\files path=C:\Program Files relocate=C:\data\new
relocate=C:\Old Program Files
Both the “relocate” and “rename” parameters can be specified below the same instance of the [Include] stanza to perform both operations for a single file or directory. However, both entries must incorporate the same variable information, which is the path to relocation directory.
Correct [Include]
path=C:\data\new (the data to be restored, and its original path)
relocate=C:\saved\data (the path data is to be relocated to)
rename=C:\saved\data\old (The relocation path directory, from above, along with the new directory name)
The relocation directory must exist on the target system before the restore job is actually run. You can create and save the job without using the “-run” parameter and establish a new directory for relocation in the command, but when the job is actually run, the target relocation directory must exist)
3.4.12 nvsetcreate
Use this command to create Selection Sets of different types using the available options.
Notes
A list of the permitted options for any set type may be obtained with the command “nvsetcreate –type <set type>”.
For NDMP filers, the nvsetcreate command can only be used to create Backup Selections Set from the CLI.
For the NetVault Backup Plug-in for NDMP, nvsetcreate will replace an existing set with the replacement set. Therefore, it is recommended that you use nvsetcreate instead of nvsetmodify for the Plug-in for NDMP.
Syntax
nvsetcreate [-setname <Set Name>] -type <set type> <Set Type Specific Options>
-assign <Assignment Character> -delimit <Delimiter Character> -parameters <Parameter File Name>] [-version]
Options
-setname – Selection Set Name. -type – Selection Set Type. It can be:
BS – Backup Selections Set BO – Backup Options Set S – Schedule Set
BT – Backup Target Set
AB – Backup Advanced Options Set RS – Restore Selections Set
AR – Restore Advanced Options Set
<set type specific options> – These are described in the sections that follow and are dependant upon the type of set to be created.
-assign – Use this option to change the character used for assignment in change descriptions. It must be used if any value (for example, a file name or directory path) contains the default assignment character “=”.
-delimit – Use this option to change character used as a delimiter in change descriptions. It must be used if any value (for example, a file name or directory path) contains the default delimiter “:”.
-parameters – Reads options and their arguments from a given parameter file so that you do not need to input them each time the command is run. You can create this file using any standard text editor. Enter one option (with its value) per line and omit “-” before the option. Use spaces or tabs to separate the option and values. For comments, begin the line with a # character. Such lines will be ignored.
Following is an example of a parameter file named example.txt: # nvsetcreate example file
setname workbackup type BS
client WinClient
This file can be used with the -parameters option as follows: ./nvsetcreate -parameters example.txt