Please enter search query.
Search <book_title>...
Veritas NetBackup™ WebSocket Service (NBWSS) Reference Guide
Last Published:
2021-01-01
Product(s):
NetBackup (9.0.0.1, 9.0)
- 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
NetBackup notification messages for a backup job
Examples A through G are the notifications that NetBackup sent to an endpoint for a backup from a VMware Intelligent Policy.
A. Start of a parent backup job (discovery)
{
"version": "1.0",
"id": "EDD85CD7-8555-47E4-8A19-01C35093F220",
"type": "NOTIFICATION",
"subType": "REQUEST",
"timeStamp": 1459811679,
"payload": [
{
"notificationType": "INFO",
"object": "JOB",
"data": [
{
"scheduleType": "ST_FULL",
"clientName": "masterserver2.domain.com",
"status": 0,
"startTime": 1459829674,
"state": "ACTIVE",
"policyName": "vmware2",
"parentJobId": 144,
"jobId": 144,
"policyType": "VMWARE",
"jobType": "BACKUP"
}
]
}
]
}B. Start of the child snapshot job
{
"version": "1.0",
"id": "7C0FD14E-089E-46C8-AA2B-344D69AA0C67",
"type": "NOTIFICATION",
"subType": "REQUEST",
"timeStamp": 1459811689,
"payload": [
{
"notificationType": "INFO",
"object": "JOB",
"data": [
{
"scheduleType": "ST_FULL",
"clientName": "DummyTestVM",
"status": 0,
"startTime": 1459829686,
"state": "ACTIVE",
"policyName": "vmware2",
"parentJobId": 144,
"jobId": 145,
"policyType": "VMWARE",
"jobType": "BACKUP"
}
]
}
]
}C. Start of child backup job (actual backup)
{
"version": "1.0",
"id": "EF507ECE-4B1C-4D87-AAB0-032ADBC915FC",
"type": "NOTIFICATION",
"subType": "REQUEST",
"timeStamp": 1459811704,
"payload": [
{
"notificationType": "INFO",
"object": "JOB",
"data": [
{
"scheduleType": "ST_FULL",
"clientName": "DummyTestVM",
"status": 0,
"startTime": 1459829698,
"state": "ACTIVE",
"policyName": "vmware2",
"parentJobId": 145,
"jobId": 146,
"policyType": "VMWARE",
"jobType": "BACKUP"
}
]
}
]
}D. Image creation
{
"version": "1.0",
"id": "608FE0C1-B03C-421D-8876-E3730A7855AF",
"type": "NOTIFICATION",
"subType": "REQUEST",
"timeStamp": 1459811724,
"payload": [
{
"notificationType": "INFO",
"object": "IMAGE",
"data": [
{
"clientType": "VMWARE",
"clientName": "DummyTestVM",
"backupTime": 1459811698,
"createdTime": 1459829720,
"operationId": "CREATE",
"backupId": "DummyTestVM_1459811698"
},
{
"clientType": "VMWARE",
"clientName": "DummyTestVM",
"backupTime": 1459811686,
"createdTime": 1459829721,
"operationId": "UPDATE",
"backupId": "DummyTestVM_1459811686"
}
]
}
]
}E. Backup job complete (actual backup job)
{
"version": "1.0",
"id": "608FE0C1-B03C-421D-8876-E3730A7855AF",
"type": "NOTIFICATION",
"subType": "REQUEST",
"timeStamp": 1459811724,
"payload": [
{
"notificationType": "INFO",
"object": "JOB",
"data": [
{
"scheduleType": "ST_FULL",
"clientName": "DummyTestVM",
"status": 0,
"startTime": 1459829698,
"state": "DONE",
"policyName": "vmware2",
"parentJobId": 145,
"jobId": 146,
"policyType": "VMWARE",
"jobType": "BACKUP"
}
]
}
]
}F. Snapshot job complete
{
"version": "1.0",
"id": "F97BAE8F-D1E3-4242-A5EC-FB1C9B8F46E3",
"type": "NOTIFICATION",
"subType": "REQUEST",
"timeStamp": 1459811734,
"payload": [
{
"notificationType": "INFO",
"object": "JOB",
"data": [
{
"scheduleType": "ST_FULL",
"clientName": "DummyTestVM",
"status": 0,
"startTime": 1459829686,
"state": "DONE",
"policyName": "vmware2",
"parentJobId": 144,
"jobId": 145,
"policyType": "VMWARE",
"jobType": "BACKUP"
}
]
}
]
}G. Parent backup job complete
{
"version": "1.0",
"id": "F97BAE8F-D1E3-4242-A5EC-FB1C9B8F46E3",
"type": "NOTIFICATION",
"subType": "REQUEST",
"timeStamp": 1459811734,
"payload": [
{
"notificationType": "INFO",
"object": "JOB",
"data": [
{
"scheduleType": "ST_FULL",
"clientName": "masterserver2.domain.com",
"status": 0,
"startTime": 1459829674,
"state": "DONE",
"policyName": "vmware2",
"parentJobId": 144,
"jobId": 144,
"policyType": "VMWARE",
"jobType": "BACKUP"
}
]
}
]
}