NetVault Backup 12.3 - CLI Reference Guide

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

nvpolicy

Performs the following tasks:

Table 62. nvpolicy

-list

Displays existing policies. To view the list of jobs defined for a policy, use this option with the policy name. For example, the following command lists all jobs defined for policy “p1”:

nvpolicy -list p1

-delete

Deletes the specified policy.

-ack

Acknowledges errors.

-addclient

Adds clients to the policy definition. For example, the following command adds clients “Client-A” and “Client-B” to the policy “p1”:

nvpolicy -addclient p1 Client-A Client-B

-addgroup

Adds client groups to the policy definition. For example, the following command adds client groups “Group-A” and “Group-B” to the policy “p1”:

nvpolicy -addgroup p1 Group-A Group-B

-create

Creates a policy using details specified in the policy definition file. The file must be created in the following format:

Example:

 

NOTE: The Source option is only required when defining a job for the Plug-in for Consolidation and or Plug-in for Data Copy.

A policy can contain one or more job definitions. For multiple jobs, include a [Job] section for each job as shown in the following example.

Example:

-state

Displays the current state of a policy — Dormant, Active, or Quiescing.

quiesce

Places an active policy in a quiesced state.

nvrestore

Performs the following tasks:

To list the restore jobs administered by the NetVault Backup Server, use the following options.

-list

Displays all restore jobs administered by the NetVault Backup Server.

-client

Specifies the name of the target NetVault Backup Client. Use this option filter the list by the specified client.

-plugin

Specifies the plug-in name. Use this option to filter the list by the specified plug-in.

-select

Specifies the name of the Restore Selections Set. Use this option to filter the list by the specified set.

NOTE: The -plugin and -select options are mutually exclusive and cannot be used together in the same instance of a nvrestore -list command.

-startdate

Specifies the start date. Use this option to display the jobs performed between the start date and end date. If the end date is not specified, all jobs starting from the start date up to the last job are listed. The valid format for the start date is DD/MM/YY.

-enddate

Specifies the end date. Use this option to display the jobs performed between the start date and end date. If the start date is not specified, all jobs starting from the first job up to the specified end data are listed. The valid format for the start date is DD/MM/YY.

To create a restore job, use the following options.

-create

Creates and optionally schedules a restore job.

Specify the ID of the backup saveset that you want to restore. 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.

Example:

59:NVSERVER:filesystem

This format helps in reducing the time taken to locate the saveset.

-title

Specifies the name of the job.

-path

Specifies the directory or file that you want to restore. Provide the full path to the items.

-relocate

Relocates the selected items to the specified path or directory. Ensure that the specified path is created before you run the restore job.

-rename

Renames the selected items. You can use this option if you do not want to overwrite existing files or directories.

-run

Runs the job. Without this option, the restore job is created and saved, but it is not scheduled to run.

-wait

Waits until the task has completed.

With this option, the utility return a result of “job succeeded” or “job failed” before releasing the prompt for additional commands.

To create a restore job from a job definition file, use the following options.

-create

Creates and optionally schedules a restore job.

Specify the ID of the backup saveset that you want to restore. 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.

Example: 59:NVSERVER:filesystem

This format helps in reducing the time taken to locate the saveset.

-definition

Specifies the name of the job definition file. Provide the full file path.

The definition file includes a list of files or directories that you want to include or exclude. It must use the following format:

Relocate=<Relocation path> (Ensure that the path is created before you run the job.)
Rename=<New name for the item> (You can use this option if you do not want to overwrite existing files or directories.)

-run

Runs the job. Without this option, the restore job is created and saved, but not scheduled to run.

-wait

Waits until the task has completed.

With this option, the utility return a result of “job succeeded” or “job failed” before releasing the prompt for additional commands.

The following rules apply to Restore Definition File:

For the Rename and Relocate options, a separate [Include] stanza must be created for each item. Correct
Both the Rename and Relocate options can be specified within the same instance of the [Include] stanza to perform both operations for a single file or directory.
path=C:\data\new (data that you want to restore and its original path)
relocate=C:\saved\data (the relocation path)
rename=C:\saved\data\old (the relocation path along with the new directory name)
The relocation directory must exist on the target system before you run the restore job. You can create and save the job without using the “-run” parameter and establish a new directory for relocation in the command, but when you runt the job, the target relocation directory must exist.

nvsetcreate

Creates a set.

Table 66. nvsetcreate

-setname

Specifies the name of the set that you want to create.

-type

Specifies the set type and set-specific options.

The set type can be one of the following:

BS: Backup Selection Set
BO: Backup Options Set
S: Schedule Set
BT: Backup Target Set
AB: Backup Advanced Options Set
RS: Restore Selection Set
AR: Restore Advanced Options Set

 

To obtain a list of available options for any set type, use the following command:

nvsetcreate -type <set type> -- help

Example:

nvsetcreate -type BS -- help

For information about set-specific options, see the following sections:

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

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

# nvsetcreate example file

setname workbackup

type BS

client WinClient

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

./nvsetcreate -parameters example.txt

The Plug-in for NDMP allows you to create only Backup Selection Sets using the nvsetcreate utility.
When creating a set for the Plug-in for NDMP, if you specify an existing set name, the nvsetcreate utility overwrites the set. You can use the nvsetcreate utility to modify a set for this plug-in instead of nvsetmodify.

Backup Selection Set

-client <client>

Specifies the name of the NetVault Backup Client that you want to back up.

-plugin <plug-in name>

Specifies the name of the plug-in that you to use for the backup. The plug-in names must appear exactly as they do on the NetVault WebUI.

Example: -plugin “File System”

-include <path

Specifies the backup path.

Include the names of each node under the selected item in the tree as they appear on the NetVault WebUI. Separate the nodes using “/” or “\” depending on the client operating system.

-exclude <path>

Specifies the paths that you want to omit during backup. It must be specified in the same way as the included paths. This option can only be used to exclude items that appear under items that have already been named for inclusion.

-info <path=value[:value[:…]]>

Specifies plug-in information object attached to a node in the selection tree.

This information is unavailable to the plug-in at backup time. It can only be specified for nodes where the default values are always added by the plug-in. The type and order of the values is plug-in dependant. For more information, contact Technical Support.

-browsesetting <entry>

Specifies the Tag name and setting for the selected option. Use this option to create Selection Set for filers with limited or no browse capability.

To list the tags, type:

nvsetcreate -type BS -helpndmptags

The available tags are:

LEVEL – NDMPC_TAG_LEVEL

HIST – NDMPC_TAG_GET_FILE_INFO

UPDATE – NDMPC_TAG_UPDATE

DIRECT –NDMPC_TAG_DIRECT_IF_POSSIBLE

When creating a Selection Set for backing up the root directory using NetVault Backup Plug-in for FileSystem, do not include the last “\” character. Specify only the drive letter. Thus, use the path C: instead of C:\.
When using the -include option in Backup Selection Sets for Plug-in for Consolidation, Plug-in for Data Copy, or Plug-in for Raw Devices, specify the full file path as displayed on the NetVault WebUI.
Documents connexes