Veritas NetBackup™ WebSocket Service (NBWSS) Reference Guide

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

WebSocket Server dialog

Use this dialog to save NetBackup credentials for a secure connection to an application server in the cloud. NetBackup uses the server credentials to connect to the cloud server's WebSocket endpoint.

To use this dialog to save the credentials, the endpoint information must be available in either of the following ways:

  • In a file that is formatted in JavaScript Object Notation (a JSON file).

  • In a URL that the cloud application generated.

The following topic contains a procedure for using this dialog:

See Saving NetBackup credentials for a WebSocket server endpoint.

Table: Fields in the WebSocket Server dialog



Select an option

Select one of the following to specify the endpoint information:

  • FILE: Use this option to locate a JSON-formatted file that contains the endpoint information.


    NetBackup extracts the endpoint information from the file and displays that information in this dialog.

  • URL: Use this option to enter the URL that contains the endpoint information.


    NetBackup extracts the endpoint information from the URL and displays that information in this dialog.


Click Browse to locate the JSON-formatted file that contains the endpoint information. Use the Look In pull-down or the search icons. From left to right, the icons can move up one level, go to the desktop, create a new folder, or change the list view.

As an alternative, you can enter the file's full path in the File Name field.


REQUIRED: After you have selected the endpoint information (FILE or URL), click Validate to view the SSL certificate of the endpoint.


If you entered a URL for the endpoint information, click Validate to extract the information and display it under Server Information.

Server Information

The following fields show the endpoint information that NetBackup extracted from the JSON file or the URL.

Host Name:

The fully qualified host name or IP address of the cloud server that contains the endpoint.

This host name or IP address must be unique: it must not be the host name or IP address for an endpoint that has already been added.

WebSocket Server Endpoint:

The full URL, port, and any additional identifier of the WebSocket endpoint.

Example endpoint: wss://


ws:// is not supported.

Group ID:

The server group that the endpoint belongs to.

Token: View

Click View to display the security token that the cloud application uses to validate the identity of NetBackup.

Add Host

If the extracted endpoint information is correct, click Add Host to save this information as NetBackup endpoint credentials.

At a configurable interval, a scheduled task checks the NetBackup database for updates to endpoints and acts accordingly. It can take up to the configured time (default is 5 minutes) to connect after you add an endpoint.

See Configuring the properties of the NetBackup WebSocket Service (NBWSS).

See About NetBackup connections to WebSocket endpoints.

The following topic describes the endpoint information and its formatting in more detail:

See WebSocket endpoint details and their formatting.