Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

NetVault 13.0.1 - Administration Guide for Managed Service Providers

Table of Contents

About Quest NetVault About this document Target audience Recommended additional reading

Getting started

About deploying NetVault About NetVault components Starting or stopping the NetVault Service Enabling Web Service over HTTP or HTTPS Understanding Managed Service Provider

About user and roles Registering tenant

Logging in to NetVault Overview of NetVault WebUI Navigation pane Quitting NetVault Workflow in MSP environment

Prerequisites MSP administrator workflow

Using the configuration wizard Monitoring the NetVault Server Sorting records in NetVault WebUI Customizing tables in NetVault WebUI

Configuring clients

About NetVault Clients

Role-based access for NetVault Clients

Installing software from WebUI (push installation)

About push installation Prerequisites Managing package stores

Configuring a package store Modifying a package store Removing a package store

Performing push installations

File format for specifying deployment targets

Monitoring deployment tasks Managing deployment tasks

Retrying failed deployment tasks Canceling a deployment task Cloning a deployment task

Adding a client to the NetVault Server Adding multiple clients About firewall settings

Firewall filtering rules Firewall configuration example

Locating a client Checking communication through a firewall Removing a client from the list of available clients

Managing clients

Viewing client details Setting client description Installing plug-ins

Role-based access to install plug-ins

Checking for upgrades Installing a product license file

Role-based access to install product license file

Checking client access Removing plug-ins Removing a client from the server

Managing client groups

About client groups Creating a client group Viewing existing client groups Modifying a client group Removing a client group

Managing catalog search

About catalog search

Prerequisites

Configuring catalog search Relocating the catalog search database directory

Changing the NetVault Catalog Database directory on a Windows-based machine Migrating NetVault Catalog Server to different Windows-based client machine Changing the NetVault Catalog Database directory on a Linux-based machine

Modifying catalog search Disabling catalog search Upgrading catalog search Removing catalog search Displaying Status of Catalog Search

Configuring storage devices

About storage devices

Role-based storage device configuration

SAN considerations Quest DR Series systems

About Quest DR Series systems Quest DR Series system prerequisites Adding a Quest DR Series system

Adding a Quest DR Series appliance Creating a container Adding a container as a media

Adding a container as a Media for QoreStor

Adding a container for QoreStor from the Manage Devices page Adding a container from the Quest QoreStor page

NetVault SmartDisk

About NetVault SmartDisk Adding a NetVault SmartDisk Migrating savesets and backup jobs from NetVault SmartDisk to QoreStor

Migrating savesets and backup jobs

EMC Data Domain Systems

About EMC Data Domain Systems Data Domain System prerequisites Adding a Data Domain System DD Boost commands

Snapshot Array Manager

Supported Storage Array Manager Prerequisites Adding Snapshot Array Manager

Virtual Tape Libraries

About Virtual Tape Library

Direct-to-cloud support

Virtual Tape Library considerations Creating and adding a Virtual Tape Library Re-adding a previously created VTL

Virtual standalone drives

About virtual standalone drive Creating and adding a virtual standalone drive

Shared Virtual Tape Libraries

About Shared Virtual Tape Libraries SVTL considerations SVTL prerequisites Creating and adding an SVTL Re-adding a previously created SVTL

Physical tape devices

Changing the default Drive Transfer Buffer Size option

Adding a standalone tape drive Adding a tape library

Creating a storage tier Editing a storage tier Removing a storage tier

Backing up data

About backing up data Secondary Copy Snapshot-based backups Backup retirement About NetVault Sets Backup and recovery strategy Creating backup jobs Creating Schedule Sets

Scheduling methods and options for non-repeating jobs Scheduling methods and options for repeating jobs

Creating Target Sets

Selecting the device Specifying media options Configuring media sharing options

Creating Source Sets for backup jobs Creating Backup Advanced Options Sets

Setting backup retirement options Specifying additional options Creating a Secondary Copy Configuring pre- and post script options for backup jobs Configuring user-defined events for backup jobs

Modifying a set Copying a set Deleting a set

Managing policies

Role-based access to manage policy

Creating a policy Viewing existing backup policies Viewing job status of policy jobs Modifying a backup policy

Modifying jobs in a backup policy Modifying clients in a backup policy Modifying events in a backup policy

Quiescing a backup policy Deleting a backup policy

About restoring data

Role-based actions to restore jobs

Creating restore jobs Restoring data using an existing Restore Selection Set Searching for files in savesets Viewing media list Creating Source Sets for restore jobs Creating Restore Advanced Options Sets

Setting restore type Specifying additional options Configuring pre- and post -scripts for restore jobs Configuring user-defined events for restore jobs

Managing online backup indexes

About managing online indexes Manually deleting online indexes Loading offline indexes Manually compressing online indexes Uncompressing online indexes

Managing Snapshots

Restoring snapshots Setting expiry for Snapshots Mounting Snapshots Unmounting Snapshots

Managing NetVault dashboard

About NetVault dashboard

Role-based access for NetVault Dashboard

Viewing NetVault dashboard

Configuring Dashboard Managing Dashboard Adding Dashboard

Sharing dashboard Cloning dashboard Deleting dashboard

Managing a widget on NetVault dashboard

Adding Widgets Positioning Widgets Widget filter options

About Managing jobs

Job activity capabilities

Viewing job activity Viewing job calendar Managing jobs

Running a job immediately Aborting a job Stopping a job Restarting a job Placing a job on hold Resuming a job Determining the reason for "waiting for media" status Viewing log messages for a job Viewing and managing a job Monitoring job progress Clearing job errors and warnings Removing a job schedule

Managing job definitions

Viewing job definitions Editing job definitions Deleting job definitions Adding a non-policy job to a policy

Viewing job history

Monitoring logs

About NetVault logs

Role-based access for monitoring logs

Viewing log messages Downloading logs Exporting logs Manually purging the log messages Setting up a user-defined log event Removing a user-defined log event Searching the knowledge base

Managing storage devices

Role-based access to manage storage devices Monitoring device activity Managing disk-based storage devices in list view

Viewing disk device details Managing a Quest DR Series system, QoreStor, or Data Domain system

Viewing device details Viewing cleaner statistics Starting or stopping cleaner Managing device users Managing a container Managing storage groups Removing Quest DR Series system Removing QoreStor

Checking the status of a disk-based storage device Changing the status of a disk-based storage device Scanning a disk-based storage device Removing all savesets from a disk-based storage device Removing a disk-based storage device

Managing disk-based storage devices in tree view

Viewing disk device details Checking the status of a disk-based storage device Changing the status of a disk-based storage device Setting storage properties for a disk-based storage device Scanning a disk-based storage device Removing a disk-based storage device

Managing the Snapshot Array Manager

Modifying the Snapshot Array Manager settings Changing the user credentials for Snapshot Array Manager Changing the status of Snapshot Array Manager Removing the Snapshot Array Manager

Managing tape libraries in list view

Viewing tape library details Opening and closing library door Opening and closing entry/exit ports Unloading or importing tapes from entry/exit ports Exporting tapes to entry/exit ports Restarting ACSLS or NDMP Libraries Importing shadow tapes (NetApp VTL) Removing a tape library

Managing tape libraries in tree view

Viewing tape library details Modifying a library Changing the device view type Opening and closing library door Opening and closing entry/exit ports Unloading or importing tapes from entry/exit ports Exporting tapes to entry/exit ports Restarting ACSLS or NDMP libraries Importing shadow tapes (NetApp VTL) Removing a tape library

Managing tape drives in list view

Viewing tape drive details Configuring performance options for a tape drive

Optimal transfer buffer size

Checking the status of a tape drive Changing the status of a tape drive Configuring cleaning slots Configuring the cleaning lives option Configuring automatic cleaning options for a tape drive Manually submitting a drive cleaning request Unloading a tape Loading a tape Removing a tape drive

Managing tape drives in tree view

Viewing tape drive details Configuring physical tape drives

Optimal transfer buffer size

Checking the status of a tape drive Changing the status of a tape drive Configuring cleaning slots Configuring the cleaning lives option Configuring automatic cleaning options for a tape drive Manually submitting a drive cleaning request Unloading a tape Loading a tape Marking media for re-use Removing a tape drive

Adding shared devices

Adding shared drives to non- shared library using the semi- automatic method Adding shared drives to non-shared library manually Sharing standalone drives

Managing storage media

Role-based access for storage media management Viewing storage summary Viewing disk storage details Viewing tape storage details Managing tape storage media

Labeling tape media Blanking tape media Scanning tape media Marking a tape as unusable Marking a tape as read-only Marking a tape for reuse Removing an offline tape

Managing savesets

Viewing saveset details Configuring saveset expiry options Expiring all savesets on disk-based storage Deleting savesets from disk-based storage devices Deleting savesets from tape-based storage devices

Managing user and group accounts

About user accounts About user and group privileges and presets

Role-based User and Groups privileges Configuring user details Configuring memberships for a user account or user group Granting privileges and quota Granting add and remove permissions Setting up notification profile

Setting a user policy Using Secure Mode

Enabling or Disabling Secure Mode

Creating a Preset Modifying a Preset Deleting a Preset

User privileges Predefined Presets Integrating Active Directory with NetVault

Considerations for Linux-based NetVault Managing AD users

Adding an AD user Deleting an AD user

Managing AD groups

Adding an AD group to NetVault Server Viewing a list of AD groups that exist in NetVault Modifying description of added AD group in NetVault Deleting an AD group that was added to NetVault

Using Azure Active Directory as an identity provider

Setting up an Azure AD login with NetVault

Registering NetVault on the Azure portal Setting authentication for Azure AD users Restricting an application to a set of users Configuring Azure AD in NetVault

Managing an Azure AD user

Adding an Azure AD user Deleting an Azure AD user

Managing Azure AD groups

Adding an Azure AD group to NetVault Server Viewing a list of Azure AD groups that exist in NetVault Modifying the description of an Azure AD group in NetVault Deleting an Azure AD group from NetVault

Managing Tenant

About tenant management Adding tenants

Configuring tenant details

Modifying tenants account Deleting tenant Disabling tenant

Monitoring events and configuring notifications

About NetVault events About notification methods Role-based access to configure notification Event classes Events types

Role-based access to view events

Viewing event logs

Reporting in NetVault

Reporting system overview

Working with reports Generating reports Setting a favorite report Setting filters for report Editing report job definitions Using notification methods to send reports by email reports Customizing table views for reports Adding charts to reports Exporting reports to PDF files

Available reports

Working with client clusters

About client cluster support Device configuration in cluster environment Installing and upgrading cluster-aware plug-ins

Prerequisites Installing a cluster-aware plug-in Upgrading a cluster-aware plug-in

Configuring a cluster-aware plug-in

Configuring preferred network address for cluster nodes Configuring default settings for a cluster-aware plug-in

Managing virtual clients

Modifying a virtual client Checking access to a virtual client Determining the current real client Removing a virtual client

Backups using cluster-aware plug-ins Restores using cluster-aware plug-ins

Configuring default settings for NetVault

About configuring default settings

Other configuration utilities

Configuring encryption settings Configuring plug-in options

Configuring default settings for Disk Devices Plug-in Configuring default settings for nvjobstart

Configuring default settings for post-scripts Configuring default settings for Verify Plug-in Configuring Deployment Manager Settings

About Deployment Manager Configuring default settings for Deployment Manager

Configuring Job Manager settings

About Job Manager Configuring default settings for Job Manager

Configuring Logging Daemon settings

About Logging Daemon Configuring disk space alert thresholds Modifying the purge policy for log messages Configuring additional settings for Logging Daemon

Configuring Media Manager settings

About Media Manager Configuring general settings for Media Manager Configuring retirement rules for dependent backups Configuring Media Manager settings for tape devices Configuring Media Manager settings for backup indexes Configuring Media Manager settings for RAS devices Configuring transfer update settings for foreign RAS devices Configuring data transfer stall timeout period for NetVault SmartDisk Configuring media request weightings Configuring default interval for backup retirement scans Configuring an alternate index read block size for Quest DR Series systems

Configuring Network Manager settings

About Network Manager Configuring timeout settings for Network Manager Enabling or disabling availability broadcasts Configuring network addresses for multihomed machines Reducing startup delay Configuring default port for Network Manager Configuring default port for Communications Manager

Configuring Process Manager settings

About Process Manager Configuring shared memory settings

Configuring RAS device settings

Configuring connection settings for NetVault SmartDisk

Configuring Schedule Manager settings

About Schedule Manager Configuring default settings for Schedule Manager Configuring default job priority settings

Configuring Web Service settings

Configuring Web Service to disable ciphers Configuring Web Service to disable protocols Enabling Web Service auditing Configuring timeout period for client operations Configuring timeout period for saveset removal request

Configuring Auditor Daemon settings

About Auditor Daemon Configuring Auditor to log only failed requests Modifying the purge policy for audit logs

Configuring firewall settings Configuring general settings

Relocating default directories Relocating the NetVault Database directory Configuring TCP/IP buffer sizes Changing language and locale settings

Changing language settings for NetVault WebUI

Disabling pre-installation package compatibility check Configuring license expiration warning period

Configuring security settings

Disabling password protection for a client Changing NetVault password

Synchronizing NetVault Time

About NetVault Time Configuring an alternate NetVault Time Server

Configuring the reporting utility

About reporting utility Customizing CSV report templates Customizing HTML report templates Customizing miscellaneous report templates Customizing plain text report templates Configuring timeout setting for report generation Configuring default mail format type for report Configuring default settings for Statistics Manager Creating a global purge policy for the Reports Database Creating table-specific purge policy

Configuring NetVault WebUI default settings Configuring NetVault to use a specific VSS provider Configuring default settings using Txtconfig

Diagnostic tracing

About diagnostic tracing Managing trace filters Enabling tracing Downloading trace files Changing the trace directory location Enabling tracing using Txtconfig Disabling tracing Deleting trace session directories

Managing diagnostic data

About support diagnostics Downloading diagnostic data Uploading diagnostic data

Using the deviceconfig utility

About deviceconfig Configuring default settings for tape libraries

General settings for tape libraries Drive cleaning settings Mixed media settings

Configuring default settings for tape drives

NDMP settings General settings for tape drives Software compression settings Drive performance settings Statistics collection settings Generic cleaning settings

NetVault processes

About NetVault processes Process description

Environment variables

Environment variables in NetVault

Network ports used by NetVault

Ports used or required

Troubleshooting

NetVault Service fails to start on Windows NetVault Service fails to start after the machine is restarted Login fails after any change in the server IP address Unexpected behavior of NetVault WebUI WebUI does not run in Compatibility View in Internet Explorer NetVault installer fails during push installation VSS-based backup fails Modifying TCP/IP socket buffer size on Windows Restores using Data Copy savesets fail on clients running NetVault 10.0.1 Restore fails on Itanium platforms if the index is larger than 2GB After upgrade, console error is displayed on WebUI pages Domain user is unable to login NetVault Server if the workstation attribute is set. Domain user is unable to login NetVault Server on Debian 9. Adding the target machine as a client fails, after successful push installation. Unable to install, uninstall or navigate catalog search page after manually uninstalling NetVault Client Host. Unable to install, uninstall catalog search on client after NetVault Server migration with the same or different server name External Azure AD user cannot add an external Azure AD user to NetVault Server Failed to verify target Windows machine from a Linux-based NetVault Server NetVault is unable to send reports as an email attachment in PDF format on RHEL 5.x platform Restore fails on NetVault Database backup When using RDA for backups, only four streams are used at once Unable to create large VTL on Linux Browsing a folder with a large number of files times out

Safe Mode in NetVault

Environment variables

•

Environment variables in NetVault

Environment variables in NetVault

The following is a list of NetVault environment variables that can be used in user-defined scripts. MSP administrator can use these environment variables for their own servers.

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

Returns the NetVault installation directory.

Specifies the target client for a job.

NV_JOBCLIENT=<Name of the NetVault Client>

Specifies the Job ID number.

NV_JOBID=<Job ID>

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.

Returns the user-defined output file for reports.

Specifies the NetVault Server Name.

NV_SERVERNAME=<Name of the NetVault Server>

Specifies the Session ID of a job.

NV_SESSIONID=<Session ID>

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.

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

Network ports used by NetVault

•

Ports used or required

Ports used or required

The following table provides a list of network ports used by NetVault.

Table 172. Ports used by NetVault
Port	Protocol	Usage	Comments
80	TCP	HTTP Listen port for incoming Web Service connections.
135	TCP	RPC port used during the client push installation process.
3306	TCP	Port used to make a TCP/IP connection to the MySQL Server.	Configured on the NetVault Client on which the Plug-in for MySQL is installed. The default port number is 3306. If a non-default port is configured for client connections on the MySQL Server, verify that the same port is configured on the NetVault Client. To run multiple instances of MySQL on the same machine, a different port is configured for each instance.
5432	TCP	Listener port for PostgreSQL Database.	Configured on the NetVault Client on which the Plug-in for PostgreSQL is installed. The default port number is 5432. If the PostgreSQL Database is configured to listen on a non-default port, verify that the same port is configured on the NetVault Client.
8443	TCP	HTTPS Listen port for incoming Web Service connections.
10000	TCP	Port for sending NDMP messages (NDMP control channels).	Configured on the NetVault Server on which the Plug-in for NDMP is installed. The default port number is 10000. You can change it, if necessary.
20031	UDP	UDP messaging.	Required on server and clients.
20031	TCP	Port used by Network Manager (nvnmgr).
User-defined listen ports for devices	TCP	Ports to listen on for device requests.	Configured on the NetVault Server and SmartClients. Requirement: Two ports per drive.
User-defined connect ports for devices	TCP	Ports to connect to remote storage devices.	Configured on clients that connect to remote storage devices. Requirement: Two ports per drive
User-defined listen ports for message channels	TCP	Ports to receive messages during data transfers.	Configured on NetVault Server and Clients. Requirement: Three ports per client. To run two or more plug-ins simultaneously on a client, NetVault requires two ports per plug‑in and an extra port per client. For example, to run two plug-ins simultaneously, NetVault requires (2 * 2) + 1 = 5 ports for a client.
User-defined connect ports for message channels	TCP	Ports for sending messages during data transfers.	Configured on NetVault Server and Clients. Requirement: Three ports per client. To run two or more plug-ins simultaneously on a client, NetVault requires two ports per plug‑in and an extra port per client. For example, to run two plug-ins simultaneously, NetVault requires (2 * 2) + 1 = 5 ports for a client.
User-defined connect ports for inter-machine setup	TCP	Ports for establishing initial contact (broadcast channels) while adding a NetVault Client, and later to ascertain its availability.	Requirement: Two ports per client.
User-defined listen ports for NDMP data channels	TCP	Ports to listen on for NetVault devices operating as NDMP movers.	These ports are used for data transfers between NDMP filer and storage device. These ports are required on the NetVault Server or Client to which the device is attached.
49152 through 65535	TCP	Dynamic ports that are used during the client push installation process.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center