Veritas NetBackup™ 8.0 WebSocket Service (NBWSS) Reference Guide

Last Published:
Product(s): NetBackup (8.0)

Configuring the properties of the NetBackup WebSocket Service (NBWSS)

Table: Configurable properties of NBWSS describes the configurable NBWSS properties and their defaults. The properties are in the nbwss.properties text file on the NetBackup master server. (For the location of this file, see the procedure in this topic.)

Each property appears on a single line in the following form:

key=value

An example .properties file is included after the table. To change the properties, use the procedure at the end of this topic.

Table: Configurable properties of NBWSS

Keys

Description

exception.ignoreDecoder

Boolean

Determines whether or not NBWSS ignores a decoder exception. A decoder exception usually occurs when NBWSS is unable to understand a message it receives.

The default is false: NBWSS closes the connection when a decoder exception occurs.

notification.sendTimeout=

Integer

Determines how long (in milliseconds) NBWSS waits to communicate with an endpoint (to send or receive a notification). By default, a notification task waits for 2 seconds before the task terminates. The notification task tries again after the time limit that the notification.scheduledRate property sets.

The default is 2000 milliseconds (2 seconds). In most cases, Veritas recommends the default.

notification.scheduledRate=

Integer

Determines how often (in seconds) NetBackup queries for new notifications. This value also determines how long NetBackup waits to receive an acknowledgement for a notification before it resends the notification.

The default is 5 seconds.

keepAlive.scheduledRate=

Integer

Determines how often (in seconds) NBWSS sends a ping to each endpoint as part of its keep alive functionality. If NetBackup receives a pong in response to each ping, the endpoint connection is still valid.

The default is 30 seconds.

keepAlive.maxPongMissAllowed=

Integer

Determines how many pongs (responses to pings) can be missed for an endpoint connection. When NBWSS sends a ping to an endpoint and a pong is not received, that is considered a missed pong. When the maximum is reached, NBWSS closes the connection to the endpoint.

The default is 10 missed pongs.

connectionInfo.period=

Integer

Determines the number of seconds between each NBWSS connection update. Each update determines the endpoints that are currently configured in NetBackup, and connects to new endpoints or disconnects from the endpoints that no longer exist.

Note:

After you add an endpoint, it can take up to the configured time to connect to that endpoint.

The default is 60 seconds.

scheduledExecutor.threadPoolSize=

Integer

Determines how many threads NetBackup uses to maintain the endpoint connection and to handle notifications.

The default is 1 thread. It may be helpful to increase this value if the number of scheduled tasks increases.

The hibernate properties

These properties are for the use of Veritas Support.

Here is the nbwss.properties file with its default settings (see the following procedure for the location of this file):

#Properties file for NetBackup WebSocket Service
exception.ignoreDecoder=false
notification.sendTimeout=2000
notification.scheduledRate=5
keepAlive.scheduledRate=30
keepAlive.maxPongMissAllowed=10
connectionInfo.period=60
scheduledExecutor.threadPoolSize=1

#Hibernate properties
hibernate.format_sql=true
hibernate.show_sql=false
hibernate.hbm2ddl.auto=update
hibernate.dialect=org.hibernate.dialect.SybaseDialect

To configure the properties of the NetBackup WebSocket Service (NBWSS)

  1. Use a text editor to open the nbwss.properties file.

    The file is in the following location on the NetBackup master server:

    On Windows: 

    install_path\NetBackup\wmc\webserver\webapps_api\
nbwss\WEB-INF\classes\nbwss.properties

    On Linux:

    /usr/openv/wmc/webserver/webapps_api/nbwss/WEB-INF/classes/
nbwss.properties
  2. Edit the value of the property that you want to change, and save the file.

    Table: Configurable properties of NBWSS describes the NBWSS properties and their defaults.

  3. For the changes to take effect, it may be necessary to restart the NetBackup Web Management Console service on the NetBackup master server.

See Starting a NetBackup connection to a cloud application.