Veritas NetBackup™ WebSocket Service (NBWSS) Reference Guide
- Using the NetBackup WebSocket Service (NBWSS) for communication with a cloud application
- Updates to this guide for NetBackup 8.1.1
- Additional documentation on NetBackup APIs
- About the NetBackup WebSocket Service (NBWSS)
- Task overview for setting up NBWSS communication
- Notes on NetBackup connections to cloud-applications
- NBWSS message formats
- API calls over NBWSS
- NBWSS notifications
- Examples of NBWSS messages
- Configuring WebSocket endpoints for NBWSS
- About NetBackup connections to WebSocket endpoints
- WebSocket endpoint details and their formatting
- Saving NetBackup credentials for a WebSocket server endpoint
- WebSocket Server dialog
- Removing NetBackup credentials for a WebSocket server endpoint
- Configuring the properties of the NetBackup WebSocket Service (NBWSS)
- Starting a NetBackup connection to a cloud application
- Troubleshooting NBWSS
- NBWSS logging
- NBWSS issues
- Problems validating the endpoint server in the WebSocket Server dialog
- Problems saving the NetBackup endpoint credentials in the WebSocket Server dialog
- Problems deleting the WebSocket server endpoint from NetBackup
- Problems displaying the list of WebSocket servers that were added in NetBackup
- Problems activating or deactivating the endpoint server
- Additional NBWSS issues
Starting a NetBackup connection to a cloud application
To talk to a cloud application, NetBackup uses a web interface that the cloud server makes available. That interface is called a WebSocket endpoint.
A NetBackup process automatically requests a connection to the WebSocket endpoint according to a preset schedule. By default, the connection process runs every 60 seconds. That process is controlled by the connectionInfo.period= property in the nbwss.properties file on the NetBackup master server. Whenever the connection process runs, it updates (adds or deletes) NetBackup connections to endpoints. For example, if a new endpoint has been added, the process checks if NetBackup is already connected to another endpoint in the same server group. If NetBackup is not connected to another endpoint in the same server group, the process initiates a connection to the new endpoint.
To control the time interval at which NetBackup starts a connection to a cloud application
- On the NetBackup master server, edit the
connectionInfo.period=property in thenbwss.propertiesfile.For the location of this file and further details:
See Configuring the properties of the NetBackup WebSocket Service (NBWSS).
Note:
To start a connection, NetBackup must have the proper credentials to access the cloud server's endpoint:
See WebSocket endpoint details and their formatting.
See Saving NetBackup credentials for a WebSocket server endpoint.