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
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.
Note:
The available data protection services depend on the availability of APIs in the current and upcoming releases of NetBackup.
Table: NBWSS communication process lists the phases in the NBWSS communication process.
Table: NBWSS communication process
Phase | Description |
|---|---|
Phase 1 | With its endpoint credentials, NetBackup sends a connection request to the cloud application. For example: |
Phase 2 | The cloud application reads the connection request and sends NetBackup a response. For example: |
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: |
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. |