NetBackup™ WebSocket Service (NBWSS) Reference Guide
- Using the NetBackup WebSocket Service (NBWSS) for communication with a cloud application
- 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
NetBackup requests a connection to the endpoint
{
"version": "1.0",
"id": "0CEAB6C2-0BBF-4F60-974D-C1F3EF39B872",
"type": "CONNECT",
"subType": "REQUEST",
"timeStamp": 1444944181,
"payload": {
"token": "qwerrtrtrtrt2234344==="
}
}Notes: In this message, the "type" field is "CONNECT" and the "subType" is "REQUEST". The "token" key contains the application validation token that was added when the endpoint was configured in NetBackup. The cloud-based application validates this token and sends a CONNECT RESPONSE message with the results of the validation (see the following example).
The "subType" is "RESPONSE".
{
"version": "1.0",
"id": "0CEAB6C2-0BBF-4F60-974D-C1F3EF39B872",
"type": "CONNECT",
"subType": "RESPONSE",
"timeStamp": 1444944191,
"payload": {
"valid": true
}
}Notes: If the token is validated, the application responds with the "valid" field set to true. NetBackup then considers the connection to be established and operations can proceed. If the token is not valid, the application should respond with "valid" set to false, which causes NetBackup to close the connection.
Note:
The response should always have the same "id" as the request.