Veritas NetBackup™ WebSocket Service (NBWSS) Reference Guide

Last Published:
Product(s): NetBackup (, 9.0)

About the NetBackup WebSocket Service (NBWSS)

Veritas provides a NetBackup WebSocket Service (NBWSS) that allows applications in the cloud to communicate with a NetBackup master server that is behind a firewall. NBWSS uses the WebSocket protocol to create a secure connection to the application's server in the cloud. On that connection, the application can interact with NetBackup by invoking REST APIs and can receive notifications from NetBackup.

NetBackup communicates with the cloud-based application over a web interface that the cloud application makes available. That interface is called a WebSocket endpoint. When a connection exists between NetBackup and the cloud application's endpoint, the application can use NBWSS messages to direct NetBackup to perform data protection services.


The available data protection services depend on the availability of APIs in the current and upcoming releases of NetBackup.

Figure: NBWSS overview

NBWSS overview

Table: NBWSS communication process lists the phases in the NBWSS communication process.

Table: NBWSS communication process



Phase 1

With its endpoint credentials, NetBackup sends a connection request to the cloud application.

For example:

See NetBackup requests a connection to the endpoint.

Phase 2

The cloud application reads the connection request and sends NetBackup a response.

For example:

See NetBackup requests a connection to the endpoint.

Phase 3

When a connection is established, the cloud application's NBWSS component can call NetBackup APIs to perform data protection services (such as backup or recovery). The cloud application must also interpret each response from NetBackup.

For example:

See The cloud application asks to make a REST API call.

See Notes on NetBackup connections to cloud-applications.

Phase 4

NetBackup sends notifications to the cloud application regarding jobs (start and end) and backup images (create, update, delete). The cloud application interprets and acknowledges the notifications.

For example:

See NetBackup notification messages for a backup job.

See NBWSS notifications.

See Task overview for setting up NBWSS communication.