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
Notes on NetBackup connections to cloud-applications
NBWSS uses the following rules to establish a connection to an endpoint:
If no active connections exist to an endpoint in a server group, NetBackup attempts to connect to the endpoint that has the highest priority.
If unable to connect to an endpoint within a server group (the server is down), NetBackup attempts to connect to the endpoint that has the next highest priority in that server group.
Note these additional rules and limitations:
At most one connection can exist per endpoint at a time.
At most one connection can exist per server group at a time.
NBWSS does not automatically close an existing connection when a higher priority connection comes online. For example, assume that server group
sg1has two endpoints (ep1andep2) with priorities 1 and 2, respectively. If NBWSS is currently connected toep2(priority 2) andep1(priority 1) comes online, NBWSS does not automatically connect toep1. The cloud application must close the connection toep2before NBWSS attempts to connect toep1.A connection process runs on a timer that responds to endpoint connection changes (such as for connecting to new endpoints or disconnecting from removed endpoints). The default period for this task is 60 seconds. As a result, it may be up to 1 minute before endpoint changes take effect.
You can use the
connectionInfo.periodproperty to configure this task.See Configuring the properties of the NetBackup WebSocket Service (NBWSS).
When the NetBackup Web Management Console service is restarted, the NetBackup web server takes a few minutes to start. As a result, it takes a few minutes for currently configured endpoints to appear in the NetBackup Administration Console. The endpoints appear under Media and Device Management > Credentials > WebSocket Servers.
An established connection does not have a time limit; the connection can exist indefinitely. In some cases the connection may have to be re-established, such as when the token that NetBackup sends to the cloud application has expired. In that case, the NetBackup credentials for the endpoint must be re-added with a new, valid token. The connection is re-established the next time the connection process runs (determined by the
connectionInfo.periodproperty).The maximum incoming packet size that is allowed on the NetBackup WebSocket channel is 2 MB. If the NetBackup WebSocket server receives a packet that is larger than 2MB, the connection is dropped. In the next refresh of connections (by default, 60 seconds later), NBWSS attempts to reconnect with the remote endpoint.