サポートと今すぐチャット
サポートとのチャット

NetVault 13.1.2 - CLI Reference Guide

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

Command syntax

The syntax of a command takes the following form:

Command -option 1 <Value> -option 2 <Value> [-option 3 <Value> | -option 4 <Value>] [-option 5], …

where

•
<Value> is a user input variable for an option.
•
Options enclosed within square brackets (“[ ]”) are optional.
•
A pipe (“|”) character between two options indicates that only one of the multiple options listed in the syntax can be used in a command.
Important notes
•
The command syntax format must be entered as one line, unless otherwise noted. The order of the options is not important in the syntax.
•
Switches can be specified using only the initial letter in their name, provided this letter is unique and no other option for the selected command begins with the same letter.
For example, the following is the command syntax for the nvbulkblankmedia utility:
nvbulkblankmedia -libraryname <library name> -medialabel <media label>
-allmedia -password <NetVault password> -wait
All the options for this command begin with different letters. So, this command can also be specified as follows:
nvbulkblankmedia -l MyLibrary1 -m MyBackupMedia* -p Mypassword -wait
where
•
“-l” represents the “-libraryname” option
•
“-m” represents the “-medialabel” option
•
“-p” represents the “-password” option
•
The CLI cannot recognize spaces in variable names. Variables that contain spaces must be enclosed within quotation marks (“ ”); otherwise, the command fails.
•
The CLI sees the use of an underscore in its syntax as a replacement for a space. Conflicts arise when a NetVault Server, Client, or backup device name contains an underscore character (“_”) and it is referenced in a CLI command.
For example, if you include the name “Test_Server” in a CLI command, NetVault searches for a machine named “Test Server”, and the command fails as it is unable to locate the machine.
Variables that contain underscores must be enclosed within quotation marks (“ ”).

CLI help

To access help about a command, type the command followed by “-help” or “--help”, or type the command and press Enter. For example, to access help for nvblankmedia, you can use the following methods:

nvblankmedia -help
nvblankmedia --help
nvblankmedia

Command exit status

Various CLI commands return a numeric value when you run them. The return value represents the actual exit status of the command as described in the following table:

 
Table 1. Command exit status
Exit status
Description

0

Command completed successfully.

1

Command failed.

2

Arguments given in the command are invalid. For example, a variable named in the command is inaccurate.

Environment variables

While using the CLI utilities in a script, you can use the following environment variables.

 
* 
NOTE: Not all CLI tools support every variable in the table. Some variables may not apply to the CLI tool you are using.
 
Table 2. Environment variables
Variable
Description

NETVAULTCLIACCOUNT

Specifies the NetVault user name. The specified account must have privileges to use the CLI utility.

NETVAULTCLIACCOUNT=<User Account Name>

This variable must be included in the script to access the CLI utility.

NETVAULTCLIPASSWORD

Specifies the password for the NetVault user account.

NETVAULTCLIPASSWORD=<Password>

This variable must be included in the script to specify the password for the user account.

NV_HOME

Returns the NetVault installation directory.

NV_JOBCLIENT

Specifies the target client for a job.

NV_JOBCLIENT=<Name of the NetVault Client>

NV_JOBID

Specifies the Job ID number.

NV_JOBID=<Job ID>

NV_JOBTITLE

Specifies the name of the job.

NV_JOBTITLE=<Job title>

NV_JOB_WARNINGS

Returns TRUE if a job completes with warnings, else returns FALSE.

•
If a backup completes with warnings:
NV_JOB_WARNINGS=TRUE
•
If a backup completes successfully:
NV_JOB_WARNINGS=FALSE

This variable can only be used in a post -script. The mail scripts use this variable, but the variable has general applicability.

If a backup completes with warnings, the NV_STATUS variable returns SUCCEEDED, while the NV_JOB_WARNINGS variable returns TRUE.

The return value is not localized; it is TRUE or FALSE in English.

NV_OUTPUT_FILE

Returns the user-defined output file for reports.

NV_SERVERNAME

Specifies the NetVault Server Name.

NV_SERVERNAME=<Name of the NetVault Server>

NV_SESSIONID

Specifies the Session ID of a job.

NV_SESSIONID=<Session ID>

NV_STATUS

Returns the exit status of a job. It returns either SUCCEEDED or FAILED.

•
If a backup job completes successfully or completes with warnings:
NV_STATUS=SUCCEEDED
•
If a backup job fails:
NV_STATUS=FAILED

This variable can only be used in a post-script. The return value is not localized; it is SUCCEEDED or FAILED in English.

NV_USER_ARG

Specifies the user-defined arguments passed with the pre- or post-scripts.

関連ドキュメント

The document was helpful.

評価を選択

I easily found the information I needed.

評価を選択