Chat now with support
Chat with Support

NetVault 13.0.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:

where

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:

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:

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.

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.

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.

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.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating